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