]> git.proxmox.com Git - mirror_qemu.git/blob - include/block/block.h
block/get_block_status: avoid redundant callouts on raw devices
[mirror_qemu.git] / include / block / block.h
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 /* BDRV_BLOCK_DATA: data is read from bs->file or another file
85 * BDRV_BLOCK_ZERO: sectors read as zero
86 * BDRV_BLOCK_OFFSET_VALID: sector stored in bs->file as raw data
87 * BDRV_BLOCK_RAW: used internally to indicate that the request
88 * was answered by the raw driver and that one
89 * should look in bs->file directly.
90 *
91 * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
92 * bs->file where sector data can be read from as raw data.
93 *
94 * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
95 *
96 * DATA ZERO OFFSET_VALID
97 * t t t sectors read as zero, bs->file is zero at offset
98 * t f t sectors read as valid from bs->file at offset
99 * f t t sectors preallocated, read as zero, bs->file not
100 * necessarily zero at offset
101 * f f t sectors preallocated but read from backing_hd,
102 * bs->file contains garbage at offset
103 * t t f sectors preallocated, read as zero, unknown offset
104 * t f f sectors read from unknown file or offset
105 * f t f not allocated or unknown offset, read as zero
106 * f f f not allocated or unknown offset, read from backing_hd
107 */
108 #define BDRV_BLOCK_DATA 1
109 #define BDRV_BLOCK_ZERO 2
110 #define BDRV_BLOCK_OFFSET_VALID 4
111 #define BDRV_BLOCK_RAW 8
112 #define BDRV_BLOCK_OFFSET_MASK BDRV_SECTOR_MASK
113
114 typedef enum {
115 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
116 } BlockErrorAction;
117
118 typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
119
120 typedef struct BDRVReopenState {
121 BlockDriverState *bs;
122 int flags;
123 void *opaque;
124 } BDRVReopenState;
125
126
127 void bdrv_iostatus_enable(BlockDriverState *bs);
128 void bdrv_iostatus_reset(BlockDriverState *bs);
129 void bdrv_iostatus_disable(BlockDriverState *bs);
130 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
131 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
132 void bdrv_info_print(Monitor *mon, const QObject *data);
133 void bdrv_info(Monitor *mon, QObject **ret_data);
134 void bdrv_stats_print(Monitor *mon, const QObject *data);
135 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
136
137 /* disk I/O throttling */
138 void bdrv_io_limits_enable(BlockDriverState *bs);
139 void bdrv_io_limits_disable(BlockDriverState *bs);
140
141 void bdrv_init(void);
142 void bdrv_init_with_whitelist(void);
143 BlockDriver *bdrv_find_protocol(const char *filename,
144 bool allow_protocol_prefix);
145 BlockDriver *bdrv_find_format(const char *format_name);
146 BlockDriver *bdrv_find_whitelisted_format(const char *format_name,
147 bool readonly);
148 int bdrv_create(BlockDriver *drv, const char* filename,
149 QEMUOptionParameter *options, Error **errp);
150 int bdrv_create_file(const char* filename, QEMUOptionParameter *options,
151 Error **errp);
152 BlockDriverState *bdrv_new(const char *device_name);
153 void bdrv_make_anon(BlockDriverState *bs);
154 void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old);
155 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
156 int bdrv_parse_cache_flags(const char *mode, int *flags);
157 int bdrv_parse_discard_flags(const char *mode, int *flags);
158 int bdrv_file_open(BlockDriverState **pbs, const char *filename,
159 QDict *options, int flags, Error **errp);
160 int bdrv_open_backing_file(BlockDriverState *bs, QDict *options, Error **errp);
161 int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options,
162 int flags, BlockDriver *drv, Error **errp);
163 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
164 BlockDriverState *bs, int flags);
165 int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
166 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
167 int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
168 BlockReopenQueue *queue, Error **errp);
169 void bdrv_reopen_commit(BDRVReopenState *reopen_state);
170 void bdrv_reopen_abort(BDRVReopenState *reopen_state);
171 void bdrv_close(BlockDriverState *bs);
172 void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify);
173 int bdrv_attach_dev(BlockDriverState *bs, void *dev);
174 void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
175 void bdrv_detach_dev(BlockDriverState *bs, void *dev);
176 void *bdrv_get_attached_dev(BlockDriverState *bs);
177 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
178 void *opaque);
179 void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
180 bool bdrv_dev_has_removable_media(BlockDriverState *bs);
181 bool bdrv_dev_is_tray_open(BlockDriverState *bs);
182 bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
183 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
184 uint8_t *buf, int nb_sectors);
185 int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
186 uint8_t *buf, int nb_sectors);
187 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
188 const uint8_t *buf, int nb_sectors);
189 int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
190 int nb_sectors);
191 int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov);
192 int bdrv_pread(BlockDriverState *bs, int64_t offset,
193 void *buf, int count);
194 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
195 const void *buf, int count);
196 int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
197 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
198 const void *buf, int count);
199 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
200 int nb_sectors, QEMUIOVector *qiov);
201 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
202 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
203 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
204 int nb_sectors, QEMUIOVector *qiov);
205 /*
206 * Efficiently zero a region of the disk image. Note that this is a regular
207 * I/O request like read or write and should have a reasonable size. This
208 * function is not suitable for zeroing the entire image in a single request
209 * because it may allocate memory for the entire region.
210 */
211 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
212 int nb_sectors);
213 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
214 const char *backing_file);
215 int bdrv_get_backing_file_depth(BlockDriverState *bs);
216 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
217 int64_t bdrv_getlength(BlockDriverState *bs);
218 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
219 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
220 int bdrv_commit(BlockDriverState *bs);
221 int bdrv_commit_all(void);
222 int bdrv_change_backing_file(BlockDriverState *bs,
223 const char *backing_file, const char *backing_fmt);
224 void bdrv_register(BlockDriver *bdrv);
225 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
226 BlockDriverState *base);
227 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
228 BlockDriverState *bs);
229 BlockDriverState *bdrv_find_base(BlockDriverState *bs);
230
231
232 typedef struct BdrvCheckResult {
233 int corruptions;
234 int leaks;
235 int check_errors;
236 int corruptions_fixed;
237 int leaks_fixed;
238 int64_t image_end_offset;
239 BlockFragInfo bfi;
240 } BdrvCheckResult;
241
242 typedef enum {
243 BDRV_FIX_LEAKS = 1,
244 BDRV_FIX_ERRORS = 2,
245 } BdrvCheckMode;
246
247 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
248
249 int bdrv_amend_options(BlockDriverState *bs_new, QEMUOptionParameter *options);
250
251 /* async block I/O */
252 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
253 int sector_num);
254 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
255 QEMUIOVector *iov, int nb_sectors,
256 BlockDriverCompletionFunc *cb, void *opaque);
257 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
258 QEMUIOVector *iov, int nb_sectors,
259 BlockDriverCompletionFunc *cb, void *opaque);
260 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
261 BlockDriverCompletionFunc *cb, void *opaque);
262 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
263 int64_t sector_num, int nb_sectors,
264 BlockDriverCompletionFunc *cb, void *opaque);
265 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
266
267 typedef struct BlockRequest {
268 /* Fields to be filled by multiwrite caller */
269 int64_t sector;
270 int nb_sectors;
271 QEMUIOVector *qiov;
272 BlockDriverCompletionFunc *cb;
273 void *opaque;
274
275 /* Filled by multiwrite implementation */
276 int error;
277 } BlockRequest;
278
279 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
280 int num_reqs);
281
282 /* sg packet commands */
283 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
284 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
285 unsigned long int req, void *buf,
286 BlockDriverCompletionFunc *cb, void *opaque);
287
288 /* Invalidate any cached metadata used by image formats */
289 void bdrv_invalidate_cache(BlockDriverState *bs);
290 void bdrv_invalidate_cache_all(void);
291
292 void bdrv_clear_incoming_migration_all(void);
293
294 /* Ensure contents are flushed to disk. */
295 int bdrv_flush(BlockDriverState *bs);
296 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
297 int bdrv_flush_all(void);
298 void bdrv_close_all(void);
299 void bdrv_drain_all(void);
300
301 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
302 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
303 int bdrv_has_zero_init_1(BlockDriverState *bs);
304 int bdrv_has_zero_init(BlockDriverState *bs);
305 int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
306 int nb_sectors, int *pnum);
307 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
308 int *pnum);
309 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
310 int64_t sector_num, int nb_sectors, int *pnum);
311
312 void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
313 BlockdevOnError on_write_error);
314 BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read);
315 BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error);
316 void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
317 bool is_read, int error);
318 int bdrv_is_read_only(BlockDriverState *bs);
319 int bdrv_is_sg(BlockDriverState *bs);
320 int bdrv_enable_write_cache(BlockDriverState *bs);
321 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
322 int bdrv_is_inserted(BlockDriverState *bs);
323 int bdrv_media_changed(BlockDriverState *bs);
324 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
325 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
326 const char *bdrv_get_format_name(BlockDriverState *bs);
327 BlockDriverState *bdrv_find(const char *name);
328 BlockDriverState *bdrv_next(BlockDriverState *bs);
329 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
330 void *opaque);
331 int bdrv_is_encrypted(BlockDriverState *bs);
332 int bdrv_key_required(BlockDriverState *bs);
333 int bdrv_set_key(BlockDriverState *bs, const char *key);
334 int bdrv_query_missing_keys(void);
335 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
336 void *opaque);
337 const char *bdrv_get_device_name(BlockDriverState *bs);
338 int bdrv_get_flags(BlockDriverState *bs);
339 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
340 const uint8_t *buf, int nb_sectors);
341 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
342 ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
343 void bdrv_round_to_clusters(BlockDriverState *bs,
344 int64_t sector_num, int nb_sectors,
345 int64_t *cluster_sector_num,
346 int *cluster_nb_sectors);
347
348 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
349 void bdrv_get_backing_filename(BlockDriverState *bs,
350 char *filename, int filename_size);
351 void bdrv_get_full_backing_filename(BlockDriverState *bs,
352 char *dest, size_t sz);
353 int bdrv_is_snapshot(BlockDriverState *bs);
354
355 int path_is_absolute(const char *path);
356 void path_combine(char *dest, int dest_size,
357 const char *base_path,
358 const char *filename);
359
360 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
361 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
362 int64_t pos, int size);
363
364 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
365 int64_t pos, int size);
366
367 void bdrv_img_create(const char *filename, const char *fmt,
368 const char *base_filename, const char *base_fmt,
369 char *options, uint64_t img_size, int flags,
370 Error **errp, bool quiet);
371
372 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
373 void *qemu_blockalign(BlockDriverState *bs, size_t size);
374 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
375
376 struct HBitmapIter;
377 void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity);
378 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
379 void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
380 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
381 void bdrv_dirty_iter_init(BlockDriverState *bs, struct HBitmapIter *hbi);
382 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
383
384 void bdrv_enable_copy_on_read(BlockDriverState *bs);
385 void bdrv_disable_copy_on_read(BlockDriverState *bs);
386
387 void bdrv_ref(BlockDriverState *bs);
388 void bdrv_unref(BlockDriverState *bs);
389 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
390 int bdrv_in_use(BlockDriverState *bs);
391
392 #ifdef CONFIG_LINUX_AIO
393 int raw_get_aio_fd(BlockDriverState *bs);
394 #else
395 static inline int raw_get_aio_fd(BlockDriverState *bs)
396 {
397 return -ENOTSUP;
398 }
399 #endif
400
401 enum BlockAcctType {
402 BDRV_ACCT_READ,
403 BDRV_ACCT_WRITE,
404 BDRV_ACCT_FLUSH,
405 BDRV_MAX_IOTYPE,
406 };
407
408 typedef struct BlockAcctCookie {
409 int64_t bytes;
410 int64_t start_time_ns;
411 enum BlockAcctType type;
412 } BlockAcctCookie;
413
414 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
415 int64_t bytes, enum BlockAcctType type);
416 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
417
418 typedef enum {
419 BLKDBG_L1_UPDATE,
420
421 BLKDBG_L1_GROW_ALLOC_TABLE,
422 BLKDBG_L1_GROW_WRITE_TABLE,
423 BLKDBG_L1_GROW_ACTIVATE_TABLE,
424
425 BLKDBG_L2_LOAD,
426 BLKDBG_L2_UPDATE,
427 BLKDBG_L2_UPDATE_COMPRESSED,
428 BLKDBG_L2_ALLOC_COW_READ,
429 BLKDBG_L2_ALLOC_WRITE,
430
431 BLKDBG_READ_AIO,
432 BLKDBG_READ_BACKING_AIO,
433 BLKDBG_READ_COMPRESSED,
434
435 BLKDBG_WRITE_AIO,
436 BLKDBG_WRITE_COMPRESSED,
437
438 BLKDBG_VMSTATE_LOAD,
439 BLKDBG_VMSTATE_SAVE,
440
441 BLKDBG_COW_READ,
442 BLKDBG_COW_WRITE,
443
444 BLKDBG_REFTABLE_LOAD,
445 BLKDBG_REFTABLE_GROW,
446 BLKDBG_REFTABLE_UPDATE,
447
448 BLKDBG_REFBLOCK_LOAD,
449 BLKDBG_REFBLOCK_UPDATE,
450 BLKDBG_REFBLOCK_UPDATE_PART,
451 BLKDBG_REFBLOCK_ALLOC,
452 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
453 BLKDBG_REFBLOCK_ALLOC_WRITE,
454 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
455 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
456 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
457
458 BLKDBG_CLUSTER_ALLOC,
459 BLKDBG_CLUSTER_ALLOC_BYTES,
460 BLKDBG_CLUSTER_FREE,
461
462 BLKDBG_FLUSH_TO_OS,
463 BLKDBG_FLUSH_TO_DISK,
464
465 BLKDBG_EVENT_MAX,
466 } BlkDebugEvent;
467
468 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
469 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
470
471 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
472 const char *tag);
473 int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
474 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
475
476 #endif