Merge branch 'master' of git://git.sv.gnu.org/qemu
[qemu-kvm/markmc.git] / block_int.h
blob8d0da7cfd7a6f90fe6399cd5c1be6ed1c56728b4
1 /*
2 * QEMU System Emulator block driver
4 * Copyright (c) 2003 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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.
24 #ifndef BLOCK_INT_H
25 #define BLOCK_INT_H
27 #include "block.h"
28 #include "qemu-option.h"
30 #define BLOCK_FLAG_ENCRYPT 1
31 #define BLOCK_FLAG_COMPRESS 2
32 #define BLOCK_FLAG_COMPAT6 4
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"
41 typedef struct AIOPool {
42 void (*cancel)(BlockDriverAIOCB *acb);
43 int aiocb_size;
44 BlockDriverAIOCB *free_aiocb;
45 } AIOPool;
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);
51 int (*bdrv_open)(BlockDriverState *bs, const char *filename, int flags);
52 int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
53 uint8_t *buf, int nb_sectors);
54 int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
55 const uint8_t *buf, int nb_sectors);
56 void (*bdrv_close)(BlockDriverState *bs);
57 int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
58 void (*bdrv_flush)(BlockDriverState *bs);
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);
62 int (*bdrv_make_empty)(BlockDriverState *bs);
63 /* aio */
64 BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
65 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
66 BlockDriverCompletionFunc *cb, void *opaque);
67 BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
68 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
69 BlockDriverCompletionFunc *cb, void *opaque);
71 const char *protocol_name;
72 int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
73 int64_t (*bdrv_getlength)(BlockDriverState *bs);
74 int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
75 const uint8_t *buf, int nb_sectors);
77 int (*bdrv_snapshot_create)(BlockDriverState *bs,
78 QEMUSnapshotInfo *sn_info);
79 int (*bdrv_snapshot_goto)(BlockDriverState *bs,
80 const char *snapshot_id);
81 int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
82 int (*bdrv_snapshot_list)(BlockDriverState *bs,
83 QEMUSnapshotInfo **psn_info);
84 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
86 int (*bdrv_put_buffer)(BlockDriverState *bs, const uint8_t *buf,
87 int64_t pos, int size);
88 int (*bdrv_get_buffer)(BlockDriverState *bs, uint8_t *buf,
89 int64_t pos, int size);
91 /* removable device specific */
92 int (*bdrv_is_inserted)(BlockDriverState *bs);
93 int (*bdrv_media_changed)(BlockDriverState *bs);
94 int (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
95 int (*bdrv_set_locked)(BlockDriverState *bs, int locked);
97 /* to control generic scsi devices */
98 int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
99 BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
100 unsigned long int req, void *buf,
101 BlockDriverCompletionFunc *cb, void *opaque);
103 /* List of options for creating images, terminated by name == NULL */
104 QEMUOptionParameter *create_options;
107 /* Returns number of errors in image, -errno for internal errors */
108 int (*bdrv_check)(BlockDriverState* bs);
110 struct BlockDriver *next;
113 struct BlockDriverState {
114 int64_t total_sectors; /* if we are reading a disk image, give its
115 size in sectors */
116 int read_only; /* if true, the media is read only */
117 int removable; /* if true, the media can be removed */
118 int locked; /* if true, the media cannot temporarily be ejected */
119 int encrypted; /* if true, the media is encrypted */
120 int valid_key; /* if true, a valid encryption key has been set */
121 int sg; /* if true, the device is a /dev/sg* */
122 /* event callback when inserting/removing */
123 void (*change_cb)(void *opaque);
124 void *change_opaque;
126 BlockDriver *drv; /* NULL means no media */
127 void *opaque;
129 char filename[1024];
130 char backing_file[1024]; /* if non zero, the image is a diff of
131 this file image */
132 char backing_format[16]; /* if non-zero and backing_file exists */
133 int is_temporary;
134 int media_changed;
136 BlockDriverState *backing_hd;
137 /* async read/write emulation */
139 void *sync_aiocb;
141 /* I/O stats (display with "info blockstats"). */
142 uint64_t rd_bytes;
143 uint64_t wr_bytes;
144 uint64_t rd_ops;
145 uint64_t wr_ops;
147 /* Whether the disk can expand beyond total_sectors */
148 int growable;
150 /* the memory alignment required for the buffers handled by this driver */
151 int buffer_alignment;
153 /* NOTE: the following infos are only hints for real hardware
154 drivers. They are not used by the block driver */
155 int cyls, heads, secs, translation;
156 int type;
157 char device_name[32];
158 BlockDriverState *next;
159 void *private;
162 struct BlockDriverAIOCB {
163 AIOPool *pool;
164 BlockDriverState *bs;
165 BlockDriverCompletionFunc *cb;
166 void *opaque;
167 BlockDriverAIOCB *next;
170 void get_tmp_filename(char *filename, int size);
172 void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
173 BlockDriverCompletionFunc *cb, void *opaque);
174 void qemu_aio_release(void *p);
176 void *qemu_blockalign(BlockDriverState *bs, size_t size);
178 extern BlockDriverState *bdrv_first;
180 #endif /* BLOCK_INT_H */