blob: f30563d81ad6f665946e3002b290c561e5bb4519 [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"
Kevin Wolfda1fa912011-07-14 17:27:13 +020030#include "qemu-coroutine.h"
Christoph Hellwigc488c7f2011-08-25 08:26:10 +020031#include "qemu-timer.h"
pbrookfaf07962007-11-11 02:51:17 +000032
thsec36ba12007-09-16 21:59:02 +000033#define BLOCK_FLAG_ENCRYPT 1
thsec36ba12007-09-16 21:59:02 +000034#define BLOCK_FLAG_COMPAT6 4
35
Kevin Wolf0e7e1982009-05-18 16:42:10 +020036#define BLOCK_OPT_SIZE "size"
37#define BLOCK_OPT_ENCRYPT "encryption"
38#define BLOCK_OPT_COMPAT6 "compat6"
39#define BLOCK_OPT_BACKING_FILE "backing_file"
40#define BLOCK_OPT_BACKING_FMT "backing_fmt"
Kevin Wolf73c632e2009-05-19 17:57:21 +020041#define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
Stefan Hajnoczi75411d22010-12-06 16:08:00 +000042#define BLOCK_OPT_TABLE_SIZE "table_size"
Kevin Wolfa35e1c12009-08-17 15:50:10 +020043#define BLOCK_OPT_PREALLOC "preallocation"
Fam Zhengf66fd6c2011-07-19 08:45:23 +080044#define BLOCK_OPT_SUBFMT "subformat"
Kevin Wolf0e7e1982009-05-18 16:42:10 +020045
aliguori6bbff9a2009-03-20 18:25:59 +000046typedef struct AIOPool {
47 void (*cancel)(BlockDriverAIOCB *acb);
48 int aiocb_size;
49 BlockDriverAIOCB *free_aiocb;
50} AIOPool;
51
bellardea2384d2004-08-01 21:59:26 +000052struct BlockDriver {
53 const char *format_name;
54 int instance_size;
55 int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
Christoph Hellwig508c7cb2009-06-15 14:04:22 +020056 int (*bdrv_probe_device)(const char *filename);
Kevin Wolf66f82ce2010-04-14 14:17:38 +020057 int (*bdrv_open)(BlockDriverState *bs, int flags);
58 int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
ths5fafdf22007-09-16 21:08:06 +000059 int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
bellardea2384d2004-08-01 21:59:26 +000060 uint8_t *buf, int nb_sectors);
ths5fafdf22007-09-16 21:08:06 +000061 int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
bellardea2384d2004-08-01 21:59:26 +000062 const uint8_t *buf, int nb_sectors);
bellarde2731ad2004-09-18 19:32:11 +000063 void (*bdrv_close)(BlockDriverState *bs);
Kevin Wolf0e7e1982009-05-18 16:42:10 +020064 int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
Kevin Wolf205ef792010-10-21 16:43:43 +020065 int (*bdrv_flush)(BlockDriverState *bs);
bellardea2384d2004-08-01 21:59:26 +000066 int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
67 int nb_sectors, int *pnum);
68 int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
bellard95389c82005-12-18 18:28:15 +000069 int (*bdrv_make_empty)(BlockDriverState *bs);
bellard83f64092006-08-01 16:21:11 +000070 /* aio */
aliguorif141eaf2009-04-07 18:43:24 +000071 BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
72 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
pbrookce1a14d2006-08-07 02:38:06 +000073 BlockDriverCompletionFunc *cb, void *opaque);
aliguorif141eaf2009-04-07 18:43:24 +000074 BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
75 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
pbrookce1a14d2006-08-07 02:38:06 +000076 BlockDriverCompletionFunc *cb, void *opaque);
Christoph Hellwigb2e12bc2009-09-04 19:01:49 +020077 BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
78 BlockDriverCompletionFunc *cb, void *opaque);
Christoph Hellwigbb8bf762010-12-16 19:36:31 +010079 int (*bdrv_discard)(BlockDriverState *bs, int64_t sector_num,
80 int nb_sectors);
bellard83f64092006-08-01 16:21:11 +000081
Kevin Wolfda1fa912011-07-14 17:27:13 +020082 int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
83 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
84 int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
85 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
86
Kevin Wolf40b4f532009-09-09 17:53:37 +020087 int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
88 int num_reqs);
89 int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
90 BlockRequest *b);
91
92
bellard83f64092006-08-01 16:21:11 +000093 const char *protocol_name;
bellard83f64092006-08-01 16:21:11 +000094 int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
95 int64_t (*bdrv_getlength)(BlockDriverState *bs);
Fam Zheng4a1d5e12011-07-12 19:56:39 +080096 int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
ths5fafdf22007-09-16 21:08:06 +000097 int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
bellardfaea38e2006-08-05 21:31:00 +000098 const uint8_t *buf, int nb_sectors);
99
ths5fafdf22007-09-16 21:08:06 +0000100 int (*bdrv_snapshot_create)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +0000101 QEMUSnapshotInfo *sn_info);
ths5fafdf22007-09-16 21:08:06 +0000102 int (*bdrv_snapshot_goto)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +0000103 const char *snapshot_id);
104 int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
ths5fafdf22007-09-16 21:08:06 +0000105 int (*bdrv_snapshot_list)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +0000106 QEMUSnapshotInfo **psn_info);
edison51ef6722010-09-21 19:58:41 -0700107 int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
108 const char *snapshot_name);
bellardfaea38e2006-08-05 21:31:00 +0000109 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
bellard83f64092006-08-01 16:21:11 +0000110
Christoph Hellwig45566e92009-07-10 23:11:57 +0200111 int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
112 int64_t pos, int size);
113 int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
114 int64_t pos, int size);
aliguori178e08a2009-04-05 19:10:55 +0000115
Kevin Wolf756e6732010-01-12 12:55:17 +0100116 int (*bdrv_change_backing_file)(BlockDriverState *bs,
117 const char *backing_file, const char *backing_fmt);
118
bellard19cb3732006-08-19 11:45:59 +0000119 /* removable device specific */
120 int (*bdrv_is_inserted)(BlockDriverState *bs);
121 int (*bdrv_media_changed)(BlockDriverState *bs);
Markus Armbruster822e1cd2011-07-20 18:23:42 +0200122 void (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
Markus Armbruster025e8492011-09-06 18:58:47 +0200123 void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
ths3b46e622007-09-17 08:09:54 +0000124
ths985a03b2007-12-24 16:10:43 +0000125 /* to control generic scsi devices */
126 int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
aliguori221f7152009-03-28 17:28:41 +0000127 BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
128 unsigned long int req, void *buf,
129 BlockDriverCompletionFunc *cb, void *opaque);
ths985a03b2007-12-24 16:10:43 +0000130
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200131 /* List of options for creating images, terminated by name == NULL */
132 QEMUOptionParameter *create_options;
133
aliguori5eb45632009-03-28 17:55:10 +0000134
Kevin Wolf9ac228e2010-06-29 12:37:54 +0200135 /*
136 * Returns 0 for completed check, -errno for internal errors.
137 * The check results are stored in result.
138 */
139 int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
aliguorie97fc192009-04-21 23:11:50 +0000140
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100141 void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
142
Kevin Wolf336c1c12010-07-28 11:26:29 +0200143 /*
144 * Returns 1 if newly created images are guaranteed to contain only
145 * zeros, 0 otherwise.
146 */
147 int (*bdrv_has_zero_init)(BlockDriverState *bs);
Kevin Wolf12c09b82009-11-30 16:54:15 +0100148
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +0100149 QLIST_ENTRY(BlockDriver) list;
bellardea2384d2004-08-01 21:59:26 +0000150};
151
152struct BlockDriverState {
bellardd15a7712006-08-06 13:35:09 +0000153 int64_t total_sectors; /* if we are reading a disk image, give its
154 size in sectors */
bellardea2384d2004-08-01 21:59:26 +0000155 int read_only; /* if true, the media is read only */
Naphtali Sprei4dca4b62010-02-14 13:39:18 +0200156 int keep_read_only; /* if true, the media was requested to stay read only */
157 int open_flags; /* flags used to open the file, re-used for re-open */
bellardea2384d2004-08-01 21:59:26 +0000158 int encrypted; /* if true, the media is encrypted */
aliguoric0f4ce72009-03-05 23:01:01 +0000159 int valid_key; /* if true, a valid encryption key has been set */
ths985a03b2007-12-24 16:10:43 +0000160 int sg; /* if true, the device is a /dev/sg* */
bellardea2384d2004-08-01 21:59:26 +0000161
bellard19cb3732006-08-19 11:45:59 +0000162 BlockDriver *drv; /* NULL means no media */
bellardea2384d2004-08-01 21:59:26 +0000163 void *opaque;
164
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200165 void *dev; /* attached device model, if any */
166 /* TODO change to DeviceState when all users are qdevified */
Markus Armbruster0e49de52011-08-03 15:07:41 +0200167 const BlockDevOps *dev_ops;
168 void *dev_opaque;
Markus Armbruster18846de2010-06-29 16:58:30 +0200169
bellardea2384d2004-08-01 21:59:26 +0000170 char filename[1024];
171 char backing_file[1024]; /* if non zero, the image is a diff of
172 this file image */
aliguori5eb45632009-03-28 17:55:10 +0000173 char backing_format[16]; /* if non-zero and backing_file exists */
bellardea2384d2004-08-01 21:59:26 +0000174 int is_temporary;
bellard19cb3732006-08-19 11:45:59 +0000175
bellardea2384d2004-08-01 21:59:26 +0000176 BlockDriverState *backing_hd;
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200177 BlockDriverState *file;
178
pbrookce1a14d2006-08-07 02:38:06 +0000179 /* async read/write emulation */
bellard83f64092006-08-01 16:21:11 +0000180
pbrookce1a14d2006-08-07 02:38:06 +0000181 void *sync_aiocb;
ths3b46e622007-09-17 08:09:54 +0000182
thsa36e69d2007-12-02 05:18:19 +0000183 /* I/O stats (display with "info blockstats"). */
Christoph Hellwiga597e792011-08-25 08:26:01 +0200184 uint64_t nr_bytes[BDRV_MAX_IOTYPE];
185 uint64_t nr_ops[BDRV_MAX_IOTYPE];
Christoph Hellwigc488c7f2011-08-25 08:26:10 +0200186 uint64_t total_time_ns[BDRV_MAX_IOTYPE];
Kevin Wolf294cc352010-04-28 14:34:01 +0200187 uint64_t wr_highest_sector;
thsa36e69d2007-12-02 05:18:19 +0000188
aliguori71d07702009-03-03 17:37:16 +0000189 /* Whether the disk can expand beyond total_sectors */
190 int growable;
191
aliguorie268ca52009-04-22 20:20:00 +0000192 /* the memory alignment required for the buffers handled by this driver */
193 int buffer_alignment;
194
Christoph Hellwige900a7b2009-09-04 19:01:15 +0200195 /* do we need to tell the quest if we have a volatile write cache? */
196 int enable_write_cache;
197
bellardea2384d2004-08-01 21:59:26 +0000198 /* NOTE: the following infos are only hints for real hardware
199 drivers. They are not used by the block driver */
bellard46d47672004-11-16 01:45:27 +0000200 int cyls, heads, secs, translation;
Markus Armbrusterabd7f682010-06-02 18:55:17 +0200201 BlockErrorAction on_read_error, on_write_error;
bellardea2384d2004-08-01 21:59:26 +0000202 char device_name[32];
Jan Kiszkac6d22832009-11-30 18:21:20 +0100203 unsigned long *dirty_bitmap;
Liran Schouraaa0eb72010-01-26 10:31:48 +0200204 int64_t dirty_count;
Marcelo Tosattidb593f22011-01-26 12:12:34 -0200205 int in_use; /* users other than guest access, eg. block migration */
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +0100206 QTAILQ_ENTRY(BlockDriverState) list;
aliguorib0a7b122009-02-11 15:20:29 +0000207 void *private;
bellardea2384d2004-08-01 21:59:26 +0000208};
209
bellard83f64092006-08-01 16:21:11 +0000210struct BlockDriverAIOCB {
aliguori6bbff9a2009-03-20 18:25:59 +0000211 AIOPool *pool;
bellard83f64092006-08-01 16:21:11 +0000212 BlockDriverState *bs;
213 BlockDriverCompletionFunc *cb;
pbrookce1a14d2006-08-07 02:38:06 +0000214 void *opaque;
215 BlockDriverAIOCB *next;
bellard83f64092006-08-01 16:21:11 +0000216};
217
bellard95389c82005-12-18 18:28:15 +0000218void get_tmp_filename(char *filename, int size);
219
Christoph Hellwigc16b5a22009-05-25 12:37:32 +0200220void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
221 BlockDriverCompletionFunc *cb, void *opaque);
pbrookce1a14d2006-08-07 02:38:06 +0000222void qemu_aio_release(void *p);
223
Christoph Hellwig508c7cb2009-06-15 14:04:22 +0200224#ifdef _WIN32
225int is_windows_drive(const char *filename);
226#endif
227
Christoph Hellwig428c1492010-02-10 23:37:09 +0100228typedef struct BlockConf {
Markus Armbrusterf8b6cc02010-05-05 16:36:52 +0200229 BlockDriverState *bs;
Christoph Hellwig428c1492010-02-10 23:37:09 +0100230 uint16_t physical_block_size;
Christoph Hellwig8cfacf02010-03-04 14:20:17 +0100231 uint16_t logical_block_size;
Christoph Hellwig428c1492010-02-10 23:37:09 +0100232 uint16_t min_io_size;
233 uint32_t opt_io_size;
Gleb Natapov1ca4d092010-12-08 13:35:05 +0200234 int32_t bootindex;
Christoph Hellwigbb8bf762010-12-16 19:36:31 +0100235 uint32_t discard_granularity;
Christoph Hellwig428c1492010-02-10 23:37:09 +0100236} BlockConf;
237
238static inline unsigned int get_physical_block_exp(BlockConf *conf)
239{
240 unsigned int exp = 0, size;
241
Christoph Hellwig1e297c32010-06-15 17:52:52 +0200242 for (size = conf->physical_block_size;
243 size > conf->logical_block_size;
244 size >>= 1) {
Christoph Hellwig428c1492010-02-10 23:37:09 +0100245 exp++;
246 }
247
248 return exp;
249}
250
251#define DEFINE_BLOCK_PROPERTIES(_state, _conf) \
Markus Armbrusterf8b6cc02010-05-05 16:36:52 +0200252 DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \
Christoph Hellwig8cfacf02010-03-04 14:20:17 +0100253 DEFINE_PROP_UINT16("logical_block_size", _state, \
254 _conf.logical_block_size, 512), \
Christoph Hellwig428c1492010-02-10 23:37:09 +0100255 DEFINE_PROP_UINT16("physical_block_size", _state, \
256 _conf.physical_block_size, 512), \
Christoph Hellwig55459492010-07-23 09:35:04 +0200257 DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \
Gleb Natapov1ca4d092010-12-08 13:35:05 +0200258 DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \
Christoph Hellwigbb8bf762010-12-16 19:36:31 +0100259 DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \
260 DEFINE_PROP_UINT32("discard_granularity", _state, \
261 _conf.discard_granularity, 0)
Christoph Hellwig428c1492010-02-10 23:37:09 +0100262
bellardea2384d2004-08-01 21:59:26 +0000263#endif /* BLOCK_INT_H */