bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 1 | /* |
| 2 | * QEMU System Emulator block driver |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 3 | * |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 4 | * Copyright (c) 2003 Fabrice Bellard |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 5 | * |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 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: |
| 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 Canet | 5e5a94b | 2014-09-05 15:46:16 +0200 | [diff] [blame] | 27 | #include "block/accounting.h" |
Paolo Bonzini | 737e150 | 2012-12-17 18:19:44 +0100 | [diff] [blame] | 28 | #include "block/block.h" |
Paolo Bonzini | 1de7afc | 2012-12-17 18:20:00 +0100 | [diff] [blame] | 29 | #include "qemu/option.h" |
| 30 | #include "qemu/queue.h" |
Paolo Bonzini | 737e150 | 2012-12-17 18:19:44 +0100 | [diff] [blame] | 31 | #include "block/coroutine.h" |
Paolo Bonzini | 1de7afc | 2012-12-17 18:20:00 +0100 | [diff] [blame] | 32 | #include "qemu/timer.h" |
Luiz Capitulino | b202381 | 2011-09-21 17:16:47 -0300 | [diff] [blame] | 33 | #include "qapi-types.h" |
Paolo Bonzini | 7b1b5d1 | 2012-12-17 18:19:43 +0100 | [diff] [blame] | 34 | #include "qapi/qmp/qerror.h" |
Paolo Bonzini | 83c9089 | 2012-12-17 18:19:49 +0100 | [diff] [blame] | 35 | #include "monitor/monitor.h" |
Paolo Bonzini | 8f0720e | 2013-01-21 17:09:41 +0100 | [diff] [blame] | 36 | #include "qemu/hbitmap.h" |
Wenchao Xia | f364ec6 | 2013-05-25 11:09:44 +0800 | [diff] [blame] | 37 | #include "block/snapshot.h" |
Alex Bligh | 6a1751b | 2013-08-21 16:02:47 +0100 | [diff] [blame] | 38 | #include "qemu/main-loop.h" |
Benoît Canet | cc0681c | 2013-09-02 14:14:39 +0200 | [diff] [blame] | 39 | #include "qemu/throttle.h" |
pbrook | faf0796 | 2007-11-11 02:51:17 +0000 | [diff] [blame] | 40 | |
Stefan Hajnoczi | bfe8043 | 2012-07-27 09:05:22 +0100 | [diff] [blame] | 41 | #define BLOCK_FLAG_ENCRYPT 1 |
| 42 | #define BLOCK_FLAG_COMPAT6 4 |
| 43 | #define BLOCK_FLAG_LAZY_REFCOUNTS 8 |
ths | ec36ba1 | 2007-09-16 21:59:02 +0000 | [diff] [blame] | 44 | |
Stefan Hajnoczi | bfe8043 | 2012-07-27 09:05:22 +0100 | [diff] [blame] | 45 | #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 Pasteka | 7f2039f | 2013-01-30 00:26:52 +0100 | [diff] [blame] | 56 | #define BLOCK_OPT_ADAPTER_TYPE "adapter_type" |
Liu Yuan | b3af018 | 2013-11-07 22:56:38 +0800 | [diff] [blame] | 57 | #define BLOCK_OPT_REDUNDANCY "redundancy" |
Chunyan Liu | 4ab1559 | 2014-06-30 14:29:58 +0800 | [diff] [blame] | 58 | #define BLOCK_OPT_NOCOW "nocow" |
Kevin Wolf | 0e7e198 | 2009-05-18 16:42:10 +0200 | [diff] [blame] | 59 | |
Kevin Wolf | 7cddd37 | 2014-11-20 16:27:11 +0100 | [diff] [blame] | 60 | #define BLOCK_PROBE_BUF_SIZE 512 |
| 61 | |
Stefan Hajnoczi | d616b22 | 2013-06-24 17:13:10 +0200 | [diff] [blame] | 62 | typedef struct BdrvTrackedRequest { |
| 63 | BlockDriverState *bs; |
Kevin Wolf | 793ed47 | 2013-12-03 15:31:25 +0100 | [diff] [blame] | 64 | int64_t offset; |
| 65 | unsigned int bytes; |
Stefan Hajnoczi | d616b22 | 2013-06-24 17:13:10 +0200 | [diff] [blame] | 66 | bool is_write; |
Kevin Wolf | 7327145 | 2013-12-04 17:08:50 +0100 | [diff] [blame] | 67 | |
Kevin Wolf | 2dbafdc | 2013-12-04 16:43:44 +0100 | [diff] [blame] | 68 | bool serialising; |
Kevin Wolf | 7327145 | 2013-12-04 17:08:50 +0100 | [diff] [blame] | 69 | int64_t overlap_offset; |
| 70 | unsigned int overlap_bytes; |
| 71 | |
Stefan Hajnoczi | d616b22 | 2013-06-24 17:13:10 +0200 | [diff] [blame] | 72 | QLIST_ENTRY(BdrvTrackedRequest) list; |
| 73 | Coroutine *co; /* owner, used for deadlock detection */ |
| 74 | CoQueue wait_queue; /* coroutines blocked on this request */ |
Kevin Wolf | 6460440 | 2013-12-13 13:04:35 +0100 | [diff] [blame] | 75 | |
| 76 | struct BdrvTrackedRequest *waiting_for; |
Stefan Hajnoczi | d616b22 | 2013-06-24 17:13:10 +0200 | [diff] [blame] | 77 | } BdrvTrackedRequest; |
| 78 | |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 79 | struct BlockDriver { |
| 80 | const char *format_name; |
| 81 | int instance_size; |
Benoît Canet | f6186f4 | 2013-10-02 14:33:48 +0200 | [diff] [blame] | 82 | |
Benoît Canet | b5042a3 | 2014-03-03 19:11:34 +0100 | [diff] [blame] | 83 | /* 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 Canet | 212a5a8 | 2014-01-23 21:31:36 +0100 | [diff] [blame] | 87 | * 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 Canet | f6186f4 | 2013-10-02 14:33:48 +0200 | [diff] [blame] | 90 | */ |
Benoît Canet | 212a5a8 | 2014-01-23 21:31:36 +0100 | [diff] [blame] | 91 | bool (*bdrv_recurse_is_first_non_filter)(BlockDriverState *bs, |
| 92 | BlockDriverState *candidate); |
Benoît Canet | f6186f4 | 2013-10-02 14:33:48 +0200 | [diff] [blame] | 93 | |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 94 | int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); |
Christoph Hellwig | 508c7cb | 2009-06-15 14:04:22 +0200 | [diff] [blame] | 95 | int (*bdrv_probe_device)(const char *filename); |
Kevin Wolf | c2ad1b0 | 2013-03-18 16:40:51 +0100 | [diff] [blame] | 96 | |
| 97 | /* Any driver implementing this callback is expected to be able to handle |
| 98 | * NULL file names in its .bdrv_open() implementation */ |
Kevin Wolf | 6963a30 | 2013-03-15 18:47:22 +0100 | [diff] [blame] | 99 | void (*bdrv_parse_filename)(const char *filename, QDict *options, Error **errp); |
Benoît Canet | 030be32 | 2013-09-24 17:07:04 +0200 | [diff] [blame] | 100 | /* 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 Cody | e971aa1 | 2012-09-20 15:13:19 -0400 | [diff] [blame] | 106 | |
Kevin Wolf | 8ee79e7 | 2014-06-04 15:09:35 +0200 | [diff] [blame] | 107 | /* Set if a driver can support backing files */ |
| 108 | bool supports_backing; |
| 109 | |
Jeff Cody | e971aa1 | 2012-09-20 15:13:19 -0400 | [diff] [blame] | 110 | /* 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 Reitz | 015a103 | 2013-09-05 14:22:29 +0200 | [diff] [blame] | 116 | 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); |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 120 | int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num, |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 121 | uint8_t *buf, int nb_sectors); |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 122 | int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num, |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 123 | const uint8_t *buf, int nb_sectors); |
bellard | e2731ad | 2004-09-18 19:32:11 +0000 | [diff] [blame] | 124 | void (*bdrv_close)(BlockDriverState *bs); |
Paolo Bonzini | e023b2e | 2012-05-08 16:51:41 +0200 | [diff] [blame] | 125 | void (*bdrv_rebind)(BlockDriverState *bs); |
Chunyan Liu | c282e1f | 2014-06-05 17:21:11 +0800 | [diff] [blame] | 126 | int (*bdrv_create)(const char *filename, QemuOpts *opts, Error **errp); |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 127 | int (*bdrv_set_key)(BlockDriverState *bs, const char *key); |
bellard | 95389c8 | 2005-12-18 18:28:15 +0000 | [diff] [blame] | 128 | int (*bdrv_make_empty)(BlockDriverState *bs); |
Max Reitz | 91af701 | 2014-07-18 20:24:56 +0200 | [diff] [blame] | 129 | |
| 130 | void (*bdrv_refresh_filename)(BlockDriverState *bs); |
| 131 | |
bellard | 83f6409 | 2006-08-01 16:21:11 +0000 | [diff] [blame] | 132 | /* aio */ |
Markus Armbruster | 7c84b1b | 2014-10-07 13:59:14 +0200 | [diff] [blame] | 133 | BlockAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs, |
aliguori | f141eaf | 2009-04-07 18:43:24 +0000 | [diff] [blame] | 134 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 135 | BlockCompletionFunc *cb, void *opaque); |
Markus Armbruster | 7c84b1b | 2014-10-07 13:59:14 +0200 | [diff] [blame] | 136 | BlockAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs, |
aliguori | f141eaf | 2009-04-07 18:43:24 +0000 | [diff] [blame] | 137 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 138 | BlockCompletionFunc *cb, void *opaque); |
Markus Armbruster | 7c84b1b | 2014-10-07 13:59:14 +0200 | [diff] [blame] | 139 | BlockAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 140 | BlockCompletionFunc *cb, void *opaque); |
Markus Armbruster | 7c84b1b | 2014-10-07 13:59:14 +0200 | [diff] [blame] | 141 | BlockAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs, |
Paolo Bonzini | 4265d62 | 2011-10-17 12:32:14 +0200 | [diff] [blame] | 142 | int64_t sector_num, int nb_sectors, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 143 | BlockCompletionFunc *cb, void *opaque); |
bellard | 83f6409 | 2006-08-01 16:21:11 +0000 | [diff] [blame] | 144 | |
Kevin Wolf | da1fa91 | 2011-07-14 17:27:13 +0200 | [diff] [blame] | 145 | 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 Hajnoczi | f08f2dd | 2012-02-07 13:27:25 +0000 | [diff] [blame] | 149 | /* |
| 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 Lieven | aa7bfbf | 2013-10-24 12:06:51 +0200 | [diff] [blame] | 156 | int64_t sector_num, int nb_sectors, BdrvRequestFlags flags); |
Paolo Bonzini | 4265d62 | 2011-10-17 12:32:14 +0200 | [diff] [blame] | 157 | int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs, |
| 158 | int64_t sector_num, int nb_sectors); |
Paolo Bonzini | b6b8a33 | 2013-09-04 19:00:28 +0200 | [diff] [blame] | 159 | int64_t coroutine_fn (*bdrv_co_get_block_status)(BlockDriverState *bs, |
Stefan Hajnoczi | 376ae3f | 2011-11-14 12:44:19 +0000 | [diff] [blame] | 160 | int64_t sector_num, int nb_sectors, int *pnum); |
Kevin Wolf | da1fa91 | 2011-07-14 17:27:13 +0200 | [diff] [blame] | 161 | |
Kevin Wolf | c68b89a | 2011-11-10 17:25:44 +0100 | [diff] [blame] | 162 | /* |
Anthony Liguori | 0f15423 | 2011-11-14 15:09:45 -0600 | [diff] [blame] | 163 | * Invalidate any cached meta-data. |
| 164 | */ |
Kevin Wolf | 5a8a30d | 2014-03-12 15:59:16 +0100 | [diff] [blame] | 165 | void (*bdrv_invalidate_cache)(BlockDriverState *bs, Error **errp); |
Anthony Liguori | 0f15423 | 2011-11-14 15:09:45 -0600 | [diff] [blame] | 166 | |
| 167 | /* |
Kevin Wolf | c68b89a | 2011-11-10 17:25:44 +0100 | [diff] [blame] | 168 | * 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 Wolf | eb489bb | 2011-11-10 18:10:11 +0100 | [diff] [blame] | 173 | /* |
| 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 | |
bellard | 83f6409 | 2006-08-01 16:21:11 +0000 | [diff] [blame] | 180 | const char *protocol_name; |
bellard | 83f6409 | 2006-08-01 16:21:11 +0000 | [diff] [blame] | 181 | int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset); |
Kevin Wolf | b94a261 | 2013-10-29 12:18:58 +0100 | [diff] [blame] | 182 | |
bellard | 83f6409 | 2006-08-01 16:21:11 +0000 | [diff] [blame] | 183 | int64_t (*bdrv_getlength)(BlockDriverState *bs); |
Kevin Wolf | b94a261 | 2013-10-29 12:18:58 +0100 | [diff] [blame] | 184 | bool has_variable_length; |
Fam Zheng | 4a1d5e1 | 2011-07-12 19:56:39 +0800 | [diff] [blame] | 185 | int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs); |
Kevin Wolf | b94a261 | 2013-10-29 12:18:58 +0100 | [diff] [blame] | 186 | |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 187 | int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num, |
bellard | faea38e | 2006-08-05 21:31:00 +0000 | [diff] [blame] | 188 | const uint8_t *buf, int nb_sectors); |
| 189 | |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 190 | int (*bdrv_snapshot_create)(BlockDriverState *bs, |
bellard | faea38e | 2006-08-05 21:31:00 +0000 | [diff] [blame] | 191 | QEMUSnapshotInfo *sn_info); |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 192 | int (*bdrv_snapshot_goto)(BlockDriverState *bs, |
bellard | faea38e | 2006-08-05 21:31:00 +0000 | [diff] [blame] | 193 | const char *snapshot_id); |
Wenchao Xia | a89d89d | 2013-09-11 14:04:33 +0800 | [diff] [blame] | 194 | int (*bdrv_snapshot_delete)(BlockDriverState *bs, |
| 195 | const char *snapshot_id, |
| 196 | const char *name, |
| 197 | Error **errp); |
ths | 5fafdf2 | 2007-09-16 21:08:06 +0000 | [diff] [blame] | 198 | int (*bdrv_snapshot_list)(BlockDriverState *bs, |
bellard | faea38e | 2006-08-05 21:31:00 +0000 | [diff] [blame] | 199 | QEMUSnapshotInfo **psn_info); |
edison | 51ef672 | 2010-09-21 19:58:41 -0700 | [diff] [blame] | 200 | int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs, |
Wenchao Xia | 7b4c478 | 2013-12-04 17:10:54 +0800 | [diff] [blame] | 201 | const char *snapshot_id, |
| 202 | const char *name, |
| 203 | Error **errp); |
bellard | faea38e | 2006-08-05 21:31:00 +0000 | [diff] [blame] | 204 | int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); |
Max Reitz | eae041f | 2013-10-09 10:46:16 +0200 | [diff] [blame] | 205 | ImageInfoSpecific *(*bdrv_get_specific_info)(BlockDriverState *bs); |
bellard | 83f6409 | 2006-08-01 16:21:11 +0000 | [diff] [blame] | 206 | |
Kevin Wolf | cf8074b | 2013-04-05 21:27:53 +0200 | [diff] [blame] | 207 | int (*bdrv_save_vmstate)(BlockDriverState *bs, QEMUIOVector *qiov, |
| 208 | int64_t pos); |
Christoph Hellwig | 45566e9 | 2009-07-10 23:11:57 +0200 | [diff] [blame] | 209 | int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf, |
| 210 | int64_t pos, int size); |
aliguori | 178e08a | 2009-04-05 19:10:55 +0000 | [diff] [blame] | 211 | |
Kevin Wolf | 756e673 | 2010-01-12 12:55:17 +0100 | [diff] [blame] | 212 | int (*bdrv_change_backing_file)(BlockDriverState *bs, |
| 213 | const char *backing_file, const char *backing_fmt); |
| 214 | |
bellard | 19cb373 | 2006-08-19 11:45:59 +0000 | [diff] [blame] | 215 | /* removable device specific */ |
| 216 | int (*bdrv_is_inserted)(BlockDriverState *bs); |
| 217 | int (*bdrv_media_changed)(BlockDriverState *bs); |
Luiz Capitulino | f36f394 | 2012-02-03 16:24:53 -0200 | [diff] [blame] | 218 | void (*bdrv_eject)(BlockDriverState *bs, bool eject_flag); |
Markus Armbruster | 025e849 | 2011-09-06 18:58:47 +0200 | [diff] [blame] | 219 | void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked); |
ths | 3b46e62 | 2007-09-17 08:09:54 +0000 | [diff] [blame] | 220 | |
ths | 985a03b | 2007-12-24 16:10:43 +0000 | [diff] [blame] | 221 | /* to control generic scsi devices */ |
| 222 | int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf); |
Markus Armbruster | 7c84b1b | 2014-10-07 13:59:14 +0200 | [diff] [blame] | 223 | BlockAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, |
aliguori | 221f715 | 2009-03-28 17:28:41 +0000 | [diff] [blame] | 224 | unsigned long int req, void *buf, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 225 | BlockCompletionFunc *cb, void *opaque); |
ths | 985a03b | 2007-12-24 16:10:43 +0000 | [diff] [blame] | 226 | |
Kevin Wolf | 0e7e198 | 2009-05-18 16:42:10 +0200 | [diff] [blame] | 227 | /* List of options for creating images, terminated by name == NULL */ |
Chunyan Liu | 83d0521 | 2014-06-05 17:20:51 +0800 | [diff] [blame] | 228 | QemuOptsList *create_opts; |
aliguori | 5eb4563 | 2009-03-28 17:55:10 +0000 | [diff] [blame] | 229 | |
Kevin Wolf | 9ac228e | 2010-06-29 12:37:54 +0200 | [diff] [blame] | 230 | /* |
| 231 | * Returns 0 for completed check, -errno for internal errors. |
| 232 | * The check results are stored in result. |
| 233 | */ |
Kevin Wolf | 4534ff5 | 2012-05-11 16:07:02 +0200 | [diff] [blame] | 234 | int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result, |
| 235 | BdrvCheckMode fix); |
aliguori | e97fc19 | 2009-04-21 23:11:50 +0000 | [diff] [blame] | 236 | |
Max Reitz | 7748543 | 2014-10-27 11:12:50 +0100 | [diff] [blame] | 237 | int (*bdrv_amend_options)(BlockDriverState *bs, QemuOpts *opts, |
| 238 | BlockDriverAmendStatusCB *status_cb); |
Max Reitz | 6f176b4 | 2013-09-03 10:09:50 +0200 | [diff] [blame] | 239 | |
Kevin Wolf | 8b9b0cc | 2010-03-15 17:27:00 +0100 | [diff] [blame] | 240 | void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event); |
| 241 | |
Kevin Wolf | 41c695c | 2012-12-06 14:32:58 +0100 | [diff] [blame] | 242 | /* 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 Zheng | 4cc70e9 | 2013-11-20 10:01:54 +0800 | [diff] [blame] | 245 | int (*bdrv_debug_remove_breakpoint)(BlockDriverState *bs, |
| 246 | const char *tag); |
Kevin Wolf | 41c695c | 2012-12-06 14:32:58 +0100 | [diff] [blame] | 247 | int (*bdrv_debug_resume)(BlockDriverState *bs, const char *tag); |
| 248 | bool (*bdrv_debug_is_suspended)(BlockDriverState *bs, const char *tag); |
| 249 | |
Kevin Wolf | 3baca89 | 2014-07-16 17:48:16 +0200 | [diff] [blame] | 250 | void (*bdrv_refresh_limits)(BlockDriverState *bs, Error **errp); |
Kevin Wolf | d34682c | 2013-12-11 19:26:16 +0100 | [diff] [blame] | 251 | |
Kevin Wolf | 336c1c1 | 2010-07-28 11:26:29 +0200 | [diff] [blame] | 252 | /* |
| 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 Wolf | 12c09b8 | 2009-11-30 16:54:15 +0100 | [diff] [blame] | 257 | |
Stefan Hajnoczi | dcd0422 | 2014-05-08 16:34:37 +0200 | [diff] [blame] | 258 | /* 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 Lei | 448ad91 | 2014-07-04 18:04:33 +0800 | [diff] [blame] | 271 | /* 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 Hajnoczi | 8a22f02 | 2010-04-13 10:29:33 +0100 | [diff] [blame] | 276 | QLIST_ENTRY(BlockDriver) list; |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 277 | }; |
| 278 | |
Peter Lieven | fe81c2c | 2013-10-24 12:06:56 +0200 | [diff] [blame] | 279 | typedef 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 Lieven | 7337aca | 2013-11-27 11:07:04 +0100 | [diff] [blame] | 291 | |
| 292 | /* optimal transfer length in sectors */ |
| 293 | int opt_transfer_length; |
Kevin Wolf | 339064d | 2013-11-28 10:23:32 +0100 | [diff] [blame] | 294 | |
Peter Lieven | 2647fab | 2014-10-27 10:18:44 +0100 | [diff] [blame] | 295 | /* maximal transfer length in sectors */ |
| 296 | int max_transfer_length; |
| 297 | |
Kevin Wolf | 339064d | 2013-11-28 10:23:32 +0100 | [diff] [blame] | 298 | /* memory alignment so that no bounce buffer is needed */ |
| 299 | size_t opt_mem_alignment; |
Peter Lieven | fe81c2c | 2013-10-24 12:06:56 +0200 | [diff] [blame] | 300 | } BlockLimits; |
| 301 | |
Fam Zheng | fbe40ff | 2014-05-23 21:29:42 +0800 | [diff] [blame] | 302 | typedef struct BdrvOpBlocker BdrvOpBlocker; |
| 303 | |
Max Reitz | 3338442 | 2014-06-20 21:57:33 +0200 | [diff] [blame] | 304 | typedef 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 Cody | 8802d1f | 2012-02-28 15:54:06 -0500 | [diff] [blame] | 313 | /* |
| 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 | */ |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 319 | struct BlockDriverState { |
bellard | d15a771 | 2006-08-06 13:35:09 +0000 | [diff] [blame] | 320 | int64_t total_sectors; /* if we are reading a disk image, give its |
| 321 | size in sectors */ |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 322 | int read_only; /* if true, the media is read only */ |
Naphtali Sprei | 4dca4b6 | 2010-02-14 13:39:18 +0200 | [diff] [blame] | 323 | int open_flags; /* flags used to open the file, re-used for re-open */ |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 324 | int encrypted; /* if true, the media is encrypted */ |
aliguori | c0f4ce7 | 2009-03-05 23:01:01 +0000 | [diff] [blame] | 325 | int valid_key; /* if true, a valid encryption key has been set */ |
ths | 985a03b | 2007-12-24 16:10:43 +0000 | [diff] [blame] | 326 | int sg; /* if true, the device is a /dev/sg* */ |
Stefan Hajnoczi | 53fec9d | 2011-11-28 16:08:47 +0000 | [diff] [blame] | 327 | int copy_on_read; /* if true, copy read backing sectors into image |
| 328 | note this is a reference count */ |
Kevin Wolf | 38f3ef5 | 2014-11-20 16:27:12 +0100 | [diff] [blame] | 329 | bool probed; |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 330 | |
bellard | 19cb373 | 2006-08-19 11:45:59 +0000 | [diff] [blame] | 331 | BlockDriver *drv; /* NULL means no media */ |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 332 | void *opaque; |
| 333 | |
Markus Armbruster | 7e7d56d | 2014-10-07 13:59:05 +0200 | [diff] [blame] | 334 | BlockBackend *blk; /* owning backend, if any */ |
| 335 | |
Stefan Hajnoczi | dcd0422 | 2014-05-08 16:34:37 +0200 | [diff] [blame] | 336 | AioContext *aio_context; /* event loop used for fd handlers, timers, etc */ |
Max Reitz | 3338442 | 2014-06-20 21:57:33 +0200 | [diff] [blame] | 337 | /* 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 Hajnoczi | dcd0422 | 2014-05-08 16:34:37 +0200 | [diff] [blame] | 341 | |
Jeff Cody | 9a29e18 | 2015-01-22 08:03:30 -0500 | [diff] [blame] | 342 | char filename[PATH_MAX]; |
| 343 | char backing_file[PATH_MAX]; /* if non zero, the image is a diff of |
| 344 | this file image */ |
aliguori | 5eb4563 | 2009-03-28 17:55:10 +0000 | [diff] [blame] | 345 | char backing_format[16]; /* if non-zero and backing_file exists */ |
bellard | 19cb373 | 2006-08-19 11:45:59 +0000 | [diff] [blame] | 346 | |
Max Reitz | 91af701 | 2014-07-18 20:24:56 +0200 | [diff] [blame] | 347 | QDict *full_open_options; |
Jeff Cody | 9a29e18 | 2015-01-22 08:03:30 -0500 | [diff] [blame] | 348 | char exact_filename[PATH_MAX]; |
Max Reitz | 91af701 | 2014-07-18 20:24:56 +0200 | [diff] [blame] | 349 | |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 350 | BlockDriverState *backing_hd; |
Kevin Wolf | 66f82ce | 2010-04-14 14:17:38 +0200 | [diff] [blame] | 351 | BlockDriverState *file; |
| 352 | |
Paolo Bonzini | d7d512f | 2012-08-23 11:20:36 +0200 | [diff] [blame] | 353 | NotifierList close_notifiers; |
| 354 | |
Stefan Hajnoczi | d616b22 | 2013-06-24 17:13:10 +0200 | [diff] [blame] | 355 | /* Callback before write request is processed */ |
| 356 | NotifierWithReturnList before_write_notifiers; |
| 357 | |
Kevin Wolf | 2dbafdc | 2013-12-04 16:43:44 +0100 | [diff] [blame] | 358 | /* number of in-flight serialising requests */ |
| 359 | unsigned int serialising_in_flight; |
Stefan Hajnoczi | 470c050 | 2012-01-18 14:40:42 +0000 | [diff] [blame] | 360 | |
Benoît Canet | cc0681c | 2013-09-02 14:14:39 +0200 | [diff] [blame] | 361 | /* I/O throttling */ |
| 362 | ThrottleState throttle_state; |
| 363 | CoQueue throttled_reqs[2]; |
Zhi Yong Wu | 0563e19 | 2011-11-03 16:57:25 +0800 | [diff] [blame] | 364 | bool io_limits_enabled; |
| 365 | |
ths | a36e69d | 2007-12-02 05:18:19 +0000 | [diff] [blame] | 366 | /* I/O stats (display with "info blockstats"). */ |
Benoît Canet | 0ddd0ad | 2014-09-05 15:46:15 +0200 | [diff] [blame] | 367 | BlockAcctStats stats; |
ths | a36e69d | 2007-12-02 05:18:19 +0000 | [diff] [blame] | 368 | |
Peter Lieven | fe81c2c | 2013-10-24 12:06:56 +0200 | [diff] [blame] | 369 | /* I/O Limits */ |
| 370 | BlockLimits bl; |
| 371 | |
aliguori | 71d0770 | 2009-03-03 17:37:16 +0000 | [diff] [blame] | 372 | /* Whether the disk can expand beyond total_sectors */ |
| 373 | int growable; |
| 374 | |
Asias He | 0d51b4d | 2013-08-22 15:24:14 +0800 | [diff] [blame] | 375 | /* Whether produces zeros when read beyond eof */ |
| 376 | bool zero_beyond_eof; |
| 377 | |
Paolo Bonzini | c25f53b | 2011-11-29 12:42:20 +0100 | [diff] [blame] | 378 | /* Alignment requirement for offset/length of I/O requests */ |
| 379 | unsigned int request_alignment; |
| 380 | |
Paolo Bonzini | 1b7fd72 | 2011-11-29 11:35:47 +0100 | [diff] [blame] | 381 | /* the block size for which the guest device expects atomicity */ |
| 382 | int guest_block_size; |
aliguori | e268ca5 | 2009-04-22 20:20:00 +0000 | [diff] [blame] | 383 | |
Christoph Hellwig | e900a7b | 2009-09-04 19:01:15 +0200 | [diff] [blame] | 384 | /* do we need to tell the quest if we have a volatile write cache? */ |
| 385 | int enable_write_cache; |
| 386 | |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 387 | /* NOTE: the following infos are only hints for real hardware |
| 388 | drivers. They are not used by the block driver */ |
Paolo Bonzini | ff06f5f | 2012-09-28 17:22:54 +0200 | [diff] [blame] | 389 | BlockdevOnError on_read_error, on_write_error; |
Luiz Capitulino | d6bf279 | 2011-10-14 17:11:23 -0300 | [diff] [blame] | 390 | bool iostatus_enabled; |
Luiz Capitulino | b202381 | 2011-09-21 17:16:47 -0300 | [diff] [blame] | 391 | BlockDeviceIoStatus iostatus; |
Benoît Canet | dc364f4 | 2014-01-23 21:31:32 +0100 | [diff] [blame] | 392 | |
| 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 Canet | dc364f4 | 2014-01-23 21:31:32 +0100 | [diff] [blame] | 397 | /* element of the list of "drives" the guest sees */ |
| 398 | QTAILQ_ENTRY(BlockDriverState) device_list; |
Fam Zheng | e4654d2 | 2013-11-13 18:29:43 +0800 | [diff] [blame] | 399 | QLIST_HEAD(, BdrvDirtyBitmap) dirty_bitmaps; |
Fam Zheng | 9fcb025 | 2013-08-23 09:14:46 +0800 | [diff] [blame] | 400 | int refcnt; |
Stefan Hajnoczi | dbffbdc | 2011-11-17 13:40:27 +0000 | [diff] [blame] | 401 | |
| 402 | QLIST_HEAD(, BdrvTrackedRequest) tracked_requests; |
Stefan Hajnoczi | eeec61f | 2012-01-18 14:40:43 +0000 | [diff] [blame] | 403 | |
Fam Zheng | fbe40ff | 2014-05-23 21:29:42 +0800 | [diff] [blame] | 404 | /* operation blockers */ |
| 405 | QLIST_HEAD(, BdrvOpBlocker) op_blockers[BLOCK_OP_TYPE_MAX]; |
| 406 | |
Stefan Hajnoczi | eeec61f | 2012-01-18 14:40:43 +0000 | [diff] [blame] | 407 | /* long-running background operation */ |
| 408 | BlockJob *job; |
Jeff Cody | e971aa1 | 2012-09-20 15:13:19 -0400 | [diff] [blame] | 409 | |
Kevin Wolf | de9c0ce | 2013-03-15 10:35:02 +0100 | [diff] [blame] | 410 | QDict *options; |
Peter Lieven | 465bee1 | 2014-05-18 00:58:19 +0200 | [diff] [blame] | 411 | BlockdevDetectZeroesOptions detect_zeroes; |
Fam Zheng | 826b6ca | 2014-05-23 21:29:47 +0800 | [diff] [blame] | 412 | |
| 413 | /* The error object in use for blocking operations on backing_hd */ |
| 414 | Error *backing_blocker; |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 415 | }; |
| 416 | |
Max Reitz | 5f535a9 | 2014-12-02 18:32:41 +0100 | [diff] [blame] | 417 | |
| 418 | /* Essential block drivers which must always be statically linked into qemu, and |
| 419 | * which therefore can be accessed without using bdrv_find_format() */ |
| 420 | extern BlockDriver bdrv_file; |
| 421 | extern BlockDriver bdrv_raw; |
| 422 | extern BlockDriver bdrv_qcow2; |
| 423 | |
| 424 | |
Jim Meyering | eba2505 | 2012-05-28 09:27:54 +0200 | [diff] [blame] | 425 | int get_tmp_filename(char *filename, int size); |
Kevin Wolf | 38f3ef5 | 2014-11-20 16:27:12 +0100 | [diff] [blame] | 426 | BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, |
| 427 | const char *filename); |
bellard | 95389c8 | 2005-12-18 18:28:15 +0000 | [diff] [blame] | 428 | |
Zhi Yong Wu | 0563e19 | 2011-11-03 16:57:25 +0800 | [diff] [blame] | 429 | void bdrv_set_io_limits(BlockDriverState *bs, |
Benoît Canet | cc0681c | 2013-09-02 14:14:39 +0200 | [diff] [blame] | 430 | ThrottleConfig *cfg); |
| 431 | |
Zhi Yong Wu | 0563e19 | 2011-11-03 16:57:25 +0800 | [diff] [blame] | 432 | |
Stefan Hajnoczi | 85d126f | 2013-03-07 13:41:48 +0100 | [diff] [blame] | 433 | /** |
Stefan Hajnoczi | d616b22 | 2013-06-24 17:13:10 +0200 | [diff] [blame] | 434 | * 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 | */ |
| 439 | void bdrv_add_before_write_notifier(BlockDriverState *bs, |
| 440 | NotifierWithReturn *notifier); |
| 441 | |
| 442 | /** |
Stefan Hajnoczi | dcd0422 | 2014-05-08 16:34:37 +0200 | [diff] [blame] | 443 | * 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 | */ |
| 450 | void 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 | */ |
| 460 | void bdrv_attach_aio_context(BlockDriverState *bs, |
| 461 | AioContext *new_context); |
| 462 | |
Max Reitz | 3338442 | 2014-06-20 21:57:33 +0200 | [diff] [blame] | 463 | /** |
| 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 | */ |
| 474 | void 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 | */ |
| 485 | void 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 Hellwig | 508c7cb | 2009-06-15 14:04:22 +0200 | [diff] [blame] | 491 | #ifdef _WIN32 |
| 492 | int is_windows_drive(const char *filename); |
| 493 | #endif |
| 494 | |
Paolo Bonzini | dc534f8 | 2012-03-30 13:17:13 +0200 | [diff] [blame] | 495 | /** |
Paolo Bonzini | dc534f8 | 2012-03-30 13:17:13 +0200 | [diff] [blame] | 496 | * 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 Hajnoczi | c83c66c | 2012-04-25 16:51:03 +0100 | [diff] [blame] | 502 | * @speed: The maximum speed, in bytes per second, or 0 for unlimited. |
Paolo Bonzini | 1d80909 | 2012-09-28 17:22:59 +0200 | [diff] [blame] | 503 | * @on_error: The action to take upon error. |
Paolo Bonzini | dc534f8 | 2012-03-30 13:17:13 +0200 | [diff] [blame] | 504 | * @cb: Completion function for the job. |
| 505 | * @opaque: Opaque pointer value passed to @cb. |
Stefan Hajnoczi | fd7f8c6 | 2012-04-25 16:51:00 +0100 | [diff] [blame] | 506 | * @errp: Error object. |
Paolo Bonzini | dc534f8 | 2012-03-30 13:17:13 +0200 | [diff] [blame] | 507 | * |
| 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 Hajnoczi | fd7f8c6 | 2012-04-25 16:51:00 +0100 | [diff] [blame] | 514 | void stream_start(BlockDriverState *bs, BlockDriverState *base, |
Paolo Bonzini | 1d80909 | 2012-09-28 17:22:59 +0200 | [diff] [blame] | 515 | const char *base_id, int64_t speed, BlockdevOnError on_error, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 516 | BlockCompletionFunc *cb, |
Stefan Hajnoczi | fd7f8c6 | 2012-04-25 16:51:00 +0100 | [diff] [blame] | 517 | void *opaque, Error **errp); |
Stefan Hajnoczi | 4f1043b | 2012-01-18 14:40:44 +0000 | [diff] [blame] | 518 | |
Jeff Cody | 747ff60 | 2012-09-27 13:29:13 -0400 | [diff] [blame] | 519 | /** |
| 520 | * commit_start: |
Fam Zheng | 03544a6 | 2013-12-16 14:45:30 +0800 | [diff] [blame] | 521 | * @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 Cody | 747ff60 | 2012-09-27 13:29:13 -0400 | [diff] [blame] | 524 | * @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 Cody | 54e2690 | 2014-06-25 15:40:10 -0400 | [diff] [blame] | 528 | * @backing_file_str: String to use as the backing file in @top's overlay |
Jeff Cody | 747ff60 | 2012-09-27 13:29:13 -0400 | [diff] [blame] | 529 | * @errp: Error object. |
| 530 | * |
| 531 | */ |
| 532 | void commit_start(BlockDriverState *bs, BlockDriverState *base, |
| 533 | BlockDriverState *top, int64_t speed, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 534 | BlockdevOnError on_error, BlockCompletionFunc *cb, |
Jeff Cody | 54e2690 | 2014-06-25 15:40:10 -0400 | [diff] [blame] | 535 | void *opaque, const char *backing_file_str, Error **errp); |
Fam Zheng | 03544a6 | 2013-12-16 14:45:30 +0800 | [diff] [blame] | 536 | /** |
| 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 | */ |
| 547 | void commit_active_start(BlockDriverState *bs, BlockDriverState *base, |
| 548 | int64_t speed, |
| 549 | BlockdevOnError on_error, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 550 | BlockCompletionFunc *cb, |
Fam Zheng | 03544a6 | 2013-12-16 14:45:30 +0800 | [diff] [blame] | 551 | void *opaque, Error **errp); |
Paolo Bonzini | 893f7eb | 2012-10-18 16:49:23 +0200 | [diff] [blame] | 552 | /* |
| 553 | * mirror_start: |
| 554 | * @bs: Block device to operate on. |
| 555 | * @target: Block device to write to. |
Benoît Canet | 09158f0 | 2014-06-27 18:25:25 +0200 | [diff] [blame] | 556 | * @replaces: Block graph node name to replace once the mirror is done. Can |
| 557 | * only be used when full mirroring is selected. |
Paolo Bonzini | 893f7eb | 2012-10-18 16:49:23 +0200 | [diff] [blame] | 558 | * @speed: The maximum speed, in bytes per second, or 0 for unlimited. |
Paolo Bonzini | eee13df | 2013-01-21 17:09:46 +0100 | [diff] [blame] | 559 | * @granularity: The chosen granularity for the dirty bitmap. |
Paolo Bonzini | 08e4ed6 | 2013-01-22 09:03:13 +0100 | [diff] [blame] | 560 | * @buf_size: The amount of data that can be in flight at one time. |
Paolo Bonzini | 893f7eb | 2012-10-18 16:49:23 +0200 | [diff] [blame] | 561 | * @mode: Whether to collapse all images in the chain to the target. |
Paolo Bonzini | b952b55 | 2012-10-18 16:49:28 +0200 | [diff] [blame] | 562 | * @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 Bonzini | 893f7eb | 2012-10-18 16:49:23 +0200 | [diff] [blame] | 564 | * @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 | */ |
| 573 | void mirror_start(BlockDriverState *bs, BlockDriverState *target, |
Benoît Canet | 09158f0 | 2014-06-27 18:25:25 +0200 | [diff] [blame] | 574 | const char *replaces, |
Paolo Bonzini | 08e4ed6 | 2013-01-22 09:03:13 +0100 | [diff] [blame] | 575 | int64_t speed, int64_t granularity, int64_t buf_size, |
| 576 | MirrorSyncMode mode, BlockdevOnError on_source_error, |
Paolo Bonzini | b952b55 | 2012-10-18 16:49:28 +0200 | [diff] [blame] | 577 | BlockdevOnError on_target_error, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 578 | BlockCompletionFunc *cb, |
Paolo Bonzini | 893f7eb | 2012-10-18 16:49:23 +0200 | [diff] [blame] | 579 | void *opaque, Error **errp); |
| 580 | |
Dietmar Maurer | 98d2c6f | 2013-06-24 17:13:11 +0200 | [diff] [blame] | 581 | /* |
| 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 Main | fc5d3f8 | 2013-07-26 11:39:04 -0700 | [diff] [blame] | 586 | * @sync_mode: What parts of the disk image should be copied to the destination. |
Dietmar Maurer | 98d2c6f | 2013-06-24 17:13:11 +0200 | [diff] [blame] | 587 | * @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 | */ |
| 595 | void backup_start(BlockDriverState *bs, BlockDriverState *target, |
Ian Main | fc5d3f8 | 2013-07-26 11:39:04 -0700 | [diff] [blame] | 596 | int64_t speed, MirrorSyncMode sync_mode, |
| 597 | BlockdevOnError on_source_error, |
Dietmar Maurer | 98d2c6f | 2013-06-24 17:13:11 +0200 | [diff] [blame] | 598 | BlockdevOnError on_target_error, |
Markus Armbruster | 097310b | 2014-10-07 13:59:15 +0200 | [diff] [blame] | 599 | BlockCompletionFunc *cb, void *opaque, |
Dietmar Maurer | 98d2c6f | 2013-06-24 17:13:11 +0200 | [diff] [blame] | 600 | Error **errp); |
| 601 | |
Markus Armbruster | a7f53e2 | 2014-10-07 13:59:25 +0200 | [diff] [blame] | 602 | void blk_dev_change_media_cb(BlockBackend *blk, bool load); |
| 603 | bool blk_dev_has_removable_media(BlockBackend *blk); |
| 604 | void blk_dev_eject_request(BlockBackend *blk, bool force); |
| 605 | bool blk_dev_is_tray_open(BlockBackend *blk); |
| 606 | bool blk_dev_is_medium_locked(BlockBackend *blk); |
| 607 | void blk_dev_resize_cb(BlockBackend *blk); |
| 608 | |
bellard | ea2384d | 2004-08-01 21:59:26 +0000 | [diff] [blame] | 609 | #endif /* BLOCK_INT_H */ |