1 #ifndef BLOCK_H 2 #define BLOCK_H 3 4 #include "block/aio.h" 5 #include "qemu-common.h" 6 #include "qemu/option.h" 7 #include "block/coroutine.h" 8 #include "qapi/qmp/qobject.h" 9 #include "qapi-types.h" 10 11 /* block.c */ 12 typedef struct BlockDriver BlockDriver; 13 typedef struct BlockJob BlockJob; 14 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; 20 bool is_dirty; 21 } BlockDriverInfo; 22 23 typedef struct BlockFragInfo { 24 uint64_t allocated_clusters; 25 uint64_t total_clusters; 26 uint64_t fragmented_clusters; 27 uint64_t compressed_clusters; 28 } BlockFragInfo; 29 30 /* Callbacks for block device models */ 31 typedef struct BlockDevOps { 32 /* 33 * Runs when virtual media changed (monitor commands eject, change) 34 * Argument load is true on load and false on eject. 35 * Beware: doesn't run when a host device's physical media 36 * changes. Sure would be useful if it did. 37 * Device models with removable media must implement this callback. 38 */ 39 void (*change_media_cb)(void *opaque, bool load); 40 /* 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 /* 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 /* 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 /* 60 * Runs when the size changed (e.g. monitor command block_resize) 61 */ 62 void (*resize_cb)(void *opaque); 63 } BlockDevOps; 64 65 #define BDRV_O_RDWR 0x0002 66 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ 67 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ 68 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */ 69 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */ 70 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */ 71 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */ 72 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */ 73 #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */ 74 #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */ 75 #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */ 76 #define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */ 77 78 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH) 79 80 #define BDRV_SECTOR_BITS 9 81 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS) 82 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1) 83 84 typedef enum { 85 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP 86 } BlockErrorAction; 87 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 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); 102 void bdrv_info_print(Monitor *mon, const QObject *data); 103 void bdrv_info(Monitor *mon, QObject **ret_data); 104 void bdrv_stats_print(Monitor *mon, const QObject *data); 105 void bdrv_info_stats(Monitor *mon, QObject **ret_data); 106 107 /* disk I/O throttling */ 108 void bdrv_io_limits_enable(BlockDriverState *bs); 109 void bdrv_io_limits_disable(BlockDriverState *bs); 110 bool bdrv_io_limits_enabled(BlockDriverState *bs); 111 112 void bdrv_init(void); 113 void bdrv_init_with_whitelist(void); 114 BlockDriver *bdrv_find_protocol(const char *filename, 115 bool allow_protocol_prefix); 116 BlockDriver *bdrv_find_format(const char *format_name); 117 BlockDriver *bdrv_find_whitelisted_format(const char *format_name, 118 bool readonly); 119 int bdrv_create(BlockDriver *drv, const char* filename, 120 QEMUOptionParameter *options); 121 int bdrv_create_file(const char* filename, QEMUOptionParameter *options); 122 BlockDriverState *bdrv_new(const char *device_name); 123 void bdrv_make_anon(BlockDriverState *bs); 124 void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old); 125 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top); 126 void bdrv_delete(BlockDriverState *bs); 127 int bdrv_parse_cache_flags(const char *mode, int *flags); 128 int bdrv_parse_discard_flags(const char *mode, int *flags); 129 int bdrv_file_open(BlockDriverState **pbs, const char *filename, 130 QDict *options, int flags); 131 int bdrv_open_backing_file(BlockDriverState *bs, QDict *options); 132 int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options, 133 int flags, BlockDriver *drv); 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); 142 void bdrv_close(BlockDriverState *bs); 143 void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify); 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); 148 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops, 149 void *opaque); 150 void bdrv_dev_eject_request(BlockDriverState *bs, bool force); 151 bool bdrv_dev_has_removable_media(BlockDriverState *bs); 152 bool bdrv_dev_is_tray_open(BlockDriverState *bs); 153 bool bdrv_dev_is_medium_locked(BlockDriverState *bs); 154 int bdrv_read(BlockDriverState *bs, int64_t sector_num, 155 uint8_t *buf, int nb_sectors); 156 int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num, 157 uint8_t *buf, int nb_sectors); 158 int bdrv_write(BlockDriverState *bs, int64_t sector_num, 159 const uint8_t *buf, int nb_sectors); 160 int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov); 161 int bdrv_pread(BlockDriverState *bs, int64_t offset, 162 void *buf, int count); 163 int bdrv_pwrite(BlockDriverState *bs, int64_t offset, 164 const void *buf, int count); 165 int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov); 166 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset, 167 const void *buf, int count); 168 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num, 169 int nb_sectors, QEMUIOVector *qiov); 170 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs, 171 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); 172 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num, 173 int nb_sectors, QEMUIOVector *qiov); 174 /* 175 * Efficiently zero a region of the disk image. Note that this is a regular 176 * I/O request like read or write and should have a reasonable size. This 177 * function is not suitable for zeroing the entire image in a single request 178 * because it may allocate memory for the entire region. 179 */ 180 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num, 181 int nb_sectors); 182 int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num, 183 int nb_sectors, int *pnum); 184 int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top, 185 BlockDriverState *base, 186 int64_t sector_num, 187 int nb_sectors, int *pnum); 188 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, 189 const char *backing_file); 190 int bdrv_get_backing_file_depth(BlockDriverState *bs); 191 int bdrv_truncate(BlockDriverState *bs, int64_t offset); 192 int64_t bdrv_getlength(BlockDriverState *bs); 193 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs); 194 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); 195 int bdrv_commit(BlockDriverState *bs); 196 int bdrv_commit_all(void); 197 int bdrv_change_backing_file(BlockDriverState *bs, 198 const char *backing_file, const char *backing_fmt); 199 void bdrv_register(BlockDriver *bdrv); 200 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top, 201 BlockDriverState *base); 202 BlockDriverState *bdrv_find_overlay(BlockDriverState *active, 203 BlockDriverState *bs); 204 BlockDriverState *bdrv_find_base(BlockDriverState *bs); 205 206 207 typedef struct BdrvCheckResult { 208 int corruptions; 209 int leaks; 210 int check_errors; 211 int corruptions_fixed; 212 int leaks_fixed; 213 int64_t image_end_offset; 214 BlockFragInfo bfi; 215 } BdrvCheckResult; 216 217 typedef enum { 218 BDRV_FIX_LEAKS = 1, 219 BDRV_FIX_ERRORS = 2, 220 } BdrvCheckMode; 221 222 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix); 223 224 /* async block I/O */ 225 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector, 226 int sector_num); 227 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num, 228 QEMUIOVector *iov, int nb_sectors, 229 BlockDriverCompletionFunc *cb, void *opaque); 230 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num, 231 QEMUIOVector *iov, int nb_sectors, 232 BlockDriverCompletionFunc *cb, void *opaque); 233 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs, 234 BlockDriverCompletionFunc *cb, void *opaque); 235 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs, 236 int64_t sector_num, int nb_sectors, 237 BlockDriverCompletionFunc *cb, void *opaque); 238 void bdrv_aio_cancel(BlockDriverAIOCB *acb); 239 240 typedef struct BlockRequest { 241 /* Fields to be filled by multiwrite caller */ 242 int64_t sector; 243 int nb_sectors; 244 QEMUIOVector *qiov; 245 BlockDriverCompletionFunc *cb; 246 void *opaque; 247 248 /* Filled by multiwrite implementation */ 249 int error; 250 } BlockRequest; 251 252 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, 253 int num_reqs); 254 255 /* sg packet commands */ 256 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); 257 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, 258 unsigned long int req, void *buf, 259 BlockDriverCompletionFunc *cb, void *opaque); 260 261 /* Invalidate any cached metadata used by image formats */ 262 void bdrv_invalidate_cache(BlockDriverState *bs); 263 void bdrv_invalidate_cache_all(void); 264 265 void bdrv_clear_incoming_migration_all(void); 266 267 /* Ensure contents are flushed to disk. */ 268 int bdrv_flush(BlockDriverState *bs); 269 int coroutine_fn bdrv_co_flush(BlockDriverState *bs); 270 int bdrv_flush_all(void); 271 void bdrv_close_all(void); 272 void bdrv_drain_all(void); 273 274 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); 275 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); 276 int bdrv_has_zero_init_1(BlockDriverState *bs); 277 int bdrv_has_zero_init(BlockDriverState *bs); 278 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, 279 int *pnum); 280 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base, 281 int64_t sector_num, int nb_sectors, int *pnum); 282 283 void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error, 284 BlockdevOnError on_write_error); 285 BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read); 286 BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error); 287 void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action, 288 bool is_read, int error); 289 int bdrv_is_read_only(BlockDriverState *bs); 290 int bdrv_is_sg(BlockDriverState *bs); 291 int bdrv_enable_write_cache(BlockDriverState *bs); 292 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce); 293 int bdrv_is_inserted(BlockDriverState *bs); 294 int bdrv_media_changed(BlockDriverState *bs); 295 void bdrv_lock_medium(BlockDriverState *bs, bool locked); 296 void bdrv_eject(BlockDriverState *bs, bool eject_flag); 297 const char *bdrv_get_format_name(BlockDriverState *bs); 298 BlockDriverState *bdrv_find(const char *name); 299 BlockDriverState *bdrv_next(BlockDriverState *bs); 300 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), 301 void *opaque); 302 int bdrv_is_encrypted(BlockDriverState *bs); 303 int bdrv_key_required(BlockDriverState *bs); 304 int bdrv_set_key(BlockDriverState *bs, const char *key); 305 int bdrv_query_missing_keys(void); 306 void bdrv_iterate_format(void (*it)(void *opaque, const char *name), 307 void *opaque); 308 const char *bdrv_get_device_name(BlockDriverState *bs); 309 int bdrv_get_flags(BlockDriverState *bs); 310 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num, 311 const uint8_t *buf, int nb_sectors); 312 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); 313 void bdrv_round_to_clusters(BlockDriverState *bs, 314 int64_t sector_num, int nb_sectors, 315 int64_t *cluster_sector_num, 316 int *cluster_nb_sectors); 317 318 const char *bdrv_get_encrypted_filename(BlockDriverState *bs); 319 void bdrv_get_backing_filename(BlockDriverState *bs, 320 char *filename, int filename_size); 321 void bdrv_get_full_backing_filename(BlockDriverState *bs, 322 char *dest, size_t sz); 323 int bdrv_is_snapshot(BlockDriverState *bs); 324 325 int path_is_absolute(const char *path); 326 void path_combine(char *dest, int dest_size, 327 const char *base_path, 328 const char *filename); 329 330 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos); 331 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, 332 int64_t pos, int size); 333 334 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, 335 int64_t pos, int size); 336 337 void bdrv_img_create(const char *filename, const char *fmt, 338 const char *base_filename, const char *base_fmt, 339 char *options, uint64_t img_size, int flags, 340 Error **errp, bool quiet); 341 342 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align); 343 void *qemu_blockalign(BlockDriverState *bs, size_t size); 344 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov); 345 346 struct HBitmapIter; 347 void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity); 348 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector); 349 void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors); 350 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors); 351 void bdrv_dirty_iter_init(BlockDriverState *bs, struct HBitmapIter *hbi); 352 int64_t bdrv_get_dirty_count(BlockDriverState *bs); 353 354 void bdrv_enable_copy_on_read(BlockDriverState *bs); 355 void bdrv_disable_copy_on_read(BlockDriverState *bs); 356 357 void bdrv_set_in_use(BlockDriverState *bs, int in_use); 358 int bdrv_in_use(BlockDriverState *bs); 359 360 #ifdef CONFIG_LINUX_AIO 361 int raw_get_aio_fd(BlockDriverState *bs); 362 #else 363 static inline int raw_get_aio_fd(BlockDriverState *bs) 364 { 365 return -ENOTSUP; 366 } 367 #endif 368 369 enum BlockAcctType { 370 BDRV_ACCT_READ, 371 BDRV_ACCT_WRITE, 372 BDRV_ACCT_FLUSH, 373 BDRV_MAX_IOTYPE, 374 }; 375 376 typedef struct BlockAcctCookie { 377 int64_t bytes; 378 int64_t start_time_ns; 379 enum BlockAcctType type; 380 } BlockAcctCookie; 381 382 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, 383 int64_t bytes, enum BlockAcctType type); 384 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie); 385 386 typedef enum { 387 BLKDBG_L1_UPDATE, 388 389 BLKDBG_L1_GROW_ALLOC_TABLE, 390 BLKDBG_L1_GROW_WRITE_TABLE, 391 BLKDBG_L1_GROW_ACTIVATE_TABLE, 392 393 BLKDBG_L2_LOAD, 394 BLKDBG_L2_UPDATE, 395 BLKDBG_L2_UPDATE_COMPRESSED, 396 BLKDBG_L2_ALLOC_COW_READ, 397 BLKDBG_L2_ALLOC_WRITE, 398 399 BLKDBG_READ_AIO, 400 BLKDBG_READ_BACKING_AIO, 401 BLKDBG_READ_COMPRESSED, 402 403 BLKDBG_WRITE_AIO, 404 BLKDBG_WRITE_COMPRESSED, 405 406 BLKDBG_VMSTATE_LOAD, 407 BLKDBG_VMSTATE_SAVE, 408 409 BLKDBG_COW_READ, 410 BLKDBG_COW_WRITE, 411 412 BLKDBG_REFTABLE_LOAD, 413 BLKDBG_REFTABLE_GROW, 414 415 BLKDBG_REFBLOCK_LOAD, 416 BLKDBG_REFBLOCK_UPDATE, 417 BLKDBG_REFBLOCK_UPDATE_PART, 418 BLKDBG_REFBLOCK_ALLOC, 419 BLKDBG_REFBLOCK_ALLOC_HOOKUP, 420 BLKDBG_REFBLOCK_ALLOC_WRITE, 421 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS, 422 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE, 423 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE, 424 425 BLKDBG_CLUSTER_ALLOC, 426 BLKDBG_CLUSTER_ALLOC_BYTES, 427 BLKDBG_CLUSTER_FREE, 428 429 BLKDBG_FLUSH_TO_OS, 430 BLKDBG_FLUSH_TO_DISK, 431 432 BLKDBG_EVENT_MAX, 433 } BlkDebugEvent; 434 435 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt) 436 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event); 437 438 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, 439 const char *tag); 440 int bdrv_debug_resume(BlockDriverState *bs, const char *tag); 441 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag); 442 443 #endif 444