root / block_int.h @ dd4239d6
History | View | Annotate | Download (7.4 kB)
1 | ea2384d3 | bellard | /*
|
---|---|---|---|
2 | ea2384d3 | bellard | * QEMU System Emulator block driver
|
3 | 5fafdf24 | ths | *
|
4 | ea2384d3 | bellard | * Copyright (c) 2003 Fabrice Bellard
|
5 | 5fafdf24 | ths | *
|
6 | ea2384d3 | bellard | * Permission is hereby granted, free of charge, to any person obtaining a copy
|
7 | ea2384d3 | bellard | * of this software and associated documentation files (the "Software"), to deal
|
8 | ea2384d3 | bellard | * in the Software without restriction, including without limitation the rights
|
9 | ea2384d3 | bellard | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
10 | ea2384d3 | bellard | * copies of the Software, and to permit persons to whom the Software is
|
11 | ea2384d3 | bellard | * furnished to do so, subject to the following conditions:
|
12 | ea2384d3 | bellard | *
|
13 | ea2384d3 | bellard | * The above copyright notice and this permission notice shall be included in
|
14 | ea2384d3 | bellard | * all copies or substantial portions of the Software.
|
15 | ea2384d3 | bellard | *
|
16 | ea2384d3 | bellard | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
17 | ea2384d3 | bellard | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
18 | ea2384d3 | bellard | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
19 | ea2384d3 | bellard | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
20 | ea2384d3 | bellard | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
21 | ea2384d3 | bellard | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
22 | ea2384d3 | bellard | * THE SOFTWARE.
|
23 | ea2384d3 | bellard | */
|
24 | ea2384d3 | bellard | #ifndef BLOCK_INT_H
|
25 | ea2384d3 | bellard | #define BLOCK_INT_H
|
26 | ea2384d3 | bellard | |
27 | faf07963 | pbrook | #include "block.h" |
28 | 0e7e1989 | Kevin Wolf | #include "qemu-option.h" |
29 | faf07963 | pbrook | |
30 | ec36ba14 | ths | #define BLOCK_FLAG_ENCRYPT 1 |
31 | ec36ba14 | ths | #define BLOCK_FLAG_COMPRESS 2 |
32 | ec36ba14 | ths | #define BLOCK_FLAG_COMPAT6 4 |
33 | ec36ba14 | ths | |
34 | 0e7e1989 | Kevin Wolf | #define BLOCK_OPT_SIZE "size" |
35 | 0e7e1989 | Kevin Wolf | #define BLOCK_OPT_ENCRYPT "encryption" |
36 | 0e7e1989 | Kevin Wolf | #define BLOCK_OPT_COMPAT6 "compat6" |
37 | 0e7e1989 | Kevin Wolf | #define BLOCK_OPT_BACKING_FILE "backing_file" |
38 | 0e7e1989 | Kevin Wolf | #define BLOCK_OPT_BACKING_FMT "backing_fmt" |
39 | 73c632ed | Kevin Wolf | #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" |
40 | a35e1c17 | Kevin Wolf | #define BLOCK_OPT_PREALLOC "preallocation" |
41 | 0e7e1989 | Kevin Wolf | |
42 | 6bbff9a0 | aliguori | typedef struct AIOPool { |
43 | 6bbff9a0 | aliguori | void (*cancel)(BlockDriverAIOCB *acb);
|
44 | 6bbff9a0 | aliguori | int aiocb_size;
|
45 | 6bbff9a0 | aliguori | BlockDriverAIOCB *free_aiocb; |
46 | 6bbff9a0 | aliguori | } AIOPool; |
47 | 6bbff9a0 | aliguori | |
48 | ea2384d3 | bellard | struct BlockDriver {
|
49 | ea2384d3 | bellard | const char *format_name; |
50 | ea2384d3 | bellard | int instance_size;
|
51 | ea2384d3 | bellard | int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); |
52 | 508c7cb3 | Christoph Hellwig | int (*bdrv_probe_device)(const char *filename); |
53 | 83f64091 | bellard | int (*bdrv_open)(BlockDriverState *bs, const char *filename, int flags); |
54 | 5fafdf24 | ths | int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
|
55 | ea2384d3 | bellard | uint8_t *buf, int nb_sectors);
|
56 | 5fafdf24 | ths | int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
|
57 | ea2384d3 | bellard | const uint8_t *buf, int nb_sectors); |
58 | e2731add | bellard | void (*bdrv_close)(BlockDriverState *bs);
|
59 | 0e7e1989 | Kevin Wolf | int (*bdrv_create)(const char *filename, QEMUOptionParameter *options); |
60 | 7a6cba61 | pbrook | void (*bdrv_flush)(BlockDriverState *bs);
|
61 | ea2384d3 | bellard | int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
|
62 | ea2384d3 | bellard | int nb_sectors, int *pnum); |
63 | ea2384d3 | bellard | int (*bdrv_set_key)(BlockDriverState *bs, const char *key); |
64 | 95389c86 | bellard | int (*bdrv_make_empty)(BlockDriverState *bs);
|
65 | 83f64091 | bellard | /* aio */
|
66 | f141eafe | aliguori | BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs, |
67 | f141eafe | aliguori | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
|
68 | ce1a14dc | pbrook | BlockDriverCompletionFunc *cb, void *opaque);
|
69 | f141eafe | aliguori | BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs, |
70 | f141eafe | aliguori | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
|
71 | ce1a14dc | pbrook | BlockDriverCompletionFunc *cb, void *opaque);
|
72 | b2e12bc6 | Christoph Hellwig | BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs, |
73 | b2e12bc6 | Christoph Hellwig | BlockDriverCompletionFunc *cb, void *opaque);
|
74 | 83f64091 | bellard | |
75 | 40b4f539 | Kevin Wolf | int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
|
76 | 40b4f539 | Kevin Wolf | int num_reqs);
|
77 | 40b4f539 | Kevin Wolf | int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
|
78 | 40b4f539 | Kevin Wolf | BlockRequest *b); |
79 | 40b4f539 | Kevin Wolf | |
80 | 40b4f539 | Kevin Wolf | |
81 | 83f64091 | bellard | const char *protocol_name; |
82 | 83f64091 | bellard | int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
|
83 | 83f64091 | bellard | int64_t (*bdrv_getlength)(BlockDriverState *bs); |
84 | 5fafdf24 | ths | int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
|
85 | faea38e7 | bellard | const uint8_t *buf, int nb_sectors); |
86 | faea38e7 | bellard | |
87 | 5fafdf24 | ths | int (*bdrv_snapshot_create)(BlockDriverState *bs,
|
88 | faea38e7 | bellard | QEMUSnapshotInfo *sn_info); |
89 | 5fafdf24 | ths | int (*bdrv_snapshot_goto)(BlockDriverState *bs,
|
90 | faea38e7 | bellard | const char *snapshot_id); |
91 | faea38e7 | bellard | int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id); |
92 | 5fafdf24 | ths | int (*bdrv_snapshot_list)(BlockDriverState *bs,
|
93 | faea38e7 | bellard | QEMUSnapshotInfo **psn_info); |
94 | faea38e7 | bellard | int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
|
95 | 83f64091 | bellard | |
96 | 45566e9c | Christoph Hellwig | int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf, |
97 | 45566e9c | Christoph Hellwig | int64_t pos, int size);
|
98 | 45566e9c | Christoph Hellwig | int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
|
99 | 45566e9c | Christoph Hellwig | int64_t pos, int size);
|
100 | 178e08a5 | aliguori | |
101 | 19cb3738 | bellard | /* removable device specific */
|
102 | 19cb3738 | bellard | int (*bdrv_is_inserted)(BlockDriverState *bs);
|
103 | 19cb3738 | bellard | int (*bdrv_media_changed)(BlockDriverState *bs);
|
104 | 19cb3738 | bellard | int (*bdrv_eject)(BlockDriverState *bs, int eject_flag); |
105 | 19cb3738 | bellard | int (*bdrv_set_locked)(BlockDriverState *bs, int locked); |
106 | 3b46e624 | ths | |
107 | 985a03b0 | ths | /* to control generic scsi devices */
|
108 | 985a03b0 | ths | int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf); |
109 | 221f715d | aliguori | BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, |
110 | 221f715d | aliguori | unsigned long int req, void *buf, |
111 | 221f715d | aliguori | BlockDriverCompletionFunc *cb, void *opaque);
|
112 | 985a03b0 | ths | |
113 | 0e7e1989 | Kevin Wolf | /* List of options for creating images, terminated by name == NULL */
|
114 | 0e7e1989 | Kevin Wolf | QEMUOptionParameter *create_options; |
115 | 0e7e1989 | Kevin Wolf | |
116 | 5eb45639 | aliguori | |
117 | e97fc193 | aliguori | /* Returns number of errors in image, -errno for internal errors */
|
118 | e97fc193 | aliguori | int (*bdrv_check)(BlockDriverState* bs);
|
119 | e97fc193 | aliguori | |
120 | ea2384d3 | bellard | struct BlockDriver *next;
|
121 | ea2384d3 | bellard | }; |
122 | ea2384d3 | bellard | |
123 | ea2384d3 | bellard | struct BlockDriverState {
|
124 | d15a771d | bellard | int64_t total_sectors; /* if we are reading a disk image, give its
|
125 | d15a771d | bellard | size in sectors */
|
126 | ea2384d3 | bellard | int read_only; /* if true, the media is read only */ |
127 | ea2384d3 | bellard | int removable; /* if true, the media can be removed */ |
128 | ea2384d3 | bellard | int locked; /* if true, the media cannot temporarily be ejected */ |
129 | ea2384d3 | bellard | int encrypted; /* if true, the media is encrypted */ |
130 | c0f4ce77 | aliguori | int valid_key; /* if true, a valid encryption key has been set */ |
131 | 985a03b0 | ths | int sg; /* if true, the device is a /dev/sg* */ |
132 | ea2384d3 | bellard | /* event callback when inserting/removing */
|
133 | ea2384d3 | bellard | void (*change_cb)(void *opaque); |
134 | ea2384d3 | bellard | void *change_opaque;
|
135 | ea2384d3 | bellard | |
136 | 19cb3738 | bellard | BlockDriver *drv; /* NULL means no media */
|
137 | ea2384d3 | bellard | void *opaque;
|
138 | ea2384d3 | bellard | |
139 | ea2384d3 | bellard | char filename[1024]; |
140 | ea2384d3 | bellard | char backing_file[1024]; /* if non zero, the image is a diff of |
141 | ea2384d3 | bellard | this file image */
|
142 | 5eb45639 | aliguori | char backing_format[16]; /* if non-zero and backing_file exists */ |
143 | ea2384d3 | bellard | int is_temporary;
|
144 | 19cb3738 | bellard | int media_changed;
|
145 | 19cb3738 | bellard | |
146 | ea2384d3 | bellard | BlockDriverState *backing_hd; |
147 | ce1a14dc | pbrook | /* async read/write emulation */
|
148 | 83f64091 | bellard | |
149 | ce1a14dc | pbrook | void *sync_aiocb;
|
150 | 3b46e624 | ths | |
151 | a36e69dd | ths | /* I/O stats (display with "info blockstats"). */
|
152 | a36e69dd | ths | uint64_t rd_bytes; |
153 | a36e69dd | ths | uint64_t wr_bytes; |
154 | a36e69dd | ths | uint64_t rd_ops; |
155 | a36e69dd | ths | uint64_t wr_ops; |
156 | a36e69dd | ths | |
157 | 71d0770c | aliguori | /* Whether the disk can expand beyond total_sectors */
|
158 | 71d0770c | aliguori | int growable;
|
159 | 71d0770c | aliguori | |
160 | e268ca52 | aliguori | /* the memory alignment required for the buffers handled by this driver */
|
161 | e268ca52 | aliguori | int buffer_alignment;
|
162 | e268ca52 | aliguori | |
163 | e900a7b7 | Christoph Hellwig | /* do we need to tell the quest if we have a volatile write cache? */
|
164 | e900a7b7 | Christoph Hellwig | int enable_write_cache;
|
165 | e900a7b7 | Christoph Hellwig | |
166 | ea2384d3 | bellard | /* NOTE: the following infos are only hints for real hardware
|
167 | ea2384d3 | bellard | drivers. They are not used by the block driver */
|
168 | 46d4767d | bellard | int cyls, heads, secs, translation;
|
169 | ea2384d3 | bellard | int type;
|
170 | ea2384d3 | bellard | char device_name[32]; |
171 | 7cd1e32a | lirans@il.ibm.com | int dirty_tracking;
|
172 | 7cd1e32a | lirans@il.ibm.com | uint8_t *dirty_bitmap; |
173 | ea2384d3 | bellard | BlockDriverState *next; |
174 | b0a7b120 | aliguori | void *private;
|
175 | ea2384d3 | bellard | }; |
176 | ea2384d3 | bellard | |
177 | 83f64091 | bellard | struct BlockDriverAIOCB {
|
178 | 6bbff9a0 | aliguori | AIOPool *pool; |
179 | 83f64091 | bellard | BlockDriverState *bs; |
180 | 83f64091 | bellard | BlockDriverCompletionFunc *cb; |
181 | ce1a14dc | pbrook | void *opaque;
|
182 | ce1a14dc | pbrook | BlockDriverAIOCB *next; |
183 | 83f64091 | bellard | }; |
184 | 83f64091 | bellard | |
185 | 95389c86 | bellard | void get_tmp_filename(char *filename, int size); |
186 | 95389c86 | bellard | |
187 | c16b5a2c | Christoph Hellwig | void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
|
188 | c16b5a2c | Christoph Hellwig | BlockDriverCompletionFunc *cb, void *opaque);
|
189 | ce1a14dc | pbrook | void qemu_aio_release(void *p); |
190 | ce1a14dc | pbrook | |
191 | e268ca52 | aliguori | void *qemu_blockalign(BlockDriverState *bs, size_t size);
|
192 | e268ca52 | aliguori | |
193 | 7ee930d0 | blueswir1 | extern BlockDriverState *bdrv_first;
|
194 | faf07963 | pbrook | |
195 | 508c7cb3 | Christoph Hellwig | #ifdef _WIN32
|
196 | 508c7cb3 | Christoph Hellwig | int is_windows_drive(const char *filename); |
197 | 508c7cb3 | Christoph Hellwig | #endif
|
198 | 508c7cb3 | Christoph Hellwig | |
199 | ea2384d3 | bellard | #endif /* BLOCK_INT_H */ |