]> git.proxmox.com Git - mirror_qemu.git/blame - block_int.h
pseries: Fix qdev.id handling in the VIO bus code
[mirror_qemu.git] / block_int.h
CommitLineData
ea2384d3
FB
1/*
2 * QEMU System Emulator block driver
5fafdf24 3 *
ea2384d3 4 * Copyright (c) 2003 Fabrice Bellard
5fafdf24 5 *
ea2384d3
FB
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
faf07963 27#include "block.h"
0e7e1989 28#include "qemu-option.h"
1b7bdbc1 29#include "qemu-queue.h"
da1fa91d 30#include "qemu-coroutine.h"
c488c7f6 31#include "qemu-timer.h"
b2023818 32#include "qapi-types.h"
faf07963 33
ec36ba14 34#define BLOCK_FLAG_ENCRYPT 1
ec36ba14
TS
35#define BLOCK_FLAG_COMPAT6 4
36
0e7e1989
KW
37#define BLOCK_OPT_SIZE "size"
38#define BLOCK_OPT_ENCRYPT "encryption"
39#define BLOCK_OPT_COMPAT6 "compat6"
40#define BLOCK_OPT_BACKING_FILE "backing_file"
41#define BLOCK_OPT_BACKING_FMT "backing_fmt"
73c632ed 42#define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
75411d23 43#define BLOCK_OPT_TABLE_SIZE "table_size"
a35e1c17 44#define BLOCK_OPT_PREALLOC "preallocation"
f66fd6c3 45#define BLOCK_OPT_SUBFMT "subformat"
0e7e1989 46
6bbff9a0
AL
47typedef struct AIOPool {
48 void (*cancel)(BlockDriverAIOCB *acb);
49 int aiocb_size;
50 BlockDriverAIOCB *free_aiocb;
51} AIOPool;
52
ea2384d3
FB
53struct BlockDriver {
54 const char *format_name;
55 int instance_size;
56 int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
508c7cb3 57 int (*bdrv_probe_device)(const char *filename);
66f82cee
KW
58 int (*bdrv_open)(BlockDriverState *bs, int flags);
59 int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
5fafdf24 60 int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
ea2384d3 61 uint8_t *buf, int nb_sectors);
5fafdf24 62 int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
ea2384d3 63 const uint8_t *buf, int nb_sectors);
e2731add 64 void (*bdrv_close)(BlockDriverState *bs);
0e7e1989 65 int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
ea2384d3
FB
66 int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
67 int nb_sectors, int *pnum);
68 int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
95389c86 69 int (*bdrv_make_empty)(BlockDriverState *bs);
83f64091 70 /* aio */
f141eafe
AL
71 BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
72 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
ce1a14dc 73 BlockDriverCompletionFunc *cb, void *opaque);
f141eafe
AL
74 BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
75 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
ce1a14dc 76 BlockDriverCompletionFunc *cb, void *opaque);
b2e12bc6
CH
77 BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
78 BlockDriverCompletionFunc *cb, void *opaque);
4265d620
PB
79 BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
80 int64_t sector_num, int nb_sectors,
81 BlockDriverCompletionFunc *cb, void *opaque);
83f64091 82
da1fa91d
KW
83 int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
84 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
85 int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
86 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
07f07615 87 int coroutine_fn (*bdrv_co_flush)(BlockDriverState *bs);
4265d620
PB
88 int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
89 int64_t sector_num, int nb_sectors);
da1fa91d 90
40b4f539
KW
91 int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
92 int num_reqs);
93 int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
94 BlockRequest *b);
95
96
83f64091 97 const char *protocol_name;
83f64091
FB
98 int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
99 int64_t (*bdrv_getlength)(BlockDriverState *bs);
4a1d5e1f 100 int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
5fafdf24 101 int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
faea38e7
FB
102 const uint8_t *buf, int nb_sectors);
103
5fafdf24 104 int (*bdrv_snapshot_create)(BlockDriverState *bs,
faea38e7 105 QEMUSnapshotInfo *sn_info);
5fafdf24 106 int (*bdrv_snapshot_goto)(BlockDriverState *bs,
faea38e7
FB
107 const char *snapshot_id);
108 int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
5fafdf24 109 int (*bdrv_snapshot_list)(BlockDriverState *bs,
faea38e7 110 QEMUSnapshotInfo **psn_info);
51ef6727 111 int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
112 const char *snapshot_name);
faea38e7 113 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
83f64091 114
45566e9c
CH
115 int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
116 int64_t pos, int size);
117 int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
118 int64_t pos, int size);
178e08a5 119
756e6736
KW
120 int (*bdrv_change_backing_file)(BlockDriverState *bs,
121 const char *backing_file, const char *backing_fmt);
122
19cb3738
FB
123 /* removable device specific */
124 int (*bdrv_is_inserted)(BlockDriverState *bs);
125 int (*bdrv_media_changed)(BlockDriverState *bs);
822e1cd1 126 void (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
025e849a 127 void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
3b46e624 128
985a03b0
TS
129 /* to control generic scsi devices */
130 int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
221f715d
AL
131 BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
132 unsigned long int req, void *buf,
133 BlockDriverCompletionFunc *cb, void *opaque);
985a03b0 134
0e7e1989
KW
135 /* List of options for creating images, terminated by name == NULL */
136 QEMUOptionParameter *create_options;
137
5eb45639 138
9ac228e0
KW
139 /*
140 * Returns 0 for completed check, -errno for internal errors.
141 * The check results are stored in result.
142 */
143 int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
e97fc193 144
8b9b0cc2
KW
145 void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
146
336c1c12
KW
147 /*
148 * Returns 1 if newly created images are guaranteed to contain only
149 * zeros, 0 otherwise.
150 */
151 int (*bdrv_has_zero_init)(BlockDriverState *bs);
12c09b8c 152
8a22f02a 153 QLIST_ENTRY(BlockDriver) list;
ea2384d3
FB
154};
155
156struct BlockDriverState {
d15a771d
FB
157 int64_t total_sectors; /* if we are reading a disk image, give its
158 size in sectors */
ea2384d3 159 int read_only; /* if true, the media is read only */
4dca4b63
NS
160 int keep_read_only; /* if true, the media was requested to stay read only */
161 int open_flags; /* flags used to open the file, re-used for re-open */
ea2384d3 162 int encrypted; /* if true, the media is encrypted */
c0f4ce77 163 int valid_key; /* if true, a valid encryption key has been set */
985a03b0 164 int sg; /* if true, the device is a /dev/sg* */
ea2384d3 165
19cb3738 166 BlockDriver *drv; /* NULL means no media */
ea2384d3
FB
167 void *opaque;
168
fa879d62
MA
169 void *dev; /* attached device model, if any */
170 /* TODO change to DeviceState when all users are qdevified */
0e49de52
MA
171 const BlockDevOps *dev_ops;
172 void *dev_opaque;
18846dee 173
ea2384d3
FB
174 char filename[1024];
175 char backing_file[1024]; /* if non zero, the image is a diff of
176 this file image */
5eb45639 177 char backing_format[16]; /* if non-zero and backing_file exists */
ea2384d3 178 int is_temporary;
19cb3738 179
ea2384d3 180 BlockDriverState *backing_hd;
66f82cee
KW
181 BlockDriverState *file;
182
ce1a14dc 183 /* async read/write emulation */
83f64091 184
ce1a14dc 185 void *sync_aiocb;
3b46e624 186
a36e69dd 187 /* I/O stats (display with "info blockstats"). */
a597e79c
CH
188 uint64_t nr_bytes[BDRV_MAX_IOTYPE];
189 uint64_t nr_ops[BDRV_MAX_IOTYPE];
c488c7f6 190 uint64_t total_time_ns[BDRV_MAX_IOTYPE];
294cc35f 191 uint64_t wr_highest_sector;
a36e69dd 192
71d0770c
AL
193 /* Whether the disk can expand beyond total_sectors */
194 int growable;
195
e268ca52
AL
196 /* the memory alignment required for the buffers handled by this driver */
197 int buffer_alignment;
198
e900a7b7
CH
199 /* do we need to tell the quest if we have a volatile write cache? */
200 int enable_write_cache;
201
ea2384d3
FB
202 /* NOTE: the following infos are only hints for real hardware
203 drivers. They are not used by the block driver */
46d4767d 204 int cyls, heads, secs, translation;
abd7f68d 205 BlockErrorAction on_read_error, on_write_error;
d6bf279e 206 bool iostatus_enabled;
b2023818 207 BlockDeviceIoStatus iostatus;
ea2384d3 208 char device_name[32];
c6d22830 209 unsigned long *dirty_bitmap;
aaa0eb75 210 int64_t dirty_count;
db593f25 211 int in_use; /* users other than guest access, eg. block migration */
1b7bdbc1 212 QTAILQ_ENTRY(BlockDriverState) list;
b0a7b120 213 void *private;
ea2384d3
FB
214};
215
83f64091 216struct BlockDriverAIOCB {
6bbff9a0 217 AIOPool *pool;
83f64091
FB
218 BlockDriverState *bs;
219 BlockDriverCompletionFunc *cb;
ce1a14dc
PB
220 void *opaque;
221 BlockDriverAIOCB *next;
83f64091
FB
222};
223
95389c86
FB
224void get_tmp_filename(char *filename, int size);
225
c16b5a2c
CH
226void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
227 BlockDriverCompletionFunc *cb, void *opaque);
ce1a14dc
PB
228void qemu_aio_release(void *p);
229
508c7cb3
CH
230#ifdef _WIN32
231int is_windows_drive(const char *filename);
232#endif
233
ea2384d3 234#endif /* BLOCK_INT_H */