blob: 1150437b70f9ff8be65373bbbb11f831c1dde221 [file] [log] [blame]
bellardfc01f7e2003-06-30 10:03:06 +00001/*
2 * QEMU System Emulator block driver
ths5fafdf22007-09-16 21:08:06 +00003 *
bellardfc01f7e2003-06-30 10:03:06 +00004 * Copyright (c) 2003 Fabrice Bellard
ths5fafdf22007-09-16 21:08:06 +00005 *
bellardfc01f7e2003-06-30 10:03:06 +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 */
blueswir13990d092008-12-05 17:53:21 +000024#include "config-host.h"
pbrookfaf07962007-11-11 02:51:17 +000025#include "qemu-common.h"
Stefan Hajnoczi6d519a52010-05-22 18:15:08 +010026#include "trace.h"
aliguori376253e2009-03-05 23:01:23 +000027#include "monitor.h"
bellardea2384d2004-08-01 21:59:26 +000028#include "block_int.h"
Anthony Liguori5efa9d52009-05-09 17:03:42 -050029#include "module.h"
Luiz Capitulinof795e742011-10-21 16:05:43 -020030#include "qjson.h"
Kevin Wolf68485422011-06-30 10:05:46 +020031#include "qemu-coroutine.h"
Luiz Capitulinob2023812011-09-21 17:16:47 -030032#include "qmp-commands.h"
Zhi Yong Wu0563e192011-11-03 16:57:25 +080033#include "qemu-timer.h"
bellardfc01f7e2003-06-30 10:03:06 +000034
Juan Quintela71e72a12009-07-27 16:12:56 +020035#ifdef CONFIG_BSD
bellard7674e7b2005-04-26 21:59:26 +000036#include <sys/types.h>
37#include <sys/stat.h>
38#include <sys/ioctl.h>
Blue Swirl72cf2d42009-09-12 07:36:22 +000039#include <sys/queue.h>
blueswir1c5e97232009-03-07 20:06:23 +000040#ifndef __DragonFly__
bellard7674e7b2005-04-26 21:59:26 +000041#include <sys/disk.h>
42#endif
blueswir1c5e97232009-03-07 20:06:23 +000043#endif
bellard7674e7b2005-04-26 21:59:26 +000044
aliguori49dc7682009-03-08 16:26:59 +000045#ifdef _WIN32
46#include <windows.h>
47#endif
48
Stefan Hajnoczi1c9805a2011-10-13 13:08:22 +010049#define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
50
Stefan Hajnoczi470c0502012-01-18 14:40:42 +000051typedef enum {
52 BDRV_REQ_COPY_ON_READ = 0x1,
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +000053 BDRV_REQ_ZERO_WRITE = 0x2,
Stefan Hajnoczi470c0502012-01-18 14:40:42 +000054} BdrvRequestFlags;
55
Markus Armbruster7d4b4ba2011-09-06 18:58:59 +020056static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load);
aliguorif141eaf2009-04-07 18:43:24 +000057static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
58 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
aliguoric87c0672009-04-07 18:43:20 +000059 BlockDriverCompletionFunc *cb, void *opaque);
aliguorif141eaf2009-04-07 18:43:24 +000060static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
61 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
pbrookce1a14d2006-08-07 02:38:06 +000062 BlockDriverCompletionFunc *cb, void *opaque);
Kevin Wolff9f05dc2011-07-15 13:50:26 +020063static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
64 int64_t sector_num, int nb_sectors,
65 QEMUIOVector *iov);
66static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
67 int64_t sector_num, int nb_sectors,
68 QEMUIOVector *iov);
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +010069static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
Stefan Hajnoczi470c0502012-01-18 14:40:42 +000070 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
71 BdrvRequestFlags flags);
Stefan Hajnoczi1c9805a2011-10-13 13:08:22 +010072static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +000073 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
74 BdrvRequestFlags flags);
Stefan Hajnoczib2a61372011-10-13 13:08:23 +010075static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
76 int64_t sector_num,
77 QEMUIOVector *qiov,
78 int nb_sectors,
79 BlockDriverCompletionFunc *cb,
80 void *opaque,
Stefan Hajnoczi8c5873d2011-10-13 21:09:28 +010081 bool is_write);
Stefan Hajnoczib2a61372011-10-13 13:08:23 +010082static void coroutine_fn bdrv_co_do_rw(void *opaque);
bellardec530c82006-04-25 22:36:06 +000083
Zhi Yong Wu98f90db2011-11-08 13:00:14 +080084static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
85 bool is_write, double elapsed_time, uint64_t *wait);
86static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
87 double elapsed_time, uint64_t *wait);
88static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
89 bool is_write, int64_t *wait);
90
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +010091static QTAILQ_HEAD(, BlockDriverState) bdrv_states =
92 QTAILQ_HEAD_INITIALIZER(bdrv_states);
blueswir17ee930d2008-09-17 19:04:14 +000093
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +010094static QLIST_HEAD(, BlockDriver) bdrv_drivers =
95 QLIST_HEAD_INITIALIZER(bdrv_drivers);
bellardea2384d2004-08-01 21:59:26 +000096
Markus Armbrusterf9092b12010-06-25 10:33:39 +020097/* The device to use for VM snapshots */
98static BlockDriverState *bs_snapshots;
99
Markus Armbrustereb852012009-10-27 18:41:44 +0100100/* If non-zero, use only whitelisted block drivers */
101static int use_bdrv_whitelist;
102
Stefan Hajnoczi9e0b22f2010-12-09 11:53:00 +0000103#ifdef _WIN32
104static int is_windows_drive_prefix(const char *filename)
105{
106 return (((filename[0] >= 'a' && filename[0] <= 'z') ||
107 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
108 filename[1] == ':');
109}
110
111int is_windows_drive(const char *filename)
112{
113 if (is_windows_drive_prefix(filename) &&
114 filename[2] == '\0')
115 return 1;
116 if (strstart(filename, "\\\\.\\", NULL) ||
117 strstart(filename, "//./", NULL))
118 return 1;
119 return 0;
120}
121#endif
122
Zhi Yong Wu0563e192011-11-03 16:57:25 +0800123/* throttling disk I/O limits */
Zhi Yong Wu98f90db2011-11-08 13:00:14 +0800124void bdrv_io_limits_disable(BlockDriverState *bs)
125{
126 bs->io_limits_enabled = false;
127
128 while (qemu_co_queue_next(&bs->throttled_reqs));
129
130 if (bs->block_timer) {
131 qemu_del_timer(bs->block_timer);
132 qemu_free_timer(bs->block_timer);
133 bs->block_timer = NULL;
134 }
135
136 bs->slice_start = 0;
137 bs->slice_end = 0;
138 bs->slice_time = 0;
139 memset(&bs->io_base, 0, sizeof(bs->io_base));
140}
141
Zhi Yong Wu0563e192011-11-03 16:57:25 +0800142static void bdrv_block_timer(void *opaque)
143{
144 BlockDriverState *bs = opaque;
145
146 qemu_co_queue_next(&bs->throttled_reqs);
147}
148
149void bdrv_io_limits_enable(BlockDriverState *bs)
150{
151 qemu_co_queue_init(&bs->throttled_reqs);
152 bs->block_timer = qemu_new_timer_ns(vm_clock, bdrv_block_timer, bs);
153 bs->slice_time = 5 * BLOCK_IO_SLICE_TIME;
154 bs->slice_start = qemu_get_clock_ns(vm_clock);
155 bs->slice_end = bs->slice_start + bs->slice_time;
156 memset(&bs->io_base, 0, sizeof(bs->io_base));
157 bs->io_limits_enabled = true;
158}
159
160bool bdrv_io_limits_enabled(BlockDriverState *bs)
161{
162 BlockIOLimit *io_limits = &bs->io_limits;
163 return io_limits->bps[BLOCK_IO_LIMIT_READ]
164 || io_limits->bps[BLOCK_IO_LIMIT_WRITE]
165 || io_limits->bps[BLOCK_IO_LIMIT_TOTAL]
166 || io_limits->iops[BLOCK_IO_LIMIT_READ]
167 || io_limits->iops[BLOCK_IO_LIMIT_WRITE]
168 || io_limits->iops[BLOCK_IO_LIMIT_TOTAL];
169}
170
Zhi Yong Wu98f90db2011-11-08 13:00:14 +0800171static void bdrv_io_limits_intercept(BlockDriverState *bs,
172 bool is_write, int nb_sectors)
173{
174 int64_t wait_time = -1;
175
176 if (!qemu_co_queue_empty(&bs->throttled_reqs)) {
177 qemu_co_queue_wait(&bs->throttled_reqs);
178 }
179
180 /* In fact, we hope to keep each request's timing, in FIFO mode. The next
181 * throttled requests will not be dequeued until the current request is
182 * allowed to be serviced. So if the current request still exceeds the
183 * limits, it will be inserted to the head. All requests followed it will
184 * be still in throttled_reqs queue.
185 */
186
187 while (bdrv_exceed_io_limits(bs, nb_sectors, is_write, &wait_time)) {
188 qemu_mod_timer(bs->block_timer,
189 wait_time + qemu_get_clock_ns(vm_clock));
190 qemu_co_queue_wait_insert_head(&bs->throttled_reqs);
191 }
192
193 qemu_co_queue_next(&bs->throttled_reqs);
194}
195
Stefan Hajnoczi9e0b22f2010-12-09 11:53:00 +0000196/* check if the path starts with "<protocol>:" */
197static int path_has_protocol(const char *path)
198{
199#ifdef _WIN32
200 if (is_windows_drive(path) ||
201 is_windows_drive_prefix(path)) {
202 return 0;
203 }
204#endif
205
206 return strchr(path, ':') != NULL;
207}
208
bellard83f64092006-08-01 16:21:11 +0000209int path_is_absolute(const char *path)
210{
211 const char *p;
bellard21664422007-01-07 18:22:37 +0000212#ifdef _WIN32
213 /* specific case for names like: "\\.\d:" */
214 if (*path == '/' || *path == '\\')
215 return 1;
216#endif
bellard83f64092006-08-01 16:21:11 +0000217 p = strchr(path, ':');
218 if (p)
219 p++;
220 else
221 p = path;
bellard3b9f94e2007-01-07 17:27:07 +0000222#ifdef _WIN32
223 return (*p == '/' || *p == '\\');
224#else
225 return (*p == '/');
226#endif
bellard83f64092006-08-01 16:21:11 +0000227}
228
229/* if filename is absolute, just copy it to dest. Otherwise, build a
230 path to it by considering it is relative to base_path. URL are
231 supported. */
232void path_combine(char *dest, int dest_size,
233 const char *base_path,
234 const char *filename)
235{
236 const char *p, *p1;
237 int len;
238
239 if (dest_size <= 0)
240 return;
241 if (path_is_absolute(filename)) {
242 pstrcpy(dest, dest_size, filename);
243 } else {
244 p = strchr(base_path, ':');
245 if (p)
246 p++;
247 else
248 p = base_path;
bellard3b9f94e2007-01-07 17:27:07 +0000249 p1 = strrchr(base_path, '/');
250#ifdef _WIN32
251 {
252 const char *p2;
253 p2 = strrchr(base_path, '\\');
254 if (!p1 || p2 > p1)
255 p1 = p2;
256 }
257#endif
bellard83f64092006-08-01 16:21:11 +0000258 if (p1)
259 p1++;
260 else
261 p1 = base_path;
262 if (p1 > p)
263 p = p1;
264 len = p - base_path;
265 if (len > dest_size - 1)
266 len = dest_size - 1;
267 memcpy(dest, base_path, len);
268 dest[len] = '\0';
269 pstrcat(dest, dest_size, filename);
270 }
271}
272
Anthony Liguori5efa9d52009-05-09 17:03:42 -0500273void bdrv_register(BlockDriver *bdrv)
bellardea2384d2004-08-01 21:59:26 +0000274{
Stefan Hajnoczi8c5873d2011-10-13 21:09:28 +0100275 /* Block drivers without coroutine functions need emulation */
276 if (!bdrv->bdrv_co_readv) {
Kevin Wolff9f05dc2011-07-15 13:50:26 +0200277 bdrv->bdrv_co_readv = bdrv_co_readv_em;
278 bdrv->bdrv_co_writev = bdrv_co_writev_em;
279
Stefan Hajnoczif8c35c12011-10-13 21:09:31 +0100280 /* bdrv_co_readv_em()/brdv_co_writev_em() work in terms of aio, so if
281 * the block driver lacks aio we need to emulate that too.
282 */
Kevin Wolff9f05dc2011-07-15 13:50:26 +0200283 if (!bdrv->bdrv_aio_readv) {
284 /* add AIO emulation layer */
285 bdrv->bdrv_aio_readv = bdrv_aio_readv_em;
286 bdrv->bdrv_aio_writev = bdrv_aio_writev_em;
Kevin Wolff9f05dc2011-07-15 13:50:26 +0200287 }
bellard83f64092006-08-01 16:21:11 +0000288 }
Christoph Hellwigb2e12bc2009-09-04 19:01:49 +0200289
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +0100290 QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list);
bellardea2384d2004-08-01 21:59:26 +0000291}
bellardb3380822004-03-14 21:38:54 +0000292
293/* create a new block device (by default it is empty) */
294BlockDriverState *bdrv_new(const char *device_name)
bellardfc01f7e2003-06-30 10:03:06 +0000295{
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +0100296 BlockDriverState *bs;
bellardb3380822004-03-14 21:38:54 +0000297
Anthony Liguori7267c092011-08-20 22:09:37 -0500298 bs = g_malloc0(sizeof(BlockDriverState));
bellardb3380822004-03-14 21:38:54 +0000299 pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
bellardea2384d2004-08-01 21:59:26 +0000300 if (device_name[0] != '\0') {
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +0100301 QTAILQ_INSERT_TAIL(&bdrv_states, bs, list);
bellardea2384d2004-08-01 21:59:26 +0000302 }
Luiz Capitulino28a72822011-09-26 17:43:50 -0300303 bdrv_iostatus_disable(bs);
bellardb3380822004-03-14 21:38:54 +0000304 return bs;
305}
306
bellardea2384d2004-08-01 21:59:26 +0000307BlockDriver *bdrv_find_format(const char *format_name)
308{
309 BlockDriver *drv1;
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +0100310 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
311 if (!strcmp(drv1->format_name, format_name)) {
bellardea2384d2004-08-01 21:59:26 +0000312 return drv1;
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +0100313 }
bellardea2384d2004-08-01 21:59:26 +0000314 }
315 return NULL;
316}
317
Markus Armbrustereb852012009-10-27 18:41:44 +0100318static int bdrv_is_whitelisted(BlockDriver *drv)
319{
320 static const char *whitelist[] = {
321 CONFIG_BDRV_WHITELIST
322 };
323 const char **p;
324
325 if (!whitelist[0])
326 return 1; /* no whitelist, anything goes */
327
328 for (p = whitelist; *p; p++) {
329 if (!strcmp(drv->format_name, *p)) {
330 return 1;
331 }
332 }
333 return 0;
334}
335
336BlockDriver *bdrv_find_whitelisted_format(const char *format_name)
337{
338 BlockDriver *drv = bdrv_find_format(format_name);
339 return drv && bdrv_is_whitelisted(drv) ? drv : NULL;
340}
341
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200342int bdrv_create(BlockDriver *drv, const char* filename,
343 QEMUOptionParameter *options)
bellardea2384d2004-08-01 21:59:26 +0000344{
345 if (!drv->bdrv_create)
346 return -ENOTSUP;
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200347
348 return drv->bdrv_create(filename, options);
bellardea2384d2004-08-01 21:59:26 +0000349}
350
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200351int bdrv_create_file(const char* filename, QEMUOptionParameter *options)
352{
353 BlockDriver *drv;
354
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900355 drv = bdrv_find_protocol(filename);
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200356 if (drv == NULL) {
Stefan Hajnoczi16905d72010-11-30 15:14:14 +0000357 return -ENOENT;
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200358 }
359
360 return bdrv_create(drv, filename, options);
361}
362
bellardd5249392004-08-03 21:14:23 +0000363#ifdef _WIN32
bellard95389c82005-12-18 18:28:15 +0000364void get_tmp_filename(char *filename, int size)
bellardd5249392004-08-03 21:14:23 +0000365{
bellard3b9f94e2007-01-07 17:27:07 +0000366 char temp_dir[MAX_PATH];
ths3b46e622007-09-17 08:09:54 +0000367
bellard3b9f94e2007-01-07 17:27:07 +0000368 GetTempPath(MAX_PATH, temp_dir);
369 GetTempFileName(temp_dir, "qem", 0, filename);
bellardd5249392004-08-03 21:14:23 +0000370}
371#else
bellard95389c82005-12-18 18:28:15 +0000372void get_tmp_filename(char *filename, int size)
bellardea2384d2004-08-01 21:59:26 +0000373{
374 int fd;
blueswir17ccfb2e2008-09-14 06:45:34 +0000375 const char *tmpdir;
bellardd5249392004-08-03 21:14:23 +0000376 /* XXX: race condition possible */
aurel320badc1e2008-03-10 00:05:34 +0000377 tmpdir = getenv("TMPDIR");
378 if (!tmpdir)
379 tmpdir = "/tmp";
380 snprintf(filename, size, "%s/vl.XXXXXX", tmpdir);
bellardea2384d2004-08-01 21:59:26 +0000381 fd = mkstemp(filename);
382 close(fd);
383}
bellardd5249392004-08-03 21:14:23 +0000384#endif
bellardea2384d2004-08-01 21:59:26 +0000385
Christoph Hellwigf3a5d3f2009-06-15 13:55:19 +0200386/*
387 * Detect host devices. By convention, /dev/cdrom[N] is always
388 * recognized as a host CDROM.
389 */
Christoph Hellwigf3a5d3f2009-06-15 13:55:19 +0200390static BlockDriver *find_hdev_driver(const char *filename)
391{
Christoph Hellwig508c7cb2009-06-15 14:04:22 +0200392 int score_max = 0, score;
393 BlockDriver *drv = NULL, *d;
Christoph Hellwigf3a5d3f2009-06-15 13:55:19 +0200394
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +0100395 QLIST_FOREACH(d, &bdrv_drivers, list) {
Christoph Hellwig508c7cb2009-06-15 14:04:22 +0200396 if (d->bdrv_probe_device) {
397 score = d->bdrv_probe_device(filename);
398 if (score > score_max) {
399 score_max = score;
400 drv = d;
401 }
402 }
Christoph Hellwigf3a5d3f2009-06-15 13:55:19 +0200403 }
404
Christoph Hellwig508c7cb2009-06-15 14:04:22 +0200405 return drv;
Christoph Hellwigf3a5d3f2009-06-15 13:55:19 +0200406}
Christoph Hellwigf3a5d3f2009-06-15 13:55:19 +0200407
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900408BlockDriver *bdrv_find_protocol(const char *filename)
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200409{
410 BlockDriver *drv1;
411 char protocol[128];
412 int len;
413 const char *p;
414
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200415 /* TODO Drivers without bdrv_file_open must be specified explicitly */
416
Christoph Hellwig39508e72010-06-23 12:25:17 +0200417 /*
418 * XXX(hch): we really should not let host device detection
419 * override an explicit protocol specification, but moving this
420 * later breaks access to device names with colons in them.
421 * Thanks to the brain-dead persistent naming schemes on udev-
422 * based Linux systems those actually are quite common.
423 */
424 drv1 = find_hdev_driver(filename);
425 if (drv1) {
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200426 return drv1;
427 }
Christoph Hellwig39508e72010-06-23 12:25:17 +0200428
Stefan Hajnoczi9e0b22f2010-12-09 11:53:00 +0000429 if (!path_has_protocol(filename)) {
Christoph Hellwig39508e72010-06-23 12:25:17 +0200430 return bdrv_find_format("file");
431 }
Stefan Hajnoczi9e0b22f2010-12-09 11:53:00 +0000432 p = strchr(filename, ':');
433 assert(p != NULL);
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200434 len = p - filename;
435 if (len > sizeof(protocol) - 1)
436 len = sizeof(protocol) - 1;
437 memcpy(protocol, filename, len);
438 protocol[len] = '\0';
439 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
440 if (drv1->protocol_name &&
441 !strcmp(drv1->protocol_name, protocol)) {
442 return drv1;
443 }
444 }
445 return NULL;
446}
447
Stefan Weilc98ac352010-07-21 21:51:51 +0200448static int find_image_format(const char *filename, BlockDriver **pdrv)
bellardea2384d2004-08-01 21:59:26 +0000449{
bellard83f64092006-08-01 16:21:11 +0000450 int ret, score, score_max;
bellardea2384d2004-08-01 21:59:26 +0000451 BlockDriver *drv1, *drv;
bellard83f64092006-08-01 16:21:11 +0000452 uint8_t buf[2048];
453 BlockDriverState *bs;
ths3b46e622007-09-17 08:09:54 +0000454
Naphtali Spreif5edb012010-01-17 16:48:13 +0200455 ret = bdrv_file_open(&bs, filename, 0);
Stefan Weilc98ac352010-07-21 21:51:51 +0200456 if (ret < 0) {
457 *pdrv = NULL;
458 return ret;
459 }
Nicholas Bellingerf8ea0b02010-05-17 09:45:57 -0700460
Kevin Wolf08a00552010-06-01 18:37:31 +0200461 /* Return the raw BlockDriver * to scsi-generic devices or empty drives */
462 if (bs->sg || !bdrv_is_inserted(bs)) {
Nicholas A. Bellinger1a396852010-05-27 08:56:28 -0700463 bdrv_delete(bs);
Stefan Weilc98ac352010-07-21 21:51:51 +0200464 drv = bdrv_find_format("raw");
465 if (!drv) {
466 ret = -ENOENT;
467 }
468 *pdrv = drv;
469 return ret;
Nicholas A. Bellinger1a396852010-05-27 08:56:28 -0700470 }
Nicholas Bellingerf8ea0b02010-05-17 09:45:57 -0700471
bellard83f64092006-08-01 16:21:11 +0000472 ret = bdrv_pread(bs, 0, buf, sizeof(buf));
473 bdrv_delete(bs);
474 if (ret < 0) {
Stefan Weilc98ac352010-07-21 21:51:51 +0200475 *pdrv = NULL;
476 return ret;
bellard83f64092006-08-01 16:21:11 +0000477 }
478
bellardea2384d2004-08-01 21:59:26 +0000479 score_max = 0;
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200480 drv = NULL;
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +0100481 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
bellard83f64092006-08-01 16:21:11 +0000482 if (drv1->bdrv_probe) {
483 score = drv1->bdrv_probe(buf, ret, filename);
484 if (score > score_max) {
485 score_max = score;
486 drv = drv1;
487 }
bellardea2384d2004-08-01 21:59:26 +0000488 }
489 }
Stefan Weilc98ac352010-07-21 21:51:51 +0200490 if (!drv) {
491 ret = -ENOENT;
492 }
493 *pdrv = drv;
494 return ret;
bellardea2384d2004-08-01 21:59:26 +0000495}
496
Stefan Hajnoczi51762282010-04-19 16:56:41 +0100497/**
498 * Set the current 'total_sectors' value
499 */
500static int refresh_total_sectors(BlockDriverState *bs, int64_t hint)
501{
502 BlockDriver *drv = bs->drv;
503
Nicholas Bellinger396759a2010-05-17 09:46:04 -0700504 /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */
505 if (bs->sg)
506 return 0;
507
Stefan Hajnoczi51762282010-04-19 16:56:41 +0100508 /* query actual device if possible, otherwise just trust the hint */
509 if (drv->bdrv_getlength) {
510 int64_t length = drv->bdrv_getlength(bs);
511 if (length < 0) {
512 return length;
513 }
514 hint = length >> BDRV_SECTOR_BITS;
515 }
516
517 bs->total_sectors = hint;
518 return 0;
519}
520
Stefan Hajnoczic3993cd2011-08-04 12:26:51 +0100521/**
522 * Set open flags for a given cache mode
523 *
524 * Return 0 on success, -1 if the cache mode was invalid.
525 */
526int bdrv_parse_cache_flags(const char *mode, int *flags)
527{
528 *flags &= ~BDRV_O_CACHE_MASK;
529
530 if (!strcmp(mode, "off") || !strcmp(mode, "none")) {
531 *flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB;
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100532 } else if (!strcmp(mode, "directsync")) {
533 *flags |= BDRV_O_NOCACHE;
Stefan Hajnoczic3993cd2011-08-04 12:26:51 +0100534 } else if (!strcmp(mode, "writeback")) {
535 *flags |= BDRV_O_CACHE_WB;
536 } else if (!strcmp(mode, "unsafe")) {
537 *flags |= BDRV_O_CACHE_WB;
538 *flags |= BDRV_O_NO_FLUSH;
539 } else if (!strcmp(mode, "writethrough")) {
540 /* this is the default */
541 } else {
542 return -1;
543 }
544
545 return 0;
546}
547
Stefan Hajnoczi53fec9d2011-11-28 16:08:47 +0000548/**
549 * The copy-on-read flag is actually a reference count so multiple users may
550 * use the feature without worrying about clobbering its previous state.
551 * Copy-on-read stays enabled until all users have called to disable it.
552 */
553void bdrv_enable_copy_on_read(BlockDriverState *bs)
554{
555 bs->copy_on_read++;
556}
557
558void bdrv_disable_copy_on_read(BlockDriverState *bs)
559{
560 assert(bs->copy_on_read > 0);
561 bs->copy_on_read--;
562}
563
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200564/*
Kevin Wolf57915332010-04-14 15:24:50 +0200565 * Common part for opening disk images and files
566 */
567static int bdrv_open_common(BlockDriverState *bs, const char *filename,
568 int flags, BlockDriver *drv)
569{
570 int ret, open_flags;
571
572 assert(drv != NULL);
573
Stefan Hajnoczi28dcee12011-09-22 20:14:12 +0100574 trace_bdrv_open_common(bs, filename, flags, drv->format_name);
575
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200576 bs->file = NULL;
Stefan Hajnoczi51762282010-04-19 16:56:41 +0100577 bs->total_sectors = 0;
Kevin Wolf57915332010-04-14 15:24:50 +0200578 bs->encrypted = 0;
579 bs->valid_key = 0;
Stefan Hajnoczi03f541b2011-10-27 10:54:28 +0100580 bs->sg = 0;
Kevin Wolf57915332010-04-14 15:24:50 +0200581 bs->open_flags = flags;
Stefan Hajnoczi03f541b2011-10-27 10:54:28 +0100582 bs->growable = 0;
Kevin Wolf57915332010-04-14 15:24:50 +0200583 bs->buffer_alignment = 512;
584
Stefan Hajnoczi53fec9d2011-11-28 16:08:47 +0000585 assert(bs->copy_on_read == 0); /* bdrv_new() and bdrv_close() make it so */
586 if ((flags & BDRV_O_RDWR) && (flags & BDRV_O_COPY_ON_READ)) {
587 bdrv_enable_copy_on_read(bs);
588 }
589
Kevin Wolf57915332010-04-14 15:24:50 +0200590 pstrcpy(bs->filename, sizeof(bs->filename), filename);
Stefan Hajnoczi03f541b2011-10-27 10:54:28 +0100591 bs->backing_file[0] = '\0';
Kevin Wolf57915332010-04-14 15:24:50 +0200592
593 if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv)) {
594 return -ENOTSUP;
595 }
596
597 bs->drv = drv;
Anthony Liguori7267c092011-08-20 22:09:37 -0500598 bs->opaque = g_malloc0(drv->instance_size);
Kevin Wolf57915332010-04-14 15:24:50 +0200599
Stefan Hajnoczi03f541b2011-10-27 10:54:28 +0100600 bs->enable_write_cache = !!(flags & BDRV_O_CACHE_WB);
Kevin Wolf57915332010-04-14 15:24:50 +0200601
602 /*
603 * Clear flags that are internal to the block layer before opening the
604 * image.
605 */
606 open_flags = flags & ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
607
608 /*
Stefan Weilebabb672011-04-26 10:29:36 +0200609 * Snapshots should be writable.
Kevin Wolf57915332010-04-14 15:24:50 +0200610 */
611 if (bs->is_temporary) {
612 open_flags |= BDRV_O_RDWR;
613 }
614
Stefan Hajnoczie7c63792011-10-27 10:54:27 +0100615 bs->keep_read_only = bs->read_only = !(open_flags & BDRV_O_RDWR);
616
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200617 /* Open the image, either directly or using a protocol */
618 if (drv->bdrv_file_open) {
619 ret = drv->bdrv_file_open(bs, filename, open_flags);
620 } else {
621 ret = bdrv_file_open(&bs->file, filename, open_flags);
622 if (ret >= 0) {
623 ret = drv->bdrv_open(bs, open_flags);
624 }
625 }
626
Kevin Wolf57915332010-04-14 15:24:50 +0200627 if (ret < 0) {
628 goto free_and_fail;
629 }
630
Stefan Hajnoczi51762282010-04-19 16:56:41 +0100631 ret = refresh_total_sectors(bs, bs->total_sectors);
632 if (ret < 0) {
633 goto free_and_fail;
Kevin Wolf57915332010-04-14 15:24:50 +0200634 }
Stefan Hajnoczi51762282010-04-19 16:56:41 +0100635
Kevin Wolf57915332010-04-14 15:24:50 +0200636#ifndef _WIN32
637 if (bs->is_temporary) {
638 unlink(filename);
639 }
640#endif
641 return 0;
642
643free_and_fail:
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200644 if (bs->file) {
645 bdrv_delete(bs->file);
646 bs->file = NULL;
647 }
Anthony Liguori7267c092011-08-20 22:09:37 -0500648 g_free(bs->opaque);
Kevin Wolf57915332010-04-14 15:24:50 +0200649 bs->opaque = NULL;
650 bs->drv = NULL;
651 return ret;
652}
653
654/*
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200655 * Opens a file using a protocol (file, host_device, nbd, ...)
656 */
bellard83f64092006-08-01 16:21:11 +0000657int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags)
bellardb3380822004-03-14 21:38:54 +0000658{
bellard83f64092006-08-01 16:21:11 +0000659 BlockDriverState *bs;
Christoph Hellwig6db95602010-04-05 16:53:57 +0200660 BlockDriver *drv;
bellard83f64092006-08-01 16:21:11 +0000661 int ret;
662
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900663 drv = bdrv_find_protocol(filename);
Christoph Hellwig6db95602010-04-05 16:53:57 +0200664 if (!drv) {
665 return -ENOENT;
666 }
667
bellard83f64092006-08-01 16:21:11 +0000668 bs = bdrv_new("");
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200669 ret = bdrv_open_common(bs, filename, flags, drv);
bellard83f64092006-08-01 16:21:11 +0000670 if (ret < 0) {
671 bdrv_delete(bs);
672 return ret;
bellard3b0d4f62005-10-30 18:30:10 +0000673 }
aliguori71d07702009-03-03 17:37:16 +0000674 bs->growable = 1;
bellard83f64092006-08-01 16:21:11 +0000675 *pbs = bs;
676 return 0;
bellardea2384d2004-08-01 21:59:26 +0000677}
bellardfc01f7e2003-06-30 10:03:06 +0000678
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200679/*
680 * Opens a disk image (raw, qcow2, vmdk, ...)
681 */
Kevin Wolfd6e90982010-03-31 14:40:27 +0200682int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
683 BlockDriver *drv)
bellardea2384d2004-08-01 21:59:26 +0000684{
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200685 int ret;
Kevin Wolf2b572812011-10-26 11:03:01 +0200686 char tmp_filename[PATH_MAX];
bellard712e7872005-04-28 21:09:32 +0000687
bellard83f64092006-08-01 16:21:11 +0000688 if (flags & BDRV_O_SNAPSHOT) {
bellardea2384d2004-08-01 21:59:26 +0000689 BlockDriverState *bs1;
690 int64_t total_size;
aliguori7c96d462008-09-12 17:54:13 +0000691 int is_protocol = 0;
Kevin Wolf91a073a2009-05-27 14:48:06 +0200692 BlockDriver *bdrv_qcow2;
693 QEMUOptionParameter *options;
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200694 char backing_filename[PATH_MAX];
ths3b46e622007-09-17 08:09:54 +0000695
bellardea2384d2004-08-01 21:59:26 +0000696 /* if snapshot, we create a temporary backing file and open it
697 instead of opening 'filename' directly */
698
699 /* if there is a backing file, use it */
700 bs1 = bdrv_new("");
Kevin Wolfd6e90982010-03-31 14:40:27 +0200701 ret = bdrv_open(bs1, filename, 0, drv);
aliguori51d7c002009-03-05 23:00:29 +0000702 if (ret < 0) {
bellardea2384d2004-08-01 21:59:26 +0000703 bdrv_delete(bs1);
aliguori51d7c002009-03-05 23:00:29 +0000704 return ret;
bellardea2384d2004-08-01 21:59:26 +0000705 }
Jes Sorensen3e829902010-05-27 16:20:30 +0200706 total_size = bdrv_getlength(bs1) & BDRV_SECTOR_MASK;
aliguori7c96d462008-09-12 17:54:13 +0000707
708 if (bs1->drv && bs1->drv->protocol_name)
709 is_protocol = 1;
710
bellardea2384d2004-08-01 21:59:26 +0000711 bdrv_delete(bs1);
ths3b46e622007-09-17 08:09:54 +0000712
bellardea2384d2004-08-01 21:59:26 +0000713 get_tmp_filename(tmp_filename, sizeof(tmp_filename));
aliguori7c96d462008-09-12 17:54:13 +0000714
715 /* Real path is meaningless for protocols */
716 if (is_protocol)
717 snprintf(backing_filename, sizeof(backing_filename),
718 "%s", filename);
Kirill A. Shutemov114cdfa2009-12-25 18:19:22 +0000719 else if (!realpath(filename, backing_filename))
720 return -errno;
aliguori7c96d462008-09-12 17:54:13 +0000721
Kevin Wolf91a073a2009-05-27 14:48:06 +0200722 bdrv_qcow2 = bdrv_find_format("qcow2");
723 options = parse_option_parameters("", bdrv_qcow2->create_options, NULL);
724
Jes Sorensen3e829902010-05-27 16:20:30 +0200725 set_option_parameter_int(options, BLOCK_OPT_SIZE, total_size);
Kevin Wolf91a073a2009-05-27 14:48:06 +0200726 set_option_parameter(options, BLOCK_OPT_BACKING_FILE, backing_filename);
727 if (drv) {
728 set_option_parameter(options, BLOCK_OPT_BACKING_FMT,
729 drv->format_name);
730 }
731
732 ret = bdrv_create(bdrv_qcow2, tmp_filename, options);
Jan Kiszkad7487682010-04-29 18:24:50 +0200733 free_option_parameters(options);
aliguori51d7c002009-03-05 23:00:29 +0000734 if (ret < 0) {
735 return ret;
bellardea2384d2004-08-01 21:59:26 +0000736 }
Kevin Wolf91a073a2009-05-27 14:48:06 +0200737
bellardea2384d2004-08-01 21:59:26 +0000738 filename = tmp_filename;
Kevin Wolf91a073a2009-05-27 14:48:06 +0200739 drv = bdrv_qcow2;
bellardea2384d2004-08-01 21:59:26 +0000740 bs->is_temporary = 1;
741 }
bellard712e7872005-04-28 21:09:32 +0000742
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200743 /* Find the right image format driver */
Christoph Hellwig6db95602010-04-05 16:53:57 +0200744 if (!drv) {
Stefan Weilc98ac352010-07-21 21:51:51 +0200745 ret = find_image_format(filename, &drv);
aliguori51d7c002009-03-05 23:00:29 +0000746 }
Christoph Hellwig69873072010-01-20 18:13:25 +0100747
aliguori51d7c002009-03-05 23:00:29 +0000748 if (!drv) {
aliguori51d7c002009-03-05 23:00:29 +0000749 goto unlink_and_fail;
bellardea2384d2004-08-01 21:59:26 +0000750 }
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200751
752 /* Open the image */
753 ret = bdrv_open_common(bs, filename, flags, drv);
754 if (ret < 0) {
Christoph Hellwig69873072010-01-20 18:13:25 +0100755 goto unlink_and_fail;
756 }
757
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200758 /* If there is a backing file, use it */
759 if ((flags & BDRV_O_NO_BACKING) == 0 && bs->backing_file[0] != '\0') {
760 char backing_filename[PATH_MAX];
761 int back_flags;
762 BlockDriver *back_drv = NULL;
763
764 bs->backing_hd = bdrv_new("");
Stefan Hajnoczidf2dbb42010-12-02 16:54:13 +0000765
766 if (path_has_protocol(bs->backing_file)) {
767 pstrcpy(backing_filename, sizeof(backing_filename),
768 bs->backing_file);
769 } else {
770 path_combine(backing_filename, sizeof(backing_filename),
771 filename, bs->backing_file);
772 }
773
774 if (bs->backing_format[0] != '\0') {
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200775 back_drv = bdrv_find_format(bs->backing_format);
Stefan Hajnoczidf2dbb42010-12-02 16:54:13 +0000776 }
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200777
778 /* backing files always opened read-only */
779 back_flags =
780 flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
781
782 ret = bdrv_open(bs->backing_hd, backing_filename, back_flags, back_drv);
783 if (ret < 0) {
784 bdrv_close(bs);
785 return ret;
786 }
787 if (bs->is_temporary) {
788 bs->backing_hd->keep_read_only = !(flags & BDRV_O_RDWR);
789 } else {
790 /* base image inherits from "parent" */
791 bs->backing_hd->keep_read_only = bs->keep_read_only;
792 }
793 }
794
795 if (!bdrv_key_required(bs)) {
Markus Armbruster7d4b4ba2011-09-06 18:58:59 +0200796 bdrv_dev_change_media_cb(bs, true);
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200797 }
798
Zhi Yong Wu98f90db2011-11-08 13:00:14 +0800799 /* throttling disk I/O limits */
800 if (bs->io_limits_enabled) {
801 bdrv_io_limits_enable(bs);
802 }
803
Kevin Wolfb6ce07a2010-04-12 16:37:13 +0200804 return 0;
805
806unlink_and_fail:
807 if (bs->is_temporary) {
808 unlink(filename);
809 }
810 return ret;
811}
812
bellardfc01f7e2003-06-30 10:03:06 +0000813void bdrv_close(BlockDriverState *bs)
814{
bellard19cb3732006-08-19 11:45:59 +0000815 if (bs->drv) {
Markus Armbrusterf9092b12010-06-25 10:33:39 +0200816 if (bs == bs_snapshots) {
817 bs_snapshots = NULL;
818 }
Stefan Hajnoczi557df6a2010-04-17 10:49:06 +0100819 if (bs->backing_hd) {
bellardea2384d2004-08-01 21:59:26 +0000820 bdrv_delete(bs->backing_hd);
Stefan Hajnoczi557df6a2010-04-17 10:49:06 +0100821 bs->backing_hd = NULL;
822 }
bellardea2384d2004-08-01 21:59:26 +0000823 bs->drv->bdrv_close(bs);
Anthony Liguori7267c092011-08-20 22:09:37 -0500824 g_free(bs->opaque);
bellardea2384d2004-08-01 21:59:26 +0000825#ifdef _WIN32
826 if (bs->is_temporary) {
827 unlink(bs->filename);
828 }
bellard67b915a2004-03-31 23:37:16 +0000829#endif
bellardea2384d2004-08-01 21:59:26 +0000830 bs->opaque = NULL;
831 bs->drv = NULL;
Stefan Hajnoczi53fec9d2011-11-28 16:08:47 +0000832 bs->copy_on_read = 0;
bellardb3380822004-03-14 21:38:54 +0000833
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200834 if (bs->file != NULL) {
835 bdrv_close(bs->file);
836 }
837
Markus Armbruster7d4b4ba2011-09-06 18:58:59 +0200838 bdrv_dev_change_media_cb(bs, false);
bellardb3380822004-03-14 21:38:54 +0000839 }
Zhi Yong Wu98f90db2011-11-08 13:00:14 +0800840
841 /*throttling disk I/O limits*/
842 if (bs->io_limits_enabled) {
843 bdrv_io_limits_disable(bs);
844 }
bellardb3380822004-03-14 21:38:54 +0000845}
846
MORITA Kazutaka2bc93fe2010-05-28 11:44:57 +0900847void bdrv_close_all(void)
848{
849 BlockDriverState *bs;
850
851 QTAILQ_FOREACH(bs, &bdrv_states, list) {
852 bdrv_close(bs);
853 }
854}
855
Stefan Hajnoczi922453b2011-11-30 12:23:43 +0000856/*
857 * Wait for pending requests to complete across all BlockDriverStates
858 *
859 * This function does not flush data to disk, use bdrv_flush_all() for that
860 * after calling this function.
861 */
862void bdrv_drain_all(void)
863{
864 BlockDriverState *bs;
865
866 qemu_aio_flush();
867
868 /* If requests are still pending there is a bug somewhere */
869 QTAILQ_FOREACH(bs, &bdrv_states, list) {
870 assert(QLIST_EMPTY(&bs->tracked_requests));
871 assert(qemu_co_queue_empty(&bs->throttled_reqs));
872 }
873}
874
Ryan Harperd22b2f42011-03-29 20:51:47 -0500875/* make a BlockDriverState anonymous by removing from bdrv_state list.
876 Also, NULL terminate the device_name to prevent double remove */
877void bdrv_make_anon(BlockDriverState *bs)
878{
879 if (bs->device_name[0] != '\0') {
880 QTAILQ_REMOVE(&bdrv_states, bs, list);
881 }
882 bs->device_name[0] = '\0';
883}
884
bellardb3380822004-03-14 21:38:54 +0000885void bdrv_delete(BlockDriverState *bs)
886{
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200887 assert(!bs->dev);
Markus Armbruster18846de2010-06-29 16:58:30 +0200888
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +0100889 /* remove from list, if necessary */
Ryan Harperd22b2f42011-03-29 20:51:47 -0500890 bdrv_make_anon(bs);
aurel3234c6f052008-04-08 19:51:21 +0000891
bellardb3380822004-03-14 21:38:54 +0000892 bdrv_close(bs);
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200893 if (bs->file != NULL) {
894 bdrv_delete(bs->file);
895 }
896
Markus Armbrusterf9092b12010-06-25 10:33:39 +0200897 assert(bs != bs_snapshots);
Anthony Liguori7267c092011-08-20 22:09:37 -0500898 g_free(bs);
bellardfc01f7e2003-06-30 10:03:06 +0000899}
900
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200901int bdrv_attach_dev(BlockDriverState *bs, void *dev)
902/* TODO change to DeviceState *dev when all users are qdevified */
Markus Armbruster18846de2010-06-29 16:58:30 +0200903{
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200904 if (bs->dev) {
Markus Armbruster18846de2010-06-29 16:58:30 +0200905 return -EBUSY;
906 }
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200907 bs->dev = dev;
Luiz Capitulino28a72822011-09-26 17:43:50 -0300908 bdrv_iostatus_reset(bs);
Markus Armbruster18846de2010-06-29 16:58:30 +0200909 return 0;
910}
911
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200912/* TODO qdevified devices don't use this, remove when devices are qdevified */
913void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev)
Markus Armbruster18846de2010-06-29 16:58:30 +0200914{
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200915 if (bdrv_attach_dev(bs, dev) < 0) {
916 abort();
917 }
918}
919
920void bdrv_detach_dev(BlockDriverState *bs, void *dev)
921/* TODO change to DeviceState *dev when all users are qdevified */
922{
923 assert(bs->dev == dev);
924 bs->dev = NULL;
Markus Armbruster0e49de52011-08-03 15:07:41 +0200925 bs->dev_ops = NULL;
926 bs->dev_opaque = NULL;
Markus Armbruster29e05f22011-09-06 18:58:57 +0200927 bs->buffer_alignment = 512;
Markus Armbruster18846de2010-06-29 16:58:30 +0200928}
929
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200930/* TODO change to return DeviceState * when all users are qdevified */
931void *bdrv_get_attached_dev(BlockDriverState *bs)
Markus Armbruster18846de2010-06-29 16:58:30 +0200932{
Markus Armbrusterfa879d62011-08-03 15:07:40 +0200933 return bs->dev;
Markus Armbruster18846de2010-06-29 16:58:30 +0200934}
935
Markus Armbruster0e49de52011-08-03 15:07:41 +0200936void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
937 void *opaque)
938{
939 bs->dev_ops = ops;
940 bs->dev_opaque = opaque;
Markus Armbruster2c6942f2011-09-06 18:58:51 +0200941 if (bdrv_dev_has_removable_media(bs) && bs == bs_snapshots) {
942 bs_snapshots = NULL;
943 }
Markus Armbruster0e49de52011-08-03 15:07:41 +0200944}
945
Luiz Capitulino329c0a42012-01-25 16:59:43 -0200946void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
947 BlockQMPEventAction action, int is_read)
948{
949 QObject *data;
950 const char *action_str;
951
952 switch (action) {
953 case BDRV_ACTION_REPORT:
954 action_str = "report";
955 break;
956 case BDRV_ACTION_IGNORE:
957 action_str = "ignore";
958 break;
959 case BDRV_ACTION_STOP:
960 action_str = "stop";
961 break;
962 default:
963 abort();
964 }
965
966 data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
967 bdrv->device_name,
968 action_str,
969 is_read ? "read" : "write");
970 monitor_protocol_event(QEVENT_BLOCK_IO_ERROR, data);
971
972 qobject_decref(data);
973}
974
Luiz Capitulino6f382ed2012-02-14 13:41:13 -0200975static void bdrv_emit_qmp_eject_event(BlockDriverState *bs, bool ejected)
976{
977 QObject *data;
978
979 data = qobject_from_jsonf("{ 'device': %s, 'tray-open': %i }",
980 bdrv_get_device_name(bs), ejected);
981 monitor_protocol_event(QEVENT_DEVICE_TRAY_MOVED, data);
982
983 qobject_decref(data);
984}
985
Markus Armbruster7d4b4ba2011-09-06 18:58:59 +0200986static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load)
Markus Armbruster0e49de52011-08-03 15:07:41 +0200987{
Markus Armbruster145feb12011-08-03 15:07:42 +0200988 if (bs->dev_ops && bs->dev_ops->change_media_cb) {
Luiz Capitulino6f382ed2012-02-14 13:41:13 -0200989 bool tray_was_closed = !bdrv_dev_is_tray_open(bs);
Markus Armbruster7d4b4ba2011-09-06 18:58:59 +0200990 bs->dev_ops->change_media_cb(bs->dev_opaque, load);
Luiz Capitulino6f382ed2012-02-14 13:41:13 -0200991 if (tray_was_closed) {
992 /* tray open */
993 bdrv_emit_qmp_eject_event(bs, true);
994 }
995 if (load) {
996 /* tray close */
997 bdrv_emit_qmp_eject_event(bs, false);
998 }
Markus Armbruster145feb12011-08-03 15:07:42 +0200999 }
1000}
1001
Markus Armbruster2c6942f2011-09-06 18:58:51 +02001002bool bdrv_dev_has_removable_media(BlockDriverState *bs)
1003{
1004 return !bs->dev || (bs->dev_ops && bs->dev_ops->change_media_cb);
1005}
1006
Paolo Bonzini025ccaa2011-11-07 17:50:13 +01001007void bdrv_dev_eject_request(BlockDriverState *bs, bool force)
1008{
1009 if (bs->dev_ops && bs->dev_ops->eject_request_cb) {
1010 bs->dev_ops->eject_request_cb(bs->dev_opaque, force);
1011 }
1012}
1013
Markus Armbrustere4def802011-09-06 18:58:53 +02001014bool bdrv_dev_is_tray_open(BlockDriverState *bs)
1015{
1016 if (bs->dev_ops && bs->dev_ops->is_tray_open) {
1017 return bs->dev_ops->is_tray_open(bs->dev_opaque);
1018 }
1019 return false;
1020}
1021
Markus Armbruster145feb12011-08-03 15:07:42 +02001022static void bdrv_dev_resize_cb(BlockDriverState *bs)
1023{
1024 if (bs->dev_ops && bs->dev_ops->resize_cb) {
1025 bs->dev_ops->resize_cb(bs->dev_opaque);
Markus Armbruster0e49de52011-08-03 15:07:41 +02001026 }
1027}
1028
Markus Armbrusterf1076392011-09-06 18:58:46 +02001029bool bdrv_dev_is_medium_locked(BlockDriverState *bs)
1030{
1031 if (bs->dev_ops && bs->dev_ops->is_medium_locked) {
1032 return bs->dev_ops->is_medium_locked(bs->dev_opaque);
1033 }
1034 return false;
1035}
1036
aliguorie97fc192009-04-21 23:11:50 +00001037/*
1038 * Run consistency checks on an image
1039 *
Kevin Wolfe076f332010-06-29 11:43:13 +02001040 * Returns 0 if the check could be completed (it doesn't mean that the image is
Stefan Weila1c72732011-04-28 17:20:38 +02001041 * free of errors) or -errno when an internal error occurred. The results of the
Kevin Wolfe076f332010-06-29 11:43:13 +02001042 * check are stored in res.
aliguorie97fc192009-04-21 23:11:50 +00001043 */
Kevin Wolfe076f332010-06-29 11:43:13 +02001044int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res)
aliguorie97fc192009-04-21 23:11:50 +00001045{
1046 if (bs->drv->bdrv_check == NULL) {
1047 return -ENOTSUP;
1048 }
1049
Kevin Wolfe076f332010-06-29 11:43:13 +02001050 memset(res, 0, sizeof(*res));
Kevin Wolf9ac228e2010-06-29 12:37:54 +02001051 return bs->drv->bdrv_check(bs, res);
aliguorie97fc192009-04-21 23:11:50 +00001052}
1053
Kevin Wolf8a426612010-07-16 17:17:01 +02001054#define COMMIT_BUF_SECTORS 2048
1055
bellard33e39632003-07-06 17:15:21 +00001056/* commit COW file into the raw image */
1057int bdrv_commit(BlockDriverState *bs)
1058{
bellard19cb3732006-08-19 11:45:59 +00001059 BlockDriver *drv = bs->drv;
Kevin Wolfee181192010-08-05 13:05:22 +02001060 BlockDriver *backing_drv;
Kevin Wolf8a426612010-07-16 17:17:01 +02001061 int64_t sector, total_sectors;
1062 int n, ro, open_flags;
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001063 int ret = 0, rw_ret = 0;
Kevin Wolf8a426612010-07-16 17:17:01 +02001064 uint8_t *buf;
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001065 char filename[1024];
1066 BlockDriverState *bs_rw, *bs_ro;
bellard33e39632003-07-06 17:15:21 +00001067
bellard19cb3732006-08-19 11:45:59 +00001068 if (!drv)
1069 return -ENOMEDIUM;
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001070
1071 if (!bs->backing_hd) {
1072 return -ENOTSUP;
bellard33e39632003-07-06 17:15:21 +00001073 }
1074
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001075 if (bs->backing_hd->keep_read_only) {
1076 return -EACCES;
1077 }
Kevin Wolfee181192010-08-05 13:05:22 +02001078
Stefan Hajnoczi2d3735d2012-01-18 14:40:41 +00001079 if (bdrv_in_use(bs) || bdrv_in_use(bs->backing_hd)) {
1080 return -EBUSY;
1081 }
1082
Kevin Wolfee181192010-08-05 13:05:22 +02001083 backing_drv = bs->backing_hd->drv;
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001084 ro = bs->backing_hd->read_only;
1085 strncpy(filename, bs->backing_hd->filename, sizeof(filename));
1086 open_flags = bs->backing_hd->open_flags;
1087
1088 if (ro) {
1089 /* re-open as RW */
1090 bdrv_delete(bs->backing_hd);
1091 bs->backing_hd = NULL;
1092 bs_rw = bdrv_new("");
Kevin Wolfee181192010-08-05 13:05:22 +02001093 rw_ret = bdrv_open(bs_rw, filename, open_flags | BDRV_O_RDWR,
1094 backing_drv);
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001095 if (rw_ret < 0) {
1096 bdrv_delete(bs_rw);
1097 /* try to re-open read-only */
1098 bs_ro = bdrv_new("");
Kevin Wolfee181192010-08-05 13:05:22 +02001099 ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR,
1100 backing_drv);
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001101 if (ret < 0) {
1102 bdrv_delete(bs_ro);
1103 /* drive not functional anymore */
1104 bs->drv = NULL;
1105 return ret;
1106 }
1107 bs->backing_hd = bs_ro;
1108 return rw_ret;
1109 }
1110 bs->backing_hd = bs_rw;
bellard33e39632003-07-06 17:15:21 +00001111 }
bellardea2384d2004-08-01 21:59:26 +00001112
Jan Kiszka6ea44302009-11-30 18:21:19 +01001113 total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
Anthony Liguori7267c092011-08-20 22:09:37 -05001114 buf = g_malloc(COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE);
bellardea2384d2004-08-01 21:59:26 +00001115
Kevin Wolf8a426612010-07-16 17:17:01 +02001116 for (sector = 0; sector < total_sectors; sector += n) {
Stefan Hajnoczi05c4af52011-11-14 12:44:18 +00001117 if (bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n)) {
Kevin Wolf8a426612010-07-16 17:17:01 +02001118
1119 if (bdrv_read(bs, sector, buf, n) != 0) {
1120 ret = -EIO;
1121 goto ro_cleanup;
1122 }
1123
1124 if (bdrv_write(bs->backing_hd, sector, buf, n) != 0) {
1125 ret = -EIO;
1126 goto ro_cleanup;
1127 }
bellardea2384d2004-08-01 21:59:26 +00001128 }
1129 }
bellard95389c82005-12-18 18:28:15 +00001130
Christoph Hellwig1d449522010-01-17 12:32:30 +01001131 if (drv->bdrv_make_empty) {
1132 ret = drv->bdrv_make_empty(bs);
1133 bdrv_flush(bs);
1134 }
bellard95389c82005-12-18 18:28:15 +00001135
Christoph Hellwig3f5075a2010-01-12 13:49:23 +01001136 /*
1137 * Make sure all data we wrote to the backing device is actually
1138 * stable on disk.
1139 */
1140 if (bs->backing_hd)
1141 bdrv_flush(bs->backing_hd);
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001142
1143ro_cleanup:
Anthony Liguori7267c092011-08-20 22:09:37 -05001144 g_free(buf);
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001145
1146 if (ro) {
1147 /* re-open as RO */
1148 bdrv_delete(bs->backing_hd);
1149 bs->backing_hd = NULL;
1150 bs_ro = bdrv_new("");
Kevin Wolfee181192010-08-05 13:05:22 +02001151 ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR,
1152 backing_drv);
Naphtali Sprei4dca4b62010-02-14 13:39:18 +02001153 if (ret < 0) {
1154 bdrv_delete(bs_ro);
1155 /* drive not functional anymore */
1156 bs->drv = NULL;
1157 return ret;
1158 }
1159 bs->backing_hd = bs_ro;
1160 bs->backing_hd->keep_read_only = 0;
1161 }
1162
Christoph Hellwig1d449522010-01-17 12:32:30 +01001163 return ret;
bellard33e39632003-07-06 17:15:21 +00001164}
1165
Markus Armbruster6ab4b5a2010-06-02 18:55:18 +02001166void bdrv_commit_all(void)
1167{
1168 BlockDriverState *bs;
1169
1170 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1171 bdrv_commit(bs);
1172 }
1173}
1174
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001175struct BdrvTrackedRequest {
1176 BlockDriverState *bs;
1177 int64_t sector_num;
1178 int nb_sectors;
1179 bool is_write;
1180 QLIST_ENTRY(BdrvTrackedRequest) list;
Stefan Hajnoczi5f8b6492011-11-30 12:23:42 +00001181 Coroutine *co; /* owner, used for deadlock detection */
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001182 CoQueue wait_queue; /* coroutines blocked on this request */
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001183};
1184
1185/**
1186 * Remove an active request from the tracked requests list
1187 *
1188 * This function should be called when a tracked request is completing.
1189 */
1190static void tracked_request_end(BdrvTrackedRequest *req)
1191{
1192 QLIST_REMOVE(req, list);
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001193 qemu_co_queue_restart_all(&req->wait_queue);
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001194}
1195
1196/**
1197 * Add an active request to the tracked requests list
1198 */
1199static void tracked_request_begin(BdrvTrackedRequest *req,
1200 BlockDriverState *bs,
1201 int64_t sector_num,
1202 int nb_sectors, bool is_write)
1203{
1204 *req = (BdrvTrackedRequest){
1205 .bs = bs,
1206 .sector_num = sector_num,
1207 .nb_sectors = nb_sectors,
1208 .is_write = is_write,
Stefan Hajnoczi5f8b6492011-11-30 12:23:42 +00001209 .co = qemu_coroutine_self(),
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001210 };
1211
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001212 qemu_co_queue_init(&req->wait_queue);
1213
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001214 QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
1215}
1216
Stefan Hajnoczid83947a2011-11-23 11:47:56 +00001217/**
1218 * Round a region to cluster boundaries
1219 */
1220static void round_to_clusters(BlockDriverState *bs,
1221 int64_t sector_num, int nb_sectors,
1222 int64_t *cluster_sector_num,
1223 int *cluster_nb_sectors)
1224{
1225 BlockDriverInfo bdi;
1226
1227 if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
1228 *cluster_sector_num = sector_num;
1229 *cluster_nb_sectors = nb_sectors;
1230 } else {
1231 int64_t c = bdi.cluster_size / BDRV_SECTOR_SIZE;
1232 *cluster_sector_num = QEMU_ALIGN_DOWN(sector_num, c);
1233 *cluster_nb_sectors = QEMU_ALIGN_UP(sector_num - *cluster_sector_num +
1234 nb_sectors, c);
1235 }
1236}
1237
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001238static bool tracked_request_overlaps(BdrvTrackedRequest *req,
1239 int64_t sector_num, int nb_sectors) {
Stefan Hajnoczid83947a2011-11-23 11:47:56 +00001240 /* aaaa bbbb */
1241 if (sector_num >= req->sector_num + req->nb_sectors) {
1242 return false;
1243 }
1244 /* bbbb aaaa */
1245 if (req->sector_num >= sector_num + nb_sectors) {
1246 return false;
1247 }
1248 return true;
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001249}
1250
1251static void coroutine_fn wait_for_overlapping_requests(BlockDriverState *bs,
1252 int64_t sector_num, int nb_sectors)
1253{
1254 BdrvTrackedRequest *req;
Stefan Hajnoczid83947a2011-11-23 11:47:56 +00001255 int64_t cluster_sector_num;
1256 int cluster_nb_sectors;
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001257 bool retry;
1258
Stefan Hajnoczid83947a2011-11-23 11:47:56 +00001259 /* If we touch the same cluster it counts as an overlap. This guarantees
1260 * that allocating writes will be serialized and not race with each other
1261 * for the same cluster. For example, in copy-on-read it ensures that the
1262 * CoR read and write operations are atomic and guest writes cannot
1263 * interleave between them.
1264 */
1265 round_to_clusters(bs, sector_num, nb_sectors,
1266 &cluster_sector_num, &cluster_nb_sectors);
1267
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001268 do {
1269 retry = false;
1270 QLIST_FOREACH(req, &bs->tracked_requests, list) {
Stefan Hajnoczid83947a2011-11-23 11:47:56 +00001271 if (tracked_request_overlaps(req, cluster_sector_num,
1272 cluster_nb_sectors)) {
Stefan Hajnoczi5f8b6492011-11-30 12:23:42 +00001273 /* Hitting this means there was a reentrant request, for
1274 * example, a block driver issuing nested requests. This must
1275 * never happen since it means deadlock.
1276 */
1277 assert(qemu_coroutine_self() != req->co);
1278
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001279 qemu_co_queue_wait(&req->wait_queue);
1280 retry = true;
1281 break;
1282 }
1283 }
1284 } while (retry);
1285}
1286
Kevin Wolf756e6732010-01-12 12:55:17 +01001287/*
1288 * Return values:
1289 * 0 - success
1290 * -EINVAL - backing format specified, but no file
1291 * -ENOSPC - can't update the backing file because no space is left in the
1292 * image file header
1293 * -ENOTSUP - format driver doesn't support changing the backing file
1294 */
1295int bdrv_change_backing_file(BlockDriverState *bs,
1296 const char *backing_file, const char *backing_fmt)
1297{
1298 BlockDriver *drv = bs->drv;
1299
1300 if (drv->bdrv_change_backing_file != NULL) {
1301 return drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
1302 } else {
1303 return -ENOTSUP;
1304 }
1305}
1306
aliguori71d07702009-03-03 17:37:16 +00001307static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
1308 size_t size)
1309{
1310 int64_t len;
1311
1312 if (!bdrv_is_inserted(bs))
1313 return -ENOMEDIUM;
1314
1315 if (bs->growable)
1316 return 0;
1317
1318 len = bdrv_getlength(bs);
1319
Kevin Wolffbb7b4e2009-05-08 14:47:24 +02001320 if (offset < 0)
1321 return -EIO;
1322
1323 if ((offset > len) || (len - offset < size))
aliguori71d07702009-03-03 17:37:16 +00001324 return -EIO;
1325
1326 return 0;
1327}
1328
1329static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
1330 int nb_sectors)
1331{
Jes Sorenseneb5a3162010-05-27 16:20:31 +02001332 return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
1333 nb_sectors * BDRV_SECTOR_SIZE);
aliguori71d07702009-03-03 17:37:16 +00001334}
1335
Stefan Hajnoczi1c9805a2011-10-13 13:08:22 +01001336typedef struct RwCo {
1337 BlockDriverState *bs;
1338 int64_t sector_num;
1339 int nb_sectors;
1340 QEMUIOVector *qiov;
1341 bool is_write;
1342 int ret;
1343} RwCo;
1344
1345static void coroutine_fn bdrv_rw_co_entry(void *opaque)
1346{
1347 RwCo *rwco = opaque;
1348
1349 if (!rwco->is_write) {
1350 rwco->ret = bdrv_co_do_readv(rwco->bs, rwco->sector_num,
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001351 rwco->nb_sectors, rwco->qiov, 0);
Stefan Hajnoczi1c9805a2011-10-13 13:08:22 +01001352 } else {
1353 rwco->ret = bdrv_co_do_writev(rwco->bs, rwco->sector_num,
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +00001354 rwco->nb_sectors, rwco->qiov, 0);
Stefan Hajnoczi1c9805a2011-10-13 13:08:22 +01001355 }
1356}
1357
1358/*
1359 * Process a synchronous request using coroutines
1360 */
1361static int bdrv_rw_co(BlockDriverState *bs, int64_t sector_num, uint8_t *buf,
1362 int nb_sectors, bool is_write)
1363{
1364 QEMUIOVector qiov;
1365 struct iovec iov = {
1366 .iov_base = (void *)buf,
1367 .iov_len = nb_sectors * BDRV_SECTOR_SIZE,
1368 };
1369 Coroutine *co;
1370 RwCo rwco = {
1371 .bs = bs,
1372 .sector_num = sector_num,
1373 .nb_sectors = nb_sectors,
1374 .qiov = &qiov,
1375 .is_write = is_write,
1376 .ret = NOT_DONE,
1377 };
1378
1379 qemu_iovec_init_external(&qiov, &iov, 1);
1380
1381 if (qemu_in_coroutine()) {
1382 /* Fast-path if already in coroutine context */
1383 bdrv_rw_co_entry(&rwco);
1384 } else {
1385 co = qemu_coroutine_create(bdrv_rw_co_entry);
1386 qemu_coroutine_enter(co, &rwco);
1387 while (rwco.ret == NOT_DONE) {
1388 qemu_aio_wait();
1389 }
1390 }
1391 return rwco.ret;
1392}
1393
bellard19cb3732006-08-19 11:45:59 +00001394/* return < 0 if error. See bdrv_write() for the return codes */
ths5fafdf22007-09-16 21:08:06 +00001395int bdrv_read(BlockDriverState *bs, int64_t sector_num,
bellardfc01f7e2003-06-30 10:03:06 +00001396 uint8_t *buf, int nb_sectors)
1397{
Stefan Hajnoczi1c9805a2011-10-13 13:08:22 +01001398 return bdrv_rw_co(bs, sector_num, buf, nb_sectors, false);
bellardfc01f7e2003-06-30 10:03:06 +00001399}
1400
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02001401static void set_dirty_bitmap(BlockDriverState *bs, int64_t sector_num,
Jan Kiszkaa55eb922009-11-30 18:21:19 +01001402 int nb_sectors, int dirty)
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02001403{
1404 int64_t start, end;
Jan Kiszkac6d22832009-11-30 18:21:20 +01001405 unsigned long val, idx, bit;
Jan Kiszkaa55eb922009-11-30 18:21:19 +01001406
Jan Kiszka6ea44302009-11-30 18:21:19 +01001407 start = sector_num / BDRV_SECTORS_PER_DIRTY_CHUNK;
Jan Kiszkac6d22832009-11-30 18:21:20 +01001408 end = (sector_num + nb_sectors - 1) / BDRV_SECTORS_PER_DIRTY_CHUNK;
Jan Kiszkaa55eb922009-11-30 18:21:19 +01001409
1410 for (; start <= end; start++) {
Jan Kiszkac6d22832009-11-30 18:21:20 +01001411 idx = start / (sizeof(unsigned long) * 8);
1412 bit = start % (sizeof(unsigned long) * 8);
1413 val = bs->dirty_bitmap[idx];
1414 if (dirty) {
Marcelo Tosatti6d59fec2010-11-08 17:02:54 -02001415 if (!(val & (1UL << bit))) {
Liran Schouraaa0eb72010-01-26 10:31:48 +02001416 bs->dirty_count++;
Marcelo Tosatti6d59fec2010-11-08 17:02:54 -02001417 val |= 1UL << bit;
Liran Schouraaa0eb72010-01-26 10:31:48 +02001418 }
Jan Kiszkac6d22832009-11-30 18:21:20 +01001419 } else {
Marcelo Tosatti6d59fec2010-11-08 17:02:54 -02001420 if (val & (1UL << bit)) {
Liran Schouraaa0eb72010-01-26 10:31:48 +02001421 bs->dirty_count--;
Marcelo Tosatti6d59fec2010-11-08 17:02:54 -02001422 val &= ~(1UL << bit);
Liran Schouraaa0eb72010-01-26 10:31:48 +02001423 }
Jan Kiszkac6d22832009-11-30 18:21:20 +01001424 }
1425 bs->dirty_bitmap[idx] = val;
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02001426 }
1427}
1428
ths5fafdf22007-09-16 21:08:06 +00001429/* Return < 0 if error. Important errors are:
bellard19cb3732006-08-19 11:45:59 +00001430 -EIO generic I/O error (may happen for all errors)
1431 -ENOMEDIUM No media inserted.
1432 -EINVAL Invalid sector number or nb_sectors
1433 -EACCES Trying to write a read-only device
1434*/
ths5fafdf22007-09-16 21:08:06 +00001435int bdrv_write(BlockDriverState *bs, int64_t sector_num,
bellardfc01f7e2003-06-30 10:03:06 +00001436 const uint8_t *buf, int nb_sectors)
1437{
Stefan Hajnoczi1c9805a2011-10-13 13:08:22 +01001438 return bdrv_rw_co(bs, sector_num, (uint8_t *)buf, nb_sectors, true);
bellard83f64092006-08-01 16:21:11 +00001439}
1440
aliguorieda578e2009-03-12 19:57:16 +00001441int bdrv_pread(BlockDriverState *bs, int64_t offset,
1442 void *buf, int count1)
bellard83f64092006-08-01 16:21:11 +00001443{
Jan Kiszka6ea44302009-11-30 18:21:19 +01001444 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
bellard83f64092006-08-01 16:21:11 +00001445 int len, nb_sectors, count;
1446 int64_t sector_num;
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001447 int ret;
bellard83f64092006-08-01 16:21:11 +00001448
1449 count = count1;
1450 /* first read to align to sector start */
Jan Kiszka6ea44302009-11-30 18:21:19 +01001451 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
bellard83f64092006-08-01 16:21:11 +00001452 if (len > count)
1453 len = count;
Jan Kiszka6ea44302009-11-30 18:21:19 +01001454 sector_num = offset >> BDRV_SECTOR_BITS;
bellard83f64092006-08-01 16:21:11 +00001455 if (len > 0) {
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001456 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1457 return ret;
Jan Kiszka6ea44302009-11-30 18:21:19 +01001458 memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
bellard83f64092006-08-01 16:21:11 +00001459 count -= len;
1460 if (count == 0)
1461 return count1;
1462 sector_num++;
1463 buf += len;
1464 }
1465
1466 /* read the sectors "in place" */
Jan Kiszka6ea44302009-11-30 18:21:19 +01001467 nb_sectors = count >> BDRV_SECTOR_BITS;
bellard83f64092006-08-01 16:21:11 +00001468 if (nb_sectors > 0) {
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001469 if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
1470 return ret;
bellard83f64092006-08-01 16:21:11 +00001471 sector_num += nb_sectors;
Jan Kiszka6ea44302009-11-30 18:21:19 +01001472 len = nb_sectors << BDRV_SECTOR_BITS;
bellard83f64092006-08-01 16:21:11 +00001473 buf += len;
1474 count -= len;
1475 }
1476
1477 /* add data from the last sector */
1478 if (count > 0) {
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001479 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1480 return ret;
bellard83f64092006-08-01 16:21:11 +00001481 memcpy(buf, tmp_buf, count);
1482 }
1483 return count1;
1484}
1485
aliguorieda578e2009-03-12 19:57:16 +00001486int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
1487 const void *buf, int count1)
bellard83f64092006-08-01 16:21:11 +00001488{
Jan Kiszka6ea44302009-11-30 18:21:19 +01001489 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
bellard83f64092006-08-01 16:21:11 +00001490 int len, nb_sectors, count;
1491 int64_t sector_num;
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001492 int ret;
bellard83f64092006-08-01 16:21:11 +00001493
1494 count = count1;
1495 /* first write to align to sector start */
Jan Kiszka6ea44302009-11-30 18:21:19 +01001496 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
bellard83f64092006-08-01 16:21:11 +00001497 if (len > count)
1498 len = count;
Jan Kiszka6ea44302009-11-30 18:21:19 +01001499 sector_num = offset >> BDRV_SECTOR_BITS;
bellard83f64092006-08-01 16:21:11 +00001500 if (len > 0) {
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001501 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1502 return ret;
Jan Kiszka6ea44302009-11-30 18:21:19 +01001503 memcpy(tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), buf, len);
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001504 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
1505 return ret;
bellard83f64092006-08-01 16:21:11 +00001506 count -= len;
1507 if (count == 0)
1508 return count1;
1509 sector_num++;
1510 buf += len;
1511 }
1512
1513 /* write the sectors "in place" */
Jan Kiszka6ea44302009-11-30 18:21:19 +01001514 nb_sectors = count >> BDRV_SECTOR_BITS;
bellard83f64092006-08-01 16:21:11 +00001515 if (nb_sectors > 0) {
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001516 if ((ret = bdrv_write(bs, sector_num, buf, nb_sectors)) < 0)
1517 return ret;
bellard83f64092006-08-01 16:21:11 +00001518 sector_num += nb_sectors;
Jan Kiszka6ea44302009-11-30 18:21:19 +01001519 len = nb_sectors << BDRV_SECTOR_BITS;
bellard83f64092006-08-01 16:21:11 +00001520 buf += len;
1521 count -= len;
1522 }
1523
1524 /* add data from the last sector */
1525 if (count > 0) {
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001526 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1527 return ret;
bellard83f64092006-08-01 16:21:11 +00001528 memcpy(tmp_buf, buf, count);
Kevin Wolf9a8c4cc2010-01-20 15:03:02 +01001529 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
1530 return ret;
bellard83f64092006-08-01 16:21:11 +00001531 }
1532 return count1;
1533}
bellard83f64092006-08-01 16:21:11 +00001534
Kevin Wolff08145f2010-06-16 16:38:15 +02001535/*
1536 * Writes to the file and ensures that no writes are reordered across this
1537 * request (acts as a barrier)
1538 *
1539 * Returns 0 on success, -errno in error cases.
1540 */
1541int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
1542 const void *buf, int count)
1543{
1544 int ret;
1545
1546 ret = bdrv_pwrite(bs, offset, buf, count);
1547 if (ret < 0) {
1548 return ret;
1549 }
1550
Stefan Hajnoczi92196b22011-08-04 12:26:52 +01001551 /* No flush needed for cache modes that use O_DSYNC */
1552 if ((bs->open_flags & BDRV_O_CACHE_WB) != 0) {
Kevin Wolff08145f2010-06-16 16:38:15 +02001553 bdrv_flush(bs);
1554 }
1555
1556 return 0;
1557}
1558
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001559static int coroutine_fn bdrv_co_do_copy_on_readv(BlockDriverState *bs,
Stefan Hajnocziab185922011-11-17 13:40:31 +00001560 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
1561{
1562 /* Perform I/O through a temporary buffer so that users who scribble over
1563 * their read buffer while the operation is in progress do not end up
1564 * modifying the image file. This is critical for zero-copy guest I/O
1565 * where anything might happen inside guest memory.
1566 */
1567 void *bounce_buffer;
1568
Stefan Hajnoczi79c053b2012-02-07 13:27:26 +00001569 BlockDriver *drv = bs->drv;
Stefan Hajnocziab185922011-11-17 13:40:31 +00001570 struct iovec iov;
1571 QEMUIOVector bounce_qiov;
1572 int64_t cluster_sector_num;
1573 int cluster_nb_sectors;
1574 size_t skip_bytes;
1575 int ret;
1576
1577 /* Cover entire cluster so no additional backing file I/O is required when
1578 * allocating cluster in the image file.
1579 */
1580 round_to_clusters(bs, sector_num, nb_sectors,
1581 &cluster_sector_num, &cluster_nb_sectors);
1582
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001583 trace_bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors,
1584 cluster_sector_num, cluster_nb_sectors);
Stefan Hajnocziab185922011-11-17 13:40:31 +00001585
1586 iov.iov_len = cluster_nb_sectors * BDRV_SECTOR_SIZE;
1587 iov.iov_base = bounce_buffer = qemu_blockalign(bs, iov.iov_len);
1588 qemu_iovec_init_external(&bounce_qiov, &iov, 1);
1589
Stefan Hajnoczi79c053b2012-02-07 13:27:26 +00001590 ret = drv->bdrv_co_readv(bs, cluster_sector_num, cluster_nb_sectors,
1591 &bounce_qiov);
Stefan Hajnocziab185922011-11-17 13:40:31 +00001592 if (ret < 0) {
1593 goto err;
1594 }
1595
Stefan Hajnoczi79c053b2012-02-07 13:27:26 +00001596 if (drv->bdrv_co_write_zeroes &&
1597 buffer_is_zero(bounce_buffer, iov.iov_len)) {
1598 ret = drv->bdrv_co_write_zeroes(bs, cluster_sector_num,
1599 cluster_nb_sectors);
1600 } else {
1601 ret = drv->bdrv_co_writev(bs, cluster_sector_num, cluster_nb_sectors,
Stefan Hajnocziab185922011-11-17 13:40:31 +00001602 &bounce_qiov);
Stefan Hajnoczi79c053b2012-02-07 13:27:26 +00001603 }
1604
Stefan Hajnocziab185922011-11-17 13:40:31 +00001605 if (ret < 0) {
1606 /* It might be okay to ignore write errors for guest requests. If this
1607 * is a deliberate copy-on-read then we don't want to ignore the error.
1608 * Simply report it in all cases.
1609 */
1610 goto err;
1611 }
1612
1613 skip_bytes = (sector_num - cluster_sector_num) * BDRV_SECTOR_SIZE;
1614 qemu_iovec_from_buffer(qiov, bounce_buffer + skip_bytes,
1615 nb_sectors * BDRV_SECTOR_SIZE);
1616
1617err:
1618 qemu_vfree(bounce_buffer);
1619 return ret;
1620}
1621
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +01001622/*
1623 * Handle a read request in coroutine context
1624 */
1625static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001626 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
1627 BdrvRequestFlags flags)
Kevin Wolfda1fa912011-07-14 17:27:13 +02001628{
1629 BlockDriver *drv = bs->drv;
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001630 BdrvTrackedRequest req;
1631 int ret;
Kevin Wolfda1fa912011-07-14 17:27:13 +02001632
Kevin Wolfda1fa912011-07-14 17:27:13 +02001633 if (!drv) {
1634 return -ENOMEDIUM;
1635 }
1636 if (bdrv_check_request(bs, sector_num, nb_sectors)) {
1637 return -EIO;
1638 }
1639
Zhi Yong Wu98f90db2011-11-08 13:00:14 +08001640 /* throttling disk read I/O */
1641 if (bs->io_limits_enabled) {
1642 bdrv_io_limits_intercept(bs, false, nb_sectors);
1643 }
1644
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001645 if (bs->copy_on_read) {
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001646 flags |= BDRV_REQ_COPY_ON_READ;
1647 }
1648 if (flags & BDRV_REQ_COPY_ON_READ) {
1649 bs->copy_on_read_in_flight++;
1650 }
1651
1652 if (bs->copy_on_read_in_flight) {
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001653 wait_for_overlapping_requests(bs, sector_num, nb_sectors);
1654 }
1655
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001656 tracked_request_begin(&req, bs, sector_num, nb_sectors, false);
Stefan Hajnocziab185922011-11-17 13:40:31 +00001657
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001658 if (flags & BDRV_REQ_COPY_ON_READ) {
Stefan Hajnocziab185922011-11-17 13:40:31 +00001659 int pnum;
1660
1661 ret = bdrv_co_is_allocated(bs, sector_num, nb_sectors, &pnum);
1662 if (ret < 0) {
1663 goto out;
1664 }
1665
1666 if (!ret || pnum != nb_sectors) {
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001667 ret = bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors, qiov);
Stefan Hajnocziab185922011-11-17 13:40:31 +00001668 goto out;
1669 }
1670 }
1671
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001672 ret = drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
Stefan Hajnocziab185922011-11-17 13:40:31 +00001673
1674out:
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001675 tracked_request_end(&req);
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001676
1677 if (flags & BDRV_REQ_COPY_ON_READ) {
1678 bs->copy_on_read_in_flight--;
1679 }
1680
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001681 return ret;
Kevin Wolfda1fa912011-07-14 17:27:13 +02001682}
1683
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +01001684int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
Kevin Wolfda1fa912011-07-14 17:27:13 +02001685 int nb_sectors, QEMUIOVector *qiov)
1686{
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +01001687 trace_bdrv_co_readv(bs, sector_num, nb_sectors);
Kevin Wolfda1fa912011-07-14 17:27:13 +02001688
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001689 return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov, 0);
1690}
1691
1692int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
1693 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
1694{
1695 trace_bdrv_co_copy_on_readv(bs, sector_num, nb_sectors);
1696
1697 return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov,
1698 BDRV_REQ_COPY_ON_READ);
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +01001699}
1700
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +00001701static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs,
1702 int64_t sector_num, int nb_sectors)
1703{
1704 BlockDriver *drv = bs->drv;
1705 QEMUIOVector qiov;
1706 struct iovec iov;
1707 int ret;
1708
1709 /* First try the efficient write zeroes operation */
1710 if (drv->bdrv_co_write_zeroes) {
1711 return drv->bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
1712 }
1713
1714 /* Fall back to bounce buffer if write zeroes is unsupported */
1715 iov.iov_len = nb_sectors * BDRV_SECTOR_SIZE;
1716 iov.iov_base = qemu_blockalign(bs, iov.iov_len);
1717 memset(iov.iov_base, 0, iov.iov_len);
1718 qemu_iovec_init_external(&qiov, &iov, 1);
1719
1720 ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, &qiov);
1721
1722 qemu_vfree(iov.iov_base);
1723 return ret;
1724}
1725
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +01001726/*
1727 * Handle a write request in coroutine context
1728 */
1729static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +00001730 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
1731 BdrvRequestFlags flags)
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +01001732{
1733 BlockDriver *drv = bs->drv;
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001734 BdrvTrackedRequest req;
Stefan Hajnoczi6b7cb242011-10-13 13:08:24 +01001735 int ret;
Kevin Wolfda1fa912011-07-14 17:27:13 +02001736
1737 if (!bs->drv) {
1738 return -ENOMEDIUM;
1739 }
1740 if (bs->read_only) {
1741 return -EACCES;
1742 }
1743 if (bdrv_check_request(bs, sector_num, nb_sectors)) {
1744 return -EIO;
1745 }
1746
Zhi Yong Wu98f90db2011-11-08 13:00:14 +08001747 /* throttling disk write I/O */
1748 if (bs->io_limits_enabled) {
1749 bdrv_io_limits_intercept(bs, true, nb_sectors);
1750 }
1751
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00001752 if (bs->copy_on_read_in_flight) {
Stefan Hajnoczif4658282011-11-17 13:40:29 +00001753 wait_for_overlapping_requests(bs, sector_num, nb_sectors);
1754 }
1755
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001756 tracked_request_begin(&req, bs, sector_num, nb_sectors, true);
1757
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +00001758 if (flags & BDRV_REQ_ZERO_WRITE) {
1759 ret = bdrv_co_do_write_zeroes(bs, sector_num, nb_sectors);
1760 } else {
1761 ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
1762 }
Stefan Hajnoczi6b7cb242011-10-13 13:08:24 +01001763
Kevin Wolfda1fa912011-07-14 17:27:13 +02001764 if (bs->dirty_bitmap) {
1765 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
1766 }
1767
1768 if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
1769 bs->wr_highest_sector = sector_num + nb_sectors - 1;
1770 }
1771
Stefan Hajnoczidbffbdc2011-11-17 13:40:27 +00001772 tracked_request_end(&req);
1773
Stefan Hajnoczi6b7cb242011-10-13 13:08:24 +01001774 return ret;
Kevin Wolfda1fa912011-07-14 17:27:13 +02001775}
1776
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +01001777int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
1778 int nb_sectors, QEMUIOVector *qiov)
1779{
1780 trace_bdrv_co_writev(bs, sector_num, nb_sectors);
1781
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +00001782 return bdrv_co_do_writev(bs, sector_num, nb_sectors, qiov, 0);
1783}
1784
1785int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs,
1786 int64_t sector_num, int nb_sectors)
1787{
1788 trace_bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
1789
1790 return bdrv_co_do_writev(bs, sector_num, nb_sectors, NULL,
1791 BDRV_REQ_ZERO_WRITE);
Stefan Hajnoczic5fbe572011-10-05 17:17:03 +01001792}
1793
bellard83f64092006-08-01 16:21:11 +00001794/**
bellard83f64092006-08-01 16:21:11 +00001795 * Truncate file to 'offset' bytes (needed only for file protocols)
1796 */
1797int bdrv_truncate(BlockDriverState *bs, int64_t offset)
1798{
1799 BlockDriver *drv = bs->drv;
Stefan Hajnoczi51762282010-04-19 16:56:41 +01001800 int ret;
bellard83f64092006-08-01 16:21:11 +00001801 if (!drv)
bellard19cb3732006-08-19 11:45:59 +00001802 return -ENOMEDIUM;
bellard83f64092006-08-01 16:21:11 +00001803 if (!drv->bdrv_truncate)
1804 return -ENOTSUP;
Naphtali Sprei59f26892009-10-26 16:25:16 +02001805 if (bs->read_only)
1806 return -EACCES;
Marcelo Tosatti85916752011-01-26 12:12:35 -02001807 if (bdrv_in_use(bs))
1808 return -EBUSY;
Stefan Hajnoczi51762282010-04-19 16:56:41 +01001809 ret = drv->bdrv_truncate(bs, offset);
1810 if (ret == 0) {
1811 ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
Markus Armbruster145feb12011-08-03 15:07:42 +02001812 bdrv_dev_resize_cb(bs);
Stefan Hajnoczi51762282010-04-19 16:56:41 +01001813 }
1814 return ret;
bellard83f64092006-08-01 16:21:11 +00001815}
1816
1817/**
Fam Zheng4a1d5e12011-07-12 19:56:39 +08001818 * Length of a allocated file in bytes. Sparse files are counted by actual
1819 * allocated space. Return < 0 if error or unknown.
1820 */
1821int64_t bdrv_get_allocated_file_size(BlockDriverState *bs)
1822{
1823 BlockDriver *drv = bs->drv;
1824 if (!drv) {
1825 return -ENOMEDIUM;
1826 }
1827 if (drv->bdrv_get_allocated_file_size) {
1828 return drv->bdrv_get_allocated_file_size(bs);
1829 }
1830 if (bs->file) {
1831 return bdrv_get_allocated_file_size(bs->file);
1832 }
1833 return -ENOTSUP;
1834}
1835
1836/**
bellard83f64092006-08-01 16:21:11 +00001837 * Length of a file in bytes. Return < 0 if error or unknown.
1838 */
1839int64_t bdrv_getlength(BlockDriverState *bs)
1840{
1841 BlockDriver *drv = bs->drv;
1842 if (!drv)
bellard19cb3732006-08-19 11:45:59 +00001843 return -ENOMEDIUM;
Stefan Hajnoczi51762282010-04-19 16:56:41 +01001844
Markus Armbruster2c6942f2011-09-06 18:58:51 +02001845 if (bs->growable || bdrv_dev_has_removable_media(bs)) {
Stefan Hajnoczi46a4e4e2011-03-29 20:04:41 +01001846 if (drv->bdrv_getlength) {
1847 return drv->bdrv_getlength(bs);
1848 }
bellard83f64092006-08-01 16:21:11 +00001849 }
Stefan Hajnoczi46a4e4e2011-03-29 20:04:41 +01001850 return bs->total_sectors * BDRV_SECTOR_SIZE;
bellardfc01f7e2003-06-30 10:03:06 +00001851}
1852
bellard19cb3732006-08-19 11:45:59 +00001853/* return 0 as number of sectors if no device present or error */
ths96b8f132007-12-17 01:35:20 +00001854void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
bellardfc01f7e2003-06-30 10:03:06 +00001855{
bellard19cb3732006-08-19 11:45:59 +00001856 int64_t length;
1857 length = bdrv_getlength(bs);
1858 if (length < 0)
1859 length = 0;
1860 else
Jan Kiszka6ea44302009-11-30 18:21:19 +01001861 length = length >> BDRV_SECTOR_BITS;
bellard19cb3732006-08-19 11:45:59 +00001862 *nb_sectors_ptr = length;
bellardfc01f7e2003-06-30 10:03:06 +00001863}
bellardcf989512004-02-16 21:56:36 +00001864
aliguorif3d54fc2008-11-25 21:50:24 +00001865struct partition {
1866 uint8_t boot_ind; /* 0x80 - active */
1867 uint8_t head; /* starting head */
1868 uint8_t sector; /* starting sector */
1869 uint8_t cyl; /* starting cylinder */
1870 uint8_t sys_ind; /* What partition type */
1871 uint8_t end_head; /* end head */
1872 uint8_t end_sector; /* end sector */
1873 uint8_t end_cyl; /* end cylinder */
1874 uint32_t start_sect; /* starting sector counting from 0 */
1875 uint32_t nr_sects; /* nr of sectors in partition */
Stefan Weil541dc0d2011-08-31 12:38:01 +02001876} QEMU_PACKED;
aliguorif3d54fc2008-11-25 21:50:24 +00001877
1878/* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
1879static int guess_disk_lchs(BlockDriverState *bs,
1880 int *pcylinders, int *pheads, int *psectors)
1881{
Jes Sorenseneb5a3162010-05-27 16:20:31 +02001882 uint8_t buf[BDRV_SECTOR_SIZE];
aliguorif3d54fc2008-11-25 21:50:24 +00001883 int ret, i, heads, sectors, cylinders;
1884 struct partition *p;
1885 uint32_t nr_sects;
blueswir1a38131b2008-12-05 17:56:40 +00001886 uint64_t nb_sectors;
aliguorif3d54fc2008-11-25 21:50:24 +00001887
1888 bdrv_get_geometry(bs, &nb_sectors);
1889
1890 ret = bdrv_read(bs, 0, buf, 1);
1891 if (ret < 0)
1892 return -1;
1893 /* test msdos magic */
1894 if (buf[510] != 0x55 || buf[511] != 0xaa)
1895 return -1;
1896 for(i = 0; i < 4; i++) {
1897 p = ((struct partition *)(buf + 0x1be)) + i;
1898 nr_sects = le32_to_cpu(p->nr_sects);
1899 if (nr_sects && p->end_head) {
1900 /* We make the assumption that the partition terminates on
1901 a cylinder boundary */
1902 heads = p->end_head + 1;
1903 sectors = p->end_sector & 63;
1904 if (sectors == 0)
1905 continue;
1906 cylinders = nb_sectors / (heads * sectors);
1907 if (cylinders < 1 || cylinders > 16383)
1908 continue;
1909 *pheads = heads;
1910 *psectors = sectors;
1911 *pcylinders = cylinders;
1912#if 0
1913 printf("guessed geometry: LCHS=%d %d %d\n",
1914 cylinders, heads, sectors);
1915#endif
1916 return 0;
1917 }
1918 }
1919 return -1;
1920}
1921
1922void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs)
1923{
1924 int translation, lba_detected = 0;
1925 int cylinders, heads, secs;
blueswir1a38131b2008-12-05 17:56:40 +00001926 uint64_t nb_sectors;
aliguorif3d54fc2008-11-25 21:50:24 +00001927
1928 /* if a geometry hint is available, use it */
1929 bdrv_get_geometry(bs, &nb_sectors);
1930 bdrv_get_geometry_hint(bs, &cylinders, &heads, &secs);
1931 translation = bdrv_get_translation_hint(bs);
1932 if (cylinders != 0) {
1933 *pcyls = cylinders;
1934 *pheads = heads;
1935 *psecs = secs;
1936 } else {
1937 if (guess_disk_lchs(bs, &cylinders, &heads, &secs) == 0) {
1938 if (heads > 16) {
1939 /* if heads > 16, it means that a BIOS LBA
1940 translation was active, so the default
1941 hardware geometry is OK */
1942 lba_detected = 1;
1943 goto default_geometry;
1944 } else {
1945 *pcyls = cylinders;
1946 *pheads = heads;
1947 *psecs = secs;
1948 /* disable any translation to be in sync with
1949 the logical geometry */
1950 if (translation == BIOS_ATA_TRANSLATION_AUTO) {
1951 bdrv_set_translation_hint(bs,
1952 BIOS_ATA_TRANSLATION_NONE);
1953 }
1954 }
1955 } else {
1956 default_geometry:
1957 /* if no geometry, use a standard physical disk geometry */
1958 cylinders = nb_sectors / (16 * 63);
1959
1960 if (cylinders > 16383)
1961 cylinders = 16383;
1962 else if (cylinders < 2)
1963 cylinders = 2;
1964 *pcyls = cylinders;
1965 *pheads = 16;
1966 *psecs = 63;
1967 if ((lba_detected == 1) && (translation == BIOS_ATA_TRANSLATION_AUTO)) {
1968 if ((*pcyls * *pheads) <= 131072) {
1969 bdrv_set_translation_hint(bs,
1970 BIOS_ATA_TRANSLATION_LARGE);
1971 } else {
1972 bdrv_set_translation_hint(bs,
1973 BIOS_ATA_TRANSLATION_LBA);
1974 }
1975 }
1976 }
1977 bdrv_set_geometry_hint(bs, *pcyls, *pheads, *psecs);
1978 }
1979}
1980
ths5fafdf22007-09-16 21:08:06 +00001981void bdrv_set_geometry_hint(BlockDriverState *bs,
bellardb3380822004-03-14 21:38:54 +00001982 int cyls, int heads, int secs)
1983{
1984 bs->cyls = cyls;
1985 bs->heads = heads;
1986 bs->secs = secs;
1987}
1988
bellard46d47672004-11-16 01:45:27 +00001989void bdrv_set_translation_hint(BlockDriverState *bs, int translation)
1990{
1991 bs->translation = translation;
1992}
1993
ths5fafdf22007-09-16 21:08:06 +00001994void bdrv_get_geometry_hint(BlockDriverState *bs,
bellardb3380822004-03-14 21:38:54 +00001995 int *pcyls, int *pheads, int *psecs)
1996{
1997 *pcyls = bs->cyls;
1998 *pheads = bs->heads;
1999 *psecs = bs->secs;
2000}
2001
Zhi Yong Wu0563e192011-11-03 16:57:25 +08002002/* throttling disk io limits */
2003void bdrv_set_io_limits(BlockDriverState *bs,
2004 BlockIOLimit *io_limits)
2005{
2006 bs->io_limits = *io_limits;
2007 bs->io_limits_enabled = bdrv_io_limits_enabled(bs);
2008}
2009
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002010/* Recognize floppy formats */
2011typedef struct FDFormat {
2012 FDriveType drive;
2013 uint8_t last_sect;
2014 uint8_t max_track;
2015 uint8_t max_head;
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002016 FDriveRate rate;
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002017} FDFormat;
2018
2019static const FDFormat fd_formats[] = {
2020 /* First entry is default format */
2021 /* 1.44 MB 3"1/2 floppy disks */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002022 { FDRIVE_DRV_144, 18, 80, 1, FDRIVE_RATE_500K, },
2023 { FDRIVE_DRV_144, 20, 80, 1, FDRIVE_RATE_500K, },
2024 { FDRIVE_DRV_144, 21, 80, 1, FDRIVE_RATE_500K, },
2025 { FDRIVE_DRV_144, 21, 82, 1, FDRIVE_RATE_500K, },
2026 { FDRIVE_DRV_144, 21, 83, 1, FDRIVE_RATE_500K, },
2027 { FDRIVE_DRV_144, 22, 80, 1, FDRIVE_RATE_500K, },
2028 { FDRIVE_DRV_144, 23, 80, 1, FDRIVE_RATE_500K, },
2029 { FDRIVE_DRV_144, 24, 80, 1, FDRIVE_RATE_500K, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002030 /* 2.88 MB 3"1/2 floppy disks */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002031 { FDRIVE_DRV_288, 36, 80, 1, FDRIVE_RATE_1M, },
2032 { FDRIVE_DRV_288, 39, 80, 1, FDRIVE_RATE_1M, },
2033 { FDRIVE_DRV_288, 40, 80, 1, FDRIVE_RATE_1M, },
2034 { FDRIVE_DRV_288, 44, 80, 1, FDRIVE_RATE_1M, },
2035 { FDRIVE_DRV_288, 48, 80, 1, FDRIVE_RATE_1M, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002036 /* 720 kB 3"1/2 floppy disks */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002037 { FDRIVE_DRV_144, 9, 80, 1, FDRIVE_RATE_250K, },
2038 { FDRIVE_DRV_144, 10, 80, 1, FDRIVE_RATE_250K, },
2039 { FDRIVE_DRV_144, 10, 82, 1, FDRIVE_RATE_250K, },
2040 { FDRIVE_DRV_144, 10, 83, 1, FDRIVE_RATE_250K, },
2041 { FDRIVE_DRV_144, 13, 80, 1, FDRIVE_RATE_250K, },
2042 { FDRIVE_DRV_144, 14, 80, 1, FDRIVE_RATE_250K, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002043 /* 1.2 MB 5"1/4 floppy disks */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002044 { FDRIVE_DRV_120, 15, 80, 1, FDRIVE_RATE_500K, },
2045 { FDRIVE_DRV_120, 18, 80, 1, FDRIVE_RATE_500K, },
2046 { FDRIVE_DRV_120, 18, 82, 1, FDRIVE_RATE_500K, },
2047 { FDRIVE_DRV_120, 18, 83, 1, FDRIVE_RATE_500K, },
2048 { FDRIVE_DRV_120, 20, 80, 1, FDRIVE_RATE_500K, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002049 /* 720 kB 5"1/4 floppy disks */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002050 { FDRIVE_DRV_120, 9, 80, 1, FDRIVE_RATE_250K, },
2051 { FDRIVE_DRV_120, 11, 80, 1, FDRIVE_RATE_250K, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002052 /* 360 kB 5"1/4 floppy disks */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002053 { FDRIVE_DRV_120, 9, 40, 1, FDRIVE_RATE_300K, },
2054 { FDRIVE_DRV_120, 9, 40, 0, FDRIVE_RATE_300K, },
2055 { FDRIVE_DRV_120, 10, 41, 1, FDRIVE_RATE_300K, },
2056 { FDRIVE_DRV_120, 10, 42, 1, FDRIVE_RATE_300K, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002057 /* 320 kB 5"1/4 floppy disks */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002058 { FDRIVE_DRV_120, 8, 40, 1, FDRIVE_RATE_250K, },
2059 { FDRIVE_DRV_120, 8, 40, 0, FDRIVE_RATE_250K, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002060 /* 360 kB must match 5"1/4 better than 3"1/2... */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002061 { FDRIVE_DRV_144, 9, 80, 0, FDRIVE_RATE_250K, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002062 /* end */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002063 { FDRIVE_DRV_NONE, -1, -1, 0, 0, },
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002064};
2065
2066void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
2067 int *max_track, int *last_sect,
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002068 FDriveType drive_in, FDriveType *drive,
2069 FDriveRate *rate)
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002070{
2071 const FDFormat *parse;
2072 uint64_t nb_sectors, size;
2073 int i, first_match, match;
2074
2075 bdrv_get_geometry_hint(bs, nb_heads, max_track, last_sect);
2076 if (*nb_heads != 0 && *max_track != 0 && *last_sect != 0) {
2077 /* User defined disk */
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002078 *rate = FDRIVE_RATE_500K;
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002079 } else {
2080 bdrv_get_geometry(bs, &nb_sectors);
2081 match = -1;
2082 first_match = -1;
2083 for (i = 0; ; i++) {
2084 parse = &fd_formats[i];
2085 if (parse->drive == FDRIVE_DRV_NONE) {
2086 break;
2087 }
2088 if (drive_in == parse->drive ||
2089 drive_in == FDRIVE_DRV_NONE) {
2090 size = (parse->max_head + 1) * parse->max_track *
2091 parse->last_sect;
2092 if (nb_sectors == size) {
2093 match = i;
2094 break;
2095 }
2096 if (first_match == -1) {
2097 first_match = i;
2098 }
2099 }
2100 }
2101 if (match == -1) {
2102 if (first_match == -1) {
2103 match = 1;
2104 } else {
2105 match = first_match;
2106 }
2107 parse = &fd_formats[match];
2108 }
2109 *nb_heads = parse->max_head + 1;
2110 *max_track = parse->max_track;
2111 *last_sect = parse->last_sect;
2112 *drive = parse->drive;
Hervé Poussineauf8d3d122012-02-06 22:29:07 +01002113 *rate = parse->rate;
Blue Swirl5bbdbb42011-02-12 20:43:32 +00002114 }
2115}
2116
bellard46d47672004-11-16 01:45:27 +00002117int bdrv_get_translation_hint(BlockDriverState *bs)
2118{
2119 return bs->translation;
2120}
2121
Markus Armbrusterabd7f682010-06-02 18:55:17 +02002122void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
2123 BlockErrorAction on_write_error)
2124{
2125 bs->on_read_error = on_read_error;
2126 bs->on_write_error = on_write_error;
2127}
2128
2129BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read)
2130{
2131 return is_read ? bs->on_read_error : bs->on_write_error;
2132}
2133
bellardb3380822004-03-14 21:38:54 +00002134int bdrv_is_read_only(BlockDriverState *bs)
2135{
2136 return bs->read_only;
2137}
2138
ths985a03b2007-12-24 16:10:43 +00002139int bdrv_is_sg(BlockDriverState *bs)
2140{
2141 return bs->sg;
2142}
2143
Christoph Hellwige900a7b2009-09-04 19:01:15 +02002144int bdrv_enable_write_cache(BlockDriverState *bs)
2145{
2146 return bs->enable_write_cache;
2147}
2148
bellardea2384d2004-08-01 21:59:26 +00002149int bdrv_is_encrypted(BlockDriverState *bs)
2150{
2151 if (bs->backing_hd && bs->backing_hd->encrypted)
2152 return 1;
2153 return bs->encrypted;
2154}
2155
aliguoric0f4ce72009-03-05 23:01:01 +00002156int bdrv_key_required(BlockDriverState *bs)
2157{
2158 BlockDriverState *backing_hd = bs->backing_hd;
2159
2160 if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
2161 return 1;
2162 return (bs->encrypted && !bs->valid_key);
2163}
2164
bellardea2384d2004-08-01 21:59:26 +00002165int bdrv_set_key(BlockDriverState *bs, const char *key)
2166{
2167 int ret;
2168 if (bs->backing_hd && bs->backing_hd->encrypted) {
2169 ret = bdrv_set_key(bs->backing_hd, key);
2170 if (ret < 0)
2171 return ret;
2172 if (!bs->encrypted)
2173 return 0;
2174 }
Shahar Havivifd04a2a2010-03-06 00:26:13 +02002175 if (!bs->encrypted) {
2176 return -EINVAL;
2177 } else if (!bs->drv || !bs->drv->bdrv_set_key) {
2178 return -ENOMEDIUM;
2179 }
aliguoric0f4ce72009-03-05 23:01:01 +00002180 ret = bs->drv->bdrv_set_key(bs, key);
aliguoribb5fc202009-03-05 23:01:15 +00002181 if (ret < 0) {
2182 bs->valid_key = 0;
2183 } else if (!bs->valid_key) {
2184 bs->valid_key = 1;
2185 /* call the change callback now, we skipped it on open */
Markus Armbruster7d4b4ba2011-09-06 18:58:59 +02002186 bdrv_dev_change_media_cb(bs, true);
aliguoribb5fc202009-03-05 23:01:15 +00002187 }
aliguoric0f4ce72009-03-05 23:01:01 +00002188 return ret;
bellardea2384d2004-08-01 21:59:26 +00002189}
2190
2191void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size)
2192{
bellard19cb3732006-08-19 11:45:59 +00002193 if (!bs->drv) {
bellardea2384d2004-08-01 21:59:26 +00002194 buf[0] = '\0';
2195 } else {
2196 pstrcpy(buf, buf_size, bs->drv->format_name);
2197 }
2198}
2199
ths5fafdf22007-09-16 21:08:06 +00002200void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
bellardea2384d2004-08-01 21:59:26 +00002201 void *opaque)
2202{
2203 BlockDriver *drv;
2204
Stefan Hajnoczi8a22f022010-04-13 10:29:33 +01002205 QLIST_FOREACH(drv, &bdrv_drivers, list) {
bellardea2384d2004-08-01 21:59:26 +00002206 it(opaque, drv->format_name);
2207 }
2208}
2209
bellardb3380822004-03-14 21:38:54 +00002210BlockDriverState *bdrv_find(const char *name)
2211{
2212 BlockDriverState *bs;
2213
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +01002214 QTAILQ_FOREACH(bs, &bdrv_states, list) {
2215 if (!strcmp(name, bs->device_name)) {
bellardb3380822004-03-14 21:38:54 +00002216 return bs;
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +01002217 }
bellardb3380822004-03-14 21:38:54 +00002218 }
2219 return NULL;
2220}
2221
Markus Armbruster2f399b02010-06-02 18:55:20 +02002222BlockDriverState *bdrv_next(BlockDriverState *bs)
2223{
2224 if (!bs) {
2225 return QTAILQ_FIRST(&bdrv_states);
2226 }
2227 return QTAILQ_NEXT(bs, list);
2228}
2229
aliguori51de9762009-03-05 23:00:43 +00002230void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
bellard81d09122004-07-14 17:21:37 +00002231{
2232 BlockDriverState *bs;
2233
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +01002234 QTAILQ_FOREACH(bs, &bdrv_states, list) {
aliguori51de9762009-03-05 23:00:43 +00002235 it(opaque, bs);
bellard81d09122004-07-14 17:21:37 +00002236 }
2237}
2238
bellardea2384d2004-08-01 21:59:26 +00002239const char *bdrv_get_device_name(BlockDriverState *bs)
2240{
2241 return bs->device_name;
2242}
2243
aliguoric6ca28d2008-10-06 13:55:43 +00002244void bdrv_flush_all(void)
2245{
2246 BlockDriverState *bs;
2247
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +01002248 QTAILQ_FOREACH(bs, &bdrv_states, list) {
Markus Armbrusterc602a482011-08-03 15:08:10 +02002249 if (!bdrv_is_read_only(bs) && bdrv_is_inserted(bs)) {
aliguoric6ca28d2008-10-06 13:55:43 +00002250 bdrv_flush(bs);
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +01002251 }
2252 }
aliguoric6ca28d2008-10-06 13:55:43 +00002253}
2254
Kevin Wolff2feebb2010-04-14 17:30:35 +02002255int bdrv_has_zero_init(BlockDriverState *bs)
2256{
2257 assert(bs->drv);
2258
Kevin Wolf336c1c12010-07-28 11:26:29 +02002259 if (bs->drv->bdrv_has_zero_init) {
2260 return bs->drv->bdrv_has_zero_init(bs);
Kevin Wolff2feebb2010-04-14 17:30:35 +02002261 }
2262
2263 return 1;
2264}
2265
Stefan Hajnoczi376ae3f2011-11-14 12:44:19 +00002266typedef struct BdrvCoIsAllocatedData {
2267 BlockDriverState *bs;
2268 int64_t sector_num;
2269 int nb_sectors;
2270 int *pnum;
2271 int ret;
2272 bool done;
2273} BdrvCoIsAllocatedData;
2274
thsf58c7b32008-06-05 21:53:49 +00002275/*
2276 * Returns true iff the specified sector is present in the disk image. Drivers
2277 * not implementing the functionality are assumed to not support backing files,
2278 * hence all their sectors are reported as allocated.
2279 *
Stefan Hajnoczibd9533e2011-11-29 13:49:51 +00002280 * If 'sector_num' is beyond the end of the disk image the return value is 0
2281 * and 'pnum' is set to 0.
2282 *
thsf58c7b32008-06-05 21:53:49 +00002283 * 'pnum' is set to the number of sectors (including and immediately following
2284 * the specified sector) that are known to be in the same
2285 * allocated/unallocated state.
2286 *
Stefan Hajnoczibd9533e2011-11-29 13:49:51 +00002287 * 'nb_sectors' is the max value 'pnum' should be set to. If nb_sectors goes
2288 * beyond the end of the disk image it will be clamped.
thsf58c7b32008-06-05 21:53:49 +00002289 */
Stefan Hajnoczi060f51c2011-11-14 12:44:26 +00002290int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
2291 int nb_sectors, int *pnum)
thsf58c7b32008-06-05 21:53:49 +00002292{
Stefan Hajnoczibd9533e2011-11-29 13:49:51 +00002293 int64_t n;
2294
2295 if (sector_num >= bs->total_sectors) {
2296 *pnum = 0;
2297 return 0;
2298 }
2299
2300 n = bs->total_sectors - sector_num;
2301 if (n < nb_sectors) {
2302 nb_sectors = n;
2303 }
2304
Stefan Hajnoczi6aebab12011-11-14 12:44:25 +00002305 if (!bs->drv->bdrv_co_is_allocated) {
Stefan Hajnoczibd9533e2011-11-29 13:49:51 +00002306 *pnum = nb_sectors;
thsf58c7b32008-06-05 21:53:49 +00002307 return 1;
2308 }
Stefan Hajnoczi6aebab12011-11-14 12:44:25 +00002309
Stefan Hajnoczi060f51c2011-11-14 12:44:26 +00002310 return bs->drv->bdrv_co_is_allocated(bs, sector_num, nb_sectors, pnum);
2311}
2312
2313/* Coroutine wrapper for bdrv_is_allocated() */
2314static void coroutine_fn bdrv_is_allocated_co_entry(void *opaque)
2315{
2316 BdrvCoIsAllocatedData *data = opaque;
2317 BlockDriverState *bs = data->bs;
2318
2319 data->ret = bdrv_co_is_allocated(bs, data->sector_num, data->nb_sectors,
2320 data->pnum);
2321 data->done = true;
2322}
2323
2324/*
2325 * Synchronous wrapper around bdrv_co_is_allocated().
2326 *
2327 * See bdrv_co_is_allocated() for details.
2328 */
2329int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
2330 int *pnum)
2331{
Stefan Hajnoczi6aebab12011-11-14 12:44:25 +00002332 Coroutine *co;
2333 BdrvCoIsAllocatedData data = {
2334 .bs = bs,
2335 .sector_num = sector_num,
2336 .nb_sectors = nb_sectors,
2337 .pnum = pnum,
2338 .done = false,
2339 };
2340
2341 co = qemu_coroutine_create(bdrv_is_allocated_co_entry);
2342 qemu_coroutine_enter(co, &data);
2343 while (!data.done) {
2344 qemu_aio_wait();
2345 }
2346 return data.ret;
thsf58c7b32008-06-05 21:53:49 +00002347}
2348
Luiz Capitulinob2023812011-09-21 17:16:47 -03002349BlockInfoList *qmp_query_block(Error **errp)
bellardb3380822004-03-14 21:38:54 +00002350{
Luiz Capitulinob2023812011-09-21 17:16:47 -03002351 BlockInfoList *head = NULL, *cur_item = NULL;
bellardb3380822004-03-14 21:38:54 +00002352 BlockDriverState *bs;
2353
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +01002354 QTAILQ_FOREACH(bs, &bdrv_states, list) {
Luiz Capitulinob2023812011-09-21 17:16:47 -03002355 BlockInfoList *info = g_malloc0(sizeof(*info));
Luiz Capitulinod15e5462009-12-10 17:16:06 -02002356
Luiz Capitulinob2023812011-09-21 17:16:47 -03002357 info->value = g_malloc0(sizeof(*info->value));
2358 info->value->device = g_strdup(bs->device_name);
2359 info->value->type = g_strdup("unknown");
2360 info->value->locked = bdrv_dev_is_medium_locked(bs);
2361 info->value->removable = bdrv_dev_has_removable_media(bs);
Luiz Capitulinod15e5462009-12-10 17:16:06 -02002362
Markus Armbrustere4def802011-09-06 18:58:53 +02002363 if (bdrv_dev_has_removable_media(bs)) {
Luiz Capitulinob2023812011-09-21 17:16:47 -03002364 info->value->has_tray_open = true;
2365 info->value->tray_open = bdrv_dev_is_tray_open(bs);
Markus Armbrustere4def802011-09-06 18:58:53 +02002366 }
Luiz Capitulinof04ef602011-09-26 17:43:54 -03002367
2368 if (bdrv_iostatus_is_enabled(bs)) {
Luiz Capitulinob2023812011-09-21 17:16:47 -03002369 info->value->has_io_status = true;
2370 info->value->io_status = bs->iostatus;
Luiz Capitulinof04ef602011-09-26 17:43:54 -03002371 }
2372
bellard19cb3732006-08-19 11:45:59 +00002373 if (bs->drv) {
Luiz Capitulinob2023812011-09-21 17:16:47 -03002374 info->value->has_inserted = true;
2375 info->value->inserted = g_malloc0(sizeof(*info->value->inserted));
2376 info->value->inserted->file = g_strdup(bs->filename);
2377 info->value->inserted->ro = bs->read_only;
2378 info->value->inserted->drv = g_strdup(bs->drv->format_name);
2379 info->value->inserted->encrypted = bs->encrypted;
2380 if (bs->backing_file[0]) {
2381 info->value->inserted->has_backing_file = true;
2382 info->value->inserted->backing_file = g_strdup(bs->backing_file);
aliguori376253e2009-03-05 23:01:23 +00002383 }
Zhi Yong Wu727f0052011-11-08 13:00:31 +08002384
2385 if (bs->io_limits_enabled) {
2386 info->value->inserted->bps =
2387 bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
2388 info->value->inserted->bps_rd =
2389 bs->io_limits.bps[BLOCK_IO_LIMIT_READ];
2390 info->value->inserted->bps_wr =
2391 bs->io_limits.bps[BLOCK_IO_LIMIT_WRITE];
2392 info->value->inserted->iops =
2393 bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
2394 info->value->inserted->iops_rd =
2395 bs->io_limits.iops[BLOCK_IO_LIMIT_READ];
2396 info->value->inserted->iops_wr =
2397 bs->io_limits.iops[BLOCK_IO_LIMIT_WRITE];
2398 }
bellardb3380822004-03-14 21:38:54 +00002399 }
Luiz Capitulinob2023812011-09-21 17:16:47 -03002400
2401 /* XXX: waiting for the qapi to support GSList */
2402 if (!cur_item) {
2403 head = cur_item = info;
2404 } else {
2405 cur_item->next = info;
2406 cur_item = info;
2407 }
bellardb3380822004-03-14 21:38:54 +00002408 }
Luiz Capitulinod15e5462009-12-10 17:16:06 -02002409
Luiz Capitulinob2023812011-09-21 17:16:47 -03002410 return head;
bellardb3380822004-03-14 21:38:54 +00002411}
thsa36e69d2007-12-02 05:18:19 +00002412
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002413/* Consider exposing this as a full fledged QMP command */
2414static BlockStats *qmp_query_blockstat(const BlockDriverState *bs, Error **errp)
thsa36e69d2007-12-02 05:18:19 +00002415{
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002416 BlockStats *s;
Luiz Capitulino218a5362009-12-10 17:16:07 -02002417
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002418 s = g_malloc0(sizeof(*s));
Luiz Capitulino218a5362009-12-10 17:16:07 -02002419
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002420 if (bs->device_name[0]) {
2421 s->has_device = true;
2422 s->device = g_strdup(bs->device_name);
Kevin Wolf294cc352010-04-28 14:34:01 +02002423 }
2424
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002425 s->stats = g_malloc0(sizeof(*s->stats));
2426 s->stats->rd_bytes = bs->nr_bytes[BDRV_ACCT_READ];
2427 s->stats->wr_bytes = bs->nr_bytes[BDRV_ACCT_WRITE];
2428 s->stats->rd_operations = bs->nr_ops[BDRV_ACCT_READ];
2429 s->stats->wr_operations = bs->nr_ops[BDRV_ACCT_WRITE];
2430 s->stats->wr_highest_offset = bs->wr_highest_sector * BDRV_SECTOR_SIZE;
2431 s->stats->flush_operations = bs->nr_ops[BDRV_ACCT_FLUSH];
2432 s->stats->wr_total_time_ns = bs->total_time_ns[BDRV_ACCT_WRITE];
2433 s->stats->rd_total_time_ns = bs->total_time_ns[BDRV_ACCT_READ];
2434 s->stats->flush_total_time_ns = bs->total_time_ns[BDRV_ACCT_FLUSH];
2435
Kevin Wolf294cc352010-04-28 14:34:01 +02002436 if (bs->file) {
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002437 s->has_parent = true;
2438 s->parent = qmp_query_blockstat(bs->file, NULL);
Kevin Wolf294cc352010-04-28 14:34:01 +02002439 }
2440
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002441 return s;
Kevin Wolf294cc352010-04-28 14:34:01 +02002442}
2443
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002444BlockStatsList *qmp_query_blockstats(Error **errp)
Luiz Capitulino218a5362009-12-10 17:16:07 -02002445{
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002446 BlockStatsList *head = NULL, *cur_item = NULL;
thsa36e69d2007-12-02 05:18:19 +00002447 BlockDriverState *bs;
2448
Stefan Hajnoczi1b7bdbc2010-04-10 07:02:42 +01002449 QTAILQ_FOREACH(bs, &bdrv_states, list) {
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002450 BlockStatsList *info = g_malloc0(sizeof(*info));
2451 info->value = qmp_query_blockstat(bs, NULL);
2452
2453 /* XXX: waiting for the qapi to support GSList */
2454 if (!cur_item) {
2455 head = cur_item = info;
2456 } else {
2457 cur_item->next = info;
2458 cur_item = info;
2459 }
thsa36e69d2007-12-02 05:18:19 +00002460 }
Luiz Capitulino218a5362009-12-10 17:16:07 -02002461
Luiz Capitulinof11f57e2011-09-22 15:56:36 -03002462 return head;
thsa36e69d2007-12-02 05:18:19 +00002463}
bellardea2384d2004-08-01 21:59:26 +00002464
aliguori045df332009-03-05 23:00:48 +00002465const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
2466{
2467 if (bs->backing_hd && bs->backing_hd->encrypted)
2468 return bs->backing_file;
2469 else if (bs->encrypted)
2470 return bs->filename;
2471 else
2472 return NULL;
2473}
2474
ths5fafdf22007-09-16 21:08:06 +00002475void bdrv_get_backing_filename(BlockDriverState *bs,
bellard83f64092006-08-01 16:21:11 +00002476 char *filename, int filename_size)
bellardea2384d2004-08-01 21:59:26 +00002477{
Kevin Wolf3574c602011-10-26 11:02:11 +02002478 pstrcpy(filename, filename_size, bs->backing_file);
bellardea2384d2004-08-01 21:59:26 +00002479}
2480
ths5fafdf22007-09-16 21:08:06 +00002481int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
bellardfaea38e2006-08-05 21:31:00 +00002482 const uint8_t *buf, int nb_sectors)
2483{
2484 BlockDriver *drv = bs->drv;
2485 if (!drv)
bellard19cb3732006-08-19 11:45:59 +00002486 return -ENOMEDIUM;
bellardfaea38e2006-08-05 21:31:00 +00002487 if (!drv->bdrv_write_compressed)
2488 return -ENOTSUP;
Kevin Wolffbb7b4e2009-05-08 14:47:24 +02002489 if (bdrv_check_request(bs, sector_num, nb_sectors))
2490 return -EIO;
Jan Kiszkaa55eb922009-11-30 18:21:19 +01002491
Jan Kiszkac6d22832009-11-30 18:21:20 +01002492 if (bs->dirty_bitmap) {
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02002493 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
2494 }
Jan Kiszkaa55eb922009-11-30 18:21:19 +01002495
bellardfaea38e2006-08-05 21:31:00 +00002496 return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
2497}
ths3b46e622007-09-17 08:09:54 +00002498
bellardfaea38e2006-08-05 21:31:00 +00002499int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2500{
2501 BlockDriver *drv = bs->drv;
2502 if (!drv)
bellard19cb3732006-08-19 11:45:59 +00002503 return -ENOMEDIUM;
bellardfaea38e2006-08-05 21:31:00 +00002504 if (!drv->bdrv_get_info)
2505 return -ENOTSUP;
2506 memset(bdi, 0, sizeof(*bdi));
2507 return drv->bdrv_get_info(bs, bdi);
2508}
2509
Christoph Hellwig45566e92009-07-10 23:11:57 +02002510int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
2511 int64_t pos, int size)
aliguori178e08a2009-04-05 19:10:55 +00002512{
2513 BlockDriver *drv = bs->drv;
2514 if (!drv)
2515 return -ENOMEDIUM;
MORITA Kazutaka7cdb1f62010-05-28 11:44:58 +09002516 if (drv->bdrv_save_vmstate)
2517 return drv->bdrv_save_vmstate(bs, buf, pos, size);
2518 if (bs->file)
2519 return bdrv_save_vmstate(bs->file, buf, pos, size);
2520 return -ENOTSUP;
aliguori178e08a2009-04-05 19:10:55 +00002521}
2522
Christoph Hellwig45566e92009-07-10 23:11:57 +02002523int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
2524 int64_t pos, int size)
aliguori178e08a2009-04-05 19:10:55 +00002525{
2526 BlockDriver *drv = bs->drv;
2527 if (!drv)
2528 return -ENOMEDIUM;
MORITA Kazutaka7cdb1f62010-05-28 11:44:58 +09002529 if (drv->bdrv_load_vmstate)
2530 return drv->bdrv_load_vmstate(bs, buf, pos, size);
2531 if (bs->file)
2532 return bdrv_load_vmstate(bs->file, buf, pos, size);
2533 return -ENOTSUP;
aliguori178e08a2009-04-05 19:10:55 +00002534}
2535
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +01002536void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
2537{
2538 BlockDriver *drv = bs->drv;
2539
2540 if (!drv || !drv->bdrv_debug_event) {
2541 return;
2542 }
2543
2544 return drv->bdrv_debug_event(bs, event);
2545
2546}
2547
bellardfaea38e2006-08-05 21:31:00 +00002548/**************************************************************/
2549/* handling of snapshots */
2550
Miguel Di Ciurcio Filhofeeee5a2010-06-08 10:40:55 -03002551int bdrv_can_snapshot(BlockDriverState *bs)
2552{
2553 BlockDriver *drv = bs->drv;
Markus Armbruster07b70bf2011-08-03 15:08:11 +02002554 if (!drv || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
Miguel Di Ciurcio Filhofeeee5a2010-06-08 10:40:55 -03002555 return 0;
2556 }
2557
2558 if (!drv->bdrv_snapshot_create) {
2559 if (bs->file != NULL) {
2560 return bdrv_can_snapshot(bs->file);
2561 }
2562 return 0;
2563 }
2564
2565 return 1;
2566}
2567
Blue Swirl199630b2010-07-25 20:49:34 +00002568int bdrv_is_snapshot(BlockDriverState *bs)
2569{
2570 return !!(bs->open_flags & BDRV_O_SNAPSHOT);
2571}
2572
Markus Armbrusterf9092b12010-06-25 10:33:39 +02002573BlockDriverState *bdrv_snapshots(void)
2574{
2575 BlockDriverState *bs;
2576
Markus Armbruster3ac906f2010-07-01 09:30:38 +02002577 if (bs_snapshots) {
Markus Armbrusterf9092b12010-06-25 10:33:39 +02002578 return bs_snapshots;
Markus Armbruster3ac906f2010-07-01 09:30:38 +02002579 }
Markus Armbrusterf9092b12010-06-25 10:33:39 +02002580
2581 bs = NULL;
2582 while ((bs = bdrv_next(bs))) {
2583 if (bdrv_can_snapshot(bs)) {
Markus Armbruster3ac906f2010-07-01 09:30:38 +02002584 bs_snapshots = bs;
2585 return bs;
Markus Armbrusterf9092b12010-06-25 10:33:39 +02002586 }
2587 }
2588 return NULL;
Markus Armbrusterf9092b12010-06-25 10:33:39 +02002589}
2590
ths5fafdf22007-09-16 21:08:06 +00002591int bdrv_snapshot_create(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +00002592 QEMUSnapshotInfo *sn_info)
2593{
2594 BlockDriver *drv = bs->drv;
2595 if (!drv)
bellard19cb3732006-08-19 11:45:59 +00002596 return -ENOMEDIUM;
MORITA Kazutaka7cdb1f62010-05-28 11:44:58 +09002597 if (drv->bdrv_snapshot_create)
2598 return drv->bdrv_snapshot_create(bs, sn_info);
2599 if (bs->file)
2600 return bdrv_snapshot_create(bs->file, sn_info);
2601 return -ENOTSUP;
bellardfaea38e2006-08-05 21:31:00 +00002602}
2603
ths5fafdf22007-09-16 21:08:06 +00002604int bdrv_snapshot_goto(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +00002605 const char *snapshot_id)
2606{
2607 BlockDriver *drv = bs->drv;
MORITA Kazutaka7cdb1f62010-05-28 11:44:58 +09002608 int ret, open_ret;
2609
bellardfaea38e2006-08-05 21:31:00 +00002610 if (!drv)
bellard19cb3732006-08-19 11:45:59 +00002611 return -ENOMEDIUM;
MORITA Kazutaka7cdb1f62010-05-28 11:44:58 +09002612 if (drv->bdrv_snapshot_goto)
2613 return drv->bdrv_snapshot_goto(bs, snapshot_id);
2614
2615 if (bs->file) {
2616 drv->bdrv_close(bs);
2617 ret = bdrv_snapshot_goto(bs->file, snapshot_id);
2618 open_ret = drv->bdrv_open(bs, bs->open_flags);
2619 if (open_ret < 0) {
2620 bdrv_delete(bs->file);
2621 bs->drv = NULL;
2622 return open_ret;
2623 }
2624 return ret;
2625 }
2626
2627 return -ENOTSUP;
bellardfaea38e2006-08-05 21:31:00 +00002628}
2629
2630int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
2631{
2632 BlockDriver *drv = bs->drv;
2633 if (!drv)
bellard19cb3732006-08-19 11:45:59 +00002634 return -ENOMEDIUM;
MORITA Kazutaka7cdb1f62010-05-28 11:44:58 +09002635 if (drv->bdrv_snapshot_delete)
2636 return drv->bdrv_snapshot_delete(bs, snapshot_id);
2637 if (bs->file)
2638 return bdrv_snapshot_delete(bs->file, snapshot_id);
2639 return -ENOTSUP;
bellardfaea38e2006-08-05 21:31:00 +00002640}
2641
ths5fafdf22007-09-16 21:08:06 +00002642int bdrv_snapshot_list(BlockDriverState *bs,
bellardfaea38e2006-08-05 21:31:00 +00002643 QEMUSnapshotInfo **psn_info)
2644{
2645 BlockDriver *drv = bs->drv;
2646 if (!drv)
bellard19cb3732006-08-19 11:45:59 +00002647 return -ENOMEDIUM;
MORITA Kazutaka7cdb1f62010-05-28 11:44:58 +09002648 if (drv->bdrv_snapshot_list)
2649 return drv->bdrv_snapshot_list(bs, psn_info);
2650 if (bs->file)
2651 return bdrv_snapshot_list(bs->file, psn_info);
2652 return -ENOTSUP;
bellardfaea38e2006-08-05 21:31:00 +00002653}
2654
edison51ef6722010-09-21 19:58:41 -07002655int bdrv_snapshot_load_tmp(BlockDriverState *bs,
2656 const char *snapshot_name)
2657{
2658 BlockDriver *drv = bs->drv;
2659 if (!drv) {
2660 return -ENOMEDIUM;
2661 }
2662 if (!bs->read_only) {
2663 return -EINVAL;
2664 }
2665 if (drv->bdrv_snapshot_load_tmp) {
2666 return drv->bdrv_snapshot_load_tmp(bs, snapshot_name);
2667 }
2668 return -ENOTSUP;
2669}
2670
Marcelo Tosattie8a6bb92012-01-18 14:40:51 +00002671BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
2672 const char *backing_file)
2673{
2674 if (!bs->drv) {
2675 return NULL;
2676 }
2677
2678 if (bs->backing_hd) {
2679 if (strcmp(bs->backing_file, backing_file) == 0) {
2680 return bs->backing_hd;
2681 } else {
2682 return bdrv_find_backing_image(bs->backing_hd, backing_file);
2683 }
2684 }
2685
2686 return NULL;
2687}
2688
bellardfaea38e2006-08-05 21:31:00 +00002689#define NB_SUFFIXES 4
2690
2691char *get_human_readable_size(char *buf, int buf_size, int64_t size)
2692{
2693 static const char suffixes[NB_SUFFIXES] = "KMGT";
2694 int64_t base;
2695 int i;
2696
2697 if (size <= 999) {
2698 snprintf(buf, buf_size, "%" PRId64, size);
2699 } else {
2700 base = 1024;
2701 for(i = 0; i < NB_SUFFIXES; i++) {
2702 if (size < (10 * base)) {
ths5fafdf22007-09-16 21:08:06 +00002703 snprintf(buf, buf_size, "%0.1f%c",
bellardfaea38e2006-08-05 21:31:00 +00002704 (double)size / base,
2705 suffixes[i]);
2706 break;
2707 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
ths5fafdf22007-09-16 21:08:06 +00002708 snprintf(buf, buf_size, "%" PRId64 "%c",
bellardfaea38e2006-08-05 21:31:00 +00002709 ((size + (base >> 1)) / base),
2710 suffixes[i]);
2711 break;
2712 }
2713 base = base * 1024;
2714 }
2715 }
2716 return buf;
2717}
2718
2719char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
2720{
2721 char buf1[128], date_buf[128], clock_buf[128];
bellard3b9f94e2007-01-07 17:27:07 +00002722#ifdef _WIN32
2723 struct tm *ptm;
2724#else
bellardfaea38e2006-08-05 21:31:00 +00002725 struct tm tm;
bellard3b9f94e2007-01-07 17:27:07 +00002726#endif
bellardfaea38e2006-08-05 21:31:00 +00002727 time_t ti;
2728 int64_t secs;
2729
2730 if (!sn) {
ths5fafdf22007-09-16 21:08:06 +00002731 snprintf(buf, buf_size,
2732 "%-10s%-20s%7s%20s%15s",
bellardfaea38e2006-08-05 21:31:00 +00002733 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
2734 } else {
2735 ti = sn->date_sec;
bellard3b9f94e2007-01-07 17:27:07 +00002736#ifdef _WIN32
2737 ptm = localtime(&ti);
2738 strftime(date_buf, sizeof(date_buf),
2739 "%Y-%m-%d %H:%M:%S", ptm);
2740#else
bellardfaea38e2006-08-05 21:31:00 +00002741 localtime_r(&ti, &tm);
2742 strftime(date_buf, sizeof(date_buf),
2743 "%Y-%m-%d %H:%M:%S", &tm);
bellard3b9f94e2007-01-07 17:27:07 +00002744#endif
bellardfaea38e2006-08-05 21:31:00 +00002745 secs = sn->vm_clock_nsec / 1000000000;
2746 snprintf(clock_buf, sizeof(clock_buf),
2747 "%02d:%02d:%02d.%03d",
2748 (int)(secs / 3600),
2749 (int)((secs / 60) % 60),
ths5fafdf22007-09-16 21:08:06 +00002750 (int)(secs % 60),
bellardfaea38e2006-08-05 21:31:00 +00002751 (int)((sn->vm_clock_nsec / 1000000) % 1000));
2752 snprintf(buf, buf_size,
ths5fafdf22007-09-16 21:08:06 +00002753 "%-10s%-20s%7s%20s%15s",
bellardfaea38e2006-08-05 21:31:00 +00002754 sn->id_str, sn->name,
2755 get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
2756 date_buf,
2757 clock_buf);
2758 }
2759 return buf;
2760}
2761
bellard83f64092006-08-01 16:21:11 +00002762/**************************************************************/
2763/* async I/Os */
2764
aliguori3b69e4b2009-01-22 16:59:24 +00002765BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
aliguorif141eaf2009-04-07 18:43:24 +00002766 QEMUIOVector *qiov, int nb_sectors,
aliguori3b69e4b2009-01-22 16:59:24 +00002767 BlockDriverCompletionFunc *cb, void *opaque)
2768{
Stefan Hajnoczibbf0a442010-10-05 14:28:53 +01002769 trace_bdrv_aio_readv(bs, sector_num, nb_sectors, opaque);
2770
Stefan Hajnoczib2a61372011-10-13 13:08:23 +01002771 return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
Stefan Hajnoczi8c5873d2011-10-13 21:09:28 +01002772 cb, opaque, false);
bellard83f64092006-08-01 16:21:11 +00002773}
2774
aliguorif141eaf2009-04-07 18:43:24 +00002775BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
2776 QEMUIOVector *qiov, int nb_sectors,
2777 BlockDriverCompletionFunc *cb, void *opaque)
bellard83f64092006-08-01 16:21:11 +00002778{
Stefan Hajnoczibbf0a442010-10-05 14:28:53 +01002779 trace_bdrv_aio_writev(bs, sector_num, nb_sectors, opaque);
2780
Stefan Hajnoczi1a6e1152011-10-13 13:08:25 +01002781 return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
Stefan Hajnoczi8c5873d2011-10-13 21:09:28 +01002782 cb, opaque, true);
bellard83f64092006-08-01 16:21:11 +00002783}
2784
Kevin Wolf40b4f532009-09-09 17:53:37 +02002785
2786typedef struct MultiwriteCB {
2787 int error;
2788 int num_requests;
2789 int num_callbacks;
2790 struct {
2791 BlockDriverCompletionFunc *cb;
2792 void *opaque;
2793 QEMUIOVector *free_qiov;
2794 void *free_buf;
2795 } callbacks[];
2796} MultiwriteCB;
2797
2798static void multiwrite_user_cb(MultiwriteCB *mcb)
2799{
2800 int i;
2801
2802 for (i = 0; i < mcb->num_callbacks; i++) {
2803 mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
Stefan Hajnoczi1e1ea482010-04-21 20:35:45 +01002804 if (mcb->callbacks[i].free_qiov) {
2805 qemu_iovec_destroy(mcb->callbacks[i].free_qiov);
2806 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002807 g_free(mcb->callbacks[i].free_qiov);
Herve Poussineauf8a83242010-01-24 21:23:56 +00002808 qemu_vfree(mcb->callbacks[i].free_buf);
Kevin Wolf40b4f532009-09-09 17:53:37 +02002809 }
2810}
2811
2812static void multiwrite_cb(void *opaque, int ret)
2813{
2814 MultiwriteCB *mcb = opaque;
2815
Stefan Hajnoczi6d519a52010-05-22 18:15:08 +01002816 trace_multiwrite_cb(mcb, ret);
2817
Kevin Wolfcb6d3ca2010-04-01 22:48:44 +02002818 if (ret < 0 && !mcb->error) {
Kevin Wolf40b4f532009-09-09 17:53:37 +02002819 mcb->error = ret;
Kevin Wolf40b4f532009-09-09 17:53:37 +02002820 }
2821
2822 mcb->num_requests--;
2823 if (mcb->num_requests == 0) {
Kevin Wolfde189a12010-07-01 16:08:51 +02002824 multiwrite_user_cb(mcb);
Anthony Liguori7267c092011-08-20 22:09:37 -05002825 g_free(mcb);
Kevin Wolf40b4f532009-09-09 17:53:37 +02002826 }
2827}
2828
2829static int multiwrite_req_compare(const void *a, const void *b)
2830{
Christoph Hellwig77be4362010-05-19 20:53:10 +02002831 const BlockRequest *req1 = a, *req2 = b;
2832
2833 /*
2834 * Note that we can't simply subtract req2->sector from req1->sector
2835 * here as that could overflow the return value.
2836 */
2837 if (req1->sector > req2->sector) {
2838 return 1;
2839 } else if (req1->sector < req2->sector) {
2840 return -1;
2841 } else {
2842 return 0;
2843 }
Kevin Wolf40b4f532009-09-09 17:53:37 +02002844}
2845
2846/*
2847 * Takes a bunch of requests and tries to merge them. Returns the number of
2848 * requests that remain after merging.
2849 */
2850static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
2851 int num_reqs, MultiwriteCB *mcb)
2852{
2853 int i, outidx;
2854
2855 // Sort requests by start sector
2856 qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);
2857
2858 // Check if adjacent requests touch the same clusters. If so, combine them,
2859 // filling up gaps with zero sectors.
2860 outidx = 0;
2861 for (i = 1; i < num_reqs; i++) {
2862 int merge = 0;
2863 int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;
2864
2865 // This handles the cases that are valid for all block drivers, namely
2866 // exactly sequential writes and overlapping writes.
2867 if (reqs[i].sector <= oldreq_last) {
2868 merge = 1;
2869 }
2870
2871 // The block driver may decide that it makes sense to combine requests
2872 // even if there is a gap of some sectors between them. In this case,
2873 // the gap is filled with zeros (therefore only applicable for yet
2874 // unused space in format like qcow2).
2875 if (!merge && bs->drv->bdrv_merge_requests) {
2876 merge = bs->drv->bdrv_merge_requests(bs, &reqs[outidx], &reqs[i]);
2877 }
2878
Christoph Hellwige2a305f2010-01-26 14:49:08 +01002879 if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
2880 merge = 0;
2881 }
2882
Kevin Wolf40b4f532009-09-09 17:53:37 +02002883 if (merge) {
2884 size_t size;
Anthony Liguori7267c092011-08-20 22:09:37 -05002885 QEMUIOVector *qiov = g_malloc0(sizeof(*qiov));
Kevin Wolf40b4f532009-09-09 17:53:37 +02002886 qemu_iovec_init(qiov,
2887 reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);
2888
2889 // Add the first request to the merged one. If the requests are
2890 // overlapping, drop the last sectors of the first request.
2891 size = (reqs[i].sector - reqs[outidx].sector) << 9;
2892 qemu_iovec_concat(qiov, reqs[outidx].qiov, size);
2893
2894 // We might need to add some zeros between the two requests
2895 if (reqs[i].sector > oldreq_last) {
2896 size_t zero_bytes = (reqs[i].sector - oldreq_last) << 9;
2897 uint8_t *buf = qemu_blockalign(bs, zero_bytes);
2898 memset(buf, 0, zero_bytes);
2899 qemu_iovec_add(qiov, buf, zero_bytes);
2900 mcb->callbacks[i].free_buf = buf;
2901 }
2902
2903 // Add the second request
2904 qemu_iovec_concat(qiov, reqs[i].qiov, reqs[i].qiov->size);
2905
Kevin Wolfcbf1dff2010-05-21 11:09:42 +02002906 reqs[outidx].nb_sectors = qiov->size >> 9;
Kevin Wolf40b4f532009-09-09 17:53:37 +02002907 reqs[outidx].qiov = qiov;
2908
2909 mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
2910 } else {
2911 outidx++;
2912 reqs[outidx].sector = reqs[i].sector;
2913 reqs[outidx].nb_sectors = reqs[i].nb_sectors;
2914 reqs[outidx].qiov = reqs[i].qiov;
2915 }
2916 }
2917
2918 return outidx + 1;
2919}
2920
2921/*
2922 * Submit multiple AIO write requests at once.
2923 *
2924 * On success, the function returns 0 and all requests in the reqs array have
2925 * been submitted. In error case this function returns -1, and any of the
2926 * requests may or may not be submitted yet. In particular, this means that the
2927 * callback will be called for some of the requests, for others it won't. The
2928 * caller must check the error field of the BlockRequest to wait for the right
2929 * callbacks (if error != 0, no callback will be called).
2930 *
2931 * The implementation may modify the contents of the reqs array, e.g. to merge
2932 * requests. However, the fields opaque and error are left unmodified as they
2933 * are used to signal failure for a single request to the caller.
2934 */
2935int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
2936{
Kevin Wolf40b4f532009-09-09 17:53:37 +02002937 MultiwriteCB *mcb;
2938 int i;
2939
Ryan Harper301db7c2011-03-07 10:01:04 -06002940 /* don't submit writes if we don't have a medium */
2941 if (bs->drv == NULL) {
2942 for (i = 0; i < num_reqs; i++) {
2943 reqs[i].error = -ENOMEDIUM;
2944 }
2945 return -1;
2946 }
2947
Kevin Wolf40b4f532009-09-09 17:53:37 +02002948 if (num_reqs == 0) {
2949 return 0;
2950 }
2951
2952 // Create MultiwriteCB structure
Anthony Liguori7267c092011-08-20 22:09:37 -05002953 mcb = g_malloc0(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
Kevin Wolf40b4f532009-09-09 17:53:37 +02002954 mcb->num_requests = 0;
2955 mcb->num_callbacks = num_reqs;
2956
2957 for (i = 0; i < num_reqs; i++) {
2958 mcb->callbacks[i].cb = reqs[i].cb;
2959 mcb->callbacks[i].opaque = reqs[i].opaque;
2960 }
2961
2962 // Check for mergable requests
2963 num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);
2964
Stefan Hajnoczi6d519a52010-05-22 18:15:08 +01002965 trace_bdrv_aio_multiwrite(mcb, mcb->num_callbacks, num_reqs);
2966
Paolo Bonzinidf9309f2011-11-14 17:50:50 +01002967 /* Run the aio requests. */
2968 mcb->num_requests = num_reqs;
Kevin Wolf40b4f532009-09-09 17:53:37 +02002969 for (i = 0; i < num_reqs; i++) {
Paolo Bonziniad54ae82011-11-30 09:12:30 +01002970 bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
Kevin Wolf40b4f532009-09-09 17:53:37 +02002971 reqs[i].nb_sectors, multiwrite_cb, mcb);
Kevin Wolf40b4f532009-09-09 17:53:37 +02002972 }
2973
2974 return 0;
Kevin Wolf40b4f532009-09-09 17:53:37 +02002975}
2976
bellard83f64092006-08-01 16:21:11 +00002977void bdrv_aio_cancel(BlockDriverAIOCB *acb)
pbrookce1a14d2006-08-07 02:38:06 +00002978{
aliguori6bbff9a2009-03-20 18:25:59 +00002979 acb->pool->cancel(acb);
bellard83f64092006-08-01 16:21:11 +00002980}
2981
Zhi Yong Wu98f90db2011-11-08 13:00:14 +08002982/* block I/O throttling */
2983static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
2984 bool is_write, double elapsed_time, uint64_t *wait)
2985{
2986 uint64_t bps_limit = 0;
2987 double bytes_limit, bytes_base, bytes_res;
2988 double slice_time, wait_time;
2989
2990 if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
2991 bps_limit = bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
2992 } else if (bs->io_limits.bps[is_write]) {
2993 bps_limit = bs->io_limits.bps[is_write];
2994 } else {
2995 if (wait) {
2996 *wait = 0;
2997 }
2998
2999 return false;
3000 }
3001
3002 slice_time = bs->slice_end - bs->slice_start;
3003 slice_time /= (NANOSECONDS_PER_SECOND);
3004 bytes_limit = bps_limit * slice_time;
3005 bytes_base = bs->nr_bytes[is_write] - bs->io_base.bytes[is_write];
3006 if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
3007 bytes_base += bs->nr_bytes[!is_write] - bs->io_base.bytes[!is_write];
3008 }
3009
3010 /* bytes_base: the bytes of data which have been read/written; and
3011 * it is obtained from the history statistic info.
3012 * bytes_res: the remaining bytes of data which need to be read/written.
3013 * (bytes_base + bytes_res) / bps_limit: used to calcuate
3014 * the total time for completing reading/writting all data.
3015 */
3016 bytes_res = (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
3017
3018 if (bytes_base + bytes_res <= bytes_limit) {
3019 if (wait) {
3020 *wait = 0;
3021 }
3022
3023 return false;
3024 }
3025
3026 /* Calc approx time to dispatch */
3027 wait_time = (bytes_base + bytes_res) / bps_limit - elapsed_time;
3028
3029 /* When the I/O rate at runtime exceeds the limits,
3030 * bs->slice_end need to be extended in order that the current statistic
3031 * info can be kept until the timer fire, so it is increased and tuned
3032 * based on the result of experiment.
3033 */
3034 bs->slice_time = wait_time * BLOCK_IO_SLICE_TIME * 10;
3035 bs->slice_end += bs->slice_time - 3 * BLOCK_IO_SLICE_TIME;
3036 if (wait) {
3037 *wait = wait_time * BLOCK_IO_SLICE_TIME * 10;
3038 }
3039
3040 return true;
3041}
3042
3043static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
3044 double elapsed_time, uint64_t *wait)
3045{
3046 uint64_t iops_limit = 0;
3047 double ios_limit, ios_base;
3048 double slice_time, wait_time;
3049
3050 if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
3051 iops_limit = bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
3052 } else if (bs->io_limits.iops[is_write]) {
3053 iops_limit = bs->io_limits.iops[is_write];
3054 } else {
3055 if (wait) {
3056 *wait = 0;
3057 }
3058
3059 return false;
3060 }
3061
3062 slice_time = bs->slice_end - bs->slice_start;
3063 slice_time /= (NANOSECONDS_PER_SECOND);
3064 ios_limit = iops_limit * slice_time;
3065 ios_base = bs->nr_ops[is_write] - bs->io_base.ios[is_write];
3066 if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
3067 ios_base += bs->nr_ops[!is_write] - bs->io_base.ios[!is_write];
3068 }
3069
3070 if (ios_base + 1 <= ios_limit) {
3071 if (wait) {
3072 *wait = 0;
3073 }
3074
3075 return false;
3076 }
3077
3078 /* Calc approx time to dispatch */
3079 wait_time = (ios_base + 1) / iops_limit;
3080 if (wait_time > elapsed_time) {
3081 wait_time = wait_time - elapsed_time;
3082 } else {
3083 wait_time = 0;
3084 }
3085
3086 bs->slice_time = wait_time * BLOCK_IO_SLICE_TIME * 10;
3087 bs->slice_end += bs->slice_time - 3 * BLOCK_IO_SLICE_TIME;
3088 if (wait) {
3089 *wait = wait_time * BLOCK_IO_SLICE_TIME * 10;
3090 }
3091
3092 return true;
3093}
3094
3095static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
3096 bool is_write, int64_t *wait)
3097{
3098 int64_t now, max_wait;
3099 uint64_t bps_wait = 0, iops_wait = 0;
3100 double elapsed_time;
3101 int bps_ret, iops_ret;
3102
3103 now = qemu_get_clock_ns(vm_clock);
3104 if ((bs->slice_start < now)
3105 && (bs->slice_end > now)) {
3106 bs->slice_end = now + bs->slice_time;
3107 } else {
3108 bs->slice_time = 5 * BLOCK_IO_SLICE_TIME;
3109 bs->slice_start = now;
3110 bs->slice_end = now + bs->slice_time;
3111
3112 bs->io_base.bytes[is_write] = bs->nr_bytes[is_write];
3113 bs->io_base.bytes[!is_write] = bs->nr_bytes[!is_write];
3114
3115 bs->io_base.ios[is_write] = bs->nr_ops[is_write];
3116 bs->io_base.ios[!is_write] = bs->nr_ops[!is_write];
3117 }
3118
3119 elapsed_time = now - bs->slice_start;
3120 elapsed_time /= (NANOSECONDS_PER_SECOND);
3121
3122 bps_ret = bdrv_exceed_bps_limits(bs, nb_sectors,
3123 is_write, elapsed_time, &bps_wait);
3124 iops_ret = bdrv_exceed_iops_limits(bs, is_write,
3125 elapsed_time, &iops_wait);
3126 if (bps_ret || iops_ret) {
3127 max_wait = bps_wait > iops_wait ? bps_wait : iops_wait;
3128 if (wait) {
3129 *wait = max_wait;
3130 }
3131
3132 now = qemu_get_clock_ns(vm_clock);
3133 if (bs->slice_end < now + max_wait) {
3134 bs->slice_end = now + max_wait;
3135 }
3136
3137 return true;
3138 }
3139
3140 if (wait) {
3141 *wait = 0;
3142 }
3143
3144 return false;
3145}
pbrookce1a14d2006-08-07 02:38:06 +00003146
bellard83f64092006-08-01 16:21:11 +00003147/**************************************************************/
3148/* async block device emulation */
3149
Christoph Hellwigc16b5a22009-05-25 12:37:32 +02003150typedef struct BlockDriverAIOCBSync {
3151 BlockDriverAIOCB common;
3152 QEMUBH *bh;
3153 int ret;
3154 /* vector translation state */
3155 QEMUIOVector *qiov;
3156 uint8_t *bounce;
3157 int is_write;
3158} BlockDriverAIOCBSync;
3159
3160static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
3161{
Kevin Wolfb666d232010-05-05 11:44:39 +02003162 BlockDriverAIOCBSync *acb =
3163 container_of(blockacb, BlockDriverAIOCBSync, common);
Dor Laor6a7ad292009-06-01 12:07:23 +03003164 qemu_bh_delete(acb->bh);
Avi Kivity36afc452009-06-23 16:20:36 +03003165 acb->bh = NULL;
Christoph Hellwigc16b5a22009-05-25 12:37:32 +02003166 qemu_aio_release(acb);
3167}
3168
3169static AIOPool bdrv_em_aio_pool = {
3170 .aiocb_size = sizeof(BlockDriverAIOCBSync),
3171 .cancel = bdrv_aio_cancel_em,
3172};
3173
bellard83f64092006-08-01 16:21:11 +00003174static void bdrv_aio_bh_cb(void *opaque)
bellardbeac80c2006-06-26 20:08:57 +00003175{
pbrookce1a14d2006-08-07 02:38:06 +00003176 BlockDriverAIOCBSync *acb = opaque;
aliguorif141eaf2009-04-07 18:43:24 +00003177
aliguorif141eaf2009-04-07 18:43:24 +00003178 if (!acb->is_write)
3179 qemu_iovec_from_buffer(acb->qiov, acb->bounce, acb->qiov->size);
aliguoriceb42de2009-04-07 18:43:28 +00003180 qemu_vfree(acb->bounce);
pbrookce1a14d2006-08-07 02:38:06 +00003181 acb->common.cb(acb->common.opaque, acb->ret);
Dor Laor6a7ad292009-06-01 12:07:23 +03003182 qemu_bh_delete(acb->bh);
Avi Kivity36afc452009-06-23 16:20:36 +03003183 acb->bh = NULL;
pbrookce1a14d2006-08-07 02:38:06 +00003184 qemu_aio_release(acb);
bellardbeac80c2006-06-26 20:08:57 +00003185}
bellardbeac80c2006-06-26 20:08:57 +00003186
aliguorif141eaf2009-04-07 18:43:24 +00003187static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
3188 int64_t sector_num,
3189 QEMUIOVector *qiov,
3190 int nb_sectors,
3191 BlockDriverCompletionFunc *cb,
3192 void *opaque,
3193 int is_write)
3194
bellardea2384d2004-08-01 21:59:26 +00003195{
pbrookce1a14d2006-08-07 02:38:06 +00003196 BlockDriverAIOCBSync *acb;
pbrookce1a14d2006-08-07 02:38:06 +00003197
Christoph Hellwigc16b5a22009-05-25 12:37:32 +02003198 acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
aliguorif141eaf2009-04-07 18:43:24 +00003199 acb->is_write = is_write;
3200 acb->qiov = qiov;
aliguorie268ca52009-04-22 20:20:00 +00003201 acb->bounce = qemu_blockalign(bs, qiov->size);
Paolo Bonzini3f3aace2011-11-14 17:50:54 +01003202 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
aliguorif141eaf2009-04-07 18:43:24 +00003203
3204 if (is_write) {
3205 qemu_iovec_to_buffer(acb->qiov, acb->bounce);
Stefan Hajnoczi1ed20ac2011-10-13 13:08:21 +01003206 acb->ret = bs->drv->bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
aliguorif141eaf2009-04-07 18:43:24 +00003207 } else {
Stefan Hajnoczi1ed20ac2011-10-13 13:08:21 +01003208 acb->ret = bs->drv->bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
aliguorif141eaf2009-04-07 18:43:24 +00003209 }
3210
pbrookce1a14d2006-08-07 02:38:06 +00003211 qemu_bh_schedule(acb->bh);
aliguorif141eaf2009-04-07 18:43:24 +00003212
pbrookce1a14d2006-08-07 02:38:06 +00003213 return &acb->common;
pbrook7a6cba62006-06-04 11:39:07 +00003214}
3215
aliguorif141eaf2009-04-07 18:43:24 +00003216static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
3217 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
pbrookce1a14d2006-08-07 02:38:06 +00003218 BlockDriverCompletionFunc *cb, void *opaque)
bellard83f64092006-08-01 16:21:11 +00003219{
aliguorif141eaf2009-04-07 18:43:24 +00003220 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
bellard83f64092006-08-01 16:21:11 +00003221}
3222
aliguorif141eaf2009-04-07 18:43:24 +00003223static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
3224 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
3225 BlockDriverCompletionFunc *cb, void *opaque)
3226{
3227 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
3228}
3229
Kevin Wolf68485422011-06-30 10:05:46 +02003230
3231typedef struct BlockDriverAIOCBCoroutine {
3232 BlockDriverAIOCB common;
3233 BlockRequest req;
3234 bool is_write;
3235 QEMUBH* bh;
3236} BlockDriverAIOCBCoroutine;
3237
3238static void bdrv_aio_co_cancel_em(BlockDriverAIOCB *blockacb)
3239{
3240 qemu_aio_flush();
3241}
3242
3243static AIOPool bdrv_em_co_aio_pool = {
3244 .aiocb_size = sizeof(BlockDriverAIOCBCoroutine),
3245 .cancel = bdrv_aio_co_cancel_em,
3246};
3247
Paolo Bonzini35246a62011-10-14 10:41:29 +02003248static void bdrv_co_em_bh(void *opaque)
Kevin Wolf68485422011-06-30 10:05:46 +02003249{
3250 BlockDriverAIOCBCoroutine *acb = opaque;
3251
3252 acb->common.cb(acb->common.opaque, acb->req.error);
3253 qemu_bh_delete(acb->bh);
3254 qemu_aio_release(acb);
3255}
3256
Stefan Hajnoczib2a61372011-10-13 13:08:23 +01003257/* Invoke bdrv_co_do_readv/bdrv_co_do_writev */
3258static void coroutine_fn bdrv_co_do_rw(void *opaque)
3259{
3260 BlockDriverAIOCBCoroutine *acb = opaque;
3261 BlockDriverState *bs = acb->common.bs;
3262
3263 if (!acb->is_write) {
3264 acb->req.error = bdrv_co_do_readv(bs, acb->req.sector,
Stefan Hajnoczi470c0502012-01-18 14:40:42 +00003265 acb->req.nb_sectors, acb->req.qiov, 0);
Stefan Hajnoczib2a61372011-10-13 13:08:23 +01003266 } else {
3267 acb->req.error = bdrv_co_do_writev(bs, acb->req.sector,
Stefan Hajnoczif08f2dd2012-02-07 13:27:25 +00003268 acb->req.nb_sectors, acb->req.qiov, 0);
Stefan Hajnoczib2a61372011-10-13 13:08:23 +01003269 }
3270
Paolo Bonzini35246a62011-10-14 10:41:29 +02003271 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
Stefan Hajnoczib2a61372011-10-13 13:08:23 +01003272 qemu_bh_schedule(acb->bh);
3273}
3274
Kevin Wolf68485422011-06-30 10:05:46 +02003275static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
3276 int64_t sector_num,
3277 QEMUIOVector *qiov,
3278 int nb_sectors,
3279 BlockDriverCompletionFunc *cb,
3280 void *opaque,
Stefan Hajnoczi8c5873d2011-10-13 21:09:28 +01003281 bool is_write)
Kevin Wolf68485422011-06-30 10:05:46 +02003282{
3283 Coroutine *co;
3284 BlockDriverAIOCBCoroutine *acb;
3285
3286 acb = qemu_aio_get(&bdrv_em_co_aio_pool, bs, cb, opaque);
3287 acb->req.sector = sector_num;
3288 acb->req.nb_sectors = nb_sectors;
3289 acb->req.qiov = qiov;
3290 acb->is_write = is_write;
3291
Stefan Hajnoczi8c5873d2011-10-13 21:09:28 +01003292 co = qemu_coroutine_create(bdrv_co_do_rw);
Kevin Wolf68485422011-06-30 10:05:46 +02003293 qemu_coroutine_enter(co, acb);
3294
3295 return &acb->common;
3296}
3297
Paolo Bonzini07f07612011-10-17 12:32:12 +02003298static void coroutine_fn bdrv_aio_flush_co_entry(void *opaque)
Christoph Hellwigb2e12bc2009-09-04 19:01:49 +02003299{
Paolo Bonzini07f07612011-10-17 12:32:12 +02003300 BlockDriverAIOCBCoroutine *acb = opaque;
3301 BlockDriverState *bs = acb->common.bs;
Christoph Hellwigb2e12bc2009-09-04 19:01:49 +02003302
Paolo Bonzini07f07612011-10-17 12:32:12 +02003303 acb->req.error = bdrv_co_flush(bs);
3304 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
Christoph Hellwigb2e12bc2009-09-04 19:01:49 +02003305 qemu_bh_schedule(acb->bh);
Christoph Hellwigb2e12bc2009-09-04 19:01:49 +02003306}
3307
Paolo Bonzini07f07612011-10-17 12:32:12 +02003308BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
Alexander Graf016f5cf2010-05-26 17:51:49 +02003309 BlockDriverCompletionFunc *cb, void *opaque)
3310{
Paolo Bonzini07f07612011-10-17 12:32:12 +02003311 trace_bdrv_aio_flush(bs, opaque);
Alexander Graf016f5cf2010-05-26 17:51:49 +02003312
Paolo Bonzini07f07612011-10-17 12:32:12 +02003313 Coroutine *co;
3314 BlockDriverAIOCBCoroutine *acb;
Alexander Graf016f5cf2010-05-26 17:51:49 +02003315
Paolo Bonzini07f07612011-10-17 12:32:12 +02003316 acb = qemu_aio_get(&bdrv_em_co_aio_pool, bs, cb, opaque);
3317 co = qemu_coroutine_create(bdrv_aio_flush_co_entry);
3318 qemu_coroutine_enter(co, acb);
Alexander Graf016f5cf2010-05-26 17:51:49 +02003319
Alexander Graf016f5cf2010-05-26 17:51:49 +02003320 return &acb->common;
3321}
3322
Paolo Bonzini4265d622011-10-17 12:32:14 +02003323static void coroutine_fn bdrv_aio_discard_co_entry(void *opaque)
3324{
3325 BlockDriverAIOCBCoroutine *acb = opaque;
3326 BlockDriverState *bs = acb->common.bs;
3327
3328 acb->req.error = bdrv_co_discard(bs, acb->req.sector, acb->req.nb_sectors);
3329 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
3330 qemu_bh_schedule(acb->bh);
3331}
3332
3333BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
3334 int64_t sector_num, int nb_sectors,
3335 BlockDriverCompletionFunc *cb, void *opaque)
3336{
3337 Coroutine *co;
3338 BlockDriverAIOCBCoroutine *acb;
3339
3340 trace_bdrv_aio_discard(bs, sector_num, nb_sectors, opaque);
3341
3342 acb = qemu_aio_get(&bdrv_em_co_aio_pool, bs, cb, opaque);
3343 acb->req.sector = sector_num;
3344 acb->req.nb_sectors = nb_sectors;
3345 co = qemu_coroutine_create(bdrv_aio_discard_co_entry);
3346 qemu_coroutine_enter(co, acb);
3347
3348 return &acb->common;
3349}
3350
bellardea2384d2004-08-01 21:59:26 +00003351void bdrv_init(void)
3352{
Anthony Liguori5efa9d52009-05-09 17:03:42 -05003353 module_call_init(MODULE_INIT_BLOCK);
bellardea2384d2004-08-01 21:59:26 +00003354}
pbrookce1a14d2006-08-07 02:38:06 +00003355
Markus Armbrustereb852012009-10-27 18:41:44 +01003356void bdrv_init_with_whitelist(void)
3357{
3358 use_bdrv_whitelist = 1;
3359 bdrv_init();
3360}
3361
Christoph Hellwigc16b5a22009-05-25 12:37:32 +02003362void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
3363 BlockDriverCompletionFunc *cb, void *opaque)
aliguori6bbff9a2009-03-20 18:25:59 +00003364{
pbrookce1a14d2006-08-07 02:38:06 +00003365 BlockDriverAIOCB *acb;
3366
aliguori6bbff9a2009-03-20 18:25:59 +00003367 if (pool->free_aiocb) {
3368 acb = pool->free_aiocb;
3369 pool->free_aiocb = acb->next;
pbrookce1a14d2006-08-07 02:38:06 +00003370 } else {
Anthony Liguori7267c092011-08-20 22:09:37 -05003371 acb = g_malloc0(pool->aiocb_size);
aliguori6bbff9a2009-03-20 18:25:59 +00003372 acb->pool = pool;
pbrookce1a14d2006-08-07 02:38:06 +00003373 }
3374 acb->bs = bs;
3375 acb->cb = cb;
3376 acb->opaque = opaque;
3377 return acb;
3378}
3379
3380void qemu_aio_release(void *p)
3381{
aliguori6bbff9a2009-03-20 18:25:59 +00003382 BlockDriverAIOCB *acb = (BlockDriverAIOCB *)p;
3383 AIOPool *pool = acb->pool;
3384 acb->next = pool->free_aiocb;
3385 pool->free_aiocb = acb;
pbrookce1a14d2006-08-07 02:38:06 +00003386}
bellard19cb3732006-08-19 11:45:59 +00003387
3388/**************************************************************/
Kevin Wolff9f05dc2011-07-15 13:50:26 +02003389/* Coroutine block device emulation */
3390
3391typedef struct CoroutineIOCompletion {
3392 Coroutine *coroutine;
3393 int ret;
3394} CoroutineIOCompletion;
3395
3396static void bdrv_co_io_em_complete(void *opaque, int ret)
3397{
3398 CoroutineIOCompletion *co = opaque;
3399
3400 co->ret = ret;
3401 qemu_coroutine_enter(co->coroutine, NULL);
3402}
3403
3404static int coroutine_fn bdrv_co_io_em(BlockDriverState *bs, int64_t sector_num,
3405 int nb_sectors, QEMUIOVector *iov,
3406 bool is_write)
3407{
3408 CoroutineIOCompletion co = {
3409 .coroutine = qemu_coroutine_self(),
3410 };
3411 BlockDriverAIOCB *acb;
3412
3413 if (is_write) {
Stefan Hajnoczia652d162011-10-05 17:17:02 +01003414 acb = bs->drv->bdrv_aio_writev(bs, sector_num, iov, nb_sectors,
3415 bdrv_co_io_em_complete, &co);
Kevin Wolff9f05dc2011-07-15 13:50:26 +02003416 } else {
Stefan Hajnoczia652d162011-10-05 17:17:02 +01003417 acb = bs->drv->bdrv_aio_readv(bs, sector_num, iov, nb_sectors,
3418 bdrv_co_io_em_complete, &co);
Kevin Wolff9f05dc2011-07-15 13:50:26 +02003419 }
3420
Stefan Hajnoczi59370aa2011-09-30 17:34:58 +01003421 trace_bdrv_co_io_em(bs, sector_num, nb_sectors, is_write, acb);
Kevin Wolff9f05dc2011-07-15 13:50:26 +02003422 if (!acb) {
3423 return -EIO;
3424 }
3425 qemu_coroutine_yield();
3426
3427 return co.ret;
3428}
3429
3430static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
3431 int64_t sector_num, int nb_sectors,
3432 QEMUIOVector *iov)
3433{
3434 return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, false);
3435}
3436
3437static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
3438 int64_t sector_num, int nb_sectors,
3439 QEMUIOVector *iov)
3440{
3441 return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, true);
3442}
3443
Paolo Bonzini07f07612011-10-17 12:32:12 +02003444static void coroutine_fn bdrv_flush_co_entry(void *opaque)
Kevin Wolfe7a8a782011-07-15 16:05:00 +02003445{
Paolo Bonzini07f07612011-10-17 12:32:12 +02003446 RwCo *rwco = opaque;
Kevin Wolfe7a8a782011-07-15 16:05:00 +02003447
Paolo Bonzini07f07612011-10-17 12:32:12 +02003448 rwco->ret = bdrv_co_flush(rwco->bs);
3449}
3450
3451int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
3452{
Kevin Wolfeb489bb2011-11-10 18:10:11 +01003453 int ret;
3454
Kevin Wolfca716362011-11-10 18:13:59 +01003455 if (!bs->drv) {
Paolo Bonzini07f07612011-10-17 12:32:12 +02003456 return 0;
Kevin Wolfeb489bb2011-11-10 18:10:11 +01003457 }
3458
Kevin Wolfca716362011-11-10 18:13:59 +01003459 /* Write back cached data to the OS even with cache=unsafe */
Kevin Wolfeb489bb2011-11-10 18:10:11 +01003460 if (bs->drv->bdrv_co_flush_to_os) {
3461 ret = bs->drv->bdrv_co_flush_to_os(bs);
3462 if (ret < 0) {
3463 return ret;
3464 }
3465 }
3466
Kevin Wolfca716362011-11-10 18:13:59 +01003467 /* But don't actually force it to the disk with cache=unsafe */
3468 if (bs->open_flags & BDRV_O_NO_FLUSH) {
3469 return 0;
3470 }
3471
Kevin Wolfeb489bb2011-11-10 18:10:11 +01003472 if (bs->drv->bdrv_co_flush_to_disk) {
Kevin Wolfc68b89a2011-11-10 17:25:44 +01003473 return bs->drv->bdrv_co_flush_to_disk(bs);
Paolo Bonzini07f07612011-10-17 12:32:12 +02003474 } else if (bs->drv->bdrv_aio_flush) {
3475 BlockDriverAIOCB *acb;
3476 CoroutineIOCompletion co = {
3477 .coroutine = qemu_coroutine_self(),
3478 };
3479
3480 acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co);
3481 if (acb == NULL) {
3482 return -EIO;
3483 } else {
3484 qemu_coroutine_yield();
3485 return co.ret;
3486 }
Paolo Bonzini07f07612011-10-17 12:32:12 +02003487 } else {
3488 /*
3489 * Some block drivers always operate in either writethrough or unsafe
3490 * mode and don't support bdrv_flush therefore. Usually qemu doesn't
3491 * know how the server works (because the behaviour is hardcoded or
3492 * depends on server-side configuration), so we can't ensure that
3493 * everything is safe on disk. Returning an error doesn't work because
3494 * that would break guests even if the server operates in writethrough
3495 * mode.
3496 *
3497 * Let's hope the user knows what he's doing.
3498 */
3499 return 0;
Kevin Wolfe7a8a782011-07-15 16:05:00 +02003500 }
Paolo Bonzini07f07612011-10-17 12:32:12 +02003501}
3502
Anthony Liguori0f154232011-11-14 15:09:45 -06003503void bdrv_invalidate_cache(BlockDriverState *bs)
3504{
3505 if (bs->drv && bs->drv->bdrv_invalidate_cache) {
3506 bs->drv->bdrv_invalidate_cache(bs);
3507 }
3508}
3509
3510void bdrv_invalidate_cache_all(void)
3511{
3512 BlockDriverState *bs;
3513
3514 QTAILQ_FOREACH(bs, &bdrv_states, list) {
3515 bdrv_invalidate_cache(bs);
3516 }
3517}
3518
Paolo Bonzini07f07612011-10-17 12:32:12 +02003519int bdrv_flush(BlockDriverState *bs)
3520{
3521 Coroutine *co;
3522 RwCo rwco = {
3523 .bs = bs,
3524 .ret = NOT_DONE,
3525 };
3526
3527 if (qemu_in_coroutine()) {
3528 /* Fast-path if already in coroutine context */
3529 bdrv_flush_co_entry(&rwco);
3530 } else {
3531 co = qemu_coroutine_create(bdrv_flush_co_entry);
3532 qemu_coroutine_enter(co, &rwco);
3533 while (rwco.ret == NOT_DONE) {
3534 qemu_aio_wait();
3535 }
3536 }
3537
3538 return rwco.ret;
Kevin Wolfe7a8a782011-07-15 16:05:00 +02003539}
3540
Paolo Bonzini4265d622011-10-17 12:32:14 +02003541static void coroutine_fn bdrv_discard_co_entry(void *opaque)
3542{
3543 RwCo *rwco = opaque;
3544
3545 rwco->ret = bdrv_co_discard(rwco->bs, rwco->sector_num, rwco->nb_sectors);
3546}
3547
3548int coroutine_fn bdrv_co_discard(BlockDriverState *bs, int64_t sector_num,
3549 int nb_sectors)
3550{
3551 if (!bs->drv) {
3552 return -ENOMEDIUM;
3553 } else if (bdrv_check_request(bs, sector_num, nb_sectors)) {
3554 return -EIO;
3555 } else if (bs->read_only) {
3556 return -EROFS;
3557 } else if (bs->drv->bdrv_co_discard) {
3558 return bs->drv->bdrv_co_discard(bs, sector_num, nb_sectors);
3559 } else if (bs->drv->bdrv_aio_discard) {
3560 BlockDriverAIOCB *acb;
3561 CoroutineIOCompletion co = {
3562 .coroutine = qemu_coroutine_self(),
3563 };
3564
3565 acb = bs->drv->bdrv_aio_discard(bs, sector_num, nb_sectors,
3566 bdrv_co_io_em_complete, &co);
3567 if (acb == NULL) {
3568 return -EIO;
3569 } else {
3570 qemu_coroutine_yield();
3571 return co.ret;
3572 }
Paolo Bonzini4265d622011-10-17 12:32:14 +02003573 } else {
3574 return 0;
3575 }
3576}
3577
3578int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors)
3579{
3580 Coroutine *co;
3581 RwCo rwco = {
3582 .bs = bs,
3583 .sector_num = sector_num,
3584 .nb_sectors = nb_sectors,
3585 .ret = NOT_DONE,
3586 };
3587
3588 if (qemu_in_coroutine()) {
3589 /* Fast-path if already in coroutine context */
3590 bdrv_discard_co_entry(&rwco);
3591 } else {
3592 co = qemu_coroutine_create(bdrv_discard_co_entry);
3593 qemu_coroutine_enter(co, &rwco);
3594 while (rwco.ret == NOT_DONE) {
3595 qemu_aio_wait();
3596 }
3597 }
3598
3599 return rwco.ret;
3600}
3601
Kevin Wolff9f05dc2011-07-15 13:50:26 +02003602/**************************************************************/
bellard19cb3732006-08-19 11:45:59 +00003603/* removable device support */
3604
3605/**
3606 * Return TRUE if the media is present
3607 */
3608int bdrv_is_inserted(BlockDriverState *bs)
3609{
3610 BlockDriver *drv = bs->drv;
Markus Armbrustera1aff5b2011-09-06 18:58:41 +02003611
bellard19cb3732006-08-19 11:45:59 +00003612 if (!drv)
3613 return 0;
3614 if (!drv->bdrv_is_inserted)
Markus Armbrustera1aff5b2011-09-06 18:58:41 +02003615 return 1;
3616 return drv->bdrv_is_inserted(bs);
bellard19cb3732006-08-19 11:45:59 +00003617}
3618
3619/**
Markus Armbruster8e49ca42011-08-03 15:08:08 +02003620 * Return whether the media changed since the last call to this
3621 * function, or -ENOTSUP if we don't know. Most drivers don't know.
bellard19cb3732006-08-19 11:45:59 +00003622 */
3623int bdrv_media_changed(BlockDriverState *bs)
3624{
3625 BlockDriver *drv = bs->drv;
bellard19cb3732006-08-19 11:45:59 +00003626
Markus Armbruster8e49ca42011-08-03 15:08:08 +02003627 if (drv && drv->bdrv_media_changed) {
3628 return drv->bdrv_media_changed(bs);
3629 }
3630 return -ENOTSUP;
bellard19cb3732006-08-19 11:45:59 +00003631}
3632
3633/**
3634 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
3635 */
Luiz Capitulinof36f3942012-02-03 16:24:53 -02003636void bdrv_eject(BlockDriverState *bs, bool eject_flag)
bellard19cb3732006-08-19 11:45:59 +00003637{
3638 BlockDriver *drv = bs->drv;
bellard19cb3732006-08-19 11:45:59 +00003639
Markus Armbruster822e1cd2011-07-20 18:23:42 +02003640 if (drv && drv->bdrv_eject) {
3641 drv->bdrv_eject(bs, eject_flag);
bellard19cb3732006-08-19 11:45:59 +00003642 }
Luiz Capitulino6f382ed2012-02-14 13:41:13 -02003643
3644 if (bs->device_name[0] != '\0') {
3645 bdrv_emit_qmp_eject_event(bs, eject_flag);
3646 }
bellard19cb3732006-08-19 11:45:59 +00003647}
3648
bellard19cb3732006-08-19 11:45:59 +00003649/**
3650 * Lock or unlock the media (if it is locked, the user won't be able
3651 * to eject it manually).
3652 */
Markus Armbruster025e8492011-09-06 18:58:47 +02003653void bdrv_lock_medium(BlockDriverState *bs, bool locked)
bellard19cb3732006-08-19 11:45:59 +00003654{
3655 BlockDriver *drv = bs->drv;
3656
Markus Armbruster025e8492011-09-06 18:58:47 +02003657 trace_bdrv_lock_medium(bs, locked);
Stefan Hajnoczib8c6d092011-03-29 20:04:40 +01003658
Markus Armbruster025e8492011-09-06 18:58:47 +02003659 if (drv && drv->bdrv_lock_medium) {
3660 drv->bdrv_lock_medium(bs, locked);
bellard19cb3732006-08-19 11:45:59 +00003661 }
3662}
ths985a03b2007-12-24 16:10:43 +00003663
3664/* needed for generic scsi interface */
3665
3666int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
3667{
3668 BlockDriver *drv = bs->drv;
3669
3670 if (drv && drv->bdrv_ioctl)
3671 return drv->bdrv_ioctl(bs, req, buf);
3672 return -ENOTSUP;
3673}
aliguori7d780662009-03-12 19:57:08 +00003674
aliguori221f7152009-03-28 17:28:41 +00003675BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
3676 unsigned long int req, void *buf,
3677 BlockDriverCompletionFunc *cb, void *opaque)
aliguori7d780662009-03-12 19:57:08 +00003678{
aliguori221f7152009-03-28 17:28:41 +00003679 BlockDriver *drv = bs->drv;
aliguori7d780662009-03-12 19:57:08 +00003680
aliguori221f7152009-03-28 17:28:41 +00003681 if (drv && drv->bdrv_aio_ioctl)
3682 return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
3683 return NULL;
aliguori7d780662009-03-12 19:57:08 +00003684}
aliguorie268ca52009-04-22 20:20:00 +00003685
Markus Armbruster7b6f9302011-09-06 18:58:56 +02003686void bdrv_set_buffer_alignment(BlockDriverState *bs, int align)
3687{
3688 bs->buffer_alignment = align;
3689}
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02003690
aliguorie268ca52009-04-22 20:20:00 +00003691void *qemu_blockalign(BlockDriverState *bs, size_t size)
3692{
3693 return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
3694}
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02003695
3696void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable)
3697{
3698 int64_t bitmap_size;
Jan Kiszkaa55eb922009-11-30 18:21:19 +01003699
Liran Schouraaa0eb72010-01-26 10:31:48 +02003700 bs->dirty_count = 0;
Jan Kiszkaa55eb922009-11-30 18:21:19 +01003701 if (enable) {
Jan Kiszkac6d22832009-11-30 18:21:20 +01003702 if (!bs->dirty_bitmap) {
3703 bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS) +
3704 BDRV_SECTORS_PER_DIRTY_CHUNK * 8 - 1;
3705 bitmap_size /= BDRV_SECTORS_PER_DIRTY_CHUNK * 8;
Jan Kiszkaa55eb922009-11-30 18:21:19 +01003706
Anthony Liguori7267c092011-08-20 22:09:37 -05003707 bs->dirty_bitmap = g_malloc0(bitmap_size);
Jan Kiszkaa55eb922009-11-30 18:21:19 +01003708 }
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02003709 } else {
Jan Kiszkac6d22832009-11-30 18:21:20 +01003710 if (bs->dirty_bitmap) {
Anthony Liguori7267c092011-08-20 22:09:37 -05003711 g_free(bs->dirty_bitmap);
Jan Kiszkac6d22832009-11-30 18:21:20 +01003712 bs->dirty_bitmap = NULL;
Jan Kiszkaa55eb922009-11-30 18:21:19 +01003713 }
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02003714 }
3715}
3716
3717int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
3718{
Jan Kiszka6ea44302009-11-30 18:21:19 +01003719 int64_t chunk = sector / (int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK;
Jan Kiszkaa55eb922009-11-30 18:21:19 +01003720
Jan Kiszkac6d22832009-11-30 18:21:20 +01003721 if (bs->dirty_bitmap &&
3722 (sector << BDRV_SECTOR_BITS) < bdrv_getlength(bs)) {
Marcelo Tosatti6d59fec2010-11-08 17:02:54 -02003723 return !!(bs->dirty_bitmap[chunk / (sizeof(unsigned long) * 8)] &
3724 (1UL << (chunk % (sizeof(unsigned long) * 8))));
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02003725 } else {
3726 return 0;
3727 }
3728}
3729
Jan Kiszkaa55eb922009-11-30 18:21:19 +01003730void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
3731 int nr_sectors)
lirans@il.ibm.com7cd1e322009-11-02 15:40:41 +02003732{
3733 set_dirty_bitmap(bs, cur_sector, nr_sectors, 0);
3734}
Liran Schouraaa0eb72010-01-26 10:31:48 +02003735
3736int64_t bdrv_get_dirty_count(BlockDriverState *bs)
3737{
3738 return bs->dirty_count;
3739}
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003740
Marcelo Tosattidb593f22011-01-26 12:12:34 -02003741void bdrv_set_in_use(BlockDriverState *bs, int in_use)
3742{
3743 assert(bs->in_use != in_use);
3744 bs->in_use = in_use;
3745}
3746
3747int bdrv_in_use(BlockDriverState *bs)
3748{
3749 return bs->in_use;
3750}
3751
Luiz Capitulino28a72822011-09-26 17:43:50 -03003752void bdrv_iostatus_enable(BlockDriverState *bs)
3753{
Luiz Capitulinod6bf2792011-10-14 17:11:23 -03003754 bs->iostatus_enabled = true;
Luiz Capitulino58e21ef2011-10-14 17:22:24 -03003755 bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
Luiz Capitulino28a72822011-09-26 17:43:50 -03003756}
3757
3758/* The I/O status is only enabled if the drive explicitly
3759 * enables it _and_ the VM is configured to stop on errors */
3760bool bdrv_iostatus_is_enabled(const BlockDriverState *bs)
3761{
Luiz Capitulinod6bf2792011-10-14 17:11:23 -03003762 return (bs->iostatus_enabled &&
Luiz Capitulino28a72822011-09-26 17:43:50 -03003763 (bs->on_write_error == BLOCK_ERR_STOP_ENOSPC ||
3764 bs->on_write_error == BLOCK_ERR_STOP_ANY ||
3765 bs->on_read_error == BLOCK_ERR_STOP_ANY));
3766}
3767
3768void bdrv_iostatus_disable(BlockDriverState *bs)
3769{
Luiz Capitulinod6bf2792011-10-14 17:11:23 -03003770 bs->iostatus_enabled = false;
Luiz Capitulino28a72822011-09-26 17:43:50 -03003771}
3772
3773void bdrv_iostatus_reset(BlockDriverState *bs)
3774{
3775 if (bdrv_iostatus_is_enabled(bs)) {
Luiz Capitulino58e21ef2011-10-14 17:22:24 -03003776 bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
Luiz Capitulino28a72822011-09-26 17:43:50 -03003777 }
3778}
3779
3780/* XXX: Today this is set by device models because it makes the implementation
3781 quite simple. However, the block layer knows about the error, so it's
3782 possible to implement this without device models being involved */
3783void bdrv_iostatus_set_err(BlockDriverState *bs, int error)
3784{
Luiz Capitulino58e21ef2011-10-14 17:22:24 -03003785 if (bdrv_iostatus_is_enabled(bs) &&
3786 bs->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
Luiz Capitulino28a72822011-09-26 17:43:50 -03003787 assert(error >= 0);
Luiz Capitulino58e21ef2011-10-14 17:22:24 -03003788 bs->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
3789 BLOCK_DEVICE_IO_STATUS_FAILED;
Luiz Capitulino28a72822011-09-26 17:43:50 -03003790 }
3791}
3792
Christoph Hellwiga597e792011-08-25 08:26:01 +02003793void
3794bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, int64_t bytes,
3795 enum BlockAcctType type)
3796{
3797 assert(type < BDRV_MAX_IOTYPE);
3798
3799 cookie->bytes = bytes;
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02003800 cookie->start_time_ns = get_clock();
Christoph Hellwiga597e792011-08-25 08:26:01 +02003801 cookie->type = type;
3802}
3803
3804void
3805bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie)
3806{
3807 assert(cookie->type < BDRV_MAX_IOTYPE);
3808
3809 bs->nr_bytes[cookie->type] += cookie->bytes;
3810 bs->nr_ops[cookie->type]++;
Christoph Hellwigc488c7f2011-08-25 08:26:10 +02003811 bs->total_time_ns[cookie->type] += get_clock() - cookie->start_time_ns;
Christoph Hellwiga597e792011-08-25 08:26:01 +02003812}
3813
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003814int bdrv_img_create(const char *filename, const char *fmt,
3815 const char *base_filename, const char *base_fmt,
3816 char *options, uint64_t img_size, int flags)
3817{
3818 QEMUOptionParameter *param = NULL, *create_options = NULL;
Kevin Wolfd2208942011-06-01 14:03:31 +02003819 QEMUOptionParameter *backing_fmt, *backing_file, *size;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003820 BlockDriverState *bs = NULL;
3821 BlockDriver *drv, *proto_drv;
Stefan Hajnoczi96df67d2011-01-24 09:32:20 +00003822 BlockDriver *backing_drv = NULL;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003823 int ret = 0;
3824
3825 /* Find driver and parse its options */
3826 drv = bdrv_find_format(fmt);
3827 if (!drv) {
3828 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4f70f242010-12-16 13:52:18 +01003829 ret = -EINVAL;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003830 goto out;
3831 }
3832
3833 proto_drv = bdrv_find_protocol(filename);
3834 if (!proto_drv) {
3835 error_report("Unknown protocol '%s'", filename);
Jes Sorensen4f70f242010-12-16 13:52:18 +01003836 ret = -EINVAL;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003837 goto out;
3838 }
3839
3840 create_options = append_option_parameters(create_options,
3841 drv->create_options);
3842 create_options = append_option_parameters(create_options,
3843 proto_drv->create_options);
3844
3845 /* Create parameter list with default values */
3846 param = parse_option_parameters("", create_options, param);
3847
3848 set_option_parameter_int(param, BLOCK_OPT_SIZE, img_size);
3849
3850 /* Parse -o options */
3851 if (options) {
3852 param = parse_option_parameters(options, create_options, param);
3853 if (param == NULL) {
3854 error_report("Invalid options for file format '%s'.", fmt);
Jes Sorensen4f70f242010-12-16 13:52:18 +01003855 ret = -EINVAL;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003856 goto out;
3857 }
3858 }
3859
3860 if (base_filename) {
3861 if (set_option_parameter(param, BLOCK_OPT_BACKING_FILE,
3862 base_filename)) {
3863 error_report("Backing file not supported for file format '%s'",
3864 fmt);
Jes Sorensen4f70f242010-12-16 13:52:18 +01003865 ret = -EINVAL;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003866 goto out;
3867 }
3868 }
3869
3870 if (base_fmt) {
3871 if (set_option_parameter(param, BLOCK_OPT_BACKING_FMT, base_fmt)) {
3872 error_report("Backing file format not supported for file "
3873 "format '%s'", fmt);
Jes Sorensen4f70f242010-12-16 13:52:18 +01003874 ret = -EINVAL;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003875 goto out;
3876 }
3877 }
3878
Jes Sorensen792da932010-12-16 13:52:17 +01003879 backing_file = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
3880 if (backing_file && backing_file->value.s) {
3881 if (!strcmp(filename, backing_file->value.s)) {
3882 error_report("Error: Trying to create an image with the "
3883 "same filename as the backing file");
Jes Sorensen4f70f242010-12-16 13:52:18 +01003884 ret = -EINVAL;
Jes Sorensen792da932010-12-16 13:52:17 +01003885 goto out;
3886 }
3887 }
3888
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003889 backing_fmt = get_option_parameter(param, BLOCK_OPT_BACKING_FMT);
3890 if (backing_fmt && backing_fmt->value.s) {
Stefan Hajnoczi96df67d2011-01-24 09:32:20 +00003891 backing_drv = bdrv_find_format(backing_fmt->value.s);
3892 if (!backing_drv) {
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003893 error_report("Unknown backing file format '%s'",
3894 backing_fmt->value.s);
Jes Sorensen4f70f242010-12-16 13:52:18 +01003895 ret = -EINVAL;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003896 goto out;
3897 }
3898 }
3899
3900 // The size for the image must always be specified, with one exception:
3901 // If we are using a backing file, we can obtain the size from there
Kevin Wolfd2208942011-06-01 14:03:31 +02003902 size = get_option_parameter(param, BLOCK_OPT_SIZE);
3903 if (size && size->value.n == -1) {
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003904 if (backing_file && backing_file->value.s) {
3905 uint64_t size;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003906 char buf[32];
3907
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003908 bs = bdrv_new("");
3909
Stefan Hajnoczi96df67d2011-01-24 09:32:20 +00003910 ret = bdrv_open(bs, backing_file->value.s, flags, backing_drv);
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003911 if (ret < 0) {
Stefan Hajnoczi96df67d2011-01-24 09:32:20 +00003912 error_report("Could not open '%s'", backing_file->value.s);
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003913 goto out;
3914 }
3915 bdrv_get_geometry(bs, &size);
3916 size *= 512;
3917
3918 snprintf(buf, sizeof(buf), "%" PRId64, size);
3919 set_option_parameter(param, BLOCK_OPT_SIZE, buf);
3920 } else {
3921 error_report("Image creation needs a size parameter");
Jes Sorensen4f70f242010-12-16 13:52:18 +01003922 ret = -EINVAL;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003923 goto out;
3924 }
3925 }
3926
3927 printf("Formatting '%s', fmt=%s ", filename, fmt);
3928 print_option_parameters(param);
3929 puts("");
3930
3931 ret = bdrv_create(drv, filename, param);
3932
3933 if (ret < 0) {
3934 if (ret == -ENOTSUP) {
3935 error_report("Formatting or formatting option not supported for "
3936 "file format '%s'", fmt);
3937 } else if (ret == -EFBIG) {
3938 error_report("The image size is too large for file format '%s'",
3939 fmt);
3940 } else {
3941 error_report("%s: error while creating %s: %s", filename, fmt,
3942 strerror(-ret));
3943 }
3944 }
3945
3946out:
3947 free_option_parameters(create_options);
3948 free_option_parameters(param);
3949
3950 if (bs) {
3951 bdrv_delete(bs);
3952 }
Jes Sorensen4f70f242010-12-16 13:52:18 +01003953
3954 return ret;
Jes Sorensenf88e1a42010-12-16 13:52:15 +01003955}
Stefan Hajnoczieeec61f2012-01-18 14:40:43 +00003956
3957void *block_job_create(const BlockJobType *job_type, BlockDriverState *bs,
3958 BlockDriverCompletionFunc *cb, void *opaque)
3959{
3960 BlockJob *job;
3961
3962 if (bs->job || bdrv_in_use(bs)) {
3963 return NULL;
3964 }
3965 bdrv_set_in_use(bs, 1);
3966
3967 job = g_malloc0(job_type->instance_size);
3968 job->job_type = job_type;
3969 job->bs = bs;
3970 job->cb = cb;
3971 job->opaque = opaque;
3972 bs->job = job;
3973 return job;
3974}
3975
3976void block_job_complete(BlockJob *job, int ret)
3977{
3978 BlockDriverState *bs = job->bs;
3979
3980 assert(bs->job == job);
3981 job->cb(job->opaque, ret);
3982 bs->job = NULL;
3983 g_free(job);
3984 bdrv_set_in_use(bs, 0);
3985}
3986
3987int block_job_set_speed(BlockJob *job, int64_t value)
3988{
3989 if (!job->job_type->set_speed) {
3990 return -ENOTSUP;
3991 }
3992 return job->job_type->set_speed(job, value);
3993}
3994
3995void block_job_cancel(BlockJob *job)
3996{
3997 job->cancelled = true;
3998}
3999
4000bool block_job_is_cancelled(BlockJob *job)
4001{
4002 return job->cancelled;
4003}