sync with latest
[sdk/emulator/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
84 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
85
86 #define BDRV_SECTOR_BITS   9
87 #define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
88 #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
89
90 typedef enum {
91     BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
92     BLOCK_ERR_STOP_ANY
93 } BlockErrorAction;
94
95 typedef enum {
96     BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
97 } BlockQMPEventAction;
98
99 void bdrv_iostatus_enable(BlockDriverState *bs);
100 void bdrv_iostatus_reset(BlockDriverState *bs);
101 void bdrv_iostatus_disable(BlockDriverState *bs);
102 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
103 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
104 void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
105                                BlockQMPEventAction action, int is_read);
106 void bdrv_info_print(Monitor *mon, const QObject *data);
107 void bdrv_info(Monitor *mon, QObject **ret_data);
108 void bdrv_stats_print(Monitor *mon, const QObject *data);
109 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
110
111 /* disk I/O throttling */
112 void bdrv_io_limits_enable(BlockDriverState *bs);
113 void bdrv_io_limits_disable(BlockDriverState *bs);
114 bool bdrv_io_limits_enabled(BlockDriverState *bs);
115
116 void bdrv_init(void);
117 void bdrv_init_with_whitelist(void);
118 BlockDriver *bdrv_find_protocol(const char *filename);
119 BlockDriver *bdrv_find_format(const char *format_name);
120 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
121 int bdrv_create(BlockDriver *drv, const char* filename,
122     QEMUOptionParameter *options);
123 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
124 BlockDriverState *bdrv_new(const char *device_name);
125 void bdrv_make_anon(BlockDriverState *bs);
126 void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old);
127 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
128 void bdrv_delete(BlockDriverState *bs);
129 int bdrv_parse_cache_flags(const char *mode, int *flags);
130 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
131 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
132               BlockDriver *drv);
133 void bdrv_close(BlockDriverState *bs);
134 int bdrv_attach_dev(BlockDriverState *bs, void *dev);
135 void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
136 void bdrv_detach_dev(BlockDriverState *bs, void *dev);
137 void *bdrv_get_attached_dev(BlockDriverState *bs);
138 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
139                       void *opaque);
140 void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
141 bool bdrv_dev_has_removable_media(BlockDriverState *bs);
142 bool bdrv_dev_is_tray_open(BlockDriverState *bs);
143 bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
144 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
145               uint8_t *buf, int nb_sectors);
146 int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
147                           uint8_t *buf, int nb_sectors);
148 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
149                const uint8_t *buf, int nb_sectors);
150 int bdrv_pread(BlockDriverState *bs, int64_t offset,
151                void *buf, int count);
152 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
153                 const void *buf, int count);
154 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
155     const void *buf, int count);
156 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
157     int nb_sectors, QEMUIOVector *qiov);
158 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
159     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
160 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
161     int nb_sectors, QEMUIOVector *qiov);
162 /*
163  * Efficiently zero a region of the disk image.  Note that this is a regular
164  * I/O request like read or write and should have a reasonable size.  This
165  * function is not suitable for zeroing the entire image in a single request
166  * because it may allocate memory for the entire region.
167  */
168 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
169     int nb_sectors);
170 int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
171     int nb_sectors, int *pnum);
172 int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
173                                             BlockDriverState *base,
174                                             int64_t sector_num,
175                                             int nb_sectors, int *pnum);
176 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
177     const char *backing_file);
178 int bdrv_get_backing_file_depth(BlockDriverState *bs);
179 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
180 int64_t bdrv_getlength(BlockDriverState *bs);
181 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
182 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
183 int bdrv_commit(BlockDriverState *bs);
184 int bdrv_commit_all(void);
185 int bdrv_change_backing_file(BlockDriverState *bs,
186     const char *backing_file, const char *backing_fmt);
187 void bdrv_register(BlockDriver *bdrv);
188
189
190 typedef struct BdrvCheckResult {
191     int corruptions;
192     int leaks;
193     int check_errors;
194     int corruptions_fixed;
195     int leaks_fixed;
196     BlockFragInfo bfi;
197 } BdrvCheckResult;
198
199 typedef enum {
200     BDRV_FIX_LEAKS    = 1,
201     BDRV_FIX_ERRORS   = 2,
202 } BdrvCheckMode;
203
204 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
205
206 /* async block I/O */
207 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
208                                      int sector_num);
209 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
210                                  QEMUIOVector *iov, int nb_sectors,
211                                  BlockDriverCompletionFunc *cb, void *opaque);
212 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
213                                   QEMUIOVector *iov, int nb_sectors,
214                                   BlockDriverCompletionFunc *cb, void *opaque);
215 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
216                                  BlockDriverCompletionFunc *cb, void *opaque);
217 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
218                                    int64_t sector_num, int nb_sectors,
219                                    BlockDriverCompletionFunc *cb, void *opaque);
220 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
221
222 typedef struct BlockRequest {
223     /* Fields to be filled by multiwrite caller */
224     int64_t sector;
225     int nb_sectors;
226     QEMUIOVector *qiov;
227     BlockDriverCompletionFunc *cb;
228     void *opaque;
229
230     /* Filled by multiwrite implementation */
231     int error;
232 } BlockRequest;
233
234 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
235     int num_reqs);
236
237 /* sg packet commands */
238 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
239 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
240         unsigned long int req, void *buf,
241         BlockDriverCompletionFunc *cb, void *opaque);
242
243 /* Invalidate any cached metadata used by image formats */
244 void bdrv_invalidate_cache(BlockDriverState *bs);
245 void bdrv_invalidate_cache_all(void);
246
247 void bdrv_clear_incoming_migration_all(void);
248
249 /* Ensure contents are flushed to disk.  */
250 int bdrv_flush(BlockDriverState *bs);
251 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
252 void bdrv_flush_all(void);
253 void bdrv_close_all(void);
254 void bdrv_drain_all(void);
255
256 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
257 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
258 int bdrv_has_zero_init(BlockDriverState *bs);
259 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
260                       int *pnum);
261
262 void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
263                        BlockErrorAction on_write_error);
264 BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
265 int bdrv_is_read_only(BlockDriverState *bs);
266 int bdrv_is_sg(BlockDriverState *bs);
267 int bdrv_enable_write_cache(BlockDriverState *bs);
268 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
269 int bdrv_is_inserted(BlockDriverState *bs);
270 int bdrv_media_changed(BlockDriverState *bs);
271 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
272 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
273 const char *bdrv_get_format_name(BlockDriverState *bs);
274 BlockDriverState *bdrv_find(const char *name);
275 BlockDriverState *bdrv_next(BlockDriverState *bs);
276 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
277                   void *opaque);
278 int bdrv_is_encrypted(BlockDriverState *bs);
279 int bdrv_key_required(BlockDriverState *bs);
280 int bdrv_set_key(BlockDriverState *bs, const char *key);
281 int bdrv_query_missing_keys(void);
282 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
283                          void *opaque);
284 const char *bdrv_get_device_name(BlockDriverState *bs);
285 int bdrv_get_flags(BlockDriverState *bs);
286 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
287                           const uint8_t *buf, int nb_sectors);
288 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
289
290 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
291 void bdrv_get_backing_filename(BlockDriverState *bs,
292                                char *filename, int filename_size);
293 void bdrv_get_full_backing_filename(BlockDriverState *bs,
294                                     char *dest, size_t sz);
295 int bdrv_can_snapshot(BlockDriverState *bs);
296 int bdrv_is_snapshot(BlockDriverState *bs);
297 BlockDriverState *bdrv_snapshots(void);
298 int bdrv_snapshot_create(BlockDriverState *bs,
299                          QEMUSnapshotInfo *sn_info);
300 int bdrv_snapshot_goto(BlockDriverState *bs,
301                        const char *snapshot_id);
302 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
303 int bdrv_snapshot_list(BlockDriverState *bs,
304                        QEMUSnapshotInfo **psn_info);
305 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
306                            const char *snapshot_name);
307 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
308
309 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
310 int path_is_absolute(const char *path);
311 void path_combine(char *dest, int dest_size,
312                   const char *base_path,
313                   const char *filename);
314
315 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
316                       int64_t pos, int size);
317
318 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
319                       int64_t pos, int size);
320
321 int bdrv_img_create(const char *filename, const char *fmt,
322                     const char *base_filename, const char *base_fmt,
323                     char *options, uint64_t img_size, int flags);
324
325 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
326 void *qemu_blockalign(BlockDriverState *bs, size_t size);
327
328 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
329
330 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
331 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
332 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
333                       int nr_sectors);
334 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
335
336 void bdrv_enable_copy_on_read(BlockDriverState *bs);
337 void bdrv_disable_copy_on_read(BlockDriverState *bs);
338
339 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
340 int bdrv_in_use(BlockDriverState *bs);
341
342 enum BlockAcctType {
343     BDRV_ACCT_READ,
344     BDRV_ACCT_WRITE,
345     BDRV_ACCT_FLUSH,
346     BDRV_MAX_IOTYPE,
347 };
348
349 typedef struct BlockAcctCookie {
350     int64_t bytes;
351     int64_t start_time_ns;
352     enum BlockAcctType type;
353 } BlockAcctCookie;
354
355 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
356         int64_t bytes, enum BlockAcctType type);
357 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
358
359 typedef enum {
360     BLKDBG_L1_UPDATE,
361
362     BLKDBG_L1_GROW_ALLOC_TABLE,
363     BLKDBG_L1_GROW_WRITE_TABLE,
364     BLKDBG_L1_GROW_ACTIVATE_TABLE,
365
366     BLKDBG_L2_LOAD,
367     BLKDBG_L2_UPDATE,
368     BLKDBG_L2_UPDATE_COMPRESSED,
369     BLKDBG_L2_ALLOC_COW_READ,
370     BLKDBG_L2_ALLOC_WRITE,
371
372     BLKDBG_READ_AIO,
373     BLKDBG_READ_BACKING_AIO,
374     BLKDBG_READ_COMPRESSED,
375
376     BLKDBG_WRITE_AIO,
377     BLKDBG_WRITE_COMPRESSED,
378
379     BLKDBG_VMSTATE_LOAD,
380     BLKDBG_VMSTATE_SAVE,
381
382     BLKDBG_COW_READ,
383     BLKDBG_COW_WRITE,
384
385     BLKDBG_REFTABLE_LOAD,
386     BLKDBG_REFTABLE_GROW,
387
388     BLKDBG_REFBLOCK_LOAD,
389     BLKDBG_REFBLOCK_UPDATE,
390     BLKDBG_REFBLOCK_UPDATE_PART,
391     BLKDBG_REFBLOCK_ALLOC,
392     BLKDBG_REFBLOCK_ALLOC_HOOKUP,
393     BLKDBG_REFBLOCK_ALLOC_WRITE,
394     BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
395     BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
396     BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
397
398     BLKDBG_CLUSTER_ALLOC,
399     BLKDBG_CLUSTER_ALLOC_BYTES,
400     BLKDBG_CLUSTER_FREE,
401
402     BLKDBG_EVENT_MAX,
403 } BlkDebugEvent;
404
405 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
406 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
407
408 #endif