]>
Commit | Line | Data |
---|---|---|
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 | ||
30 | #define BLOCK_FLAG_ENCRYPT 1 | |
31 | #define BLOCK_FLAG_COMPRESS 2 | |
32 | #define BLOCK_FLAG_COMPAT6 4 | |
33 | ||
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" | |
39 | #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" | |
40 | #define BLOCK_OPT_PREALLOC "preallocation" | |
41 | ||
42 | typedef struct AIOPool { | |
43 | void (*cancel)(BlockDriverAIOCB *acb); | |
44 | int aiocb_size; | |
45 | BlockDriverAIOCB *free_aiocb; | |
46 | } AIOPool; | |
47 | ||
48 | struct BlockDriver { | |
49 | const char *format_name; | |
50 | int instance_size; | |
51 | int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); | |
52 | int (*bdrv_probe_device)(const char *filename); | |
53 | int (*bdrv_open)(BlockDriverState *bs, const char *filename, int flags); | |
54 | int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num, | |
55 | uint8_t *buf, int nb_sectors); | |
56 | int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num, | |
57 | const uint8_t *buf, int nb_sectors); | |
58 | void (*bdrv_close)(BlockDriverState *bs); | |
59 | int (*bdrv_create)(const char *filename, QEMUOptionParameter *options); | |
60 | void (*bdrv_flush)(BlockDriverState *bs); | |
61 | int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num, | |
62 | int nb_sectors, int *pnum); | |
63 | int (*bdrv_set_key)(BlockDriverState *bs, const char *key); | |
64 | int (*bdrv_make_empty)(BlockDriverState *bs); | |
65 | /* aio */ | |
66 | BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs, | |
67 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, | |
68 | BlockDriverCompletionFunc *cb, void *opaque); | |
69 | BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs, | |
70 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, | |
71 | BlockDriverCompletionFunc *cb, void *opaque); | |
72 | BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs, | |
73 | BlockDriverCompletionFunc *cb, void *opaque); | |
74 | ||
75 | int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs, | |
76 | int num_reqs); | |
77 | int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a, | |
78 | BlockRequest *b); | |
79 | ||
80 | ||
81 | const char *protocol_name; | |
82 | int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset); | |
83 | int64_t (*bdrv_getlength)(BlockDriverState *bs); | |
84 | int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num, | |
85 | const uint8_t *buf, int nb_sectors); | |
86 | ||
87 | int (*bdrv_snapshot_create)(BlockDriverState *bs, | |
88 | QEMUSnapshotInfo *sn_info); | |
89 | int (*bdrv_snapshot_goto)(BlockDriverState *bs, | |
90 | const char *snapshot_id); | |
91 | int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id); | |
92 | int (*bdrv_snapshot_list)(BlockDriverState *bs, | |
93 | QEMUSnapshotInfo **psn_info); | |
94 | int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); | |
95 | ||
96 | int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf, | |
97 | int64_t pos, int size); | |
98 | int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf, | |
99 | int64_t pos, int size); | |
100 | ||
101 | /* removable device specific */ | |
102 | int (*bdrv_is_inserted)(BlockDriverState *bs); | |
103 | int (*bdrv_media_changed)(BlockDriverState *bs); | |
104 | int (*bdrv_eject)(BlockDriverState *bs, int eject_flag); | |
105 | int (*bdrv_set_locked)(BlockDriverState *bs, int locked); | |
106 | ||
107 | /* to control generic scsi devices */ | |
108 | int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf); | |
109 | BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, | |
110 | unsigned long int req, void *buf, | |
111 | BlockDriverCompletionFunc *cb, void *opaque); | |
112 | ||
113 | /* List of options for creating images, terminated by name == NULL */ | |
114 | QEMUOptionParameter *create_options; | |
115 | ||
116 | ||
117 | /* Returns number of errors in image, -errno for internal errors */ | |
118 | int (*bdrv_check)(BlockDriverState* bs); | |
119 | ||
120 | /* Set if newly created images are not guaranteed to contain only zeros */ | |
121 | int no_zero_init; | |
122 | ||
123 | struct BlockDriver *next; | |
124 | }; | |
125 | ||
126 | struct BlockDriverState { | |
127 | int64_t total_sectors; /* if we are reading a disk image, give its | |
128 | size in sectors */ | |
129 | int read_only; /* if true, the media is read only */ | |
130 | int removable; /* if true, the media can be removed */ | |
131 | int locked; /* if true, the media cannot temporarily be ejected */ | |
132 | int encrypted; /* if true, the media is encrypted */ | |
133 | int valid_key; /* if true, a valid encryption key has been set */ | |
134 | int sg; /* if true, the device is a /dev/sg* */ | |
135 | /* event callback when inserting/removing */ | |
136 | void (*change_cb)(void *opaque); | |
137 | void *change_opaque; | |
138 | ||
139 | BlockDriver *drv; /* NULL means no media */ | |
140 | void *opaque; | |
141 | ||
142 | char filename[1024]; | |
143 | char backing_file[1024]; /* if non zero, the image is a diff of | |
144 | this file image */ | |
145 | char backing_format[16]; /* if non-zero and backing_file exists */ | |
146 | int is_temporary; | |
147 | int media_changed; | |
148 | ||
149 | BlockDriverState *backing_hd; | |
150 | /* async read/write emulation */ | |
151 | ||
152 | void *sync_aiocb; | |
153 | ||
154 | /* I/O stats (display with "info blockstats"). */ | |
155 | uint64_t rd_bytes; | |
156 | uint64_t wr_bytes; | |
157 | uint64_t rd_ops; | |
158 | uint64_t wr_ops; | |
159 | ||
160 | /* Whether the disk can expand beyond total_sectors */ | |
161 | int growable; | |
162 | ||
163 | /* the memory alignment required for the buffers handled by this driver */ | |
164 | int buffer_alignment; | |
165 | ||
166 | /* do we need to tell the quest if we have a volatile write cache? */ | |
167 | int enable_write_cache; | |
168 | ||
169 | /* NOTE: the following infos are only hints for real hardware | |
170 | drivers. They are not used by the block driver */ | |
171 | int cyls, heads, secs, translation; | |
172 | int type; | |
173 | char device_name[32]; | |
174 | unsigned long *dirty_bitmap; | |
175 | BlockDriverState *next; | |
176 | void *private; | |
177 | }; | |
178 | ||
179 | struct BlockDriverAIOCB { | |
180 | AIOPool *pool; | |
181 | BlockDriverState *bs; | |
182 | BlockDriverCompletionFunc *cb; | |
183 | void *opaque; | |
184 | BlockDriverAIOCB *next; | |
185 | }; | |
186 | ||
187 | void get_tmp_filename(char *filename, int size); | |
188 | ||
189 | void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs, | |
190 | BlockDriverCompletionFunc *cb, void *opaque); | |
191 | void qemu_aio_release(void *p); | |
192 | ||
193 | void *qemu_blockalign(BlockDriverState *bs, size_t size); | |
194 | ||
195 | extern BlockDriverState *bdrv_first; | |
196 | ||
197 | #ifdef _WIN32 | |
198 | int is_windows_drive(const char *filename); | |
199 | #endif | |
200 | ||
201 | #endif /* BLOCK_INT_H */ |