blob: e264be97b27ced74efa902e1525ea6a4bf4a9c98 [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
Benoît Canet5e5a94b2014-09-05 15:46:16 +020027#include "block/accounting.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010028#include "block/block.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010029#include "qemu/option.h"
30#include "qemu/queue.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010031#include "block/coroutine.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010032#include "qemu/timer.h"
Luiz Capitulinob2023812011-09-21 17:16:47 -030033#include "qapi-types.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010034#include "qapi/qmp/qerror.h"
Paolo Bonzini83c90892012-12-17 18:19:49 +010035#include "monitor/monitor.h"
Paolo Bonzini8f0720e2013-01-21 17:09:41 +010036#include "qemu/hbitmap.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080037#include "block/snapshot.h"
Alex Bligh6a1751b2013-08-21 16:02:47 +010038#include "qemu/main-loop.h"
Benoît Canetcc0681c2013-09-02 14:14:39 +020039#include "qemu/throttle.h"
pbrookfaf07962007-11-11 02:51:17 +000040
Stefan Hajnoczibfe80432012-07-27 09:05:22 +010041#define BLOCK_FLAG_ENCRYPT 1
42#define BLOCK_FLAG_COMPAT6 4
43#define BLOCK_FLAG_LAZY_REFCOUNTS 8
thsec36ba12007-09-16 21:59:02 +000044
Stefan Hajnoczibfe80432012-07-27 09:05:22 +010045#define BLOCK_OPT_SIZE "size"
46#define BLOCK_OPT_ENCRYPT "encryption"
47#define BLOCK_OPT_COMPAT6 "compat6"
48#define BLOCK_OPT_BACKING_FILE "backing_file"
49#define BLOCK_OPT_BACKING_FMT "backing_fmt"
50#define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
51#define BLOCK_OPT_TABLE_SIZE "table_size"
52#define BLOCK_OPT_PREALLOC "preallocation"
53#define BLOCK_OPT_SUBFMT "subformat"
54#define BLOCK_OPT_COMPAT_LEVEL "compat"
55#define BLOCK_OPT_LAZY_REFCOUNTS "lazy_refcounts"
Othmar Pasteka7f2039f2013-01-30 00:26:52 +010056#define BLOCK_OPT_ADAPTER_TYPE "adapter_type"
Liu Yuanb3af0182013-11-07 22:56:38 +080057#define BLOCK_OPT_REDUNDANCY "redundancy"
Chunyan Liu4ab15592014-06-30 14:29:58 +080058#define BLOCK_OPT_NOCOW "nocow"
Kevin Wolf0e7e1982009-05-18 16:42:10 +020059
Kevin Wolf7cddd372014-11-20 16:27:11 +010060#define BLOCK_PROBE_BUF_SIZE 512
61
Stefan Hajnoczid616b222013-06-24 17:13:10 +020062typedef struct BdrvTrackedRequest {
63 BlockDriverState *bs;
Kevin Wolf793ed472013-12-03 15:31:25 +010064 int64_t offset;
65 unsigned int bytes;
Stefan Hajnoczid616b222013-06-24 17:13:10 +020066 bool is_write;
Kevin Wolf73271452013-12-04 17:08:50 +010067
Kevin Wolf2dbafdc2013-12-04 16:43:44 +010068 bool serialising;
Kevin Wolf73271452013-12-04 17:08:50 +010069 int64_t overlap_offset;
70 unsigned int overlap_bytes;
71
Stefan Hajnoczid616b222013-06-24 17:13:10 +020072 QLIST_ENTRY(BdrvTrackedRequest) list;
73 Coroutine *co; /* owner, used for deadlock detection */
74 CoQueue wait_queue; /* coroutines blocked on this request */
Kevin Wolf64604402013-12-13 13:04:35 +010075
76 struct BdrvTrackedRequest *waiting_for;
Stefan Hajnoczid616b222013-06-24 17:13:10 +020077} BdrvTrackedRequest;
78
bellardea2384d2004-08-01 21:59:26 +000079struct BlockDriver {
80 const char *format_name;
81 int instance_size;
Benoît Canetf6186f42013-10-02 14:33:48 +020082
Benoît Canetb5042a32014-03-03 19:11:34 +010083 /* set to true if the BlockDriver is a block filter */
84 bool is_filter;
85 /* for snapshots block filter like Quorum can implement the
86 * following recursive callback.
Benoît Canet212a5a82014-01-23 21:31:36 +010087 * It's purpose is to recurse on the filter children while calling
88 * bdrv_recurse_is_first_non_filter on them.
89 * For a sample implementation look in the future Quorum block filter.
Benoît Canetf6186f42013-10-02 14:33:48 +020090 */
Benoît Canet212a5a82014-01-23 21:31:36 +010091 bool (*bdrv_recurse_is_first_non_filter)(BlockDriverState *bs,
92 BlockDriverState *candidate);
Benoît Canetf6186f42013-10-02 14:33:48 +020093
bellardea2384d2004-08-01 21:59:26 +000094 int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
Christoph Hellwig508c7cb2009-06-15 14:04:22 +020095 int (*bdrv_probe_device)(const char *filename);
Kevin Wolfc2ad1b02013-03-18 16:40:51 +010096
97 /* Any driver implementing this callback is expected to be able to handle
98 * NULL file names in its .bdrv_open() implementation */
Kevin Wolf6963a302013-03-15 18:47:22 +010099 void (*bdrv_parse_filename)(const char *filename, QDict *options, Error **errp);
Benoît Canet030be322013-09-24 17:07:04 +0200100 /* Drivers not implementing bdrv_parse_filename nor bdrv_open should have
101 * this field set to true, except ones that are defined only by their
102 * child's bs.
103 * An example of the last type will be the quorum block driver.
104 */
105 bool bdrv_needs_filename;
Jeff Codye971aa12012-09-20 15:13:19 -0400106
Kevin Wolf8ee79e72014-06-04 15:09:35 +0200107 /* Set if a driver can support backing files */
108 bool supports_backing;
109
Jeff Codye971aa12012-09-20 15:13:19 -0400110 /* For handling image reopen for split or non-split files */
111 int (*bdrv_reopen_prepare)(BDRVReopenState *reopen_state,
112 BlockReopenQueue *queue, Error **errp);
113 void (*bdrv_reopen_commit)(BDRVReopenState *reopen_state);
114 void (*bdrv_reopen_abort)(BDRVReopenState *reopen_state);
115
Max Reitz015a1032013-09-05 14:22:29 +0200116 int (*bdrv_open)(BlockDriverState *bs, QDict *options, int flags,
117 Error **errp);
118 int (*bdrv_file_open)(BlockDriverState *bs, QDict *options, int flags,
119 Error **errp);
ths5fafdf22007-09-16 21:08:06 +0000120 int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
bellardea2384d2004-08-01 21:59:26 +0000121 uint8_t *buf, int nb_sectors);
ths5fafdf22007-09-16 21:08:06 +0000122 int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
bellardea2384d2004-08-01 21:59:26 +0000123 const uint8_t *buf, int nb_sectors);
bellarde2731ad2004-09-18 19:32:11 +0000124 void (*bdrv_close)(BlockDriverState *bs);
Paolo Bonzinie023b2e2012-05-08 16:51:41 +0200125 void (*bdrv_rebind)(BlockDriverState *bs);
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800126 int (*bdrv_create)(const char *filename, QemuOpts *opts, Error **errp);
bellardea2384d2004-08-01 21:59:26 +0000127 int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
bellard95389c82005-12-18 18:28:15 +0000128 int (*bdrv_make_empty)(BlockDriverState *bs);
Max Reitz91af7012014-07-18 20:24:56 +0200129
130 void (*bdrv_refresh_filename)(BlockDriverState *bs);
131
bellard83f64092006-08-01 16:21:11 +0000132 /* aio */
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200133 BlockAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
aliguorif141eaf2009-04-07 18:43:24 +0000134 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
Markus Armbruster097310b2014-10-07 13:59:15 +0200135 BlockCompletionFunc *cb, void *opaque);
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200136 BlockAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
aliguorif141eaf2009-04-07 18:43:24 +0000137 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
Markus Armbruster097310b2014-10-07 13:59:15 +0200138 BlockCompletionFunc *cb, void *opaque);
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200139 BlockAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
Markus Armbruster097310b2014-10-07 13:59:15 +0200140 BlockCompletionFunc *cb, void *opaque);
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200141 BlockAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
Paolo Bonzini4265d622011-10-17 12:32:14 +0200142 int64_t sector_num, int nb_sectors,
Markus Armbruster097310b2014-10-07 13:59:15 +0200143 BlockCompletionFunc *cb, void *opaque);
bellard83f64092006-08-01 16:21:11 +0000144
Kevin Wolfda1fa912011-07-14 17:27:13 +0200145 int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
146 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
147 int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
148 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +0000149 /*
150 * Efficiently zero a region of the disk image. Typically an image format
151 * would use a compact metadata representation to implement this. This
152 * function pointer may be NULL and .bdrv_co_writev() will be called
153 * instead.
154 */
155 int coroutine_fn (*bdrv_co_write_zeroes)(BlockDriverState *bs,
Peter Lievenaa7bfbf2013-10-24 12:06:51 +0200156 int64_t sector_num, int nb_sectors, BdrvRequestFlags flags);
Paolo Bonzini4265d622011-10-17 12:32:14 +0200157 int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
158 int64_t sector_num, int nb_sectors);
Paolo Bonzinib6b8a332013-09-04 19:00:28 +0200159 int64_t coroutine_fn (*bdrv_co_get_block_status)(BlockDriverState *bs,
Stefan Hajnoczi376ae3f2011-11-14 12:44:19 +0000160 int64_t sector_num, int nb_sectors, int *pnum);
Kevin Wolfda1fa912011-07-14 17:27:13 +0200161
Kevin Wolfc68b89a2011-11-10 17:25:44 +0100162 /*
Anthony Liguori0f154232011-11-14 15:09:45 -0600163 * Invalidate any cached meta-data.
164 */
Kevin Wolf5a8a30d2014-03-12 15:59:16 +0100165 void (*bdrv_invalidate_cache)(BlockDriverState *bs, Error **errp);
Anthony Liguori0f154232011-11-14 15:09:45 -0600166
167 /*
Kevin Wolfc68b89a2011-11-10 17:25:44 +0100168 * Flushes all data that was already written to the OS all the way down to
169 * the disk (for example raw-posix calls fsync()).
170 */
171 int coroutine_fn (*bdrv_co_flush_to_disk)(BlockDriverState *bs);
172
Kevin Wolfeb489bb2011-11-10 18:10:11 +0100173 /*
174 * Flushes all internal caches to the OS. The data may still sit in a
175 * writeback cache of the host OS, but it will survive a crash of the qemu
176 * process.
177 */
178 int coroutine_fn (*bdrv_co_flush_to_os)(BlockDriverState *bs);
179
bellard83f64092006-08-01 16:21:11 +0000180 const char *protocol_name;
bellard83f64092006-08-01 16:21:11 +0000181 int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
Kevin Wolfb94a2612013-10-29 12:18:58 +0100182
bellard83f64092006-08-01 16:21:11 +0000183 int64_t (*bdrv_getlength)(BlockDriverState *bs);
Kevin Wolfb94a2612013-10-29 12:18:58 +0100184 bool has_variable_length;
Fam Zheng4a1d5e12011-07-12 19:56:39 +0800185 int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
Kevin Wolfb94a2612013-10-29 12:18:58 +0100186
ths5fafdf22007-09-16 21:08:06 +0000187 int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
bellardfaea38e2006-08-05 21:31:00 +0000188 const uint8_t *buf, int nb_sectors);
189
ths5fafdf22007-09-16 21:08:06 +0000190 int (*bdrv_snapshot_create)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +0000191 QEMUSnapshotInfo *sn_info);
ths5fafdf22007-09-16 21:08:06 +0000192 int (*bdrv_snapshot_goto)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +0000193 const char *snapshot_id);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +0800194 int (*bdrv_snapshot_delete)(BlockDriverState *bs,
195 const char *snapshot_id,
196 const char *name,
197 Error **errp);
ths5fafdf22007-09-16 21:08:06 +0000198 int (*bdrv_snapshot_list)(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +0000199 QEMUSnapshotInfo **psn_info);
edison51ef6722010-09-21 19:58:41 -0700200 int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
Wenchao Xia7b4c4782013-12-04 17:10:54 +0800201 const char *snapshot_id,
202 const char *name,
203 Error **errp);
bellardfaea38e2006-08-05 21:31:00 +0000204 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
Max Reitzeae041f2013-10-09 10:46:16 +0200205 ImageInfoSpecific *(*bdrv_get_specific_info)(BlockDriverState *bs);
bellard83f64092006-08-01 16:21:11 +0000206
Kevin Wolfcf8074b2013-04-05 21:27:53 +0200207 int (*bdrv_save_vmstate)(BlockDriverState *bs, QEMUIOVector *qiov,
208 int64_t pos);
Christoph Hellwig45566e92009-07-10 23:11:57 +0200209 int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
210 int64_t pos, int size);
aliguori178e08a2009-04-05 19:10:55 +0000211
Kevin Wolf756e6732010-01-12 12:55:17 +0100212 int (*bdrv_change_backing_file)(BlockDriverState *bs,
213 const char *backing_file, const char *backing_fmt);
214
bellard19cb3732006-08-19 11:45:59 +0000215 /* removable device specific */
216 int (*bdrv_is_inserted)(BlockDriverState *bs);
217 int (*bdrv_media_changed)(BlockDriverState *bs);
Luiz Capitulinof36f3942012-02-03 16:24:53 -0200218 void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag);
Markus Armbruster025e8492011-09-06 18:58:47 +0200219 void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
ths3b46e622007-09-17 08:09:54 +0000220
ths985a03b2007-12-24 16:10:43 +0000221 /* to control generic scsi devices */
222 int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200223 BlockAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
aliguori221f7152009-03-28 17:28:41 +0000224 unsigned long int req, void *buf,
Markus Armbruster097310b2014-10-07 13:59:15 +0200225 BlockCompletionFunc *cb, void *opaque);
ths985a03b2007-12-24 16:10:43 +0000226
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200227 /* List of options for creating images, terminated by name == NULL */
Chunyan Liu83d05212014-06-05 17:20:51 +0800228 QemuOptsList *create_opts;
aliguori5eb45632009-03-28 17:55:10 +0000229
Kevin Wolf9ac228e2010-06-29 12:37:54 +0200230 /*
231 * Returns 0 for completed check, -errno for internal errors.
232 * The check results are stored in result.
233 */
Kevin Wolf4534ff52012-05-11 16:07:02 +0200234 int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result,
235 BdrvCheckMode fix);
aliguorie97fc192009-04-21 23:11:50 +0000236
Max Reitz77485432014-10-27 11:12:50 +0100237 int (*bdrv_amend_options)(BlockDriverState *bs, QemuOpts *opts,
238 BlockDriverAmendStatusCB *status_cb);
Max Reitz6f176b42013-09-03 10:09:50 +0200239
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100240 void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
241
Kevin Wolf41c695c2012-12-06 14:32:58 +0100242 /* TODO Better pass a option string/QDict/QemuOpts to add any rule? */
243 int (*bdrv_debug_breakpoint)(BlockDriverState *bs, const char *event,
244 const char *tag);
Fam Zheng4cc70e92013-11-20 10:01:54 +0800245 int (*bdrv_debug_remove_breakpoint)(BlockDriverState *bs,
246 const char *tag);
Kevin Wolf41c695c2012-12-06 14:32:58 +0100247 int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag);
248 bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag);
249
Kevin Wolf3baca892014-07-16 17:48:16 +0200250 void (*bdrv_refresh_limits)(BlockDriverState *bs, Error **errp);
Kevin Wolfd34682c2013-12-11 19:26:16 +0100251
Kevin Wolf336c1c12010-07-28 11:26:29 +0200252 /*
253 * Returns 1 if newly created images are guaranteed to contain only
254 * zeros, 0 otherwise.
255 */
256 int (*bdrv_has_zero_init)(BlockDriverState *bs);
Kevin Wolf12c09b82009-11-30 16:54:15 +0100257
Stefan Hajnoczidcd04222014-05-08 16:34:37 +0200258 /* Remove fd handlers, timers, and other event loop callbacks so the event
259 * loop is no longer in use. Called with no in-flight requests and in
260 * depth-first traversal order with parents before child nodes.
261 */
262 void (*bdrv_detach_aio_context)(BlockDriverState *bs);
263
264 /* Add fd handlers, timers, and other event loop callbacks so I/O requests
265 * can be processed again. Called with no in-flight requests and in
266 * depth-first traversal order with child nodes before parent nodes.
267 */
268 void (*bdrv_attach_aio_context)(BlockDriverState *bs,
269 AioContext *new_context);
270
Ming Lei448ad912014-07-04 18:04:33 +0800271 /* io queue for linux-aio */
272 void (*bdrv_io_plug)(BlockDriverState *bs);
273 void (*bdrv_io_unplug)(BlockDriverState *bs);
274 void (*bdrv_flush_io_queue)(BlockDriverState *bs);
275
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +0100276 QLIST_ENTRY(BlockDriver) list;
bellardea2384d2004-08-01 21:59:26 +0000277};
278
Peter Lievenfe81c2c2013-10-24 12:06:56 +0200279typedef struct BlockLimits {
280 /* maximum number of sectors that can be discarded at once */
281 int max_discard;
282
283 /* optimal alignment for discard requests in sectors */
284 int64_t discard_alignment;
285
286 /* maximum number of sectors that can zeroized at once */
287 int max_write_zeroes;
288
289 /* optimal alignment for write zeroes requests in sectors */
290 int64_t write_zeroes_alignment;
Peter Lieven7337aca2013-11-27 11:07:04 +0100291
292 /* optimal transfer length in sectors */
293 int opt_transfer_length;
Kevin Wolf339064d2013-11-28 10:23:32 +0100294
Peter Lieven2647fab2014-10-27 10:18:44 +0100295 /* maximal transfer length in sectors */
296 int max_transfer_length;
297
Kevin Wolf339064d2013-11-28 10:23:32 +0100298 /* memory alignment so that no bounce buffer is needed */
299 size_t opt_mem_alignment;
Peter Lievenfe81c2c2013-10-24 12:06:56 +0200300} BlockLimits;
301
Fam Zhengfbe40ff2014-05-23 21:29:42 +0800302typedef struct BdrvOpBlocker BdrvOpBlocker;
303
Max Reitz33384422014-06-20 21:57:33 +0200304typedef struct BdrvAioNotifier {
305 void (*attached_aio_context)(AioContext *new_context, void *opaque);
306 void (*detach_aio_context)(void *opaque);
307
308 void *opaque;
309
310 QLIST_ENTRY(BdrvAioNotifier) list;
311} BdrvAioNotifier;
312
Jeff Cody8802d1f2012-02-28 15:54:06 -0500313/*
314 * Note: the function bdrv_append() copies and swaps contents of
315 * BlockDriverStates, so if you add new fields to this struct, please
316 * inspect bdrv_append() to determine if the new fields need to be
317 * copied as well.
318 */
bellardea2384d2004-08-01 21:59:26 +0000319struct BlockDriverState {
bellardd15a7712006-08-06 13:35:09 +0000320 int64_t total_sectors; /* if we are reading a disk image, give its
321 size in sectors */
bellardea2384d2004-08-01 21:59:26 +0000322 int read_only; /* if true, the media is read only */
Naphtali Sprei4dca4b62010-02-14 13:39:18 +0200323 int open_flags; /* flags used to open the file, re-used for re-open */
bellardea2384d2004-08-01 21:59:26 +0000324 int encrypted; /* if true, the media is encrypted */
aliguoric0f4ce72009-03-05 23:01:01 +0000325 int valid_key; /* if true, a valid encryption key has been set */
ths985a03b2007-12-24 16:10:43 +0000326 int sg; /* if true, the device is a /dev/sg* */
Stefan Hajnoczi53fec9d2011-11-28 16:08:47 +0000327 int copy_on_read; /* if true, copy read backing sectors into image
328 note this is a reference count */
Kevin Wolf38f3ef52014-11-20 16:27:12 +0100329 bool probed;
bellardea2384d2004-08-01 21:59:26 +0000330
bellard19cb3732006-08-19 11:45:59 +0000331 BlockDriver *drv; /* NULL means no media */
bellardea2384d2004-08-01 21:59:26 +0000332 void *opaque;
333
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200334 BlockBackend *blk; /* owning backend, if any */
335
Stefan Hajnoczidcd04222014-05-08 16:34:37 +0200336 AioContext *aio_context; /* event loop used for fd handlers, timers, etc */
Max Reitz33384422014-06-20 21:57:33 +0200337 /* long-running tasks intended to always use the same AioContext as this
338 * BDS may register themselves in this list to be notified of changes
339 * regarding this BDS's context */
340 QLIST_HEAD(, BdrvAioNotifier) aio_notifiers;
Stefan Hajnoczidcd04222014-05-08 16:34:37 +0200341
Jeff Cody9a29e182015-01-22 08:03:30 -0500342 char filename[PATH_MAX];
343 char backing_file[PATH_MAX]; /* if non zero, the image is a diff of
344 this file image */
aliguori5eb45632009-03-28 17:55:10 +0000345 char backing_format[16]; /* if non-zero and backing_file exists */
bellard19cb3732006-08-19 11:45:59 +0000346
Max Reitz91af7012014-07-18 20:24:56 +0200347 QDict *full_open_options;
Jeff Cody9a29e182015-01-22 08:03:30 -0500348 char exact_filename[PATH_MAX];
Max Reitz91af7012014-07-18 20:24:56 +0200349
bellardea2384d2004-08-01 21:59:26 +0000350 BlockDriverState *backing_hd;
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200351 BlockDriverState *file;
352
Paolo Bonzinid7d512f2012-08-23 11:20:36 +0200353 NotifierList close_notifiers;
354
Stefan Hajnoczid616b222013-06-24 17:13:10 +0200355 /* Callback before write request is processed */
356 NotifierWithReturnList before_write_notifiers;
357
Kevin Wolf2dbafdc2013-12-04 16:43:44 +0100358 /* number of in-flight serialising requests */
359 unsigned int serialising_in_flight;
Stefan Hajnoczi470c0502012-01-18 14:40:42 +0000360
Benoît Canetcc0681c2013-09-02 14:14:39 +0200361 /* I/O throttling */
362 ThrottleState throttle_state;
363 CoQueue throttled_reqs[2];
Zhi Yong Wu0563e192011-11-03 16:57:25 +0800364 bool io_limits_enabled;
365
thsa36e69d2007-12-02 05:18:19 +0000366 /* I/O stats (display with "info blockstats"). */
Benoît Canet0ddd0ad2014-09-05 15:46:15 +0200367 BlockAcctStats stats;
thsa36e69d2007-12-02 05:18:19 +0000368
Peter Lievenfe81c2c2013-10-24 12:06:56 +0200369 /* I/O Limits */
370 BlockLimits bl;
371
aliguori71d07702009-03-03 17:37:16 +0000372 /* Whether the disk can expand beyond total_sectors */
373 int growable;
374
Asias He0d51b4d2013-08-22 15:24:14 +0800375 /* Whether produces zeros when read beyond eof */
376 bool zero_beyond_eof;
377
Paolo Bonzinic25f53b2011-11-29 12:42:20 +0100378 /* Alignment requirement for offset/length of I/O requests */
379 unsigned int request_alignment;
380
Paolo Bonzini1b7fd722011-11-29 11:35:47 +0100381 /* the block size for which the guest device expects atomicity */
382 int guest_block_size;
aliguorie268ca52009-04-22 20:20:00 +0000383
Christoph Hellwige900a7b2009-09-04 19:01:15 +0200384 /* do we need to tell the quest if we have a volatile write cache? */
385 int enable_write_cache;
386
bellardea2384d2004-08-01 21:59:26 +0000387 /* NOTE: the following infos are only hints for real hardware
388 drivers. They are not used by the block driver */
Paolo Bonziniff06f5f2012-09-28 17:22:54 +0200389 BlockdevOnError on_read_error, on_write_error;
Luiz Capitulinod6bf2792011-10-14 17:11:23 -0300390 bool iostatus_enabled;
Luiz Capitulinob2023812011-09-21 17:16:47 -0300391 BlockDeviceIoStatus iostatus;
Benoît Canetdc364f42014-01-23 21:31:32 +0100392
393 /* the following member gives a name to every node on the bs graph. */
394 char node_name[32];
395 /* element of the list of named nodes building the graph */
396 QTAILQ_ENTRY(BlockDriverState) node_list;
Benoît Canetdc364f42014-01-23 21:31:32 +0100397 /* element of the list of "drives" the guest sees */
398 QTAILQ_ENTRY(BlockDriverState) device_list;
Fam Zhenge4654d22013-11-13 18:29:43 +0800399 QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps;
Fam Zheng9fcb0252013-08-23 09:14:46 +0800400 int refcnt;
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +0000401
402 QLIST_HEAD(, BdrvTrackedRequest) tracked_requests;
Stefan Hajnoczieeec61f2012-01-18 14:40:43 +0000403
Fam Zhengfbe40ff2014-05-23 21:29:42 +0800404 /* operation blockers */
405 QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX];
406
Stefan Hajnoczieeec61f2012-01-18 14:40:43 +0000407 /* long-running background operation */
408 BlockJob *job;
Jeff Codye971aa12012-09-20 15:13:19 -0400409
Kevin Wolfde9c0ce2013-03-15 10:35:02 +0100410 QDict *options;
Peter Lieven465bee12014-05-18 00:58:19 +0200411 BlockdevDetectZeroesOptions detect_zeroes;
Fam Zheng826b6ca2014-05-23 21:29:47 +0800412
413 /* The error object in use for blocking operations on backing_hd */
414 Error *backing_blocker;
bellardea2384d2004-08-01 21:59:26 +0000415};
416
Max Reitz5f535a92014-12-02 18:32:41 +0100417
418/* Essential block drivers which must always be statically linked into qemu, and
419 * which therefore can be accessed without using bdrv_find_format() */
420extern BlockDriver bdrv_file;
421extern BlockDriver bdrv_raw;
422extern BlockDriver bdrv_qcow2;
423
424
Jim Meyeringeba25052012-05-28 09:27:54 +0200425int get_tmp_filename(char *filename, int size);
Kevin Wolf38f3ef52014-11-20 16:27:12 +0100426BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size,
427 const char *filename);
bellard95389c82005-12-18 18:28:15 +0000428
Zhi Yong Wu0563e192011-11-03 16:57:25 +0800429void bdrv_set_io_limits(BlockDriverState *bs,
Benoît Canetcc0681c2013-09-02 14:14:39 +0200430 ThrottleConfig *cfg);
431
Zhi Yong Wu0563e192011-11-03 16:57:25 +0800432
Stefan Hajnoczi85d126f2013-03-07 13:41:48 +0100433/**
Stefan Hajnoczid616b222013-06-24 17:13:10 +0200434 * bdrv_add_before_write_notifier:
435 *
436 * Register a callback that is invoked before write requests are processed but
437 * after any throttling or waiting for overlapping requests.
438 */
439void bdrv_add_before_write_notifier(BlockDriverState *bs,
440 NotifierWithReturn *notifier);
441
442/**
Stefan Hajnoczidcd04222014-05-08 16:34:37 +0200443 * bdrv_detach_aio_context:
444 *
445 * May be called from .bdrv_detach_aio_context() to detach children from the
446 * current #AioContext. This is only needed by block drivers that manage their
447 * own children. Both ->file and ->backing_hd are automatically handled and
448 * block drivers should not call this function on them explicitly.
449 */
450void bdrv_detach_aio_context(BlockDriverState *bs);
451
452/**
453 * bdrv_attach_aio_context:
454 *
455 * May be called from .bdrv_attach_aio_context() to attach children to the new
456 * #AioContext. This is only needed by block drivers that manage their own
457 * children. Both ->file and ->backing_hd are automatically handled and block
458 * drivers should not call this function on them explicitly.
459 */
460void bdrv_attach_aio_context(BlockDriverState *bs,
461 AioContext *new_context);
462
Max Reitz33384422014-06-20 21:57:33 +0200463/**
464 * bdrv_add_aio_context_notifier:
465 *
466 * If a long-running job intends to be always run in the same AioContext as a
467 * certain BDS, it may use this function to be notified of changes regarding the
468 * association of the BDS to an AioContext.
469 *
470 * attached_aio_context() is called after the target BDS has been attached to a
471 * new AioContext; detach_aio_context() is called before the target BDS is being
472 * detached from its old AioContext.
473 */
474void bdrv_add_aio_context_notifier(BlockDriverState *bs,
475 void (*attached_aio_context)(AioContext *new_context, void *opaque),
476 void (*detach_aio_context)(void *opaque), void *opaque);
477
478/**
479 * bdrv_remove_aio_context_notifier:
480 *
481 * Unsubscribe of change notifications regarding the BDS's AioContext. The
482 * parameters given here have to be the same as those given to
483 * bdrv_add_aio_context_notifier().
484 */
485void bdrv_remove_aio_context_notifier(BlockDriverState *bs,
486 void (*aio_context_attached)(AioContext *,
487 void *),
488 void (*aio_context_detached)(void *),
489 void *opaque);
490
Christoph Hellwig508c7cb2009-06-15 14:04:22 +0200491#ifdef _WIN32
492int is_windows_drive(const char *filename);
493#endif
494
Paolo Bonzinidc534f82012-03-30 13:17:13 +0200495/**
Paolo Bonzinidc534f82012-03-30 13:17:13 +0200496 * stream_start:
497 * @bs: Block device to operate on.
498 * @base: Block device that will become the new base, or %NULL to
499 * flatten the whole backing file chain onto @bs.
500 * @base_id: The file name that will be written to @bs as the new
501 * backing file if the job completes. Ignored if @base is %NULL.
Stefan Hajnoczic83c66c2012-04-25 16:51:03 +0100502 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
Paolo Bonzini1d809092012-09-28 17:22:59 +0200503 * @on_error: The action to take upon error.
Paolo Bonzinidc534f82012-03-30 13:17:13 +0200504 * @cb: Completion function for the job.
505 * @opaque: Opaque pointer value passed to @cb.
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +0100506 * @errp: Error object.
Paolo Bonzinidc534f82012-03-30 13:17:13 +0200507 *
508 * Start a streaming operation on @bs. Clusters that are unallocated
509 * in @bs, but allocated in any image between @base and @bs (both
510 * exclusive) will be written to @bs. At the end of a successful
511 * streaming job, the backing file of @bs will be changed to
512 * @base_id in the written image and to @base in the live BlockDriverState.
513 */
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +0100514void stream_start(BlockDriverState *bs, BlockDriverState *base,
Paolo Bonzini1d809092012-09-28 17:22:59 +0200515 const char *base_id, int64_t speed, BlockdevOnError on_error,
Markus Armbruster097310b2014-10-07 13:59:15 +0200516 BlockCompletionFunc *cb,
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +0100517 void *opaque, Error **errp);
Stefan Hajnoczi4f1043b2012-01-18 14:40:44 +0000518
Jeff Cody747ff602012-09-27 13:29:13 -0400519/**
520 * commit_start:
Fam Zheng03544a62013-12-16 14:45:30 +0800521 * @bs: Active block device.
522 * @top: Top block device to be committed.
523 * @base: Block device that will be written into, and become the new top.
Jeff Cody747ff602012-09-27 13:29:13 -0400524 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
525 * @on_error: The action to take upon error.
526 * @cb: Completion function for the job.
527 * @opaque: Opaque pointer value passed to @cb.
Jeff Cody54e26902014-06-25 15:40:10 -0400528 * @backing_file_str: String to use as the backing file in @top's overlay
Jeff Cody747ff602012-09-27 13:29:13 -0400529 * @errp: Error object.
530 *
531 */
532void commit_start(BlockDriverState *bs, BlockDriverState *base,
533 BlockDriverState *top, int64_t speed,
Markus Armbruster097310b2014-10-07 13:59:15 +0200534 BlockdevOnError on_error, BlockCompletionFunc *cb,
Jeff Cody54e26902014-06-25 15:40:10 -0400535 void *opaque, const char *backing_file_str, Error **errp);
Fam Zheng03544a62013-12-16 14:45:30 +0800536/**
537 * commit_active_start:
538 * @bs: Active block device to be committed.
539 * @base: Block device that will be written into, and become the new top.
540 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
541 * @on_error: The action to take upon error.
542 * @cb: Completion function for the job.
543 * @opaque: Opaque pointer value passed to @cb.
544 * @errp: Error object.
545 *
546 */
547void commit_active_start(BlockDriverState *bs, BlockDriverState *base,
548 int64_t speed,
549 BlockdevOnError on_error,
Markus Armbruster097310b2014-10-07 13:59:15 +0200550 BlockCompletionFunc *cb,
Fam Zheng03544a62013-12-16 14:45:30 +0800551 void *opaque, Error **errp);
Paolo Bonzini893f7eb2012-10-18 16:49:23 +0200552/*
553 * mirror_start:
554 * @bs: Block device to operate on.
555 * @target: Block device to write to.
Benoît Canet09158f02014-06-27 18:25:25 +0200556 * @replaces: Block graph node name to replace once the mirror is done. Can
557 * only be used when full mirroring is selected.
Paolo Bonzini893f7eb2012-10-18 16:49:23 +0200558 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
Paolo Bonzinieee13df2013-01-21 17:09:46 +0100559 * @granularity: The chosen granularity for the dirty bitmap.
Paolo Bonzini08e4ed62013-01-22 09:03:13 +0100560 * @buf_size: The amount of data that can be in flight at one time.
Paolo Bonzini893f7eb2012-10-18 16:49:23 +0200561 * @mode: Whether to collapse all images in the chain to the target.
Paolo Bonzinib952b552012-10-18 16:49:28 +0200562 * @on_source_error: The action to take upon error reading from the source.
563 * @on_target_error: The action to take upon error writing to the target.
Paolo Bonzini893f7eb2012-10-18 16:49:23 +0200564 * @cb: Completion function for the job.
565 * @opaque: Opaque pointer value passed to @cb.
566 * @errp: Error object.
567 *
568 * Start a mirroring operation on @bs. Clusters that are allocated
569 * in @bs will be written to @bs until the job is cancelled or
570 * manually completed. At the end of a successful mirroring job,
571 * @bs will be switched to read from @target.
572 */
573void mirror_start(BlockDriverState *bs, BlockDriverState *target,
Benoît Canet09158f02014-06-27 18:25:25 +0200574 const char *replaces,
Paolo Bonzini08e4ed62013-01-22 09:03:13 +0100575 int64_t speed, int64_t granularity, int64_t buf_size,
576 MirrorSyncMode mode, BlockdevOnError on_source_error,
Paolo Bonzinib952b552012-10-18 16:49:28 +0200577 BlockdevOnError on_target_error,
Markus Armbruster097310b2014-10-07 13:59:15 +0200578 BlockCompletionFunc *cb,
Paolo Bonzini893f7eb2012-10-18 16:49:23 +0200579 void *opaque, Error **errp);
580
Dietmar Maurer98d2c6f2013-06-24 17:13:11 +0200581/*
582 * backup_start:
583 * @bs: Block device to operate on.
584 * @target: Block device to write to.
585 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
Ian Mainfc5d3f82013-07-26 11:39:04 -0700586 * @sync_mode: What parts of the disk image should be copied to the destination.
Dietmar Maurer98d2c6f2013-06-24 17:13:11 +0200587 * @on_source_error: The action to take upon error reading from the source.
588 * @on_target_error: The action to take upon error writing to the target.
589 * @cb: Completion function for the job.
590 * @opaque: Opaque pointer value passed to @cb.
591 *
592 * Start a backup operation on @bs. Clusters in @bs are written to @target
593 * until the job is cancelled or manually completed.
594 */
595void backup_start(BlockDriverState *bs, BlockDriverState *target,
Ian Mainfc5d3f82013-07-26 11:39:04 -0700596 int64_t speed, MirrorSyncMode sync_mode,
597 BlockdevOnError on_source_error,
Dietmar Maurer98d2c6f2013-06-24 17:13:11 +0200598 BlockdevOnError on_target_error,
Markus Armbruster097310b2014-10-07 13:59:15 +0200599 BlockCompletionFunc *cb, void *opaque,
Dietmar Maurer98d2c6f2013-06-24 17:13:11 +0200600 Error **errp);
601
Markus Armbrustera7f53e22014-10-07 13:59:25 +0200602void blk_dev_change_media_cb(BlockBackend *blk, bool load);
603bool blk_dev_has_removable_media(BlockBackend *blk);
604void blk_dev_eject_request(BlockBackend *blk, bool force);
605bool blk_dev_is_tray_open(BlockBackend *blk);
606bool blk_dev_is_medium_locked(BlockBackend *blk);
607void blk_dev_resize_cb(BlockBackend *blk);
608
bellardea2384d2004-08-01 21:59:26 +0000609#endif /* BLOCK_INT_H */