PPC: booke: add tlbnps handling
[qemu.git] / block_int.h
1 /*
2 * QEMU System Emulator block driver
3 *
4 * Copyright (c) 2003 Fabrice Bellard
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 #ifndef BLOCK_INT_H
25 #define BLOCK_INT_H
26
27 #include "block.h"
28 #include "qemu-option.h"
29 #include "qemu-queue.h"
30 #include "qemu-coroutine.h"
31 #include "qemu-timer.h"
32 #include "qapi-types.h"
33
34 #define BLOCK_FLAG_ENCRYPT 1
35 #define BLOCK_FLAG_COMPAT6 4
36
37 #define BLOCK_IO_LIMIT_READ 0
38 #define BLOCK_IO_LIMIT_WRITE 1
39 #define BLOCK_IO_LIMIT_TOTAL 2
40
41 #define BLOCK_IO_SLICE_TIME 100000000
42 #define NANOSECONDS_PER_SECOND 1000000000.0
43
44 #define BLOCK_OPT_SIZE "size"
45 #define BLOCK_OPT_ENCRYPT "encryption"
46 #define BLOCK_OPT_COMPAT6 "compat6"
47 #define BLOCK_OPT_BACKING_FILE "backing_file"
48 #define BLOCK_OPT_BACKING_FMT "backing_fmt"
49 #define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
50 #define BLOCK_OPT_TABLE_SIZE "table_size"
51 #define BLOCK_OPT_PREALLOC "preallocation"
52 #define BLOCK_OPT_SUBFMT "subformat"
53
54 typedef struct BdrvTrackedRequest BdrvTrackedRequest;
55
56 typedef struct AIOPool {
57 void (*cancel)(BlockDriverAIOCB *acb);
58 int aiocb_size;
59 BlockDriverAIOCB *free_aiocb;
60 } AIOPool;
61
62 typedef struct BlockIOLimit {
63 int64_t bps[3];
64 int64_t iops[3];
65 } BlockIOLimit;
66
67 typedef struct BlockIOBaseValue {
68 uint64_t bytes[2];
69 uint64_t ios[2];
70 } BlockIOBaseValue;
71
72 typedef void BlockJobCancelFunc(void *opaque);
73 typedef struct BlockJob BlockJob;
74 typedef struct BlockJobType {
75 /** Derived BlockJob struct size */
76 size_t instance_size;
77
78 /** String describing the operation, part of query-block-jobs QMP API */
79 const char *job_type;
80
81 /** Optional callback for job types that support setting a speed limit */
82 int (*set_speed)(BlockJob *job, int64_t value);
83 } BlockJobType;
84
85 /**
86 * Long-running operation on a BlockDriverState
87 */
88 struct BlockJob {
89 const BlockJobType *job_type;
90 BlockDriverState *bs;
91 bool cancelled;
92
93 /* These fields are published by the query-block-jobs QMP API */
94 int64_t offset;
95 int64_t len;
96 int64_t speed;
97
98 BlockDriverCompletionFunc *cb;
99 void *opaque;
100 };
101
102 struct BlockDriver {
103 const char *format_name;
104 int instance_size;
105 int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
106 int (*bdrv_probe_device)(const char *filename);
107 int (*bdrv_open)(BlockDriverState *bs, int flags);
108 int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
109 int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
110 uint8_t *buf, int nb_sectors);
111 int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
112 const uint8_t *buf, int nb_sectors);
113 void (*bdrv_close)(BlockDriverState *bs);
114 int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
115 int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
116 int (*bdrv_make_empty)(BlockDriverState *bs);
117 /* aio */
118 BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
119 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
120 BlockDriverCompletionFunc *cb, void *opaque);
121 BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
122 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
123 BlockDriverCompletionFunc *cb, void *opaque);
124 BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
125 BlockDriverCompletionFunc *cb, void *opaque);
126 BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
127 int64_t sector_num, int nb_sectors,
128 BlockDriverCompletionFunc *cb, void *opaque);
129
130 int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
131 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
132 int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
133 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
134 int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
135 int64_t sector_num, int nb_sectors);
136 int coroutine_fn (*bdrv_co_is_allocated)(BlockDriverState *bs,
137 int64_t sector_num, int nb_sectors, int *pnum);
138
139 /*
140 * Invalidate any cached meta-data.
141 */
142 void (*bdrv_invalidate_cache)(BlockDriverState *bs);
143
144 /*
145 * Flushes all data that was already written to the OS all the way down to
146 * the disk (for example raw-posix calls fsync()).
147 */
148 int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs);
149
150 /*
151 * Flushes all internal caches to the OS. The data may still sit in a
152 * writeback cache of the host OS, but it will survive a crash of the qemu
153 * process.
154 */
155 int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs);
156
157 int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
158 int num_reqs);
159 int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
160 BlockRequest *b);
161
162
163 const char *protocol_name;
164 int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
165 int64_t (*bdrv_getlength)(BlockDriverState *bs);
166 int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
167 int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
168 const uint8_t *buf, int nb_sectors);
169
170 int (*bdrv_snapshot_create)(BlockDriverState *bs,
171 QEMUSnapshotInfo *sn_info);
172 int (*bdrv_snapshot_goto)(BlockDriverState *bs,
173 const char *snapshot_id);
174 int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
175 int (*bdrv_snapshot_list)(BlockDriverState *bs,
176 QEMUSnapshotInfo **psn_info);
177 int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
178 const char *snapshot_name);
179 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
180
181 int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
182 int64_t pos, int size);
183 int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
184 int64_t pos, int size);
185
186 int (*bdrv_change_backing_file)(BlockDriverState *bs,
187 const char *backing_file, const char *backing_fmt);
188
189 /* removable device specific */
190 int (*bdrv_is_inserted)(BlockDriverState *bs);
191 int (*bdrv_media_changed)(BlockDriverState *bs);
192 void (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
193 void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
194
195 /* to control generic scsi devices */
196 int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
197 BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
198 unsigned long int req, void *buf,
199 BlockDriverCompletionFunc *cb, void *opaque);
200
201 /* List of options for creating images, terminated by name == NULL */
202 QEMUOptionParameter *create_options;
203
204
205 /*
206 * Returns 0 for completed check, -errno for internal errors.
207 * The check results are stored in result.
208 */
209 int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
210
211 void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
212
213 /*
214 * Returns 1 if newly created images are guaranteed to contain only
215 * zeros, 0 otherwise.
216 */
217 int (*bdrv_has_zero_init)(BlockDriverState *bs);
218
219 QLIST_ENTRY(BlockDriver) list;
220 };
221
222 struct BlockDriverState {
223 int64_t total_sectors; /* if we are reading a disk image, give its
224 size in sectors */
225 int read_only; /* if true, the media is read only */
226 int keep_read_only; /* if true, the media was requested to stay read only */
227 int open_flags; /* flags used to open the file, re-used for re-open */
228 int encrypted; /* if true, the media is encrypted */
229 int valid_key; /* if true, a valid encryption key has been set */
230 int sg; /* if true, the device is a /dev/sg* */
231 int copy_on_read; /* if true, copy read backing sectors into image
232 note this is a reference count */
233
234 BlockDriver *drv; /* NULL means no media */
235 void *opaque;
236
237 void *dev; /* attached device model, if any */
238 /* TODO change to DeviceState when all users are qdevified */
239 const BlockDevOps *dev_ops;
240 void *dev_opaque;
241
242 char filename[1024];
243 char backing_file[1024]; /* if non zero, the image is a diff of
244 this file image */
245 char backing_format[16]; /* if non-zero and backing_file exists */
246 int is_temporary;
247
248 BlockDriverState *backing_hd;
249 BlockDriverState *file;
250
251 /* number of in-flight copy-on-read requests */
252 unsigned int copy_on_read_in_flight;
253
254 /* async read/write emulation */
255
256 void *sync_aiocb;
257
258 /* the time for latest disk I/O */
259 int64_t slice_time;
260 int64_t slice_start;
261 int64_t slice_end;
262 BlockIOLimit io_limits;
263 BlockIOBaseValue io_base;
264 CoQueue throttled_reqs;
265 QEMUTimer *block_timer;
266 bool io_limits_enabled;
267
268 /* I/O stats (display with "info blockstats"). */
269 uint64_t nr_bytes[BDRV_MAX_IOTYPE];
270 uint64_t nr_ops[BDRV_MAX_IOTYPE];
271 uint64_t total_time_ns[BDRV_MAX_IOTYPE];
272 uint64_t wr_highest_sector;
273
274 /* Whether the disk can expand beyond total_sectors */
275 int growable;
276
277 /* the memory alignment required for the buffers handled by this driver */
278 int buffer_alignment;
279
280 /* do we need to tell the quest if we have a volatile write cache? */
281 int enable_write_cache;
282
283 /* NOTE: the following infos are only hints for real hardware
284 drivers. They are not used by the block driver */
285 int cyls, heads, secs, translation;
286 BlockErrorAction on_read_error, on_write_error;
287 bool iostatus_enabled;
288 BlockDeviceIoStatus iostatus;
289 char device_name[32];
290 unsigned long *dirty_bitmap;
291 int64_t dirty_count;
292 int in_use; /* users other than guest access, eg. block migration */
293 QTAILQ_ENTRY(BlockDriverState) list;
294 void *private;
295
296 QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
297
298 /* long-running background operation */
299 BlockJob *job;
300 };
301
302 struct BlockDriverAIOCB {
303 AIOPool *pool;
304 BlockDriverState *bs;
305 BlockDriverCompletionFunc *cb;
306 void *opaque;
307 BlockDriverAIOCB *next;
308 };
309
310 void get_tmp_filename(char *filename, int size);
311
312 void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
313 BlockDriverCompletionFunc *cb, void *opaque);
314 void qemu_aio_release(void *p);
315
316 void bdrv_set_io_limits(BlockDriverState *bs,
317 BlockIOLimit *io_limits);
318
319 #ifdef _WIN32
320 int is_windows_drive(const char *filename);
321 #endif
322
323 void *block_job_create(const BlockJobType *job_type, BlockDriverState *bs,
324 BlockDriverCompletionFunc *cb, void *opaque);
325 void block_job_complete(BlockJob *job, int ret);
326 int block_job_set_speed(BlockJob *job, int64_t value);
327 void block_job_cancel(BlockJob *job);
328 bool block_job_is_cancelled(BlockJob *job);
329
330 int stream_start(BlockDriverState *bs, BlockDriverState *base,
331 const char *base_id, BlockDriverCompletionFunc *cb,
332 void *opaque);
333
334 #endif /* BLOCK_INT_H */