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