]> git.proxmox.com Git - mirror_qemu.git/blob - include/block/block.h
Merge remote-tracking branch 'bonzini/nbd-next' into staging
[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 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,
139 QDict *options, int flags);
140 int bdrv_open_backing_file(BlockDriverState *bs);
141 int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options,
142 int flags, BlockDriver *drv);
143 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
144 BlockDriverState *bs, int flags);
145 int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
146 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
147 int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
148 BlockReopenQueue *queue, Error **errp);
149 void bdrv_reopen_commit(BDRVReopenState *reopen_state);
150 void bdrv_reopen_abort(BDRVReopenState *reopen_state);
151 void bdrv_close(BlockDriverState *bs);
152 void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify);
153 int bdrv_attach_dev(BlockDriverState *bs, void *dev);
154 void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
155 void bdrv_detach_dev(BlockDriverState *bs, void *dev);
156 void *bdrv_get_attached_dev(BlockDriverState *bs);
157 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
158 void *opaque);
159 void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
160 bool bdrv_dev_has_removable_media(BlockDriverState *bs);
161 bool bdrv_dev_is_tray_open(BlockDriverState *bs);
162 bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
163 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
164 uint8_t *buf, int nb_sectors);
165 int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
166 uint8_t *buf, int nb_sectors);
167 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
168 const uint8_t *buf, int nb_sectors);
169 int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov);
170 int bdrv_pread(BlockDriverState *bs, int64_t offset,
171 void *buf, int count);
172 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
173 const void *buf, int count);
174 int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
175 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
176 const void *buf, int count);
177 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
178 int nb_sectors, QEMUIOVector *qiov);
179 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
180 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
181 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
182 int nb_sectors, QEMUIOVector *qiov);
183 /*
184 * Efficiently zero a region of the disk image. Note that this is a regular
185 * I/O request like read or write and should have a reasonable size. This
186 * function is not suitable for zeroing the entire image in a single request
187 * because it may allocate memory for the entire region.
188 */
189 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
190 int nb_sectors);
191 int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
192 int nb_sectors, int *pnum);
193 int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
194 BlockDriverState *base,
195 int64_t sector_num,
196 int nb_sectors, int *pnum);
197 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
198 const char *backing_file);
199 int bdrv_get_backing_file_depth(BlockDriverState *bs);
200 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
201 int64_t bdrv_getlength(BlockDriverState *bs);
202 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
203 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
204 int bdrv_commit(BlockDriverState *bs);
205 int bdrv_commit_all(void);
206 int bdrv_change_backing_file(BlockDriverState *bs,
207 const char *backing_file, const char *backing_fmt);
208 void bdrv_register(BlockDriver *bdrv);
209 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
210 BlockDriverState *base);
211 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
212 BlockDriverState *bs);
213 BlockDriverState *bdrv_find_base(BlockDriverState *bs);
214
215
216 typedef struct BdrvCheckResult {
217 int corruptions;
218 int leaks;
219 int check_errors;
220 int corruptions_fixed;
221 int leaks_fixed;
222 int64_t image_end_offset;
223 BlockFragInfo bfi;
224 } BdrvCheckResult;
225
226 typedef enum {
227 BDRV_FIX_LEAKS = 1,
228 BDRV_FIX_ERRORS = 2,
229 } BdrvCheckMode;
230
231 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
232
233 /* async block I/O */
234 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
235 int sector_num);
236 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
237 QEMUIOVector *iov, int nb_sectors,
238 BlockDriverCompletionFunc *cb, void *opaque);
239 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
240 QEMUIOVector *iov, int nb_sectors,
241 BlockDriverCompletionFunc *cb, void *opaque);
242 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
243 BlockDriverCompletionFunc *cb, void *opaque);
244 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
245 int64_t sector_num, int nb_sectors,
246 BlockDriverCompletionFunc *cb, void *opaque);
247 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
248
249 typedef struct BlockRequest {
250 /* Fields to be filled by multiwrite caller */
251 int64_t sector;
252 int nb_sectors;
253 QEMUIOVector *qiov;
254 BlockDriverCompletionFunc *cb;
255 void *opaque;
256
257 /* Filled by multiwrite implementation */
258 int error;
259 } BlockRequest;
260
261 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
262 int num_reqs);
263
264 /* sg packet commands */
265 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
266 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
267 unsigned long int req, void *buf,
268 BlockDriverCompletionFunc *cb, void *opaque);
269
270 /* Invalidate any cached metadata used by image formats */
271 void bdrv_invalidate_cache(BlockDriverState *bs);
272 void bdrv_invalidate_cache_all(void);
273
274 void bdrv_clear_incoming_migration_all(void);
275
276 /* Ensure contents are flushed to disk. */
277 int bdrv_flush(BlockDriverState *bs);
278 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
279 void bdrv_flush_all(void);
280 void bdrv_close_all(void);
281 void bdrv_drain_all(void);
282
283 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
284 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
285 int bdrv_has_zero_init(BlockDriverState *bs);
286 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
287 int *pnum);
288 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
289 int64_t sector_num, int nb_sectors, int *pnum);
290
291 void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
292 BlockdevOnError on_write_error);
293 BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read);
294 BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error);
295 void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
296 bool is_read, int error);
297 int bdrv_is_read_only(BlockDriverState *bs);
298 int bdrv_is_sg(BlockDriverState *bs);
299 int bdrv_enable_write_cache(BlockDriverState *bs);
300 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
301 int bdrv_is_inserted(BlockDriverState *bs);
302 int bdrv_media_changed(BlockDriverState *bs);
303 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
304 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
305 const char *bdrv_get_format_name(BlockDriverState *bs);
306 BlockDriverState *bdrv_find(const char *name);
307 BlockDriverState *bdrv_next(BlockDriverState *bs);
308 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
309 void *opaque);
310 int bdrv_is_encrypted(BlockDriverState *bs);
311 int bdrv_key_required(BlockDriverState *bs);
312 int bdrv_set_key(BlockDriverState *bs, const char *key);
313 int bdrv_query_missing_keys(void);
314 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
315 void *opaque);
316 const char *bdrv_get_device_name(BlockDriverState *bs);
317 int bdrv_get_flags(BlockDriverState *bs);
318 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
319 const uint8_t *buf, int nb_sectors);
320 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
321 void bdrv_round_to_clusters(BlockDriverState *bs,
322 int64_t sector_num, int nb_sectors,
323 int64_t *cluster_sector_num,
324 int *cluster_nb_sectors);
325
326 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
327 void bdrv_get_backing_filename(BlockDriverState *bs,
328 char *filename, int filename_size);
329 void bdrv_get_full_backing_filename(BlockDriverState *bs,
330 char *dest, size_t sz);
331 BlockInfo *bdrv_query_info(BlockDriverState *s);
332 BlockStats *bdrv_query_stats(const BlockDriverState *bs);
333 int bdrv_can_snapshot(BlockDriverState *bs);
334 int bdrv_is_snapshot(BlockDriverState *bs);
335 BlockDriverState *bdrv_snapshots(void);
336 int bdrv_snapshot_create(BlockDriverState *bs,
337 QEMUSnapshotInfo *sn_info);
338 int bdrv_snapshot_goto(BlockDriverState *bs,
339 const char *snapshot_id);
340 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
341 int bdrv_snapshot_list(BlockDriverState *bs,
342 QEMUSnapshotInfo **psn_info);
343 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
344 const char *snapshot_name);
345 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
346
347 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
348 int path_is_absolute(const char *path);
349 void path_combine(char *dest, int dest_size,
350 const char *base_path,
351 const char *filename);
352
353 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
354 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
355 int64_t pos, int size);
356
357 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
358 int64_t pos, int size);
359
360 void bdrv_img_create(const char *filename, const char *fmt,
361 const char *base_filename, const char *base_fmt,
362 char *options, uint64_t img_size, int flags,
363 Error **errp, bool quiet);
364
365 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
366 void *qemu_blockalign(BlockDriverState *bs, size_t size);
367 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
368
369 struct HBitmapIter;
370 void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity);
371 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
372 void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
373 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
374 void bdrv_dirty_iter_init(BlockDriverState *bs, struct HBitmapIter *hbi);
375 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
376
377 void bdrv_enable_copy_on_read(BlockDriverState *bs);
378 void bdrv_disable_copy_on_read(BlockDriverState *bs);
379
380 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
381 int bdrv_in_use(BlockDriverState *bs);
382
383 #ifdef CONFIG_LINUX_AIO
384 int raw_get_aio_fd(BlockDriverState *bs);
385 #else
386 static inline int raw_get_aio_fd(BlockDriverState *bs)
387 {
388 return -ENOTSUP;
389 }
390 #endif
391
392 enum BlockAcctType {
393 BDRV_ACCT_READ,
394 BDRV_ACCT_WRITE,
395 BDRV_ACCT_FLUSH,
396 BDRV_MAX_IOTYPE,
397 };
398
399 typedef struct BlockAcctCookie {
400 int64_t bytes;
401 int64_t start_time_ns;
402 enum BlockAcctType type;
403 } BlockAcctCookie;
404
405 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
406 int64_t bytes, enum BlockAcctType type);
407 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
408
409 typedef enum {
410 BLKDBG_L1_UPDATE,
411
412 BLKDBG_L1_GROW_ALLOC_TABLE,
413 BLKDBG_L1_GROW_WRITE_TABLE,
414 BLKDBG_L1_GROW_ACTIVATE_TABLE,
415
416 BLKDBG_L2_LOAD,
417 BLKDBG_L2_UPDATE,
418 BLKDBG_L2_UPDATE_COMPRESSED,
419 BLKDBG_L2_ALLOC_COW_READ,
420 BLKDBG_L2_ALLOC_WRITE,
421
422 BLKDBG_READ_AIO,
423 BLKDBG_READ_BACKING_AIO,
424 BLKDBG_READ_COMPRESSED,
425
426 BLKDBG_WRITE_AIO,
427 BLKDBG_WRITE_COMPRESSED,
428
429 BLKDBG_VMSTATE_LOAD,
430 BLKDBG_VMSTATE_SAVE,
431
432 BLKDBG_COW_READ,
433 BLKDBG_COW_WRITE,
434
435 BLKDBG_REFTABLE_LOAD,
436 BLKDBG_REFTABLE_GROW,
437
438 BLKDBG_REFBLOCK_LOAD,
439 BLKDBG_REFBLOCK_UPDATE,
440 BLKDBG_REFBLOCK_UPDATE_PART,
441 BLKDBG_REFBLOCK_ALLOC,
442 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
443 BLKDBG_REFBLOCK_ALLOC_WRITE,
444 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
445 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
446 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
447
448 BLKDBG_CLUSTER_ALLOC,
449 BLKDBG_CLUSTER_ALLOC_BYTES,
450 BLKDBG_CLUSTER_FREE,
451
452 BLKDBG_EVENT_MAX,
453 } BlkDebugEvent;
454
455 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
456 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
457
458 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
459 const char *tag);
460 int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
461 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
462
463 #endif