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_write_zeroes(BlockDriverState *bs, int64_t sector_num, 161 int nb_sectors); 162 int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov); 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); 167 int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov); 168 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset, 169 const void *buf, int count); 170 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num, 171 int nb_sectors, QEMUIOVector *qiov); 172 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs, 173 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); 174 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num, 175 int nb_sectors, QEMUIOVector *qiov); 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); 184 int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num, 185 int nb_sectors, int *pnum); 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); 190 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, 191 const char *backing_file); 192 int bdrv_get_backing_file_depth(BlockDriverState *bs); 193 int bdrv_truncate(BlockDriverState *bs, int64_t offset); 194 int64_t bdrv_getlength(BlockDriverState *bs); 195 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs); 196 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); 197 int bdrv_commit(BlockDriverState *bs); 198 int bdrv_commit_all(void); 199 int bdrv_change_backing_file(BlockDriverState *bs, 200 const char *backing_file, const char *backing_fmt); 201 void bdrv_register(BlockDriver *bdrv); 202 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top, 203 BlockDriverState *base); 204 BlockDriverState *bdrv_find_overlay(BlockDriverState *active, 205 BlockDriverState *bs); 206 BlockDriverState *bdrv_find_base(BlockDriverState *bs); 207 208 209 typedef struct BdrvCheckResult { 210 int corruptions; 211 int leaks; 212 int check_errors; 213 int corruptions_fixed; 214 int leaks_fixed; 215 int64_t image_end_offset; 216 BlockFragInfo bfi; 217 } BdrvCheckResult; 218 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); 225 226 /* async block I/O */ 227 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector, 228 int sector_num); 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); 235 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs, 236 BlockDriverCompletionFunc *cb, void *opaque); 237 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs, 238 int64_t sector_num, int nb_sectors, 239 BlockDriverCompletionFunc *cb, void *opaque); 240 void bdrv_aio_cancel(BlockDriverAIOCB *acb); 241 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 257 /* sg packet commands */ 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); 262 263 /* Invalidate any cached metadata used by image formats */ 264 void bdrv_invalidate_cache(BlockDriverState *bs); 265 void bdrv_invalidate_cache_all(void); 266 267 void bdrv_clear_incoming_migration_all(void); 268 269 /* Ensure contents are flushed to disk. */ 270 int bdrv_flush(BlockDriverState *bs); 271 int coroutine_fn bdrv_co_flush(BlockDriverState *bs); 272 int bdrv_flush_all(void); 273 void bdrv_close_all(void); 274 void bdrv_drain_all(void); 275 276 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); 277 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); 278 int bdrv_has_zero_init_1(BlockDriverState *bs); 279 int bdrv_has_zero_init(BlockDriverState *bs); 280 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, 281 int *pnum); 282 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base, 283 int64_t sector_num, int nb_sectors, int *pnum); 284 285 void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error, 286 BlockdevOnError on_write_error); 287 BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read); 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); 291 int bdrv_is_read_only(BlockDriverState *bs); 292 int bdrv_is_sg(BlockDriverState *bs); 293 int bdrv_enable_write_cache(BlockDriverState *bs); 294 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce); 295 int bdrv_is_inserted(BlockDriverState *bs); 296 int bdrv_media_changed(BlockDriverState *bs); 297 void bdrv_lock_medium(BlockDriverState *bs, bool locked); 298 void bdrv_eject(BlockDriverState *bs, bool eject_flag); 299 const char *bdrv_get_format_name(BlockDriverState *bs); 300 BlockDriverState *bdrv_find(const char *name); 301 BlockDriverState *bdrv_next(BlockDriverState *bs); 302 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), 303 void *opaque); 304 int bdrv_is_encrypted(BlockDriverState *bs); 305 int bdrv_key_required(BlockDriverState *bs); 306 int bdrv_set_key(BlockDriverState *bs, const char *key); 307 int bdrv_query_missing_keys(void); 308 void bdrv_iterate_format(void (*it)(void *opaque, const char *name), 309 void *opaque); 310 const char *bdrv_get_device_name(BlockDriverState *bs); 311 int bdrv_get_flags(BlockDriverState *bs); 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 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); 319 320 const char *bdrv_get_encrypted_filename(BlockDriverState *bs); 321 void bdrv_get_backing_filename(BlockDriverState *bs, 322 char *filename, int filename_size); 323 void bdrv_get_full_backing_filename(BlockDriverState *bs, 324 char *dest, size_t sz); 325 int bdrv_is_snapshot(BlockDriverState *bs); 326 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 332 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos); 333 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, 334 int64_t pos, int size); 335 336 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, 337 int64_t pos, int size); 338 339 void bdrv_img_create(const char *filename, const char *fmt, 340 const char *base_filename, const char *base_fmt, 341 char *options, uint64_t img_size, int flags, 342 Error **errp, bool quiet); 343 344 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align); 345 void *qemu_blockalign(BlockDriverState *bs, size_t size); 346 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov); 347 348 struct HBitmapIter; 349 void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity); 350 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector); 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); 353 void bdrv_dirty_iter_init(BlockDriverState *bs, struct HBitmapIter *hbi); 354 int64_t bdrv_get_dirty_count(BlockDriverState *bs); 355 356 void bdrv_enable_copy_on_read(BlockDriverState *bs); 357 void bdrv_disable_copy_on_read(BlockDriverState *bs); 358 359 void bdrv_set_in_use(BlockDriverState *bs, int in_use); 360 int bdrv_in_use(BlockDriverState *bs); 361 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 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; 380 int64_t start_time_ns; 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 388 typedef enum { 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 401 BLKDBG_READ_AIO, 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 431 BLKDBG_FLUSH_TO_OS, 432 BLKDBG_FLUSH_TO_DISK, 433 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 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 445 #endif 446