]>
Commit | Line | Data |
---|---|---|
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" |
faf07963 | 29 | |
ec36ba14 TS |
30 | #define BLOCK_FLAG_ENCRYPT 1 |
31 | #define BLOCK_FLAG_COMPRESS 2 | |
32 | #define BLOCK_FLAG_COMPAT6 4 | |
33 | ||
0e7e1989 KW |
34 | #define BLOCK_OPT_SIZE "size" |
35 | #define BLOCK_OPT_ENCRYPT "encryption" | |
36 | #define BLOCK_OPT_COMPAT6 "compat6" | |
37 | #define BLOCK_OPT_BACKING_FILE "backing_file" | |
38 | #define BLOCK_OPT_BACKING_FMT "backing_fmt" | |
73c632ed | 39 | #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" |
0e7e1989 | 40 | |
6bbff9a0 AL |
41 | typedef struct AIOPool { |
42 | void (*cancel)(BlockDriverAIOCB *acb); | |
43 | int aiocb_size; | |
44 | BlockDriverAIOCB *free_aiocb; | |
45 | } AIOPool; | |
46 | ||
ea2384d3 FB |
47 | struct BlockDriver { |
48 | const char *format_name; | |
49 | int instance_size; | |
50 | int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); | |
83f64091 | 51 | int (*bdrv_open)(BlockDriverState *bs, const char *filename, int flags); |
5fafdf24 | 52 | int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num, |
ea2384d3 | 53 | uint8_t *buf, int nb_sectors); |
5fafdf24 | 54 | int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num, |
ea2384d3 | 55 | const uint8_t *buf, int nb_sectors); |
e2731add | 56 | void (*bdrv_close)(BlockDriverState *bs); |
0e7e1989 | 57 | int (*bdrv_create)(const char *filename, QEMUOptionParameter *options); |
7a6cba61 | 58 | void (*bdrv_flush)(BlockDriverState *bs); |
ea2384d3 FB |
59 | int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num, |
60 | int nb_sectors, int *pnum); | |
61 | int (*bdrv_set_key)(BlockDriverState *bs, const char *key); | |
95389c86 | 62 | int (*bdrv_make_empty)(BlockDriverState *bs); |
83f64091 | 63 | /* aio */ |
f141eafe AL |
64 | BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs, |
65 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, | |
ce1a14dc | 66 | BlockDriverCompletionFunc *cb, void *opaque); |
f141eafe AL |
67 | BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs, |
68 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, | |
ce1a14dc | 69 | BlockDriverCompletionFunc *cb, void *opaque); |
83f64091 | 70 | void (*bdrv_aio_cancel)(BlockDriverAIOCB *acb); |
ce1a14dc | 71 | int aiocb_size; |
83f64091 FB |
72 | |
73 | const char *protocol_name; | |
83f64091 FB |
74 | int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset); |
75 | int64_t (*bdrv_getlength)(BlockDriverState *bs); | |
5fafdf24 | 76 | int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num, |
faea38e7 FB |
77 | const uint8_t *buf, int nb_sectors); |
78 | ||
5fafdf24 | 79 | int (*bdrv_snapshot_create)(BlockDriverState *bs, |
faea38e7 | 80 | QEMUSnapshotInfo *sn_info); |
5fafdf24 | 81 | int (*bdrv_snapshot_goto)(BlockDriverState *bs, |
faea38e7 FB |
82 | const char *snapshot_id); |
83 | int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id); | |
5fafdf24 | 84 | int (*bdrv_snapshot_list)(BlockDriverState *bs, |
faea38e7 FB |
85 | QEMUSnapshotInfo **psn_info); |
86 | int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); | |
83f64091 | 87 | |
178e08a5 AL |
88 | int (*bdrv_put_buffer)(BlockDriverState *bs, const uint8_t *buf, |
89 | int64_t pos, int size); | |
90 | int (*bdrv_get_buffer)(BlockDriverState *bs, uint8_t *buf, | |
91 | int64_t pos, int size); | |
92 | ||
19cb3738 FB |
93 | /* removable device specific */ |
94 | int (*bdrv_is_inserted)(BlockDriverState *bs); | |
95 | int (*bdrv_media_changed)(BlockDriverState *bs); | |
96 | int (*bdrv_eject)(BlockDriverState *bs, int eject_flag); | |
97 | int (*bdrv_set_locked)(BlockDriverState *bs, int locked); | |
3b46e624 | 98 | |
985a03b0 TS |
99 | /* to control generic scsi devices */ |
100 | int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf); | |
221f715d AL |
101 | BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, |
102 | unsigned long int req, void *buf, | |
103 | BlockDriverCompletionFunc *cb, void *opaque); | |
985a03b0 | 104 | |
6bbff9a0 | 105 | AIOPool aio_pool; |
5eb45639 | 106 | |
0e7e1989 KW |
107 | /* List of options for creating images, terminated by name == NULL */ |
108 | QEMUOptionParameter *create_options; | |
109 | ||
5eb45639 | 110 | |
e97fc193 AL |
111 | /* Returns number of errors in image, -errno for internal errors */ |
112 | int (*bdrv_check)(BlockDriverState* bs); | |
113 | ||
ea2384d3 FB |
114 | struct BlockDriver *next; |
115 | }; | |
116 | ||
117 | struct BlockDriverState { | |
d15a771d FB |
118 | int64_t total_sectors; /* if we are reading a disk image, give its |
119 | size in sectors */ | |
ea2384d3 | 120 | int read_only; /* if true, the media is read only */ |
ea2384d3 FB |
121 | int removable; /* if true, the media can be removed */ |
122 | int locked; /* if true, the media cannot temporarily be ejected */ | |
123 | int encrypted; /* if true, the media is encrypted */ | |
c0f4ce77 | 124 | int valid_key; /* if true, a valid encryption key has been set */ |
985a03b0 | 125 | int sg; /* if true, the device is a /dev/sg* */ |
ea2384d3 FB |
126 | /* event callback when inserting/removing */ |
127 | void (*change_cb)(void *opaque); | |
128 | void *change_opaque; | |
129 | ||
19cb3738 | 130 | BlockDriver *drv; /* NULL means no media */ |
ea2384d3 FB |
131 | void *opaque; |
132 | ||
ea2384d3 FB |
133 | char filename[1024]; |
134 | char backing_file[1024]; /* if non zero, the image is a diff of | |
135 | this file image */ | |
5eb45639 | 136 | char backing_format[16]; /* if non-zero and backing_file exists */ |
ea2384d3 | 137 | int is_temporary; |
19cb3738 FB |
138 | int media_changed; |
139 | ||
ea2384d3 | 140 | BlockDriverState *backing_hd; |
ce1a14dc | 141 | /* async read/write emulation */ |
83f64091 | 142 | |
ce1a14dc | 143 | void *sync_aiocb; |
3b46e624 | 144 | |
a36e69dd TS |
145 | /* I/O stats (display with "info blockstats"). */ |
146 | uint64_t rd_bytes; | |
147 | uint64_t wr_bytes; | |
148 | uint64_t rd_ops; | |
149 | uint64_t wr_ops; | |
150 | ||
71d0770c AL |
151 | /* Whether the disk can expand beyond total_sectors */ |
152 | int growable; | |
153 | ||
e268ca52 AL |
154 | /* the memory alignment required for the buffers handled by this driver */ |
155 | int buffer_alignment; | |
156 | ||
ea2384d3 FB |
157 | /* NOTE: the following infos are only hints for real hardware |
158 | drivers. They are not used by the block driver */ | |
46d4767d | 159 | int cyls, heads, secs, translation; |
ea2384d3 FB |
160 | int type; |
161 | char device_name[32]; | |
162 | BlockDriverState *next; | |
b0a7b120 | 163 | void *private; |
ea2384d3 FB |
164 | }; |
165 | ||
83f64091 | 166 | struct BlockDriverAIOCB { |
6bbff9a0 | 167 | AIOPool *pool; |
83f64091 FB |
168 | BlockDriverState *bs; |
169 | BlockDriverCompletionFunc *cb; | |
ce1a14dc PB |
170 | void *opaque; |
171 | BlockDriverAIOCB *next; | |
83f64091 FB |
172 | }; |
173 | ||
95389c86 FB |
174 | void get_tmp_filename(char *filename, int size); |
175 | ||
6bbff9a0 AL |
176 | void aio_pool_init(AIOPool *pool, int aiocb_size, |
177 | void (*cancel)(BlockDriverAIOCB *acb)); | |
178 | ||
ce1a14dc PB |
179 | void *qemu_aio_get(BlockDriverState *bs, BlockDriverCompletionFunc *cb, |
180 | void *opaque); | |
6bbff9a0 AL |
181 | void *qemu_aio_get_pool(AIOPool *pool, BlockDriverState *bs, |
182 | BlockDriverCompletionFunc *cb, void *opaque); | |
ce1a14dc PB |
183 | void qemu_aio_release(void *p); |
184 | ||
e268ca52 AL |
185 | void *qemu_blockalign(BlockDriverState *bs, size_t size); |
186 | ||
7ee930d0 | 187 | extern BlockDriverState *bdrv_first; |
faf07963 | 188 | |
ea2384d3 | 189 | #endif /* BLOCK_INT_H */ |