blob: 96ff4cf1bc9e8a100c14c72059378eff4ea59ae0 [file] [log] [blame]
bellardea2384d2004-08-01 21:59:26 +00001/*
2 * QEMU System Emulator block driver
ths5fafdf22007-09-16 21:08:06 +00003 *
bellardea2384d2004-08-01 21:59:26 +00004 * Copyright (c) 2003 Fabrice Bellard
ths5fafdf22007-09-16 21:08:06 +00005 *
bellardea2384d2004-08-01 21:59:26 +00006 * 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
pbrookfaf07962007-11-11 02:51:17 +000027#include "block.h"
Kevin Wolf0e7e1982009-05-18 16:42:10 +020028#include "qemu-option.h"
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +010029#include "qemu-queue.h"
pbrookfaf07962007-11-11 02:51:17 +000030
thsec36ba12007-09-16 21:59:02 +000031#define BLOCK_FLAG_ENCRYPT 1
32#define BLOCK_FLAG_COMPRESS 2
33#define BLOCK_FLAG_COMPAT6 4
34
Kevin Wolf0e7e1982009-05-18 16:42:10 +020035#define BLOCK_OPT_SIZE "size"
36#define BLOCK_OPT_ENCRYPT "encryption"
37#define BLOCK_OPT_COMPAT6 "compat6"
38#define BLOCK_OPT_BACKING_FILE "backing_file"
39#define BLOCK_OPT_BACKING_FMT "backing_fmt"
Kevin Wolf73c632e2009-05-19 17:57:21 +020040#define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
Kevin Wolfa35e1c12009-08-17 15:50:10 +020041#define BLOCK_OPT_PREALLOC "preallocation"
Kevin Wolf0e7e1982009-05-18 16:42:10 +020042
aliguori6bbff9a2009-03-20 18:25:59 +000043typedef struct AIOPool {
44 void (*cancel)(BlockDriverAIOCB *acb);
45 int aiocb_size;
46 BlockDriverAIOCB *free_aiocb;
47} AIOPool;
48
bellardea2384d2004-08-01 21:59:26 +000049struct BlockDriver {
50 const char *format_name;
51 int instance_size;
52 int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
Christoph Hellwig508c7cb2009-06-15 14:04:22 +020053 int (*bdrv_probe_device)(const char *filename);
Kevin Wolf66f82ce2010-04-14 14:17:38 +020054 int (*bdrv_open)(BlockDriverState *bs, int flags);
55 int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
ths5fafdf22007-09-16 21:08:06 +000056 int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
bellardea2384d2004-08-01 21:59:26 +000057 uint8_t *buf, int nb_sectors);
ths5fafdf22007-09-16 21:08:06 +000058 int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
bellardea2384d2004-08-01 21:59:26 +000059 const uint8_t *buf, int nb_sectors);
bellarde2731ad2004-09-18 19:32:11 +000060 void (*bdrv_close)(BlockDriverState *bs);
Kevin Wolf0e7e1982009-05-18 16:42:10 +020061 int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
pbrook7a6cba62006-06-04 11:39:07 +000062 void (*bdrv_flush)(BlockDriverState *bs);
bellardea2384d2004-08-01 21:59:26 +000063 int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
64 int nb_sectors, int *pnum);
65 int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
bellard95389c82005-12-18 18:28:15 +000066 int (*bdrv_make_empty)(BlockDriverState *bs);
bellard83f64092006-08-01 16:21:11 +000067 /* aio */
aliguorif141eaf2009-04-07 18:43:24 +000068 BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
69 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
pbrookce1a14d2006-08-07 02:38:06 +000070 BlockDriverCompletionFunc *cb, void *opaque);
aliguorif141eaf2009-04-07 18:43:24 +000071 BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
72 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
pbrookce1a14d2006-08-07 02:38:06 +000073 BlockDriverCompletionFunc *cb, void *opaque);
Christoph Hellwigb2e12bc2009-09-04 19:01:49 +020074 BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
75 BlockDriverCompletionFunc *cb, void *opaque);
bellard83f64092006-08-01 16:21:11 +000076
Kevin Wolf40b4f532009-09-09 17:53:37 +020077 int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
78 int num_reqs);
79 int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
80 BlockRequest *b);
81
82
bellard83f64092006-08-01 16:21:11 +000083 const char *protocol_name;
bellard83f64092006-08-01 16:21:11 +000084 int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
85 int64_t (*bdrv_getlength)(BlockDriverState *bs);
ths5fafdf22007-09-16 21:08:06 +000086 int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
bellardfaea38e2006-08-05 21:31:00 +000087 const uint8_t *buf, int nb_sectors);
88
ths5fafdf22007-09-16 21:08:06 +000089 int (*bdrv_snapshot_create)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +000090 QEMUSnapshotInfo *sn_info);
ths5fafdf22007-09-16 21:08:06 +000091 int (*bdrv_snapshot_goto)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +000092 const char *snapshot_id);
93 int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
ths5fafdf22007-09-16 21:08:06 +000094 int (*bdrv_snapshot_list)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +000095 QEMUSnapshotInfo **psn_info);
96 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
bellard83f64092006-08-01 16:21:11 +000097
Christoph Hellwig45566e92009-07-10 23:11:57 +020098 int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
99 int64_t pos, int size);
100 int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
101 int64_t pos, int size);
aliguori178e08a2009-04-05 19:10:55 +0000102
Kevin Wolf756e6732010-01-12 12:55:17 +0100103 int (*bdrv_change_backing_file)(BlockDriverState *bs,
104 const char *backing_file, const char *backing_fmt);
105
bellard19cb3732006-08-19 11:45:59 +0000106 /* removable device specific */
107 int (*bdrv_is_inserted)(BlockDriverState *bs);
108 int (*bdrv_media_changed)(BlockDriverState *bs);
109 int (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
110 int (*bdrv_set_locked)(BlockDriverState *bs, int locked);
ths3b46e622007-09-17 08:09:54 +0000111
ths985a03b2007-12-24 16:10:43 +0000112 /* to control generic scsi devices */
113 int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
aliguori221f7152009-03-28 17:28:41 +0000114 BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
115 unsigned long int req, void *buf,
116 BlockDriverCompletionFunc *cb, void *opaque);
ths985a03b2007-12-24 16:10:43 +0000117
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200118 /* List of options for creating images, terminated by name == NULL */
119 QEMUOptionParameter *create_options;
120
aliguori5eb45632009-03-28 17:55:10 +0000121
Kevin Wolf9ac228e2010-06-29 12:37:54 +0200122 /*
123 * Returns 0 for completed check, -errno for internal errors.
124 * The check results are stored in result.
125 */
126 int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
aliguorie97fc192009-04-21 23:11:50 +0000127
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100128 void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
129
Kevin Wolf12c09b82009-11-30 16:54:15 +0100130 /* Set if newly created images are not guaranteed to contain only zeros */
131 int no_zero_init;
132
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +0100133 QLIST_ENTRY(BlockDriver) list;
bellardea2384d2004-08-01 21:59:26 +0000134};
135
136struct BlockDriverState {
bellardd15a7712006-08-06 13:35:09 +0000137 int64_t total_sectors; /* if we are reading a disk image, give its
138 size in sectors */
bellardea2384d2004-08-01 21:59:26 +0000139 int read_only; /* if true, the media is read only */
Naphtali Sprei4dca4b62010-02-14 13:39:18 +0200140 int keep_read_only; /* if true, the media was requested to stay read only */
141 int open_flags; /* flags used to open the file, re-used for re-open */
bellardea2384d2004-08-01 21:59:26 +0000142 int removable; /* if true, the media can be removed */
143 int locked; /* if true, the media cannot temporarily be ejected */
144 int encrypted; /* if true, the media is encrypted */
aliguoric0f4ce72009-03-05 23:01:01 +0000145 int valid_key; /* if true, a valid encryption key has been set */
ths985a03b2007-12-24 16:10:43 +0000146 int sg; /* if true, the device is a /dev/sg* */
Anthony Liguori79368c82010-07-14 10:58:00 -0500147 int probed; /* if true, format was probed automatically */
bellardea2384d2004-08-01 21:59:26 +0000148 /* event callback when inserting/removing */
149 void (*change_cb)(void *opaque);
150 void *change_opaque;
151
bellard19cb3732006-08-19 11:45:59 +0000152 BlockDriver *drv; /* NULL means no media */
bellardea2384d2004-08-01 21:59:26 +0000153 void *opaque;
154
Markus Armbruster18846de2010-06-29 16:58:30 +0200155 DeviceState *peer;
156
bellardea2384d2004-08-01 21:59:26 +0000157 char filename[1024];
158 char backing_file[1024]; /* if non zero, the image is a diff of
159 this file image */
aliguori5eb45632009-03-28 17:55:10 +0000160 char backing_format[16]; /* if non-zero and backing_file exists */
bellardea2384d2004-08-01 21:59:26 +0000161 int is_temporary;
bellard19cb3732006-08-19 11:45:59 +0000162 int media_changed;
163
bellardea2384d2004-08-01 21:59:26 +0000164 BlockDriverState *backing_hd;
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200165 BlockDriverState *file;
166
pbrookce1a14d2006-08-07 02:38:06 +0000167 /* async read/write emulation */
bellard83f64092006-08-01 16:21:11 +0000168
pbrookce1a14d2006-08-07 02:38:06 +0000169 void *sync_aiocb;
ths3b46e622007-09-17 08:09:54 +0000170
thsa36e69d2007-12-02 05:18:19 +0000171 /* I/O stats (display with "info blockstats"). */
172 uint64_t rd_bytes;
173 uint64_t wr_bytes;
174 uint64_t rd_ops;
175 uint64_t wr_ops;
Kevin Wolf294cc352010-04-28 14:34:01 +0200176 uint64_t wr_highest_sector;
thsa36e69d2007-12-02 05:18:19 +0000177
aliguori71d07702009-03-03 17:37:16 +0000178 /* Whether the disk can expand beyond total_sectors */
179 int growable;
180
aliguorie268ca52009-04-22 20:20:00 +0000181 /* the memory alignment required for the buffers handled by this driver */
182 int buffer_alignment;
183
Christoph Hellwige900a7b2009-09-04 19:01:15 +0200184 /* do we need to tell the quest if we have a volatile write cache? */
185 int enable_write_cache;
186
bellardea2384d2004-08-01 21:59:26 +0000187 /* NOTE: the following infos are only hints for real hardware
188 drivers. They are not used by the block driver */
bellard46d47672004-11-16 01:45:27 +0000189 int cyls, heads, secs, translation;
bellardea2384d2004-08-01 21:59:26 +0000190 int type;
Markus Armbrusterabd7f682010-06-02 18:55:17 +0200191 BlockErrorAction on_read_error, on_write_error;
bellardea2384d2004-08-01 21:59:26 +0000192 char device_name[32];
Jan Kiszkac6d22832009-11-30 18:21:20 +0100193 unsigned long *dirty_bitmap;
Liran Schouraaa0eb72010-01-26 10:31:48 +0200194 int64_t dirty_count;
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +0100195 QTAILQ_ENTRY(BlockDriverState) list;
aliguorib0a7b122009-02-11 15:20:29 +0000196 void *private;
bellardea2384d2004-08-01 21:59:26 +0000197};
198
bellard83f64092006-08-01 16:21:11 +0000199struct BlockDriverAIOCB {
aliguori6bbff9a2009-03-20 18:25:59 +0000200 AIOPool *pool;
bellard83f64092006-08-01 16:21:11 +0000201 BlockDriverState *bs;
202 BlockDriverCompletionFunc *cb;
pbrookce1a14d2006-08-07 02:38:06 +0000203 void *opaque;
204 BlockDriverAIOCB *next;
bellard83f64092006-08-01 16:21:11 +0000205};
206
bellard95389c82005-12-18 18:28:15 +0000207void get_tmp_filename(char *filename, int size);
208
Christoph Hellwigc16b5a22009-05-25 12:37:32 +0200209void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
210 BlockDriverCompletionFunc *cb, void *opaque);
pbrookce1a14d2006-08-07 02:38:06 +0000211void qemu_aio_release(void *p);
212
aliguorie268ca52009-04-22 20:20:00 +0000213void *qemu_blockalign(BlockDriverState *bs, size_t size);
214
Christoph Hellwig508c7cb2009-06-15 14:04:22 +0200215#ifdef _WIN32
216int is_windows_drive(const char *filename);
217#endif
218
Christoph Hellwig428c1492010-02-10 23:37:09 +0100219typedef struct BlockConf {
Markus Armbrusterf8b6cc02010-05-05 16:36:52 +0200220 BlockDriverState *bs;
Christoph Hellwig428c1492010-02-10 23:37:09 +0100221 uint16_t physical_block_size;
Christoph Hellwig8cfacf02010-03-04 14:20:17 +0100222 uint16_t logical_block_size;
Christoph Hellwig428c1492010-02-10 23:37:09 +0100223 uint16_t min_io_size;
224 uint32_t opt_io_size;
225} BlockConf;
226
227static inline unsigned int get_physical_block_exp(BlockConf *conf)
228{
229 unsigned int exp = 0, size;
230
Christoph Hellwig1e297c32010-06-15 17:52:52 +0200231 for (size = conf->physical_block_size;
232 size > conf->logical_block_size;
233 size >>= 1) {
Christoph Hellwig428c1492010-02-10 23:37:09 +0100234 exp++;
235 }
236
237 return exp;
238}
239
240#define DEFINE_BLOCK_PROPERTIES(_state, _conf) \
Markus Armbrusterf8b6cc02010-05-05 16:36:52 +0200241 DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \
Christoph Hellwig8cfacf02010-03-04 14:20:17 +0100242 DEFINE_PROP_UINT16("logical_block_size", _state, \
243 _conf.logical_block_size, 512), \
Christoph Hellwig428c1492010-02-10 23:37:09 +0100244 DEFINE_PROP_UINT16("physical_block_size", _state, \
245 _conf.physical_block_size, 512), \
246 DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 512), \
247 DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 512)
248
bellardea2384d2004-08-01 21:59:26 +0000249#endif /* BLOCK_INT_H */