]> git.proxmox.com Git - mirror_qemu.git/blob - block.h
block: add support functions for live commit, to find and delete images.
[mirror_qemu.git] / block.h
1 #ifndef BLOCK_H
2 #define BLOCK_H
3
4 #include "qemu-aio.h"
5 #include "qemu-common.h"
6 #include "qemu-option.h"
7 #include "qemu-coroutine.h"
8 #include "qobject.h"
9
10 /* block.c */
11 typedef struct BlockDriver BlockDriver;
12
13 typedef struct BlockDriverInfo {
14 /* in bytes, 0 if irrelevant */
15 int cluster_size;
16 /* offset at which the VM state can be saved (0 if not possible) */
17 int64_t vm_state_offset;
18 bool is_dirty;
19 } BlockDriverInfo;
20
21 typedef struct BlockFragInfo {
22 uint64_t allocated_clusters;
23 uint64_t total_clusters;
24 uint64_t fragmented_clusters;
25 } BlockFragInfo;
26
27 typedef struct QEMUSnapshotInfo {
28 char id_str[128]; /* unique snapshot id */
29 /* the following fields are informative. They are not needed for
30 the consistency of the snapshot */
31 char name[256]; /* user chosen name */
32 uint64_t vm_state_size; /* VM state info size */
33 uint32_t date_sec; /* UTC date of the snapshot */
34 uint32_t date_nsec;
35 uint64_t vm_clock_nsec; /* VM clock relative to boot */
36 } QEMUSnapshotInfo;
37
38 /* Callbacks for block device models */
39 typedef struct BlockDevOps {
40 /*
41 * Runs when virtual media changed (monitor commands eject, change)
42 * Argument load is true on load and false on eject.
43 * Beware: doesn't run when a host device's physical media
44 * changes. Sure would be useful if it did.
45 * Device models with removable media must implement this callback.
46 */
47 void (*change_media_cb)(void *opaque, bool load);
48 /*
49 * Runs when an eject request is issued from the monitor, the tray
50 * is closed, and the medium is locked.
51 * Device models that do not implement is_medium_locked will not need
52 * this callback. Device models that can lock the medium or tray might
53 * want to implement the callback and unlock the tray when "force" is
54 * true, even if they do not support eject requests.
55 */
56 void (*eject_request_cb)(void *opaque, bool force);
57 /*
58 * Is the virtual tray open?
59 * Device models implement this only when the device has a tray.
60 */
61 bool (*is_tray_open)(void *opaque);
62 /*
63 * Is the virtual medium locked into the device?
64 * Device models implement this only when device has such a lock.
65 */
66 bool (*is_medium_locked)(void *opaque);
67 /*
68 * Runs when the size changed (e.g. monitor command block_resize)
69 */
70 void (*resize_cb)(void *opaque);
71 } BlockDevOps;
72
73 #define BDRV_O_RDWR 0x0002
74 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
75 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
76 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
77 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
78 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
79 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
80 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
81 #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */
82 #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */
83 #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */
84
85 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
86
87 #define BDRV_SECTOR_BITS 9
88 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
89 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
90
91 typedef enum {
92 BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
93 BLOCK_ERR_STOP_ANY
94 } BlockErrorAction;
95
96 typedef enum {
97 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
98 } BlockQMPEventAction;
99
100 typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
101
102 typedef struct BDRVReopenState {
103 BlockDriverState *bs;
104 int flags;
105 void *opaque;
106 } BDRVReopenState;
107
108
109 void bdrv_iostatus_enable(BlockDriverState *bs);
110 void bdrv_iostatus_reset(BlockDriverState *bs);
111 void bdrv_iostatus_disable(BlockDriverState *bs);
112 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
113 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
114 void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
115 BlockQMPEventAction action, int is_read);
116 void bdrv_info_print(Monitor *mon, const QObject *data);
117 void bdrv_info(Monitor *mon, QObject **ret_data);
118 void bdrv_stats_print(Monitor *mon, const QObject *data);
119 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
120
121 /* disk I/O throttling */
122 void bdrv_io_limits_enable(BlockDriverState *bs);
123 void bdrv_io_limits_disable(BlockDriverState *bs);
124 bool bdrv_io_limits_enabled(BlockDriverState *bs);
125
126 void bdrv_init(void);
127 void bdrv_init_with_whitelist(void);
128 BlockDriver *bdrv_find_protocol(const char *filename);
129 BlockDriver *bdrv_find_format(const char *format_name);
130 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
131 int bdrv_create(BlockDriver *drv, const char* filename,
132 QEMUOptionParameter *options);
133 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
134 BlockDriverState *bdrv_new(const char *device_name);
135 void bdrv_make_anon(BlockDriverState *bs);
136 void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old);
137 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
138 void bdrv_delete(BlockDriverState *bs);
139 int bdrv_parse_cache_flags(const char *mode, int *flags);
140 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
141 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
142 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 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
211
212 typedef struct BdrvCheckResult {
213 int corruptions;
214 int leaks;
215 int check_errors;
216 int corruptions_fixed;
217 int leaks_fixed;
218 BlockFragInfo bfi;
219 } BdrvCheckResult;
220
221 typedef enum {
222 BDRV_FIX_LEAKS = 1,
223 BDRV_FIX_ERRORS = 2,
224 } BdrvCheckMode;
225
226 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
227
228 /* async block I/O */
229 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
230 int sector_num);
231 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
232 QEMUIOVector *iov, int nb_sectors,
233 BlockDriverCompletionFunc *cb, void *opaque);
234 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
235 QEMUIOVector *iov, int nb_sectors,
236 BlockDriverCompletionFunc *cb, void *opaque);
237 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
238 BlockDriverCompletionFunc *cb, void *opaque);
239 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
240 int64_t sector_num, int nb_sectors,
241 BlockDriverCompletionFunc *cb, void *opaque);
242 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
243
244 typedef struct BlockRequest {
245 /* Fields to be filled by multiwrite caller */
246 int64_t sector;
247 int nb_sectors;
248 QEMUIOVector *qiov;
249 BlockDriverCompletionFunc *cb;
250 void *opaque;
251
252 /* Filled by multiwrite implementation */
253 int error;
254 } BlockRequest;
255
256 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
257 int num_reqs);
258
259 /* sg packet commands */
260 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
261 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
262 unsigned long int req, void *buf,
263 BlockDriverCompletionFunc *cb, void *opaque);
264
265 /* Invalidate any cached metadata used by image formats */
266 void bdrv_invalidate_cache(BlockDriverState *bs);
267 void bdrv_invalidate_cache_all(void);
268
269 void bdrv_clear_incoming_migration_all(void);
270
271 /* Ensure contents are flushed to disk. */
272 int bdrv_flush(BlockDriverState *bs);
273 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
274 void bdrv_flush_all(void);
275 void bdrv_close_all(void);
276 void bdrv_drain_all(void);
277
278 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
279 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
280 int bdrv_has_zero_init(BlockDriverState *bs);
281 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
282 int *pnum);
283
284 void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
285 BlockErrorAction on_write_error);
286 BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
287 int bdrv_is_read_only(BlockDriverState *bs);
288 int bdrv_is_sg(BlockDriverState *bs);
289 int bdrv_enable_write_cache(BlockDriverState *bs);
290 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
291 int bdrv_is_inserted(BlockDriverState *bs);
292 int bdrv_media_changed(BlockDriverState *bs);
293 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
294 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
295 const char *bdrv_get_format_name(BlockDriverState *bs);
296 BlockDriverState *bdrv_find(const char *name);
297 BlockDriverState *bdrv_next(BlockDriverState *bs);
298 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
299 void *opaque);
300 int bdrv_is_encrypted(BlockDriverState *bs);
301 int bdrv_key_required(BlockDriverState *bs);
302 int bdrv_set_key(BlockDriverState *bs, const char *key);
303 int bdrv_query_missing_keys(void);
304 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
305 void *opaque);
306 const char *bdrv_get_device_name(BlockDriverState *bs);
307 int bdrv_get_flags(BlockDriverState *bs);
308 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
309 const uint8_t *buf, int nb_sectors);
310 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
311
312 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
313 void bdrv_get_backing_filename(BlockDriverState *bs,
314 char *filename, int filename_size);
315 void bdrv_get_full_backing_filename(BlockDriverState *bs,
316 char *dest, size_t sz);
317 int bdrv_can_snapshot(BlockDriverState *bs);
318 int bdrv_is_snapshot(BlockDriverState *bs);
319 BlockDriverState *bdrv_snapshots(void);
320 int bdrv_snapshot_create(BlockDriverState *bs,
321 QEMUSnapshotInfo *sn_info);
322 int bdrv_snapshot_goto(BlockDriverState *bs,
323 const char *snapshot_id);
324 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
325 int bdrv_snapshot_list(BlockDriverState *bs,
326 QEMUSnapshotInfo **psn_info);
327 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
328 const char *snapshot_name);
329 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
330
331 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
332 int path_is_absolute(const char *path);
333 void path_combine(char *dest, int dest_size,
334 const char *base_path,
335 const char *filename);
336
337 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
338 int64_t pos, int size);
339
340 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
341 int64_t pos, int size);
342
343 int bdrv_img_create(const char *filename, const char *fmt,
344 const char *base_filename, const char *base_fmt,
345 char *options, uint64_t img_size, int flags);
346
347 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
348 void *qemu_blockalign(BlockDriverState *bs, size_t size);
349
350 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
351
352 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
353 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
354 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
355 int nr_sectors);
356 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
357
358 void bdrv_enable_copy_on_read(BlockDriverState *bs);
359 void bdrv_disable_copy_on_read(BlockDriverState *bs);
360
361 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
362 int bdrv_in_use(BlockDriverState *bs);
363
364 enum BlockAcctType {
365 BDRV_ACCT_READ,
366 BDRV_ACCT_WRITE,
367 BDRV_ACCT_FLUSH,
368 BDRV_MAX_IOTYPE,
369 };
370
371 typedef struct BlockAcctCookie {
372 int64_t bytes;
373 int64_t start_time_ns;
374 enum BlockAcctType type;
375 } BlockAcctCookie;
376
377 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
378 int64_t bytes, enum BlockAcctType type);
379 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
380
381 typedef enum {
382 BLKDBG_L1_UPDATE,
383
384 BLKDBG_L1_GROW_ALLOC_TABLE,
385 BLKDBG_L1_GROW_WRITE_TABLE,
386 BLKDBG_L1_GROW_ACTIVATE_TABLE,
387
388 BLKDBG_L2_LOAD,
389 BLKDBG_L2_UPDATE,
390 BLKDBG_L2_UPDATE_COMPRESSED,
391 BLKDBG_L2_ALLOC_COW_READ,
392 BLKDBG_L2_ALLOC_WRITE,
393
394 BLKDBG_READ_AIO,
395 BLKDBG_READ_BACKING_AIO,
396 BLKDBG_READ_COMPRESSED,
397
398 BLKDBG_WRITE_AIO,
399 BLKDBG_WRITE_COMPRESSED,
400
401 BLKDBG_VMSTATE_LOAD,
402 BLKDBG_VMSTATE_SAVE,
403
404 BLKDBG_COW_READ,
405 BLKDBG_COW_WRITE,
406
407 BLKDBG_REFTABLE_LOAD,
408 BLKDBG_REFTABLE_GROW,
409
410 BLKDBG_REFBLOCK_LOAD,
411 BLKDBG_REFBLOCK_UPDATE,
412 BLKDBG_REFBLOCK_UPDATE_PART,
413 BLKDBG_REFBLOCK_ALLOC,
414 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
415 BLKDBG_REFBLOCK_ALLOC_WRITE,
416 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
417 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
418 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
419
420 BLKDBG_CLUSTER_ALLOC,
421 BLKDBG_CLUSTER_ALLOC_BYTES,
422 BLKDBG_CLUSTER_FREE,
423
424 BLKDBG_EVENT_MAX,
425 } BlkDebugEvent;
426
427 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
428 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
429
430 #endif