PPC: booke: add tlbnps handling
[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 } BlockDriverInfo;
19
20 typedef struct QEMUSnapshotInfo {
21 char id_str[128]; /* unique snapshot id */
22 /* the following fields are informative. They are not needed for
23 the consistency of the snapshot */
24 char name[256]; /* user chosen name */
25 uint64_t vm_state_size; /* VM state info size */
26 uint32_t date_sec; /* UTC date of the snapshot */
27 uint32_t date_nsec;
28 uint64_t vm_clock_nsec; /* VM clock relative to boot */
29 } QEMUSnapshotInfo;
30
31 /* Callbacks for block device models */
32 typedef struct BlockDevOps {
33 /*
34 * Runs when virtual media changed (monitor commands eject, change)
35 * Argument load is true on load and false on eject.
36 * Beware: doesn't run when a host device's physical media
37 * changes. Sure would be useful if it did.
38 * Device models with removable media must implement this callback.
39 */
40 void (*change_media_cb)(void *opaque, bool load);
41 /*
42 * Runs when an eject request is issued from the monitor, the tray
43 * is closed, and the medium is locked.
44 * Device models that do not implement is_medium_locked will not need
45 * this callback. Device models that can lock the medium or tray might
46 * want to implement the callback and unlock the tray when "force" is
47 * true, even if they do not support eject requests.
48 */
49 void (*eject_request_cb)(void *opaque, bool force);
50 /*
51 * Is the virtual tray open?
52 * Device models implement this only when the device has a tray.
53 */
54 bool (*is_tray_open)(void *opaque);
55 /*
56 * Is the virtual medium locked into the device?
57 * Device models implement this only when device has such a lock.
58 */
59 bool (*is_medium_locked)(void *opaque);
60 /*
61 * Runs when the size changed (e.g. monitor command block_resize)
62 */
63 void (*resize_cb)(void *opaque);
64 } BlockDevOps;
65
66 #define BDRV_O_RDWR 0x0002
67 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
68 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
69 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
70 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
71 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
72 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
73 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
74
75 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
76
77 #define BDRV_SECTOR_BITS 9
78 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
79 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
80
81 typedef enum {
82 BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
83 BLOCK_ERR_STOP_ANY
84 } BlockErrorAction;
85
86 typedef enum {
87 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
88 } BlockMonEventAction;
89
90 void bdrv_iostatus_enable(BlockDriverState *bs);
91 void bdrv_iostatus_reset(BlockDriverState *bs);
92 void bdrv_iostatus_disable(BlockDriverState *bs);
93 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
94 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
95 void bdrv_mon_event(const BlockDriverState *bdrv,
96 BlockMonEventAction action, int is_read);
97 void bdrv_info_print(Monitor *mon, const QObject *data);
98 void bdrv_info(Monitor *mon, QObject **ret_data);
99 void bdrv_stats_print(Monitor *mon, const QObject *data);
100 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
101
102 /* disk I/O throttling */
103 void bdrv_io_limits_enable(BlockDriverState *bs);
104 void bdrv_io_limits_disable(BlockDriverState *bs);
105 bool bdrv_io_limits_enabled(BlockDriverState *bs);
106
107 void bdrv_init(void);
108 void bdrv_init_with_whitelist(void);
109 BlockDriver *bdrv_find_protocol(const char *filename);
110 BlockDriver *bdrv_find_format(const char *format_name);
111 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
112 int bdrv_create(BlockDriver *drv, const char* filename,
113 QEMUOptionParameter *options);
114 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
115 BlockDriverState *bdrv_new(const char *device_name);
116 void bdrv_make_anon(BlockDriverState *bs);
117 void bdrv_delete(BlockDriverState *bs);
118 int bdrv_parse_cache_flags(const char *mode, int *flags);
119 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
120 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
121 BlockDriver *drv);
122 void bdrv_close(BlockDriverState *bs);
123 int bdrv_attach_dev(BlockDriverState *bs, void *dev);
124 void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
125 void bdrv_detach_dev(BlockDriverState *bs, void *dev);
126 void *bdrv_get_attached_dev(BlockDriverState *bs);
127 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
128 void *opaque);
129 void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
130 bool bdrv_dev_has_removable_media(BlockDriverState *bs);
131 bool bdrv_dev_is_tray_open(BlockDriverState *bs);
132 bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
133 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
134 uint8_t *buf, int nb_sectors);
135 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
136 const uint8_t *buf, int nb_sectors);
137 int bdrv_pread(BlockDriverState *bs, int64_t offset,
138 void *buf, int count);
139 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
140 const void *buf, int count);
141 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
142 const void *buf, int count);
143 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
144 int nb_sectors, QEMUIOVector *qiov);
145 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
146 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
147 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
148 int nb_sectors, QEMUIOVector *qiov);
149 int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
150 int nb_sectors, int *pnum);
151 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
152 const char *backing_file);
153 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
154 int64_t bdrv_getlength(BlockDriverState *bs);
155 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
156 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
157 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
158 int bdrv_commit(BlockDriverState *bs);
159 void bdrv_commit_all(void);
160 int bdrv_change_backing_file(BlockDriverState *bs,
161 const char *backing_file, const char *backing_fmt);
162 void bdrv_register(BlockDriver *bdrv);
163
164
165 typedef struct BdrvCheckResult {
166 int corruptions;
167 int leaks;
168 int check_errors;
169 } BdrvCheckResult;
170
171 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);
172
173 /* async block I/O */
174 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
175 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
176 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
177 int sector_num);
178 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
179 QEMUIOVector *iov, int nb_sectors,
180 BlockDriverCompletionFunc *cb, void *opaque);
181 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
182 QEMUIOVector *iov, int nb_sectors,
183 BlockDriverCompletionFunc *cb, void *opaque);
184 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
185 BlockDriverCompletionFunc *cb, void *opaque);
186 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
187 int64_t sector_num, int nb_sectors,
188 BlockDriverCompletionFunc *cb, void *opaque);
189 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
190
191 typedef struct BlockRequest {
192 /* Fields to be filled by multiwrite caller */
193 int64_t sector;
194 int nb_sectors;
195 QEMUIOVector *qiov;
196 BlockDriverCompletionFunc *cb;
197 void *opaque;
198
199 /* Filled by multiwrite implementation */
200 int error;
201 } BlockRequest;
202
203 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
204 int num_reqs);
205
206 /* sg packet commands */
207 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
208 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
209 unsigned long int req, void *buf,
210 BlockDriverCompletionFunc *cb, void *opaque);
211
212 /* Invalidate any cached metadata used by image formats */
213 void bdrv_invalidate_cache(BlockDriverState *bs);
214 void bdrv_invalidate_cache_all(void);
215
216 /* Ensure contents are flushed to disk. */
217 int bdrv_flush(BlockDriverState *bs);
218 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
219 void bdrv_flush_all(void);
220 void bdrv_close_all(void);
221 void bdrv_drain_all(void);
222
223 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
224 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
225 int bdrv_has_zero_init(BlockDriverState *bs);
226 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
227 int *pnum);
228
229 #define BIOS_ATA_TRANSLATION_AUTO 0
230 #define BIOS_ATA_TRANSLATION_NONE 1
231 #define BIOS_ATA_TRANSLATION_LBA 2
232 #define BIOS_ATA_TRANSLATION_LARGE 3
233 #define BIOS_ATA_TRANSLATION_RECHS 4
234
235 void bdrv_set_geometry_hint(BlockDriverState *bs,
236 int cyls, int heads, int secs);
237 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
238 void bdrv_get_geometry_hint(BlockDriverState *bs,
239 int *pcyls, int *pheads, int *psecs);
240 typedef enum FDriveType {
241 FDRIVE_DRV_144 = 0x00, /* 1.44 MB 3"5 drive */
242 FDRIVE_DRV_288 = 0x01, /* 2.88 MB 3"5 drive */
243 FDRIVE_DRV_120 = 0x02, /* 1.2 MB 5"25 drive */
244 FDRIVE_DRV_NONE = 0x03, /* No drive connected */
245 } FDriveType;
246
247 void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
248 int *max_track, int *last_sect,
249 FDriveType drive_in, FDriveType *drive);
250 int bdrv_get_translation_hint(BlockDriverState *bs);
251 void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
252 BlockErrorAction on_write_error);
253 BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
254 int bdrv_is_read_only(BlockDriverState *bs);
255 int bdrv_is_sg(BlockDriverState *bs);
256 int bdrv_enable_write_cache(BlockDriverState *bs);
257 int bdrv_is_inserted(BlockDriverState *bs);
258 int bdrv_media_changed(BlockDriverState *bs);
259 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
260 void bdrv_eject(BlockDriverState *bs, int eject_flag);
261 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
262 BlockDriverState *bdrv_find(const char *name);
263 BlockDriverState *bdrv_next(BlockDriverState *bs);
264 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
265 void *opaque);
266 int bdrv_is_encrypted(BlockDriverState *bs);
267 int bdrv_key_required(BlockDriverState *bs);
268 int bdrv_set_key(BlockDriverState *bs, const char *key);
269 int bdrv_query_missing_keys(void);
270 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
271 void *opaque);
272 const char *bdrv_get_device_name(BlockDriverState *bs);
273 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
274 const uint8_t *buf, int nb_sectors);
275 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
276
277 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
278 void bdrv_get_backing_filename(BlockDriverState *bs,
279 char *filename, int filename_size);
280 int bdrv_can_snapshot(BlockDriverState *bs);
281 int bdrv_is_snapshot(BlockDriverState *bs);
282 BlockDriverState *bdrv_snapshots(void);
283 int bdrv_snapshot_create(BlockDriverState *bs,
284 QEMUSnapshotInfo *sn_info);
285 int bdrv_snapshot_goto(BlockDriverState *bs,
286 const char *snapshot_id);
287 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
288 int bdrv_snapshot_list(BlockDriverState *bs,
289 QEMUSnapshotInfo **psn_info);
290 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
291 const char *snapshot_name);
292 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
293
294 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
295 int path_is_absolute(const char *path);
296 void path_combine(char *dest, int dest_size,
297 const char *base_path,
298 const char *filename);
299
300 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
301 int64_t pos, int size);
302
303 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
304 int64_t pos, int size);
305
306 int bdrv_img_create(const char *filename, const char *fmt,
307 const char *base_filename, const char *base_fmt,
308 char *options, uint64_t img_size, int flags);
309
310 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
311 void *qemu_blockalign(BlockDriverState *bs, size_t size);
312
313 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
314
315 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
316 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
317 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
318 int nr_sectors);
319 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
320
321 void bdrv_enable_copy_on_read(BlockDriverState *bs);
322 void bdrv_disable_copy_on_read(BlockDriverState *bs);
323
324 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
325 int bdrv_in_use(BlockDriverState *bs);
326
327 enum BlockAcctType {
328 BDRV_ACCT_READ,
329 BDRV_ACCT_WRITE,
330 BDRV_ACCT_FLUSH,
331 BDRV_MAX_IOTYPE,
332 };
333
334 typedef struct BlockAcctCookie {
335 int64_t bytes;
336 int64_t start_time_ns;
337 enum BlockAcctType type;
338 } BlockAcctCookie;
339
340 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
341 int64_t bytes, enum BlockAcctType type);
342 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
343
344 typedef enum {
345 BLKDBG_L1_UPDATE,
346
347 BLKDBG_L1_GROW_ALLOC_TABLE,
348 BLKDBG_L1_GROW_WRITE_TABLE,
349 BLKDBG_L1_GROW_ACTIVATE_TABLE,
350
351 BLKDBG_L2_LOAD,
352 BLKDBG_L2_UPDATE,
353 BLKDBG_L2_UPDATE_COMPRESSED,
354 BLKDBG_L2_ALLOC_COW_READ,
355 BLKDBG_L2_ALLOC_WRITE,
356
357 BLKDBG_READ,
358 BLKDBG_READ_AIO,
359 BLKDBG_READ_BACKING,
360 BLKDBG_READ_BACKING_AIO,
361 BLKDBG_READ_COMPRESSED,
362
363 BLKDBG_WRITE_AIO,
364 BLKDBG_WRITE_COMPRESSED,
365
366 BLKDBG_VMSTATE_LOAD,
367 BLKDBG_VMSTATE_SAVE,
368
369 BLKDBG_COW_READ,
370 BLKDBG_COW_WRITE,
371
372 BLKDBG_REFTABLE_LOAD,
373 BLKDBG_REFTABLE_GROW,
374
375 BLKDBG_REFBLOCK_LOAD,
376 BLKDBG_REFBLOCK_UPDATE,
377 BLKDBG_REFBLOCK_UPDATE_PART,
378 BLKDBG_REFBLOCK_ALLOC,
379 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
380 BLKDBG_REFBLOCK_ALLOC_WRITE,
381 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
382 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
383 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
384
385 BLKDBG_CLUSTER_ALLOC,
386 BLKDBG_CLUSTER_ALLOC_BYTES,
387 BLKDBG_CLUSTER_FREE,
388
389 BLKDBG_EVENT_MAX,
390 } BlkDebugEvent;
391
392 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
393 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
394
395
396 /* Convenience for block device models */
397
398 typedef struct BlockConf {
399 BlockDriverState *bs;
400 uint16_t physical_block_size;
401 uint16_t logical_block_size;
402 uint16_t min_io_size;
403 uint32_t opt_io_size;
404 int32_t bootindex;
405 uint32_t discard_granularity;
406 } BlockConf;
407
408 static inline unsigned int get_physical_block_exp(BlockConf *conf)
409 {
410 unsigned int exp = 0, size;
411
412 for (size = conf->physical_block_size;
413 size > conf->logical_block_size;
414 size >>= 1) {
415 exp++;
416 }
417
418 return exp;
419 }
420
421 #define DEFINE_BLOCK_PROPERTIES(_state, _conf) \
422 DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \
423 DEFINE_PROP_UINT16("logical_block_size", _state, \
424 _conf.logical_block_size, 512), \
425 DEFINE_PROP_UINT16("physical_block_size", _state, \
426 _conf.physical_block_size, 512), \
427 DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \
428 DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \
429 DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \
430 DEFINE_PROP_UINT32("discard_granularity", _state, \
431 _conf.discard_granularity, 0)
432
433 #endif
434