xref: /openbmc/qemu/block.c (revision 31ca6d077c24b7aaa322d8930e3e5debbdb4a047)
1fc01f7e7Sbellard /*
2fc01f7e7Sbellard  * QEMU System Emulator block driver
3fc01f7e7Sbellard  *
4fc01f7e7Sbellard  * Copyright (c) 2003 Fabrice Bellard
5fc01f7e7Sbellard  *
6fc01f7e7Sbellard  * Permission is hereby granted, free of charge, to any person obtaining a copy
7fc01f7e7Sbellard  * of this software and associated documentation files (the "Software"), to deal
8fc01f7e7Sbellard  * in the Software without restriction, including without limitation the rights
9fc01f7e7Sbellard  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10fc01f7e7Sbellard  * copies of the Software, and to permit persons to whom the Software is
11fc01f7e7Sbellard  * furnished to do so, subject to the following conditions:
12fc01f7e7Sbellard  *
13fc01f7e7Sbellard  * The above copyright notice and this permission notice shall be included in
14fc01f7e7Sbellard  * all copies or substantial portions of the Software.
15fc01f7e7Sbellard  *
16fc01f7e7Sbellard  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17fc01f7e7Sbellard  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18fc01f7e7Sbellard  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19fc01f7e7Sbellard  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20fc01f7e7Sbellard  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21fc01f7e7Sbellard  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22fc01f7e7Sbellard  * THE SOFTWARE.
23fc01f7e7Sbellard  */
243990d09aSblueswir1 #include "config-host.h"
25faf07963Spbrook #include "qemu-common.h"
266d519a5fSStefan Hajnoczi #include "trace.h"
2783c9089eSPaolo Bonzini #include "monitor/monitor.h"
28737e150eSPaolo Bonzini #include "block/block_int.h"
29737e150eSPaolo Bonzini #include "block/blockjob.h"
301de7afc9SPaolo Bonzini #include "qemu/module.h"
317b1b5d19SPaolo Bonzini #include "qapi/qmp/qjson.h"
329c17d615SPaolo Bonzini #include "sysemu/sysemu.h"
331de7afc9SPaolo Bonzini #include "qemu/notify.h"
34737e150eSPaolo Bonzini #include "block/coroutine.h"
35b2023818SLuiz Capitulino #include "qmp-commands.h"
361de7afc9SPaolo Bonzini #include "qemu/timer.h"
37fc01f7e7Sbellard 
3871e72a19SJuan Quintela #ifdef CONFIG_BSD
397674e7bfSbellard #include <sys/types.h>
407674e7bfSbellard #include <sys/stat.h>
417674e7bfSbellard #include <sys/ioctl.h>
4272cf2d4fSBlue Swirl #include <sys/queue.h>
43c5e97233Sblueswir1 #ifndef __DragonFly__
447674e7bfSbellard #include <sys/disk.h>
457674e7bfSbellard #endif
46c5e97233Sblueswir1 #endif
477674e7bfSbellard 
4849dc768dSaliguori #ifdef _WIN32
4949dc768dSaliguori #include <windows.h>
5049dc768dSaliguori #endif
5149dc768dSaliguori 
521c9805a3SStefan Hajnoczi #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
531c9805a3SStefan Hajnoczi 
54470c0504SStefan Hajnoczi typedef enum {
55470c0504SStefan Hajnoczi     BDRV_REQ_COPY_ON_READ = 0x1,
56f08f2ddaSStefan Hajnoczi     BDRV_REQ_ZERO_WRITE   = 0x2,
57470c0504SStefan Hajnoczi } BdrvRequestFlags;
58470c0504SStefan Hajnoczi 
597d4b4ba5SMarkus Armbruster static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load);
60f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
61f141eafeSaliguori         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
62c87c0672Saliguori         BlockDriverCompletionFunc *cb, void *opaque);
63f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
64f141eafeSaliguori         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
65ce1a14dcSpbrook         BlockDriverCompletionFunc *cb, void *opaque);
66f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
67f9f05dc5SKevin Wolf                                          int64_t sector_num, int nb_sectors,
68f9f05dc5SKevin Wolf                                          QEMUIOVector *iov);
69f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
70f9f05dc5SKevin Wolf                                          int64_t sector_num, int nb_sectors,
71f9f05dc5SKevin Wolf                                          QEMUIOVector *iov);
72c5fbe571SStefan Hajnoczi static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
73470c0504SStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
74470c0504SStefan Hajnoczi     BdrvRequestFlags flags);
751c9805a3SStefan Hajnoczi static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
76f08f2ddaSStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
77f08f2ddaSStefan Hajnoczi     BdrvRequestFlags flags);
78b2a61371SStefan Hajnoczi static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
79b2a61371SStefan Hajnoczi                                                int64_t sector_num,
80b2a61371SStefan Hajnoczi                                                QEMUIOVector *qiov,
81b2a61371SStefan Hajnoczi                                                int nb_sectors,
82b2a61371SStefan Hajnoczi                                                BlockDriverCompletionFunc *cb,
83b2a61371SStefan Hajnoczi                                                void *opaque,
848c5873d6SStefan Hajnoczi                                                bool is_write);
85b2a61371SStefan Hajnoczi static void coroutine_fn bdrv_co_do_rw(void *opaque);
86621f0589SKevin Wolf static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs,
87621f0589SKevin Wolf     int64_t sector_num, int nb_sectors);
88ec530c81Sbellard 
8998f90dbaSZhi Yong Wu static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
9098f90dbaSZhi Yong Wu         bool is_write, double elapsed_time, uint64_t *wait);
9198f90dbaSZhi Yong Wu static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
9298f90dbaSZhi Yong Wu         double elapsed_time, uint64_t *wait);
9398f90dbaSZhi Yong Wu static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
9498f90dbaSZhi Yong Wu         bool is_write, int64_t *wait);
9598f90dbaSZhi Yong Wu 
961b7bdbc1SStefan Hajnoczi static QTAILQ_HEAD(, BlockDriverState) bdrv_states =
971b7bdbc1SStefan Hajnoczi     QTAILQ_HEAD_INITIALIZER(bdrv_states);
987ee930d0Sblueswir1 
998a22f02aSStefan Hajnoczi static QLIST_HEAD(, BlockDriver) bdrv_drivers =
1008a22f02aSStefan Hajnoczi     QLIST_HEAD_INITIALIZER(bdrv_drivers);
101ea2384d3Sbellard 
102f9092b10SMarkus Armbruster /* The device to use for VM snapshots */
103f9092b10SMarkus Armbruster static BlockDriverState *bs_snapshots;
104f9092b10SMarkus Armbruster 
105eb852011SMarkus Armbruster /* If non-zero, use only whitelisted block drivers */
106eb852011SMarkus Armbruster static int use_bdrv_whitelist;
107eb852011SMarkus Armbruster 
1089e0b22f4SStefan Hajnoczi #ifdef _WIN32
1099e0b22f4SStefan Hajnoczi static int is_windows_drive_prefix(const char *filename)
1109e0b22f4SStefan Hajnoczi {
1119e0b22f4SStefan Hajnoczi     return (((filename[0] >= 'a' && filename[0] <= 'z') ||
1129e0b22f4SStefan Hajnoczi              (filename[0] >= 'A' && filename[0] <= 'Z')) &&
1139e0b22f4SStefan Hajnoczi             filename[1] == ':');
1149e0b22f4SStefan Hajnoczi }
1159e0b22f4SStefan Hajnoczi 
1169e0b22f4SStefan Hajnoczi int is_windows_drive(const char *filename)
1179e0b22f4SStefan Hajnoczi {
1189e0b22f4SStefan Hajnoczi     if (is_windows_drive_prefix(filename) &&
1199e0b22f4SStefan Hajnoczi         filename[2] == '\0')
1209e0b22f4SStefan Hajnoczi         return 1;
1219e0b22f4SStefan Hajnoczi     if (strstart(filename, "\\\\.\\", NULL) ||
1229e0b22f4SStefan Hajnoczi         strstart(filename, "//./", NULL))
1239e0b22f4SStefan Hajnoczi         return 1;
1249e0b22f4SStefan Hajnoczi     return 0;
1259e0b22f4SStefan Hajnoczi }
1269e0b22f4SStefan Hajnoczi #endif
1279e0b22f4SStefan Hajnoczi 
1280563e191SZhi Yong Wu /* throttling disk I/O limits */
12998f90dbaSZhi Yong Wu void bdrv_io_limits_disable(BlockDriverState *bs)
13098f90dbaSZhi Yong Wu {
13198f90dbaSZhi Yong Wu     bs->io_limits_enabled = false;
13298f90dbaSZhi Yong Wu 
13398f90dbaSZhi Yong Wu     while (qemu_co_queue_next(&bs->throttled_reqs));
13498f90dbaSZhi Yong Wu 
13598f90dbaSZhi Yong Wu     if (bs->block_timer) {
13698f90dbaSZhi Yong Wu         qemu_del_timer(bs->block_timer);
13798f90dbaSZhi Yong Wu         qemu_free_timer(bs->block_timer);
13898f90dbaSZhi Yong Wu         bs->block_timer = NULL;
13998f90dbaSZhi Yong Wu     }
14098f90dbaSZhi Yong Wu 
14198f90dbaSZhi Yong Wu     bs->slice_start = 0;
14298f90dbaSZhi Yong Wu     bs->slice_end   = 0;
14398f90dbaSZhi Yong Wu }
14498f90dbaSZhi Yong Wu 
1450563e191SZhi Yong Wu static void bdrv_block_timer(void *opaque)
1460563e191SZhi Yong Wu {
1470563e191SZhi Yong Wu     BlockDriverState *bs = opaque;
1480563e191SZhi Yong Wu 
1490563e191SZhi Yong Wu     qemu_co_queue_next(&bs->throttled_reqs);
1500563e191SZhi Yong Wu }
1510563e191SZhi Yong Wu 
1520563e191SZhi Yong Wu void bdrv_io_limits_enable(BlockDriverState *bs)
1530563e191SZhi Yong Wu {
1540563e191SZhi Yong Wu     qemu_co_queue_init(&bs->throttled_reqs);
1550563e191SZhi Yong Wu     bs->block_timer = qemu_new_timer_ns(vm_clock, bdrv_block_timer, bs);
1560563e191SZhi Yong Wu     bs->io_limits_enabled = true;
1570563e191SZhi Yong Wu }
1580563e191SZhi Yong Wu 
1590563e191SZhi Yong Wu bool bdrv_io_limits_enabled(BlockDriverState *bs)
1600563e191SZhi Yong Wu {
1610563e191SZhi Yong Wu     BlockIOLimit *io_limits = &bs->io_limits;
1620563e191SZhi Yong Wu     return io_limits->bps[BLOCK_IO_LIMIT_READ]
1630563e191SZhi Yong Wu          || io_limits->bps[BLOCK_IO_LIMIT_WRITE]
1640563e191SZhi Yong Wu          || io_limits->bps[BLOCK_IO_LIMIT_TOTAL]
1650563e191SZhi Yong Wu          || io_limits->iops[BLOCK_IO_LIMIT_READ]
1660563e191SZhi Yong Wu          || io_limits->iops[BLOCK_IO_LIMIT_WRITE]
1670563e191SZhi Yong Wu          || io_limits->iops[BLOCK_IO_LIMIT_TOTAL];
1680563e191SZhi Yong Wu }
1690563e191SZhi Yong Wu 
17098f90dbaSZhi Yong Wu static void bdrv_io_limits_intercept(BlockDriverState *bs,
17198f90dbaSZhi Yong Wu                                      bool is_write, int nb_sectors)
17298f90dbaSZhi Yong Wu {
17398f90dbaSZhi Yong Wu     int64_t wait_time = -1;
17498f90dbaSZhi Yong Wu 
17598f90dbaSZhi Yong Wu     if (!qemu_co_queue_empty(&bs->throttled_reqs)) {
17698f90dbaSZhi Yong Wu         qemu_co_queue_wait(&bs->throttled_reqs);
17798f90dbaSZhi Yong Wu     }
17898f90dbaSZhi Yong Wu 
17998f90dbaSZhi Yong Wu     /* In fact, we hope to keep each request's timing, in FIFO mode. The next
18098f90dbaSZhi Yong Wu      * throttled requests will not be dequeued until the current request is
18198f90dbaSZhi Yong Wu      * allowed to be serviced. So if the current request still exceeds the
18298f90dbaSZhi Yong Wu      * limits, it will be inserted to the head. All requests followed it will
18398f90dbaSZhi Yong Wu      * be still in throttled_reqs queue.
18498f90dbaSZhi Yong Wu      */
18598f90dbaSZhi Yong Wu 
18698f90dbaSZhi Yong Wu     while (bdrv_exceed_io_limits(bs, nb_sectors, is_write, &wait_time)) {
18798f90dbaSZhi Yong Wu         qemu_mod_timer(bs->block_timer,
18898f90dbaSZhi Yong Wu                        wait_time + qemu_get_clock_ns(vm_clock));
18998f90dbaSZhi Yong Wu         qemu_co_queue_wait_insert_head(&bs->throttled_reqs);
19098f90dbaSZhi Yong Wu     }
19198f90dbaSZhi Yong Wu 
19298f90dbaSZhi Yong Wu     qemu_co_queue_next(&bs->throttled_reqs);
19398f90dbaSZhi Yong Wu }
19498f90dbaSZhi Yong Wu 
1959e0b22f4SStefan Hajnoczi /* check if the path starts with "<protocol>:" */
1969e0b22f4SStefan Hajnoczi static int path_has_protocol(const char *path)
1979e0b22f4SStefan Hajnoczi {
198947995c0SPaolo Bonzini     const char *p;
199947995c0SPaolo Bonzini 
2009e0b22f4SStefan Hajnoczi #ifdef _WIN32
2019e0b22f4SStefan Hajnoczi     if (is_windows_drive(path) ||
2029e0b22f4SStefan Hajnoczi         is_windows_drive_prefix(path)) {
2039e0b22f4SStefan Hajnoczi         return 0;
2049e0b22f4SStefan Hajnoczi     }
205947995c0SPaolo Bonzini     p = path + strcspn(path, ":/\\");
206947995c0SPaolo Bonzini #else
207947995c0SPaolo Bonzini     p = path + strcspn(path, ":/");
2089e0b22f4SStefan Hajnoczi #endif
2099e0b22f4SStefan Hajnoczi 
210947995c0SPaolo Bonzini     return *p == ':';
2119e0b22f4SStefan Hajnoczi }
2129e0b22f4SStefan Hajnoczi 
21383f64091Sbellard int path_is_absolute(const char *path)
21483f64091Sbellard {
21521664424Sbellard #ifdef _WIN32
21621664424Sbellard     /* specific case for names like: "\\.\d:" */
217f53f4da9SPaolo Bonzini     if (is_windows_drive(path) || is_windows_drive_prefix(path)) {
21821664424Sbellard         return 1;
219f53f4da9SPaolo Bonzini     }
220f53f4da9SPaolo Bonzini     return (*path == '/' || *path == '\\');
2213b9f94e1Sbellard #else
222f53f4da9SPaolo Bonzini     return (*path == '/');
2233b9f94e1Sbellard #endif
22483f64091Sbellard }
22583f64091Sbellard 
22683f64091Sbellard /* if filename is absolute, just copy it to dest. Otherwise, build a
22783f64091Sbellard    path to it by considering it is relative to base_path. URL are
22883f64091Sbellard    supported. */
22983f64091Sbellard void path_combine(char *dest, int dest_size,
23083f64091Sbellard                   const char *base_path,
23183f64091Sbellard                   const char *filename)
23283f64091Sbellard {
23383f64091Sbellard     const char *p, *p1;
23483f64091Sbellard     int len;
23583f64091Sbellard 
23683f64091Sbellard     if (dest_size <= 0)
23783f64091Sbellard         return;
23883f64091Sbellard     if (path_is_absolute(filename)) {
23983f64091Sbellard         pstrcpy(dest, dest_size, filename);
24083f64091Sbellard     } else {
24183f64091Sbellard         p = strchr(base_path, ':');
24283f64091Sbellard         if (p)
24383f64091Sbellard             p++;
24483f64091Sbellard         else
24583f64091Sbellard             p = base_path;
2463b9f94e1Sbellard         p1 = strrchr(base_path, '/');
2473b9f94e1Sbellard #ifdef _WIN32
2483b9f94e1Sbellard         {
2493b9f94e1Sbellard             const char *p2;
2503b9f94e1Sbellard             p2 = strrchr(base_path, '\\');
2513b9f94e1Sbellard             if (!p1 || p2 > p1)
2523b9f94e1Sbellard                 p1 = p2;
2533b9f94e1Sbellard         }
2543b9f94e1Sbellard #endif
25583f64091Sbellard         if (p1)
25683f64091Sbellard             p1++;
25783f64091Sbellard         else
25883f64091Sbellard             p1 = base_path;
25983f64091Sbellard         if (p1 > p)
26083f64091Sbellard             p = p1;
26183f64091Sbellard         len = p - base_path;
26283f64091Sbellard         if (len > dest_size - 1)
26383f64091Sbellard             len = dest_size - 1;
26483f64091Sbellard         memcpy(dest, base_path, len);
26583f64091Sbellard         dest[len] = '\0';
26683f64091Sbellard         pstrcat(dest, dest_size, filename);
26783f64091Sbellard     }
26883f64091Sbellard }
26983f64091Sbellard 
270dc5a1371SPaolo Bonzini void bdrv_get_full_backing_filename(BlockDriverState *bs, char *dest, size_t sz)
271dc5a1371SPaolo Bonzini {
272dc5a1371SPaolo Bonzini     if (bs->backing_file[0] == '\0' || path_has_protocol(bs->backing_file)) {
273dc5a1371SPaolo Bonzini         pstrcpy(dest, sz, bs->backing_file);
274dc5a1371SPaolo Bonzini     } else {
275dc5a1371SPaolo Bonzini         path_combine(dest, sz, bs->filename, bs->backing_file);
276dc5a1371SPaolo Bonzini     }
277dc5a1371SPaolo Bonzini }
278dc5a1371SPaolo Bonzini 
2795efa9d5aSAnthony Liguori void bdrv_register(BlockDriver *bdrv)
280ea2384d3Sbellard {
2818c5873d6SStefan Hajnoczi     /* Block drivers without coroutine functions need emulation */
2828c5873d6SStefan Hajnoczi     if (!bdrv->bdrv_co_readv) {
283f9f05dc5SKevin Wolf         bdrv->bdrv_co_readv = bdrv_co_readv_em;
284f9f05dc5SKevin Wolf         bdrv->bdrv_co_writev = bdrv_co_writev_em;
285f9f05dc5SKevin Wolf 
286f8c35c1dSStefan Hajnoczi         /* bdrv_co_readv_em()/brdv_co_writev_em() work in terms of aio, so if
287f8c35c1dSStefan Hajnoczi          * the block driver lacks aio we need to emulate that too.
288f8c35c1dSStefan Hajnoczi          */
289f9f05dc5SKevin Wolf         if (!bdrv->bdrv_aio_readv) {
29083f64091Sbellard             /* add AIO emulation layer */
291f141eafeSaliguori             bdrv->bdrv_aio_readv = bdrv_aio_readv_em;
292f141eafeSaliguori             bdrv->bdrv_aio_writev = bdrv_aio_writev_em;
29383f64091Sbellard         }
294f9f05dc5SKevin Wolf     }
295b2e12bc6SChristoph Hellwig 
2968a22f02aSStefan Hajnoczi     QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list);
297ea2384d3Sbellard }
298b338082bSbellard 
299b338082bSbellard /* create a new block device (by default it is empty) */
300b338082bSbellard BlockDriverState *bdrv_new(const char *device_name)
301fc01f7e7Sbellard {
3021b7bdbc1SStefan Hajnoczi     BlockDriverState *bs;
303b338082bSbellard 
3047267c094SAnthony Liguori     bs = g_malloc0(sizeof(BlockDriverState));
305b338082bSbellard     pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
306ea2384d3Sbellard     if (device_name[0] != '\0') {
3071b7bdbc1SStefan Hajnoczi         QTAILQ_INSERT_TAIL(&bdrv_states, bs, list);
308ea2384d3Sbellard     }
30928a7282aSLuiz Capitulino     bdrv_iostatus_disable(bs);
310d7d512f6SPaolo Bonzini     notifier_list_init(&bs->close_notifiers);
311d7d512f6SPaolo Bonzini 
312b338082bSbellard     return bs;
313b338082bSbellard }
314b338082bSbellard 
315d7d512f6SPaolo Bonzini void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify)
316d7d512f6SPaolo Bonzini {
317d7d512f6SPaolo Bonzini     notifier_list_add(&bs->close_notifiers, notify);
318d7d512f6SPaolo Bonzini }
319d7d512f6SPaolo Bonzini 
320ea2384d3Sbellard BlockDriver *bdrv_find_format(const char *format_name)
321ea2384d3Sbellard {
322ea2384d3Sbellard     BlockDriver *drv1;
3238a22f02aSStefan Hajnoczi     QLIST_FOREACH(drv1, &bdrv_drivers, list) {
3248a22f02aSStefan Hajnoczi         if (!strcmp(drv1->format_name, format_name)) {
325ea2384d3Sbellard             return drv1;
326ea2384d3Sbellard         }
3278a22f02aSStefan Hajnoczi     }
328ea2384d3Sbellard     return NULL;
329ea2384d3Sbellard }
330ea2384d3Sbellard 
331eb852011SMarkus Armbruster static int bdrv_is_whitelisted(BlockDriver *drv)
332eb852011SMarkus Armbruster {
333eb852011SMarkus Armbruster     static const char *whitelist[] = {
334eb852011SMarkus Armbruster         CONFIG_BDRV_WHITELIST
335eb852011SMarkus Armbruster     };
336eb852011SMarkus Armbruster     const char **p;
337eb852011SMarkus Armbruster 
338eb852011SMarkus Armbruster     if (!whitelist[0])
339eb852011SMarkus Armbruster         return 1;               /* no whitelist, anything goes */
340eb852011SMarkus Armbruster 
341eb852011SMarkus Armbruster     for (p = whitelist; *p; p++) {
342eb852011SMarkus Armbruster         if (!strcmp(drv->format_name, *p)) {
343eb852011SMarkus Armbruster             return 1;
344eb852011SMarkus Armbruster         }
345eb852011SMarkus Armbruster     }
346eb852011SMarkus Armbruster     return 0;
347eb852011SMarkus Armbruster }
348eb852011SMarkus Armbruster 
349eb852011SMarkus Armbruster BlockDriver *bdrv_find_whitelisted_format(const char *format_name)
350eb852011SMarkus Armbruster {
351eb852011SMarkus Armbruster     BlockDriver *drv = bdrv_find_format(format_name);
352eb852011SMarkus Armbruster     return drv && bdrv_is_whitelisted(drv) ? drv : NULL;
353eb852011SMarkus Armbruster }
354eb852011SMarkus Armbruster 
3555b7e1542SZhi Yong Wu typedef struct CreateCo {
3565b7e1542SZhi Yong Wu     BlockDriver *drv;
3575b7e1542SZhi Yong Wu     char *filename;
3585b7e1542SZhi Yong Wu     QEMUOptionParameter *options;
3595b7e1542SZhi Yong Wu     int ret;
3605b7e1542SZhi Yong Wu } CreateCo;
3615b7e1542SZhi Yong Wu 
3625b7e1542SZhi Yong Wu static void coroutine_fn bdrv_create_co_entry(void *opaque)
3635b7e1542SZhi Yong Wu {
3645b7e1542SZhi Yong Wu     CreateCo *cco = opaque;
3655b7e1542SZhi Yong Wu     assert(cco->drv);
3665b7e1542SZhi Yong Wu 
3675b7e1542SZhi Yong Wu     cco->ret = cco->drv->bdrv_create(cco->filename, cco->options);
3685b7e1542SZhi Yong Wu }
3695b7e1542SZhi Yong Wu 
3700e7e1989SKevin Wolf int bdrv_create(BlockDriver *drv, const char* filename,
3710e7e1989SKevin Wolf     QEMUOptionParameter *options)
372ea2384d3Sbellard {
3735b7e1542SZhi Yong Wu     int ret;
3740e7e1989SKevin Wolf 
3755b7e1542SZhi Yong Wu     Coroutine *co;
3765b7e1542SZhi Yong Wu     CreateCo cco = {
3775b7e1542SZhi Yong Wu         .drv = drv,
3785b7e1542SZhi Yong Wu         .filename = g_strdup(filename),
3795b7e1542SZhi Yong Wu         .options = options,
3805b7e1542SZhi Yong Wu         .ret = NOT_DONE,
3815b7e1542SZhi Yong Wu     };
3825b7e1542SZhi Yong Wu 
3835b7e1542SZhi Yong Wu     if (!drv->bdrv_create) {
38480168bffSLuiz Capitulino         ret = -ENOTSUP;
38580168bffSLuiz Capitulino         goto out;
3865b7e1542SZhi Yong Wu     }
3875b7e1542SZhi Yong Wu 
3885b7e1542SZhi Yong Wu     if (qemu_in_coroutine()) {
3895b7e1542SZhi Yong Wu         /* Fast-path if already in coroutine context */
3905b7e1542SZhi Yong Wu         bdrv_create_co_entry(&cco);
3915b7e1542SZhi Yong Wu     } else {
3925b7e1542SZhi Yong Wu         co = qemu_coroutine_create(bdrv_create_co_entry);
3935b7e1542SZhi Yong Wu         qemu_coroutine_enter(co, &cco);
3945b7e1542SZhi Yong Wu         while (cco.ret == NOT_DONE) {
3955b7e1542SZhi Yong Wu             qemu_aio_wait();
3965b7e1542SZhi Yong Wu         }
3975b7e1542SZhi Yong Wu     }
3985b7e1542SZhi Yong Wu 
3995b7e1542SZhi Yong Wu     ret = cco.ret;
4005b7e1542SZhi Yong Wu 
40180168bffSLuiz Capitulino out:
40280168bffSLuiz Capitulino     g_free(cco.filename);
4035b7e1542SZhi Yong Wu     return ret;
404ea2384d3Sbellard }
405ea2384d3Sbellard 
40684a12e66SChristoph Hellwig int bdrv_create_file(const char* filename, QEMUOptionParameter *options)
40784a12e66SChristoph Hellwig {
40884a12e66SChristoph Hellwig     BlockDriver *drv;
40984a12e66SChristoph Hellwig 
410b50cbabcSMORITA Kazutaka     drv = bdrv_find_protocol(filename);
41184a12e66SChristoph Hellwig     if (drv == NULL) {
41216905d71SStefan Hajnoczi         return -ENOENT;
41384a12e66SChristoph Hellwig     }
41484a12e66SChristoph Hellwig 
41584a12e66SChristoph Hellwig     return bdrv_create(drv, filename, options);
41684a12e66SChristoph Hellwig }
41784a12e66SChristoph Hellwig 
418eba25057SJim Meyering /*
419eba25057SJim Meyering  * Create a uniquely-named empty temporary file.
420eba25057SJim Meyering  * Return 0 upon success, otherwise a negative errno value.
421eba25057SJim Meyering  */
422eba25057SJim Meyering int get_tmp_filename(char *filename, int size)
423eba25057SJim Meyering {
424d5249393Sbellard #ifdef _WIN32
4253b9f94e1Sbellard     char temp_dir[MAX_PATH];
426eba25057SJim Meyering     /* GetTempFileName requires that its output buffer (4th param)
427eba25057SJim Meyering        have length MAX_PATH or greater.  */
428eba25057SJim Meyering     assert(size >= MAX_PATH);
429eba25057SJim Meyering     return (GetTempPath(MAX_PATH, temp_dir)
430eba25057SJim Meyering             && GetTempFileName(temp_dir, "qem", 0, filename)
431eba25057SJim Meyering             ? 0 : -GetLastError());
432d5249393Sbellard #else
433ea2384d3Sbellard     int fd;
4347ccfb2ebSblueswir1     const char *tmpdir;
4350badc1eeSaurel32     tmpdir = getenv("TMPDIR");
4360badc1eeSaurel32     if (!tmpdir)
4370badc1eeSaurel32         tmpdir = "/tmp";
438eba25057SJim Meyering     if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) {
439eba25057SJim Meyering         return -EOVERFLOW;
440ea2384d3Sbellard     }
441eba25057SJim Meyering     fd = mkstemp(filename);
442fe235a06SDunrong Huang     if (fd < 0) {
443fe235a06SDunrong Huang         return -errno;
444fe235a06SDunrong Huang     }
445fe235a06SDunrong Huang     if (close(fd) != 0) {
446fe235a06SDunrong Huang         unlink(filename);
447eba25057SJim Meyering         return -errno;
448eba25057SJim Meyering     }
449eba25057SJim Meyering     return 0;
450d5249393Sbellard #endif
451eba25057SJim Meyering }
452ea2384d3Sbellard 
453f3a5d3f8SChristoph Hellwig /*
454f3a5d3f8SChristoph Hellwig  * Detect host devices. By convention, /dev/cdrom[N] is always
455f3a5d3f8SChristoph Hellwig  * recognized as a host CDROM.
456f3a5d3f8SChristoph Hellwig  */
457f3a5d3f8SChristoph Hellwig static BlockDriver *find_hdev_driver(const char *filename)
458f3a5d3f8SChristoph Hellwig {
459508c7cb3SChristoph Hellwig     int score_max = 0, score;
460508c7cb3SChristoph Hellwig     BlockDriver *drv = NULL, *d;
461f3a5d3f8SChristoph Hellwig 
4628a22f02aSStefan Hajnoczi     QLIST_FOREACH(d, &bdrv_drivers, list) {
463508c7cb3SChristoph Hellwig         if (d->bdrv_probe_device) {
464508c7cb3SChristoph Hellwig             score = d->bdrv_probe_device(filename);
465508c7cb3SChristoph Hellwig             if (score > score_max) {
466508c7cb3SChristoph Hellwig                 score_max = score;
467508c7cb3SChristoph Hellwig                 drv = d;
468f3a5d3f8SChristoph Hellwig             }
469508c7cb3SChristoph Hellwig         }
470f3a5d3f8SChristoph Hellwig     }
471f3a5d3f8SChristoph Hellwig 
472508c7cb3SChristoph Hellwig     return drv;
473f3a5d3f8SChristoph Hellwig }
474f3a5d3f8SChristoph Hellwig 
475b50cbabcSMORITA Kazutaka BlockDriver *bdrv_find_protocol(const char *filename)
47684a12e66SChristoph Hellwig {
47784a12e66SChristoph Hellwig     BlockDriver *drv1;
47884a12e66SChristoph Hellwig     char protocol[128];
47984a12e66SChristoph Hellwig     int len;
48084a12e66SChristoph Hellwig     const char *p;
48184a12e66SChristoph Hellwig 
48266f82ceeSKevin Wolf     /* TODO Drivers without bdrv_file_open must be specified explicitly */
48366f82ceeSKevin Wolf 
48439508e7aSChristoph Hellwig     /*
48539508e7aSChristoph Hellwig      * XXX(hch): we really should not let host device detection
48639508e7aSChristoph Hellwig      * override an explicit protocol specification, but moving this
48739508e7aSChristoph Hellwig      * later breaks access to device names with colons in them.
48839508e7aSChristoph Hellwig      * Thanks to the brain-dead persistent naming schemes on udev-
48939508e7aSChristoph Hellwig      * based Linux systems those actually are quite common.
49039508e7aSChristoph Hellwig      */
49184a12e66SChristoph Hellwig     drv1 = find_hdev_driver(filename);
49239508e7aSChristoph Hellwig     if (drv1) {
49384a12e66SChristoph Hellwig         return drv1;
49484a12e66SChristoph Hellwig     }
49539508e7aSChristoph Hellwig 
4969e0b22f4SStefan Hajnoczi     if (!path_has_protocol(filename)) {
49739508e7aSChristoph Hellwig         return bdrv_find_format("file");
49839508e7aSChristoph Hellwig     }
4999e0b22f4SStefan Hajnoczi     p = strchr(filename, ':');
5009e0b22f4SStefan Hajnoczi     assert(p != NULL);
50184a12e66SChristoph Hellwig     len = p - filename;
50284a12e66SChristoph Hellwig     if (len > sizeof(protocol) - 1)
50384a12e66SChristoph Hellwig         len = sizeof(protocol) - 1;
50484a12e66SChristoph Hellwig     memcpy(protocol, filename, len);
50584a12e66SChristoph Hellwig     protocol[len] = '\0';
50684a12e66SChristoph Hellwig     QLIST_FOREACH(drv1, &bdrv_drivers, list) {
50784a12e66SChristoph Hellwig         if (drv1->protocol_name &&
50884a12e66SChristoph Hellwig             !strcmp(drv1->protocol_name, protocol)) {
50984a12e66SChristoph Hellwig             return drv1;
51084a12e66SChristoph Hellwig         }
51184a12e66SChristoph Hellwig     }
51284a12e66SChristoph Hellwig     return NULL;
51384a12e66SChristoph Hellwig }
51484a12e66SChristoph Hellwig 
515f500a6d3SKevin Wolf static int find_image_format(BlockDriverState *bs, const char *filename,
516f500a6d3SKevin Wolf                              BlockDriver **pdrv)
517ea2384d3Sbellard {
518f500a6d3SKevin Wolf     int score, score_max;
519ea2384d3Sbellard     BlockDriver *drv1, *drv;
52083f64091Sbellard     uint8_t buf[2048];
521f500a6d3SKevin Wolf     int ret = 0;
522f8ea0b00SNicholas Bellinger 
52308a00559SKevin Wolf     /* Return the raw BlockDriver * to scsi-generic devices or empty drives */
5248e895599SPaolo Bonzini     if (bs->sg || !bdrv_is_inserted(bs) || bdrv_getlength(bs) == 0) {
525c98ac35dSStefan Weil         drv = bdrv_find_format("raw");
526c98ac35dSStefan Weil         if (!drv) {
527c98ac35dSStefan Weil             ret = -ENOENT;
528c98ac35dSStefan Weil         }
529c98ac35dSStefan Weil         *pdrv = drv;
530c98ac35dSStefan Weil         return ret;
5311a396859SNicholas A. Bellinger     }
532f8ea0b00SNicholas Bellinger 
53383f64091Sbellard     ret = bdrv_pread(bs, 0, buf, sizeof(buf));
534ea2384d3Sbellard     if (ret < 0) {
535c98ac35dSStefan Weil         *pdrv = NULL;
536c98ac35dSStefan Weil         return ret;
537ea2384d3Sbellard     }
538ea2384d3Sbellard 
539ea2384d3Sbellard     score_max = 0;
54084a12e66SChristoph Hellwig     drv = NULL;
5418a22f02aSStefan Hajnoczi     QLIST_FOREACH(drv1, &bdrv_drivers, list) {
54283f64091Sbellard         if (drv1->bdrv_probe) {
543ea2384d3Sbellard             score = drv1->bdrv_probe(buf, ret, filename);
544ea2384d3Sbellard             if (score > score_max) {
545ea2384d3Sbellard                 score_max = score;
546ea2384d3Sbellard                 drv = drv1;
547ea2384d3Sbellard             }
548ea2384d3Sbellard         }
54983f64091Sbellard     }
550c98ac35dSStefan Weil     if (!drv) {
551c98ac35dSStefan Weil         ret = -ENOENT;
552c98ac35dSStefan Weil     }
553c98ac35dSStefan Weil     *pdrv = drv;
554c98ac35dSStefan Weil     return ret;
555ea2384d3Sbellard }
556ea2384d3Sbellard 
55751762288SStefan Hajnoczi /**
55851762288SStefan Hajnoczi  * Set the current 'total_sectors' value
55951762288SStefan Hajnoczi  */
56051762288SStefan Hajnoczi static int refresh_total_sectors(BlockDriverState *bs, int64_t hint)
56151762288SStefan Hajnoczi {
56251762288SStefan Hajnoczi     BlockDriver *drv = bs->drv;
56351762288SStefan Hajnoczi 
564396759adSNicholas Bellinger     /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */
565396759adSNicholas Bellinger     if (bs->sg)
566396759adSNicholas Bellinger         return 0;
567396759adSNicholas Bellinger 
56851762288SStefan Hajnoczi     /* query actual device if possible, otherwise just trust the hint */
56951762288SStefan Hajnoczi     if (drv->bdrv_getlength) {
57051762288SStefan Hajnoczi         int64_t length = drv->bdrv_getlength(bs);
57151762288SStefan Hajnoczi         if (length < 0) {
57251762288SStefan Hajnoczi             return length;
57351762288SStefan Hajnoczi         }
57451762288SStefan Hajnoczi         hint = length >> BDRV_SECTOR_BITS;
57551762288SStefan Hajnoczi     }
57651762288SStefan Hajnoczi 
57751762288SStefan Hajnoczi     bs->total_sectors = hint;
57851762288SStefan Hajnoczi     return 0;
57951762288SStefan Hajnoczi }
58051762288SStefan Hajnoczi 
581c3993cdcSStefan Hajnoczi /**
5829e8f1835SPaolo Bonzini  * Set open flags for a given discard mode
5839e8f1835SPaolo Bonzini  *
5849e8f1835SPaolo Bonzini  * Return 0 on success, -1 if the discard mode was invalid.
5859e8f1835SPaolo Bonzini  */
5869e8f1835SPaolo Bonzini int bdrv_parse_discard_flags(const char *mode, int *flags)
5879e8f1835SPaolo Bonzini {
5889e8f1835SPaolo Bonzini     *flags &= ~BDRV_O_UNMAP;
5899e8f1835SPaolo Bonzini 
5909e8f1835SPaolo Bonzini     if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) {
5919e8f1835SPaolo Bonzini         /* do nothing */
5929e8f1835SPaolo Bonzini     } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) {
5939e8f1835SPaolo Bonzini         *flags |= BDRV_O_UNMAP;
5949e8f1835SPaolo Bonzini     } else {
5959e8f1835SPaolo Bonzini         return -1;
5969e8f1835SPaolo Bonzini     }
5979e8f1835SPaolo Bonzini 
5989e8f1835SPaolo Bonzini     return 0;
5999e8f1835SPaolo Bonzini }
6009e8f1835SPaolo Bonzini 
6019e8f1835SPaolo Bonzini /**
602c3993cdcSStefan Hajnoczi  * Set open flags for a given cache mode
603c3993cdcSStefan Hajnoczi  *
604c3993cdcSStefan Hajnoczi  * Return 0 on success, -1 if the cache mode was invalid.
605c3993cdcSStefan Hajnoczi  */
606c3993cdcSStefan Hajnoczi int bdrv_parse_cache_flags(const char *mode, int *flags)
607c3993cdcSStefan Hajnoczi {
608c3993cdcSStefan Hajnoczi     *flags &= ~BDRV_O_CACHE_MASK;
609c3993cdcSStefan Hajnoczi 
610c3993cdcSStefan Hajnoczi     if (!strcmp(mode, "off") || !strcmp(mode, "none")) {
611c3993cdcSStefan Hajnoczi         *flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB;
61292196b2fSStefan Hajnoczi     } else if (!strcmp(mode, "directsync")) {
61392196b2fSStefan Hajnoczi         *flags |= BDRV_O_NOCACHE;
614c3993cdcSStefan Hajnoczi     } else if (!strcmp(mode, "writeback")) {
615c3993cdcSStefan Hajnoczi         *flags |= BDRV_O_CACHE_WB;
616c3993cdcSStefan Hajnoczi     } else if (!strcmp(mode, "unsafe")) {
617c3993cdcSStefan Hajnoczi         *flags |= BDRV_O_CACHE_WB;
618c3993cdcSStefan Hajnoczi         *flags |= BDRV_O_NO_FLUSH;
619c3993cdcSStefan Hajnoczi     } else if (!strcmp(mode, "writethrough")) {
620c3993cdcSStefan Hajnoczi         /* this is the default */
621c3993cdcSStefan Hajnoczi     } else {
622c3993cdcSStefan Hajnoczi         return -1;
623c3993cdcSStefan Hajnoczi     }
624c3993cdcSStefan Hajnoczi 
625c3993cdcSStefan Hajnoczi     return 0;
626c3993cdcSStefan Hajnoczi }
627c3993cdcSStefan Hajnoczi 
62853fec9d3SStefan Hajnoczi /**
62953fec9d3SStefan Hajnoczi  * The copy-on-read flag is actually a reference count so multiple users may
63053fec9d3SStefan Hajnoczi  * use the feature without worrying about clobbering its previous state.
63153fec9d3SStefan Hajnoczi  * Copy-on-read stays enabled until all users have called to disable it.
63253fec9d3SStefan Hajnoczi  */
63353fec9d3SStefan Hajnoczi void bdrv_enable_copy_on_read(BlockDriverState *bs)
63453fec9d3SStefan Hajnoczi {
63553fec9d3SStefan Hajnoczi     bs->copy_on_read++;
63653fec9d3SStefan Hajnoczi }
63753fec9d3SStefan Hajnoczi 
63853fec9d3SStefan Hajnoczi void bdrv_disable_copy_on_read(BlockDriverState *bs)
63953fec9d3SStefan Hajnoczi {
64053fec9d3SStefan Hajnoczi     assert(bs->copy_on_read > 0);
64153fec9d3SStefan Hajnoczi     bs->copy_on_read--;
64253fec9d3SStefan Hajnoczi }
64353fec9d3SStefan Hajnoczi 
6447b272452SKevin Wolf static int bdrv_open_flags(BlockDriverState *bs, int flags)
6457b272452SKevin Wolf {
6467b272452SKevin Wolf     int open_flags = flags | BDRV_O_CACHE_WB;
6477b272452SKevin Wolf 
6487b272452SKevin Wolf     /*
6497b272452SKevin Wolf      * Clear flags that are internal to the block layer before opening the
6507b272452SKevin Wolf      * image.
6517b272452SKevin Wolf      */
6527b272452SKevin Wolf     open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
6537b272452SKevin Wolf 
6547b272452SKevin Wolf     /*
6557b272452SKevin Wolf      * Snapshots should be writable.
6567b272452SKevin Wolf      */
6577b272452SKevin Wolf     if (bs->is_temporary) {
6587b272452SKevin Wolf         open_flags |= BDRV_O_RDWR;
6597b272452SKevin Wolf     }
6607b272452SKevin Wolf 
6617b272452SKevin Wolf     return open_flags;
6627b272452SKevin Wolf }
6637b272452SKevin Wolf 
664b6ce07aaSKevin Wolf /*
66557915332SKevin Wolf  * Common part for opening disk images and files
666b6ad491aSKevin Wolf  *
667b6ad491aSKevin Wolf  * Removes all processed options from *options.
66857915332SKevin Wolf  */
669f500a6d3SKevin Wolf static int bdrv_open_common(BlockDriverState *bs, BlockDriverState *file,
670b6ad491aSKevin Wolf     const char *filename, QDict *options,
67157915332SKevin Wolf     int flags, BlockDriver *drv)
67257915332SKevin Wolf {
67357915332SKevin Wolf     int ret, open_flags;
67457915332SKevin Wolf 
67557915332SKevin Wolf     assert(drv != NULL);
6766405875cSPaolo Bonzini     assert(bs->file == NULL);
677707ff828SKevin Wolf     assert(options != NULL && bs->options != options);
67857915332SKevin Wolf 
67928dcee10SStefan Hajnoczi     trace_bdrv_open_common(bs, filename, flags, drv->format_name);
68028dcee10SStefan Hajnoczi 
6815d186eb0SKevin Wolf     if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv)) {
6825d186eb0SKevin Wolf         return -ENOTSUP;
6835d186eb0SKevin Wolf     }
6845d186eb0SKevin Wolf 
6855d186eb0SKevin Wolf     /* bdrv_open() with directly using a protocol as drv. This layer is already
6865d186eb0SKevin Wolf      * opened, so assign it to bs (while file becomes a closed BlockDriverState)
6875d186eb0SKevin Wolf      * and return immediately. */
6885d186eb0SKevin Wolf     if (file != NULL && drv->bdrv_file_open) {
6895d186eb0SKevin Wolf         bdrv_swap(file, bs);
6905d186eb0SKevin Wolf         return 0;
6915d186eb0SKevin Wolf     }
6925d186eb0SKevin Wolf 
69357915332SKevin Wolf     bs->open_flags = flags;
69457915332SKevin Wolf     bs->buffer_alignment = 512;
69557915332SKevin Wolf 
69653fec9d3SStefan Hajnoczi     assert(bs->copy_on_read == 0); /* bdrv_new() and bdrv_close() make it so */
69753fec9d3SStefan Hajnoczi     if ((flags & BDRV_O_RDWR) && (flags & BDRV_O_COPY_ON_READ)) {
69853fec9d3SStefan Hajnoczi         bdrv_enable_copy_on_read(bs);
69953fec9d3SStefan Hajnoczi     }
70053fec9d3SStefan Hajnoczi 
701c2ad1b0cSKevin Wolf     if (filename != NULL) {
70257915332SKevin Wolf         pstrcpy(bs->filename, sizeof(bs->filename), filename);
703c2ad1b0cSKevin Wolf     } else {
704c2ad1b0cSKevin Wolf         bs->filename[0] = '\0';
705c2ad1b0cSKevin Wolf     }
70657915332SKevin Wolf 
70757915332SKevin Wolf     bs->drv = drv;
7087267c094SAnthony Liguori     bs->opaque = g_malloc0(drv->instance_size);
70957915332SKevin Wolf 
71003f541bdSStefan Hajnoczi     bs->enable_write_cache = !!(flags & BDRV_O_CACHE_WB);
7117b272452SKevin Wolf     open_flags = bdrv_open_flags(bs, flags);
71257915332SKevin Wolf 
713be028adcSJeff Cody     bs->read_only = !(open_flags & BDRV_O_RDWR);
714e7c63796SStefan Hajnoczi 
71566f82ceeSKevin Wolf     /* Open the image, either directly or using a protocol */
71666f82ceeSKevin Wolf     if (drv->bdrv_file_open) {
7175d186eb0SKevin Wolf         assert(file == NULL);
718c2ad1b0cSKevin Wolf         assert(drv->bdrv_parse_filename || filename != NULL);
719787e4a85SKevin Wolf         ret = drv->bdrv_file_open(bs, filename, options, open_flags);
720f500a6d3SKevin Wolf     } else {
7212af5ef70SKevin Wolf         if (file == NULL) {
7222af5ef70SKevin Wolf             qerror_report(ERROR_CLASS_GENERIC_ERROR, "Can't use '%s' as a "
7232af5ef70SKevin Wolf                           "block driver for the protocol level",
7242af5ef70SKevin Wolf                           drv->format_name);
7252af5ef70SKevin Wolf             ret = -EINVAL;
7262af5ef70SKevin Wolf             goto free_and_fail;
7272af5ef70SKevin Wolf         }
728f500a6d3SKevin Wolf         assert(file != NULL);
729f500a6d3SKevin Wolf         bs->file = file;
730b6ad491aSKevin Wolf         ret = drv->bdrv_open(bs, options, open_flags);
73166f82ceeSKevin Wolf     }
73266f82ceeSKevin Wolf 
73357915332SKevin Wolf     if (ret < 0) {
73457915332SKevin Wolf         goto free_and_fail;
73557915332SKevin Wolf     }
73657915332SKevin Wolf 
73751762288SStefan Hajnoczi     ret = refresh_total_sectors(bs, bs->total_sectors);
73851762288SStefan Hajnoczi     if (ret < 0) {
73951762288SStefan Hajnoczi         goto free_and_fail;
74057915332SKevin Wolf     }
74151762288SStefan Hajnoczi 
74257915332SKevin Wolf #ifndef _WIN32
74357915332SKevin Wolf     if (bs->is_temporary) {
744c2ad1b0cSKevin Wolf         assert(filename != NULL);
74557915332SKevin Wolf         unlink(filename);
74657915332SKevin Wolf     }
74757915332SKevin Wolf #endif
74857915332SKevin Wolf     return 0;
74957915332SKevin Wolf 
75057915332SKevin Wolf free_and_fail:
75166f82ceeSKevin Wolf     bs->file = NULL;
7527267c094SAnthony Liguori     g_free(bs->opaque);
75357915332SKevin Wolf     bs->opaque = NULL;
75457915332SKevin Wolf     bs->drv = NULL;
75557915332SKevin Wolf     return ret;
75657915332SKevin Wolf }
75757915332SKevin Wolf 
75857915332SKevin Wolf /*
759b6ce07aaSKevin Wolf  * Opens a file using a protocol (file, host_device, nbd, ...)
760787e4a85SKevin Wolf  *
761787e4a85SKevin Wolf  * options is a QDict of options to pass to the block drivers, or NULL for an
762787e4a85SKevin Wolf  * empty set of options. The reference to the QDict belongs to the block layer
763787e4a85SKevin Wolf  * after the call (even on failure), so if the caller intends to reuse the
764787e4a85SKevin Wolf  * dictionary, it needs to use QINCREF() before calling bdrv_file_open.
765b6ce07aaSKevin Wolf  */
766787e4a85SKevin Wolf int bdrv_file_open(BlockDriverState **pbs, const char *filename,
767787e4a85SKevin Wolf                    QDict *options, int flags)
768b338082bSbellard {
76983f64091Sbellard     BlockDriverState *bs;
7706db95603SChristoph Hellwig     BlockDriver *drv;
771c2ad1b0cSKevin Wolf     const char *drvname;
77283f64091Sbellard     int ret;
7733b0d4f61Sbellard 
774707ff828SKevin Wolf     /* NULL means an empty set of options */
775707ff828SKevin Wolf     if (options == NULL) {
776707ff828SKevin Wolf         options = qdict_new();
7773b0d4f61Sbellard     }
778707ff828SKevin Wolf 
779707ff828SKevin Wolf     bs = bdrv_new("");
780707ff828SKevin Wolf     bs->options = options;
781707ff828SKevin Wolf     options = qdict_clone_shallow(options);
782707ff828SKevin Wolf 
783c2ad1b0cSKevin Wolf     /* Find the right block driver */
784c2ad1b0cSKevin Wolf     drvname = qdict_get_try_str(options, "driver");
785c2ad1b0cSKevin Wolf     if (drvname) {
786c2ad1b0cSKevin Wolf         drv = bdrv_find_whitelisted_format(drvname);
787c2ad1b0cSKevin Wolf         qdict_del(options, "driver");
788c2ad1b0cSKevin Wolf     } else if (filename) {
789c2ad1b0cSKevin Wolf         drv = bdrv_find_protocol(filename);
790c2ad1b0cSKevin Wolf     } else {
791c2ad1b0cSKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR,
792c2ad1b0cSKevin Wolf                       "Must specify either driver or file");
793c2ad1b0cSKevin Wolf         drv = NULL;
794c2ad1b0cSKevin Wolf     }
795c2ad1b0cSKevin Wolf 
796c2ad1b0cSKevin Wolf     if (!drv) {
797c2ad1b0cSKevin Wolf         ret = -ENOENT;
798c2ad1b0cSKevin Wolf         goto fail;
799c2ad1b0cSKevin Wolf     }
800c2ad1b0cSKevin Wolf 
801c2ad1b0cSKevin Wolf     /* Parse the filename and open it */
802c2ad1b0cSKevin Wolf     if (drv->bdrv_parse_filename && filename) {
8036963a30dSKevin Wolf         Error *local_err = NULL;
8046963a30dSKevin Wolf         drv->bdrv_parse_filename(filename, options, &local_err);
8056963a30dSKevin Wolf         if (error_is_set(&local_err)) {
8066963a30dSKevin Wolf             qerror_report_err(local_err);
8076963a30dSKevin Wolf             error_free(local_err);
8086963a30dSKevin Wolf             ret = -EINVAL;
8096963a30dSKevin Wolf             goto fail;
8106963a30dSKevin Wolf         }
811c2ad1b0cSKevin Wolf     } else if (!drv->bdrv_parse_filename && !filename) {
812c2ad1b0cSKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR,
813c2ad1b0cSKevin Wolf                       "The '%s' block driver requires a file name",
814c2ad1b0cSKevin Wolf                       drv->format_name);
815c2ad1b0cSKevin Wolf         ret = -EINVAL;
816c2ad1b0cSKevin Wolf         goto fail;
8176963a30dSKevin Wolf     }
8186963a30dSKevin Wolf 
819707ff828SKevin Wolf     ret = bdrv_open_common(bs, NULL, filename, options, flags, drv);
820707ff828SKevin Wolf     if (ret < 0) {
821707ff828SKevin Wolf         goto fail;
822707ff828SKevin Wolf     }
823707ff828SKevin Wolf 
824707ff828SKevin Wolf     /* Check if any unknown options were used */
825707ff828SKevin Wolf     if (qdict_size(options) != 0) {
826707ff828SKevin Wolf         const QDictEntry *entry = qdict_first(options);
827707ff828SKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR, "Block protocol '%s' doesn't "
828707ff828SKevin Wolf                       "support the option '%s'",
829707ff828SKevin Wolf                       drv->format_name, entry->key);
830707ff828SKevin Wolf         ret = -EINVAL;
831707ff828SKevin Wolf         goto fail;
832707ff828SKevin Wolf     }
833707ff828SKevin Wolf     QDECREF(options);
834707ff828SKevin Wolf 
83571d0770cSaliguori     bs->growable = 1;
83683f64091Sbellard     *pbs = bs;
83783f64091Sbellard     return 0;
838707ff828SKevin Wolf 
839707ff828SKevin Wolf fail:
840707ff828SKevin Wolf     QDECREF(options);
841707ff828SKevin Wolf     if (!bs->drv) {
842707ff828SKevin Wolf         QDECREF(bs->options);
843707ff828SKevin Wolf     }
844707ff828SKevin Wolf     bdrv_delete(bs);
845707ff828SKevin Wolf     return ret;
8463b0d4f61Sbellard }
8473b0d4f61Sbellard 
848*31ca6d07SKevin Wolf /*
849*31ca6d07SKevin Wolf  * Opens the backing file for a BlockDriverState if not yet open
850*31ca6d07SKevin Wolf  *
851*31ca6d07SKevin Wolf  * options is a QDict of options to pass to the block drivers, or NULL for an
852*31ca6d07SKevin Wolf  * empty set of options. The reference to the QDict is transferred to this
853*31ca6d07SKevin Wolf  * function (even on failure), so if the caller intends to reuse the dictionary,
854*31ca6d07SKevin Wolf  * it needs to use QINCREF() before calling bdrv_file_open.
855*31ca6d07SKevin Wolf  */
856*31ca6d07SKevin Wolf int bdrv_open_backing_file(BlockDriverState *bs, QDict *options)
8579156df12SPaolo Bonzini {
8589156df12SPaolo Bonzini     char backing_filename[PATH_MAX];
8599156df12SPaolo Bonzini     int back_flags, ret;
8609156df12SPaolo Bonzini     BlockDriver *back_drv = NULL;
8619156df12SPaolo Bonzini 
8629156df12SPaolo Bonzini     if (bs->backing_hd != NULL) {
863*31ca6d07SKevin Wolf         QDECREF(options);
8649156df12SPaolo Bonzini         return 0;
8659156df12SPaolo Bonzini     }
8669156df12SPaolo Bonzini 
867*31ca6d07SKevin Wolf     /* NULL means an empty set of options */
868*31ca6d07SKevin Wolf     if (options == NULL) {
869*31ca6d07SKevin Wolf         options = qdict_new();
870*31ca6d07SKevin Wolf     }
871*31ca6d07SKevin Wolf 
8729156df12SPaolo Bonzini     bs->open_flags &= ~BDRV_O_NO_BACKING;
873*31ca6d07SKevin Wolf     if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) {
874*31ca6d07SKevin Wolf         QDECREF(options);
8759156df12SPaolo Bonzini         return 0;
8769156df12SPaolo Bonzini     }
8779156df12SPaolo Bonzini 
8789156df12SPaolo Bonzini     bs->backing_hd = bdrv_new("");
8799156df12SPaolo Bonzini     bdrv_get_full_backing_filename(bs, backing_filename,
8809156df12SPaolo Bonzini                                    sizeof(backing_filename));
8819156df12SPaolo Bonzini 
8829156df12SPaolo Bonzini     if (bs->backing_format[0] != '\0') {
8839156df12SPaolo Bonzini         back_drv = bdrv_find_format(bs->backing_format);
8849156df12SPaolo Bonzini     }
8859156df12SPaolo Bonzini 
8869156df12SPaolo Bonzini     /* backing files always opened read-only */
8879156df12SPaolo Bonzini     back_flags = bs->open_flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT);
8889156df12SPaolo Bonzini 
889*31ca6d07SKevin Wolf     ret = bdrv_open(bs->backing_hd,
890*31ca6d07SKevin Wolf                     *backing_filename ? backing_filename : NULL, options,
891de9c0cecSKevin Wolf                     back_flags, back_drv);
8929156df12SPaolo Bonzini     if (ret < 0) {
8939156df12SPaolo Bonzini         bdrv_delete(bs->backing_hd);
8949156df12SPaolo Bonzini         bs->backing_hd = NULL;
8959156df12SPaolo Bonzini         bs->open_flags |= BDRV_O_NO_BACKING;
8969156df12SPaolo Bonzini         return ret;
8979156df12SPaolo Bonzini     }
8989156df12SPaolo Bonzini     return 0;
8999156df12SPaolo Bonzini }
9009156df12SPaolo Bonzini 
901707ff828SKevin Wolf static void extract_subqdict(QDict *src, QDict **dst, const char *start)
902707ff828SKevin Wolf {
903707ff828SKevin Wolf     const QDictEntry *entry, *next;
904707ff828SKevin Wolf     const char *p;
905707ff828SKevin Wolf 
906707ff828SKevin Wolf     *dst = qdict_new();
907707ff828SKevin Wolf     entry = qdict_first(src);
908707ff828SKevin Wolf 
909707ff828SKevin Wolf     while (entry != NULL) {
910707ff828SKevin Wolf         next = qdict_next(src, entry);
911707ff828SKevin Wolf         if (strstart(entry->key, start, &p)) {
912707ff828SKevin Wolf             qobject_incref(entry->value);
913707ff828SKevin Wolf             qdict_put_obj(*dst, p, entry->value);
914707ff828SKevin Wolf             qdict_del(src, entry->key);
915707ff828SKevin Wolf         }
916707ff828SKevin Wolf         entry = next;
917707ff828SKevin Wolf     }
918707ff828SKevin Wolf }
919707ff828SKevin Wolf 
920b6ce07aaSKevin Wolf /*
921b6ce07aaSKevin Wolf  * Opens a disk image (raw, qcow2, vmdk, ...)
922de9c0cecSKevin Wolf  *
923de9c0cecSKevin Wolf  * options is a QDict of options to pass to the block drivers, or NULL for an
924de9c0cecSKevin Wolf  * empty set of options. The reference to the QDict belongs to the block layer
925de9c0cecSKevin Wolf  * after the call (even on failure), so if the caller intends to reuse the
926de9c0cecSKevin Wolf  * dictionary, it needs to use QINCREF() before calling bdrv_open.
927b6ce07aaSKevin Wolf  */
928de9c0cecSKevin Wolf int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options,
929de9c0cecSKevin Wolf               int flags, BlockDriver *drv)
930ea2384d3Sbellard {
931b6ce07aaSKevin Wolf     int ret;
93289c9bc3dSStefan Weil     /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */
93389c9bc3dSStefan Weil     char tmp_filename[PATH_MAX + 1];
934f500a6d3SKevin Wolf     BlockDriverState *file = NULL;
935707ff828SKevin Wolf     QDict *file_options = NULL;
93633e3963eSbellard 
937de9c0cecSKevin Wolf     /* NULL means an empty set of options */
938de9c0cecSKevin Wolf     if (options == NULL) {
939de9c0cecSKevin Wolf         options = qdict_new();
940de9c0cecSKevin Wolf     }
941de9c0cecSKevin Wolf 
942de9c0cecSKevin Wolf     bs->options = options;
943b6ad491aSKevin Wolf     options = qdict_clone_shallow(options);
944de9c0cecSKevin Wolf 
945de9c0cecSKevin Wolf     /* For snapshot=on, create a temporary qcow2 overlay */
94683f64091Sbellard     if (flags & BDRV_O_SNAPSHOT) {
947ea2384d3Sbellard         BlockDriverState *bs1;
948ea2384d3Sbellard         int64_t total_size;
94991a073a9SKevin Wolf         BlockDriver *bdrv_qcow2;
95008b392e1SKevin Wolf         QEMUOptionParameter *create_options;
951b6ce07aaSKevin Wolf         char backing_filename[PATH_MAX];
95233e3963eSbellard 
953c2ad1b0cSKevin Wolf         if (qdict_size(options) != 0) {
954c2ad1b0cSKevin Wolf             error_report("Can't use snapshot=on with driver-specific options");
955c2ad1b0cSKevin Wolf             ret = -EINVAL;
956c2ad1b0cSKevin Wolf             goto fail;
957c2ad1b0cSKevin Wolf         }
958c2ad1b0cSKevin Wolf         assert(filename != NULL);
959c2ad1b0cSKevin Wolf 
960ea2384d3Sbellard         /* if snapshot, we create a temporary backing file and open it
961ea2384d3Sbellard            instead of opening 'filename' directly */
962ea2384d3Sbellard 
963ea2384d3Sbellard         /* if there is a backing file, use it */
964ea2384d3Sbellard         bs1 = bdrv_new("");
965de9c0cecSKevin Wolf         ret = bdrv_open(bs1, filename, NULL, 0, drv);
96651d7c00cSaliguori         if (ret < 0) {
967ea2384d3Sbellard             bdrv_delete(bs1);
968de9c0cecSKevin Wolf             goto fail;
969ea2384d3Sbellard         }
9703e82990bSJes Sorensen         total_size = bdrv_getlength(bs1) & BDRV_SECTOR_MASK;
9717c96d46eSaliguori 
972ea2384d3Sbellard         bdrv_delete(bs1);
973ea2384d3Sbellard 
974eba25057SJim Meyering         ret = get_tmp_filename(tmp_filename, sizeof(tmp_filename));
975eba25057SJim Meyering         if (ret < 0) {
976de9c0cecSKevin Wolf             goto fail;
977eba25057SJim Meyering         }
9787c96d46eSaliguori 
9797c96d46eSaliguori         /* Real path is meaningless for protocols */
9804d70655bSStefan Hajnoczi         if (path_has_protocol(filename)) {
9817c96d46eSaliguori             snprintf(backing_filename, sizeof(backing_filename),
9827c96d46eSaliguori                      "%s", filename);
983de9c0cecSKevin Wolf         } else if (!realpath(filename, backing_filename)) {
984de9c0cecSKevin Wolf             ret = -errno;
985de9c0cecSKevin Wolf             goto fail;
986de9c0cecSKevin Wolf         }
9877c96d46eSaliguori 
98891a073a9SKevin Wolf         bdrv_qcow2 = bdrv_find_format("qcow2");
98908b392e1SKevin Wolf         create_options = parse_option_parameters("", bdrv_qcow2->create_options,
99008b392e1SKevin Wolf                                                  NULL);
99191a073a9SKevin Wolf 
99208b392e1SKevin Wolf         set_option_parameter_int(create_options, BLOCK_OPT_SIZE, total_size);
99308b392e1SKevin Wolf         set_option_parameter(create_options, BLOCK_OPT_BACKING_FILE,
99408b392e1SKevin Wolf                              backing_filename);
99591a073a9SKevin Wolf         if (drv) {
99608b392e1SKevin Wolf             set_option_parameter(create_options, BLOCK_OPT_BACKING_FMT,
99791a073a9SKevin Wolf                 drv->format_name);
99891a073a9SKevin Wolf         }
99991a073a9SKevin Wolf 
100008b392e1SKevin Wolf         ret = bdrv_create(bdrv_qcow2, tmp_filename, create_options);
100108b392e1SKevin Wolf         free_option_parameters(create_options);
100251d7c00cSaliguori         if (ret < 0) {
1003de9c0cecSKevin Wolf             goto fail;
1004ea2384d3Sbellard         }
100591a073a9SKevin Wolf 
1006ea2384d3Sbellard         filename = tmp_filename;
100791a073a9SKevin Wolf         drv = bdrv_qcow2;
1008ea2384d3Sbellard         bs->is_temporary = 1;
1009ea2384d3Sbellard     }
1010ea2384d3Sbellard 
1011f500a6d3SKevin Wolf     /* Open image file without format layer */
1012be028adcSJeff Cody     if (flags & BDRV_O_RDWR) {
1013be028adcSJeff Cody         flags |= BDRV_O_ALLOW_RDWR;
1014be028adcSJeff Cody     }
1015be028adcSJeff Cody 
1016707ff828SKevin Wolf     extract_subqdict(options, &file_options, "file.");
1017707ff828SKevin Wolf 
1018707ff828SKevin Wolf     ret = bdrv_file_open(&file, filename, file_options,
1019707ff828SKevin Wolf                          bdrv_open_flags(bs, flags));
1020f500a6d3SKevin Wolf     if (ret < 0) {
1021de9c0cecSKevin Wolf         goto fail;
1022f500a6d3SKevin Wolf     }
1023f500a6d3SKevin Wolf 
1024f500a6d3SKevin Wolf     /* Find the right image format driver */
1025f500a6d3SKevin Wolf     if (!drv) {
1026f500a6d3SKevin Wolf         ret = find_image_format(file, filename, &drv);
1027f500a6d3SKevin Wolf     }
1028f500a6d3SKevin Wolf 
1029f500a6d3SKevin Wolf     if (!drv) {
1030f500a6d3SKevin Wolf         goto unlink_and_fail;
1031f500a6d3SKevin Wolf     }
1032f500a6d3SKevin Wolf 
1033b6ce07aaSKevin Wolf     /* Open the image */
1034b6ad491aSKevin Wolf     ret = bdrv_open_common(bs, file, filename, options, flags, drv);
1035b6ce07aaSKevin Wolf     if (ret < 0) {
10366987307cSChristoph Hellwig         goto unlink_and_fail;
10376987307cSChristoph Hellwig     }
10386987307cSChristoph Hellwig 
1039f500a6d3SKevin Wolf     if (bs->file != file) {
1040f500a6d3SKevin Wolf         bdrv_delete(file);
1041f500a6d3SKevin Wolf         file = NULL;
1042f500a6d3SKevin Wolf     }
1043f500a6d3SKevin Wolf 
1044b6ce07aaSKevin Wolf     /* If there is a backing file, use it */
10459156df12SPaolo Bonzini     if ((flags & BDRV_O_NO_BACKING) == 0) {
1046*31ca6d07SKevin Wolf         QDict *backing_options;
1047*31ca6d07SKevin Wolf 
1048*31ca6d07SKevin Wolf         extract_subqdict(options, &backing_options, "backing.");
1049*31ca6d07SKevin Wolf         ret = bdrv_open_backing_file(bs, backing_options);
1050b6ce07aaSKevin Wolf         if (ret < 0) {
1051b6ad491aSKevin Wolf             goto close_and_fail;
1052b6ce07aaSKevin Wolf         }
1053b6ce07aaSKevin Wolf     }
1054b6ce07aaSKevin Wolf 
1055b6ad491aSKevin Wolf     /* Check if any unknown options were used */
1056b6ad491aSKevin Wolf     if (qdict_size(options) != 0) {
1057b6ad491aSKevin Wolf         const QDictEntry *entry = qdict_first(options);
1058b6ad491aSKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR, "Block format '%s' used by "
1059b6ad491aSKevin Wolf             "device '%s' doesn't support the option '%s'",
1060b6ad491aSKevin Wolf             drv->format_name, bs->device_name, entry->key);
1061b6ad491aSKevin Wolf 
1062b6ad491aSKevin Wolf         ret = -EINVAL;
1063b6ad491aSKevin Wolf         goto close_and_fail;
1064b6ad491aSKevin Wolf     }
1065b6ad491aSKevin Wolf     QDECREF(options);
1066b6ad491aSKevin Wolf 
1067b6ce07aaSKevin Wolf     if (!bdrv_key_required(bs)) {
10687d4b4ba5SMarkus Armbruster         bdrv_dev_change_media_cb(bs, true);
1069b6ce07aaSKevin Wolf     }
1070b6ce07aaSKevin Wolf 
107198f90dbaSZhi Yong Wu     /* throttling disk I/O limits */
107298f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
107398f90dbaSZhi Yong Wu         bdrv_io_limits_enable(bs);
107498f90dbaSZhi Yong Wu     }
107598f90dbaSZhi Yong Wu 
1076b6ce07aaSKevin Wolf     return 0;
1077b6ce07aaSKevin Wolf 
1078b6ce07aaSKevin Wolf unlink_and_fail:
1079f500a6d3SKevin Wolf     if (file != NULL) {
1080f500a6d3SKevin Wolf         bdrv_delete(file);
1081f500a6d3SKevin Wolf     }
1082b6ce07aaSKevin Wolf     if (bs->is_temporary) {
1083b6ce07aaSKevin Wolf         unlink(filename);
1084b6ce07aaSKevin Wolf     }
1085de9c0cecSKevin Wolf fail:
1086de9c0cecSKevin Wolf     QDECREF(bs->options);
1087b6ad491aSKevin Wolf     QDECREF(options);
1088de9c0cecSKevin Wolf     bs->options = NULL;
1089b6ad491aSKevin Wolf     return ret;
1090de9c0cecSKevin Wolf 
1091b6ad491aSKevin Wolf close_and_fail:
1092b6ad491aSKevin Wolf     bdrv_close(bs);
1093b6ad491aSKevin Wolf     QDECREF(options);
1094b6ce07aaSKevin Wolf     return ret;
1095b6ce07aaSKevin Wolf }
1096b6ce07aaSKevin Wolf 
1097e971aa12SJeff Cody typedef struct BlockReopenQueueEntry {
1098e971aa12SJeff Cody      bool prepared;
1099e971aa12SJeff Cody      BDRVReopenState state;
1100e971aa12SJeff Cody      QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry;
1101e971aa12SJeff Cody } BlockReopenQueueEntry;
1102e971aa12SJeff Cody 
1103e971aa12SJeff Cody /*
1104e971aa12SJeff Cody  * Adds a BlockDriverState to a simple queue for an atomic, transactional
1105e971aa12SJeff Cody  * reopen of multiple devices.
1106e971aa12SJeff Cody  *
1107e971aa12SJeff Cody  * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT
1108e971aa12SJeff Cody  * already performed, or alternatively may be NULL a new BlockReopenQueue will
1109e971aa12SJeff Cody  * be created and initialized. This newly created BlockReopenQueue should be
1110e971aa12SJeff Cody  * passed back in for subsequent calls that are intended to be of the same
1111e971aa12SJeff Cody  * atomic 'set'.
1112e971aa12SJeff Cody  *
1113e971aa12SJeff Cody  * bs is the BlockDriverState to add to the reopen queue.
1114e971aa12SJeff Cody  *
1115e971aa12SJeff Cody  * flags contains the open flags for the associated bs
1116e971aa12SJeff Cody  *
1117e971aa12SJeff Cody  * returns a pointer to bs_queue, which is either the newly allocated
1118e971aa12SJeff Cody  * bs_queue, or the existing bs_queue being used.
1119e971aa12SJeff Cody  *
1120e971aa12SJeff Cody  */
1121e971aa12SJeff Cody BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
1122e971aa12SJeff Cody                                     BlockDriverState *bs, int flags)
1123e971aa12SJeff Cody {
1124e971aa12SJeff Cody     assert(bs != NULL);
1125e971aa12SJeff Cody 
1126e971aa12SJeff Cody     BlockReopenQueueEntry *bs_entry;
1127e971aa12SJeff Cody     if (bs_queue == NULL) {
1128e971aa12SJeff Cody         bs_queue = g_new0(BlockReopenQueue, 1);
1129e971aa12SJeff Cody         QSIMPLEQ_INIT(bs_queue);
1130e971aa12SJeff Cody     }
1131e971aa12SJeff Cody 
1132e971aa12SJeff Cody     if (bs->file) {
1133e971aa12SJeff Cody         bdrv_reopen_queue(bs_queue, bs->file, flags);
1134e971aa12SJeff Cody     }
1135e971aa12SJeff Cody 
1136e971aa12SJeff Cody     bs_entry = g_new0(BlockReopenQueueEntry, 1);
1137e971aa12SJeff Cody     QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry);
1138e971aa12SJeff Cody 
1139e971aa12SJeff Cody     bs_entry->state.bs = bs;
1140e971aa12SJeff Cody     bs_entry->state.flags = flags;
1141e971aa12SJeff Cody 
1142e971aa12SJeff Cody     return bs_queue;
1143e971aa12SJeff Cody }
1144e971aa12SJeff Cody 
1145e971aa12SJeff Cody /*
1146e971aa12SJeff Cody  * Reopen multiple BlockDriverStates atomically & transactionally.
1147e971aa12SJeff Cody  *
1148e971aa12SJeff Cody  * The queue passed in (bs_queue) must have been built up previous
1149e971aa12SJeff Cody  * via bdrv_reopen_queue().
1150e971aa12SJeff Cody  *
1151e971aa12SJeff Cody  * Reopens all BDS specified in the queue, with the appropriate
1152e971aa12SJeff Cody  * flags.  All devices are prepared for reopen, and failure of any
1153e971aa12SJeff Cody  * device will cause all device changes to be abandonded, and intermediate
1154e971aa12SJeff Cody  * data cleaned up.
1155e971aa12SJeff Cody  *
1156e971aa12SJeff Cody  * If all devices prepare successfully, then the changes are committed
1157e971aa12SJeff Cody  * to all devices.
1158e971aa12SJeff Cody  *
1159e971aa12SJeff Cody  */
1160e971aa12SJeff Cody int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp)
1161e971aa12SJeff Cody {
1162e971aa12SJeff Cody     int ret = -1;
1163e971aa12SJeff Cody     BlockReopenQueueEntry *bs_entry, *next;
1164e971aa12SJeff Cody     Error *local_err = NULL;
1165e971aa12SJeff Cody 
1166e971aa12SJeff Cody     assert(bs_queue != NULL);
1167e971aa12SJeff Cody 
1168e971aa12SJeff Cody     bdrv_drain_all();
1169e971aa12SJeff Cody 
1170e971aa12SJeff Cody     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
1171e971aa12SJeff Cody         if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) {
1172e971aa12SJeff Cody             error_propagate(errp, local_err);
1173e971aa12SJeff Cody             goto cleanup;
1174e971aa12SJeff Cody         }
1175e971aa12SJeff Cody         bs_entry->prepared = true;
1176e971aa12SJeff Cody     }
1177e971aa12SJeff Cody 
1178e971aa12SJeff Cody     /* If we reach this point, we have success and just need to apply the
1179e971aa12SJeff Cody      * changes
1180e971aa12SJeff Cody      */
1181e971aa12SJeff Cody     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
1182e971aa12SJeff Cody         bdrv_reopen_commit(&bs_entry->state);
1183e971aa12SJeff Cody     }
1184e971aa12SJeff Cody 
1185e971aa12SJeff Cody     ret = 0;
1186e971aa12SJeff Cody 
1187e971aa12SJeff Cody cleanup:
1188e971aa12SJeff Cody     QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) {
1189e971aa12SJeff Cody         if (ret && bs_entry->prepared) {
1190e971aa12SJeff Cody             bdrv_reopen_abort(&bs_entry->state);
1191e971aa12SJeff Cody         }
1192e971aa12SJeff Cody         g_free(bs_entry);
1193e971aa12SJeff Cody     }
1194e971aa12SJeff Cody     g_free(bs_queue);
1195e971aa12SJeff Cody     return ret;
1196e971aa12SJeff Cody }
1197e971aa12SJeff Cody 
1198e971aa12SJeff Cody 
1199e971aa12SJeff Cody /* Reopen a single BlockDriverState with the specified flags. */
1200e971aa12SJeff Cody int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp)
1201e971aa12SJeff Cody {
1202e971aa12SJeff Cody     int ret = -1;
1203e971aa12SJeff Cody     Error *local_err = NULL;
1204e971aa12SJeff Cody     BlockReopenQueue *queue = bdrv_reopen_queue(NULL, bs, bdrv_flags);
1205e971aa12SJeff Cody 
1206e971aa12SJeff Cody     ret = bdrv_reopen_multiple(queue, &local_err);
1207e971aa12SJeff Cody     if (local_err != NULL) {
1208e971aa12SJeff Cody         error_propagate(errp, local_err);
1209e971aa12SJeff Cody     }
1210e971aa12SJeff Cody     return ret;
1211e971aa12SJeff Cody }
1212e971aa12SJeff Cody 
1213e971aa12SJeff Cody 
1214e971aa12SJeff Cody /*
1215e971aa12SJeff Cody  * Prepares a BlockDriverState for reopen. All changes are staged in the
1216e971aa12SJeff Cody  * 'opaque' field of the BDRVReopenState, which is used and allocated by
1217e971aa12SJeff Cody  * the block driver layer .bdrv_reopen_prepare()
1218e971aa12SJeff Cody  *
1219e971aa12SJeff Cody  * bs is the BlockDriverState to reopen
1220e971aa12SJeff Cody  * flags are the new open flags
1221e971aa12SJeff Cody  * queue is the reopen queue
1222e971aa12SJeff Cody  *
1223e971aa12SJeff Cody  * Returns 0 on success, non-zero on error.  On error errp will be set
1224e971aa12SJeff Cody  * as well.
1225e971aa12SJeff Cody  *
1226e971aa12SJeff Cody  * On failure, bdrv_reopen_abort() will be called to clean up any data.
1227e971aa12SJeff Cody  * It is the responsibility of the caller to then call the abort() or
1228e971aa12SJeff Cody  * commit() for any other BDS that have been left in a prepare() state
1229e971aa12SJeff Cody  *
1230e971aa12SJeff Cody  */
1231e971aa12SJeff Cody int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue,
1232e971aa12SJeff Cody                         Error **errp)
1233e971aa12SJeff Cody {
1234e971aa12SJeff Cody     int ret = -1;
1235e971aa12SJeff Cody     Error *local_err = NULL;
1236e971aa12SJeff Cody     BlockDriver *drv;
1237e971aa12SJeff Cody 
1238e971aa12SJeff Cody     assert(reopen_state != NULL);
1239e971aa12SJeff Cody     assert(reopen_state->bs->drv != NULL);
1240e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1241e971aa12SJeff Cody 
1242e971aa12SJeff Cody     /* if we are to stay read-only, do not allow permission change
1243e971aa12SJeff Cody      * to r/w */
1244e971aa12SJeff Cody     if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) &&
1245e971aa12SJeff Cody         reopen_state->flags & BDRV_O_RDWR) {
1246e971aa12SJeff Cody         error_set(errp, QERR_DEVICE_IS_READ_ONLY,
1247e971aa12SJeff Cody                   reopen_state->bs->device_name);
1248e971aa12SJeff Cody         goto error;
1249e971aa12SJeff Cody     }
1250e971aa12SJeff Cody 
1251e971aa12SJeff Cody 
1252e971aa12SJeff Cody     ret = bdrv_flush(reopen_state->bs);
1253e971aa12SJeff Cody     if (ret) {
1254e971aa12SJeff Cody         error_set(errp, ERROR_CLASS_GENERIC_ERROR, "Error (%s) flushing drive",
1255e971aa12SJeff Cody                   strerror(-ret));
1256e971aa12SJeff Cody         goto error;
1257e971aa12SJeff Cody     }
1258e971aa12SJeff Cody 
1259e971aa12SJeff Cody     if (drv->bdrv_reopen_prepare) {
1260e971aa12SJeff Cody         ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err);
1261e971aa12SJeff Cody         if (ret) {
1262e971aa12SJeff Cody             if (local_err != NULL) {
1263e971aa12SJeff Cody                 error_propagate(errp, local_err);
1264e971aa12SJeff Cody             } else {
1265e971aa12SJeff Cody                 error_set(errp, QERR_OPEN_FILE_FAILED,
1266e971aa12SJeff Cody                           reopen_state->bs->filename);
1267e971aa12SJeff Cody             }
1268e971aa12SJeff Cody             goto error;
1269e971aa12SJeff Cody         }
1270e971aa12SJeff Cody     } else {
1271e971aa12SJeff Cody         /* It is currently mandatory to have a bdrv_reopen_prepare()
1272e971aa12SJeff Cody          * handler for each supported drv. */
1273e971aa12SJeff Cody         error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1274e971aa12SJeff Cody                   drv->format_name, reopen_state->bs->device_name,
1275e971aa12SJeff Cody                  "reopening of file");
1276e971aa12SJeff Cody         ret = -1;
1277e971aa12SJeff Cody         goto error;
1278e971aa12SJeff Cody     }
1279e971aa12SJeff Cody 
1280e971aa12SJeff Cody     ret = 0;
1281e971aa12SJeff Cody 
1282e971aa12SJeff Cody error:
1283e971aa12SJeff Cody     return ret;
1284e971aa12SJeff Cody }
1285e971aa12SJeff Cody 
1286e971aa12SJeff Cody /*
1287e971aa12SJeff Cody  * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and
1288e971aa12SJeff Cody  * makes them final by swapping the staging BlockDriverState contents into
1289e971aa12SJeff Cody  * the active BlockDriverState contents.
1290e971aa12SJeff Cody  */
1291e971aa12SJeff Cody void bdrv_reopen_commit(BDRVReopenState *reopen_state)
1292e971aa12SJeff Cody {
1293e971aa12SJeff Cody     BlockDriver *drv;
1294e971aa12SJeff Cody 
1295e971aa12SJeff Cody     assert(reopen_state != NULL);
1296e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1297e971aa12SJeff Cody     assert(drv != NULL);
1298e971aa12SJeff Cody 
1299e971aa12SJeff Cody     /* If there are any driver level actions to take */
1300e971aa12SJeff Cody     if (drv->bdrv_reopen_commit) {
1301e971aa12SJeff Cody         drv->bdrv_reopen_commit(reopen_state);
1302e971aa12SJeff Cody     }
1303e971aa12SJeff Cody 
1304e971aa12SJeff Cody     /* set BDS specific flags now */
1305e971aa12SJeff Cody     reopen_state->bs->open_flags         = reopen_state->flags;
1306e971aa12SJeff Cody     reopen_state->bs->enable_write_cache = !!(reopen_state->flags &
1307e971aa12SJeff Cody                                               BDRV_O_CACHE_WB);
1308e971aa12SJeff Cody     reopen_state->bs->read_only = !(reopen_state->flags & BDRV_O_RDWR);
1309e971aa12SJeff Cody }
1310e971aa12SJeff Cody 
1311e971aa12SJeff Cody /*
1312e971aa12SJeff Cody  * Abort the reopen, and delete and free the staged changes in
1313e971aa12SJeff Cody  * reopen_state
1314e971aa12SJeff Cody  */
1315e971aa12SJeff Cody void bdrv_reopen_abort(BDRVReopenState *reopen_state)
1316e971aa12SJeff Cody {
1317e971aa12SJeff Cody     BlockDriver *drv;
1318e971aa12SJeff Cody 
1319e971aa12SJeff Cody     assert(reopen_state != NULL);
1320e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1321e971aa12SJeff Cody     assert(drv != NULL);
1322e971aa12SJeff Cody 
1323e971aa12SJeff Cody     if (drv->bdrv_reopen_abort) {
1324e971aa12SJeff Cody         drv->bdrv_reopen_abort(reopen_state);
1325e971aa12SJeff Cody     }
1326e971aa12SJeff Cody }
1327e971aa12SJeff Cody 
1328e971aa12SJeff Cody 
1329fc01f7e7Sbellard void bdrv_close(BlockDriverState *bs)
1330fc01f7e7Sbellard {
133180ccf93bSLiu Yuan     bdrv_flush(bs);
13323e914655SPaolo Bonzini     if (bs->job) {
13333e914655SPaolo Bonzini         block_job_cancel_sync(bs->job);
13343e914655SPaolo Bonzini     }
13357094f12fSKevin Wolf     bdrv_drain_all();
1336d7d512f6SPaolo Bonzini     notifier_list_notify(&bs->close_notifiers, bs);
13377094f12fSKevin Wolf 
13383cbc002cSPaolo Bonzini     if (bs->drv) {
1339f9092b10SMarkus Armbruster         if (bs == bs_snapshots) {
1340f9092b10SMarkus Armbruster             bs_snapshots = NULL;
1341f9092b10SMarkus Armbruster         }
1342557df6acSStefan Hajnoczi         if (bs->backing_hd) {
1343ea2384d3Sbellard             bdrv_delete(bs->backing_hd);
1344557df6acSStefan Hajnoczi             bs->backing_hd = NULL;
1345557df6acSStefan Hajnoczi         }
1346ea2384d3Sbellard         bs->drv->bdrv_close(bs);
13477267c094SAnthony Liguori         g_free(bs->opaque);
1348ea2384d3Sbellard #ifdef _WIN32
1349ea2384d3Sbellard         if (bs->is_temporary) {
1350ea2384d3Sbellard             unlink(bs->filename);
1351ea2384d3Sbellard         }
135267b915a5Sbellard #endif
1353ea2384d3Sbellard         bs->opaque = NULL;
1354ea2384d3Sbellard         bs->drv = NULL;
135553fec9d3SStefan Hajnoczi         bs->copy_on_read = 0;
1356a275fa42SPaolo Bonzini         bs->backing_file[0] = '\0';
1357a275fa42SPaolo Bonzini         bs->backing_format[0] = '\0';
13586405875cSPaolo Bonzini         bs->total_sectors = 0;
13596405875cSPaolo Bonzini         bs->encrypted = 0;
13606405875cSPaolo Bonzini         bs->valid_key = 0;
13616405875cSPaolo Bonzini         bs->sg = 0;
13626405875cSPaolo Bonzini         bs->growable = 0;
1363de9c0cecSKevin Wolf         QDECREF(bs->options);
1364de9c0cecSKevin Wolf         bs->options = NULL;
1365b338082bSbellard 
136666f82ceeSKevin Wolf         if (bs->file != NULL) {
13670ac9377dSPaolo Bonzini             bdrv_delete(bs->file);
13680ac9377dSPaolo Bonzini             bs->file = NULL;
136966f82ceeSKevin Wolf         }
13709ca11154SPavel Hrdina     }
137166f82ceeSKevin Wolf 
13727d4b4ba5SMarkus Armbruster     bdrv_dev_change_media_cb(bs, false);
137398f90dbaSZhi Yong Wu 
137498f90dbaSZhi Yong Wu     /*throttling disk I/O limits*/
137598f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
137698f90dbaSZhi Yong Wu         bdrv_io_limits_disable(bs);
137798f90dbaSZhi Yong Wu     }
1378b338082bSbellard }
1379b338082bSbellard 
13802bc93fedSMORITA Kazutaka void bdrv_close_all(void)
13812bc93fedSMORITA Kazutaka {
13822bc93fedSMORITA Kazutaka     BlockDriverState *bs;
13832bc93fedSMORITA Kazutaka 
13842bc93fedSMORITA Kazutaka     QTAILQ_FOREACH(bs, &bdrv_states, list) {
13852bc93fedSMORITA Kazutaka         bdrv_close(bs);
13862bc93fedSMORITA Kazutaka     }
13872bc93fedSMORITA Kazutaka }
13882bc93fedSMORITA Kazutaka 
1389922453bcSStefan Hajnoczi /*
1390922453bcSStefan Hajnoczi  * Wait for pending requests to complete across all BlockDriverStates
1391922453bcSStefan Hajnoczi  *
1392922453bcSStefan Hajnoczi  * This function does not flush data to disk, use bdrv_flush_all() for that
1393922453bcSStefan Hajnoczi  * after calling this function.
13944c355d53SZhi Yong Wu  *
13954c355d53SZhi Yong Wu  * Note that completion of an asynchronous I/O operation can trigger any
13964c355d53SZhi Yong Wu  * number of other I/O operations on other devices---for example a coroutine
13974c355d53SZhi Yong Wu  * can be arbitrarily complex and a constant flow of I/O can come until the
13984c355d53SZhi Yong Wu  * coroutine is complete.  Because of this, it is not possible to have a
13994c355d53SZhi Yong Wu  * function to drain a single device's I/O queue.
1400922453bcSStefan Hajnoczi  */
1401922453bcSStefan Hajnoczi void bdrv_drain_all(void)
1402922453bcSStefan Hajnoczi {
1403922453bcSStefan Hajnoczi     BlockDriverState *bs;
14044c355d53SZhi Yong Wu     bool busy;
1405922453bcSStefan Hajnoczi 
14064c355d53SZhi Yong Wu     do {
14074c355d53SZhi Yong Wu         busy = qemu_aio_wait();
14084c355d53SZhi Yong Wu 
14094c355d53SZhi Yong Wu         /* FIXME: We do not have timer support here, so this is effectively
14104c355d53SZhi Yong Wu          * a busy wait.
14114c355d53SZhi Yong Wu          */
14124c355d53SZhi Yong Wu         QTAILQ_FOREACH(bs, &bdrv_states, list) {
14134c355d53SZhi Yong Wu             if (!qemu_co_queue_empty(&bs->throttled_reqs)) {
14144c355d53SZhi Yong Wu                 qemu_co_queue_restart_all(&bs->throttled_reqs);
14154c355d53SZhi Yong Wu                 busy = true;
14164c355d53SZhi Yong Wu             }
14174c355d53SZhi Yong Wu         }
14184c355d53SZhi Yong Wu     } while (busy);
1419922453bcSStefan Hajnoczi 
1420922453bcSStefan Hajnoczi     /* If requests are still pending there is a bug somewhere */
1421922453bcSStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
1422922453bcSStefan Hajnoczi         assert(QLIST_EMPTY(&bs->tracked_requests));
1423922453bcSStefan Hajnoczi         assert(qemu_co_queue_empty(&bs->throttled_reqs));
1424922453bcSStefan Hajnoczi     }
1425922453bcSStefan Hajnoczi }
1426922453bcSStefan Hajnoczi 
1427d22b2f41SRyan Harper /* make a BlockDriverState anonymous by removing from bdrv_state list.
1428d22b2f41SRyan Harper    Also, NULL terminate the device_name to prevent double remove */
1429d22b2f41SRyan Harper void bdrv_make_anon(BlockDriverState *bs)
1430d22b2f41SRyan Harper {
1431d22b2f41SRyan Harper     if (bs->device_name[0] != '\0') {
1432d22b2f41SRyan Harper         QTAILQ_REMOVE(&bdrv_states, bs, list);
1433d22b2f41SRyan Harper     }
1434d22b2f41SRyan Harper     bs->device_name[0] = '\0';
1435d22b2f41SRyan Harper }
1436d22b2f41SRyan Harper 
1437e023b2e2SPaolo Bonzini static void bdrv_rebind(BlockDriverState *bs)
1438e023b2e2SPaolo Bonzini {
1439e023b2e2SPaolo Bonzini     if (bs->drv && bs->drv->bdrv_rebind) {
1440e023b2e2SPaolo Bonzini         bs->drv->bdrv_rebind(bs);
1441e023b2e2SPaolo Bonzini     }
1442e023b2e2SPaolo Bonzini }
1443e023b2e2SPaolo Bonzini 
14444ddc07caSPaolo Bonzini static void bdrv_move_feature_fields(BlockDriverState *bs_dest,
14454ddc07caSPaolo Bonzini                                      BlockDriverState *bs_src)
14464ddc07caSPaolo Bonzini {
14474ddc07caSPaolo Bonzini     /* move some fields that need to stay attached to the device */
14484ddc07caSPaolo Bonzini     bs_dest->open_flags         = bs_src->open_flags;
14494ddc07caSPaolo Bonzini 
14504ddc07caSPaolo Bonzini     /* dev info */
14514ddc07caSPaolo Bonzini     bs_dest->dev_ops            = bs_src->dev_ops;
14524ddc07caSPaolo Bonzini     bs_dest->dev_opaque         = bs_src->dev_opaque;
14534ddc07caSPaolo Bonzini     bs_dest->dev                = bs_src->dev;
14544ddc07caSPaolo Bonzini     bs_dest->buffer_alignment   = bs_src->buffer_alignment;
14554ddc07caSPaolo Bonzini     bs_dest->copy_on_read       = bs_src->copy_on_read;
14564ddc07caSPaolo Bonzini 
14574ddc07caSPaolo Bonzini     bs_dest->enable_write_cache = bs_src->enable_write_cache;
14584ddc07caSPaolo Bonzini 
14594ddc07caSPaolo Bonzini     /* i/o timing parameters */
14604ddc07caSPaolo Bonzini     bs_dest->slice_start        = bs_src->slice_start;
14614ddc07caSPaolo Bonzini     bs_dest->slice_end          = bs_src->slice_end;
14625905fbc9SStefan Hajnoczi     bs_dest->slice_submitted    = bs_src->slice_submitted;
14634ddc07caSPaolo Bonzini     bs_dest->io_limits          = bs_src->io_limits;
14644ddc07caSPaolo Bonzini     bs_dest->throttled_reqs     = bs_src->throttled_reqs;
14654ddc07caSPaolo Bonzini     bs_dest->block_timer        = bs_src->block_timer;
14664ddc07caSPaolo Bonzini     bs_dest->io_limits_enabled  = bs_src->io_limits_enabled;
14674ddc07caSPaolo Bonzini 
14684ddc07caSPaolo Bonzini     /* r/w error */
14694ddc07caSPaolo Bonzini     bs_dest->on_read_error      = bs_src->on_read_error;
14704ddc07caSPaolo Bonzini     bs_dest->on_write_error     = bs_src->on_write_error;
14714ddc07caSPaolo Bonzini 
14724ddc07caSPaolo Bonzini     /* i/o status */
14734ddc07caSPaolo Bonzini     bs_dest->iostatus_enabled   = bs_src->iostatus_enabled;
14744ddc07caSPaolo Bonzini     bs_dest->iostatus           = bs_src->iostatus;
14754ddc07caSPaolo Bonzini 
14764ddc07caSPaolo Bonzini     /* dirty bitmap */
14774ddc07caSPaolo Bonzini     bs_dest->dirty_bitmap       = bs_src->dirty_bitmap;
14784ddc07caSPaolo Bonzini 
14794ddc07caSPaolo Bonzini     /* job */
14804ddc07caSPaolo Bonzini     bs_dest->in_use             = bs_src->in_use;
14814ddc07caSPaolo Bonzini     bs_dest->job                = bs_src->job;
14824ddc07caSPaolo Bonzini 
14834ddc07caSPaolo Bonzini     /* keep the same entry in bdrv_states */
14844ddc07caSPaolo Bonzini     pstrcpy(bs_dest->device_name, sizeof(bs_dest->device_name),
14854ddc07caSPaolo Bonzini             bs_src->device_name);
14864ddc07caSPaolo Bonzini     bs_dest->list = bs_src->list;
14874ddc07caSPaolo Bonzini }
14884ddc07caSPaolo Bonzini 
14894ddc07caSPaolo Bonzini /*
14904ddc07caSPaolo Bonzini  * Swap bs contents for two image chains while they are live,
14914ddc07caSPaolo Bonzini  * while keeping required fields on the BlockDriverState that is
14924ddc07caSPaolo Bonzini  * actually attached to a device.
14934ddc07caSPaolo Bonzini  *
14944ddc07caSPaolo Bonzini  * This will modify the BlockDriverState fields, and swap contents
14954ddc07caSPaolo Bonzini  * between bs_new and bs_old. Both bs_new and bs_old are modified.
14964ddc07caSPaolo Bonzini  *
14974ddc07caSPaolo Bonzini  * bs_new is required to be anonymous.
14984ddc07caSPaolo Bonzini  *
14994ddc07caSPaolo Bonzini  * This function does not create any image files.
15004ddc07caSPaolo Bonzini  */
15014ddc07caSPaolo Bonzini void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old)
15024ddc07caSPaolo Bonzini {
15034ddc07caSPaolo Bonzini     BlockDriverState tmp;
15044ddc07caSPaolo Bonzini 
15054ddc07caSPaolo Bonzini     /* bs_new must be anonymous and shouldn't have anything fancy enabled */
15064ddc07caSPaolo Bonzini     assert(bs_new->device_name[0] == '\0');
15074ddc07caSPaolo Bonzini     assert(bs_new->dirty_bitmap == NULL);
15084ddc07caSPaolo Bonzini     assert(bs_new->job == NULL);
15094ddc07caSPaolo Bonzini     assert(bs_new->dev == NULL);
15104ddc07caSPaolo Bonzini     assert(bs_new->in_use == 0);
15114ddc07caSPaolo Bonzini     assert(bs_new->io_limits_enabled == false);
15124ddc07caSPaolo Bonzini     assert(bs_new->block_timer == NULL);
15134ddc07caSPaolo Bonzini 
15144ddc07caSPaolo Bonzini     tmp = *bs_new;
15154ddc07caSPaolo Bonzini     *bs_new = *bs_old;
15164ddc07caSPaolo Bonzini     *bs_old = tmp;
15174ddc07caSPaolo Bonzini 
15184ddc07caSPaolo Bonzini     /* there are some fields that should not be swapped, move them back */
15194ddc07caSPaolo Bonzini     bdrv_move_feature_fields(&tmp, bs_old);
15204ddc07caSPaolo Bonzini     bdrv_move_feature_fields(bs_old, bs_new);
15214ddc07caSPaolo Bonzini     bdrv_move_feature_fields(bs_new, &tmp);
15224ddc07caSPaolo Bonzini 
15234ddc07caSPaolo Bonzini     /* bs_new shouldn't be in bdrv_states even after the swap!  */
15244ddc07caSPaolo Bonzini     assert(bs_new->device_name[0] == '\0');
15254ddc07caSPaolo Bonzini 
15264ddc07caSPaolo Bonzini     /* Check a few fields that should remain attached to the device */
15274ddc07caSPaolo Bonzini     assert(bs_new->dev == NULL);
15284ddc07caSPaolo Bonzini     assert(bs_new->job == NULL);
15294ddc07caSPaolo Bonzini     assert(bs_new->in_use == 0);
15304ddc07caSPaolo Bonzini     assert(bs_new->io_limits_enabled == false);
15314ddc07caSPaolo Bonzini     assert(bs_new->block_timer == NULL);
15324ddc07caSPaolo Bonzini 
15334ddc07caSPaolo Bonzini     bdrv_rebind(bs_new);
15344ddc07caSPaolo Bonzini     bdrv_rebind(bs_old);
15354ddc07caSPaolo Bonzini }
15364ddc07caSPaolo Bonzini 
15378802d1fdSJeff Cody /*
15388802d1fdSJeff Cody  * Add new bs contents at the top of an image chain while the chain is
15398802d1fdSJeff Cody  * live, while keeping required fields on the top layer.
15408802d1fdSJeff Cody  *
15418802d1fdSJeff Cody  * This will modify the BlockDriverState fields, and swap contents
15428802d1fdSJeff Cody  * between bs_new and bs_top. Both bs_new and bs_top are modified.
15438802d1fdSJeff Cody  *
1544f6801b83SJeff Cody  * bs_new is required to be anonymous.
1545f6801b83SJeff Cody  *
15468802d1fdSJeff Cody  * This function does not create any image files.
15478802d1fdSJeff Cody  */
15488802d1fdSJeff Cody void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top)
15498802d1fdSJeff Cody {
15504ddc07caSPaolo Bonzini     bdrv_swap(bs_new, bs_top);
15518802d1fdSJeff Cody 
15528802d1fdSJeff Cody     /* The contents of 'tmp' will become bs_top, as we are
15538802d1fdSJeff Cody      * swapping bs_new and bs_top contents. */
15544ddc07caSPaolo Bonzini     bs_top->backing_hd = bs_new;
15554ddc07caSPaolo Bonzini     bs_top->open_flags &= ~BDRV_O_NO_BACKING;
15564ddc07caSPaolo Bonzini     pstrcpy(bs_top->backing_file, sizeof(bs_top->backing_file),
15574ddc07caSPaolo Bonzini             bs_new->filename);
15584ddc07caSPaolo Bonzini     pstrcpy(bs_top->backing_format, sizeof(bs_top->backing_format),
15594ddc07caSPaolo Bonzini             bs_new->drv ? bs_new->drv->format_name : "");
15608802d1fdSJeff Cody }
15618802d1fdSJeff Cody 
1562b338082bSbellard void bdrv_delete(BlockDriverState *bs)
1563b338082bSbellard {
1564fa879d62SMarkus Armbruster     assert(!bs->dev);
15653e914655SPaolo Bonzini     assert(!bs->job);
15663e914655SPaolo Bonzini     assert(!bs->in_use);
156718846deeSMarkus Armbruster 
15681b7bdbc1SStefan Hajnoczi     /* remove from list, if necessary */
1569d22b2f41SRyan Harper     bdrv_make_anon(bs);
157034c6f050Saurel32 
1571b338082bSbellard     bdrv_close(bs);
157266f82ceeSKevin Wolf 
1573f9092b10SMarkus Armbruster     assert(bs != bs_snapshots);
15747267c094SAnthony Liguori     g_free(bs);
1575fc01f7e7Sbellard }
1576fc01f7e7Sbellard 
1577fa879d62SMarkus Armbruster int bdrv_attach_dev(BlockDriverState *bs, void *dev)
1578fa879d62SMarkus Armbruster /* TODO change to DeviceState *dev when all users are qdevified */
157918846deeSMarkus Armbruster {
1580fa879d62SMarkus Armbruster     if (bs->dev) {
158118846deeSMarkus Armbruster         return -EBUSY;
158218846deeSMarkus Armbruster     }
1583fa879d62SMarkus Armbruster     bs->dev = dev;
158428a7282aSLuiz Capitulino     bdrv_iostatus_reset(bs);
158518846deeSMarkus Armbruster     return 0;
158618846deeSMarkus Armbruster }
158718846deeSMarkus Armbruster 
1588fa879d62SMarkus Armbruster /* TODO qdevified devices don't use this, remove when devices are qdevified */
1589fa879d62SMarkus Armbruster void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev)
159018846deeSMarkus Armbruster {
1591fa879d62SMarkus Armbruster     if (bdrv_attach_dev(bs, dev) < 0) {
1592fa879d62SMarkus Armbruster         abort();
1593fa879d62SMarkus Armbruster     }
1594fa879d62SMarkus Armbruster }
1595fa879d62SMarkus Armbruster 
1596fa879d62SMarkus Armbruster void bdrv_detach_dev(BlockDriverState *bs, void *dev)
1597fa879d62SMarkus Armbruster /* TODO change to DeviceState *dev when all users are qdevified */
1598fa879d62SMarkus Armbruster {
1599fa879d62SMarkus Armbruster     assert(bs->dev == dev);
1600fa879d62SMarkus Armbruster     bs->dev = NULL;
16010e49de52SMarkus Armbruster     bs->dev_ops = NULL;
16020e49de52SMarkus Armbruster     bs->dev_opaque = NULL;
160329e05f20SMarkus Armbruster     bs->buffer_alignment = 512;
160418846deeSMarkus Armbruster }
160518846deeSMarkus Armbruster 
1606fa879d62SMarkus Armbruster /* TODO change to return DeviceState * when all users are qdevified */
1607fa879d62SMarkus Armbruster void *bdrv_get_attached_dev(BlockDriverState *bs)
160818846deeSMarkus Armbruster {
1609fa879d62SMarkus Armbruster     return bs->dev;
161018846deeSMarkus Armbruster }
161118846deeSMarkus Armbruster 
16120e49de52SMarkus Armbruster void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
16130e49de52SMarkus Armbruster                       void *opaque)
16140e49de52SMarkus Armbruster {
16150e49de52SMarkus Armbruster     bs->dev_ops = ops;
16160e49de52SMarkus Armbruster     bs->dev_opaque = opaque;
16172c6942faSMarkus Armbruster     if (bdrv_dev_has_removable_media(bs) && bs == bs_snapshots) {
16182c6942faSMarkus Armbruster         bs_snapshots = NULL;
16192c6942faSMarkus Armbruster     }
16200e49de52SMarkus Armbruster }
16210e49de52SMarkus Armbruster 
162232c81a4aSPaolo Bonzini void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
162332c81a4aSPaolo Bonzini                                enum MonitorEvent ev,
16241ceee0d5SPaolo Bonzini                                BlockErrorAction action, bool is_read)
1625329c0a48SLuiz Capitulino {
1626329c0a48SLuiz Capitulino     QObject *data;
1627329c0a48SLuiz Capitulino     const char *action_str;
1628329c0a48SLuiz Capitulino 
1629329c0a48SLuiz Capitulino     switch (action) {
1630329c0a48SLuiz Capitulino     case BDRV_ACTION_REPORT:
1631329c0a48SLuiz Capitulino         action_str = "report";
1632329c0a48SLuiz Capitulino         break;
1633329c0a48SLuiz Capitulino     case BDRV_ACTION_IGNORE:
1634329c0a48SLuiz Capitulino         action_str = "ignore";
1635329c0a48SLuiz Capitulino         break;
1636329c0a48SLuiz Capitulino     case BDRV_ACTION_STOP:
1637329c0a48SLuiz Capitulino         action_str = "stop";
1638329c0a48SLuiz Capitulino         break;
1639329c0a48SLuiz Capitulino     default:
1640329c0a48SLuiz Capitulino         abort();
1641329c0a48SLuiz Capitulino     }
1642329c0a48SLuiz Capitulino 
1643329c0a48SLuiz Capitulino     data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
1644329c0a48SLuiz Capitulino                               bdrv->device_name,
1645329c0a48SLuiz Capitulino                               action_str,
1646329c0a48SLuiz Capitulino                               is_read ? "read" : "write");
164732c81a4aSPaolo Bonzini     monitor_protocol_event(ev, data);
1648329c0a48SLuiz Capitulino 
1649329c0a48SLuiz Capitulino     qobject_decref(data);
1650329c0a48SLuiz Capitulino }
1651329c0a48SLuiz Capitulino 
16526f382ed2SLuiz Capitulino static void bdrv_emit_qmp_eject_event(BlockDriverState *bs, bool ejected)
16536f382ed2SLuiz Capitulino {
16546f382ed2SLuiz Capitulino     QObject *data;
16556f382ed2SLuiz Capitulino 
16566f382ed2SLuiz Capitulino     data = qobject_from_jsonf("{ 'device': %s, 'tray-open': %i }",
16576f382ed2SLuiz Capitulino                               bdrv_get_device_name(bs), ejected);
16586f382ed2SLuiz Capitulino     monitor_protocol_event(QEVENT_DEVICE_TRAY_MOVED, data);
16596f382ed2SLuiz Capitulino 
16606f382ed2SLuiz Capitulino     qobject_decref(data);
16616f382ed2SLuiz Capitulino }
16626f382ed2SLuiz Capitulino 
16637d4b4ba5SMarkus Armbruster static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load)
16640e49de52SMarkus Armbruster {
1665145feb17SMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->change_media_cb) {
16666f382ed2SLuiz Capitulino         bool tray_was_closed = !bdrv_dev_is_tray_open(bs);
16677d4b4ba5SMarkus Armbruster         bs->dev_ops->change_media_cb(bs->dev_opaque, load);
16686f382ed2SLuiz Capitulino         if (tray_was_closed) {
16696f382ed2SLuiz Capitulino             /* tray open */
16706f382ed2SLuiz Capitulino             bdrv_emit_qmp_eject_event(bs, true);
16716f382ed2SLuiz Capitulino         }
16726f382ed2SLuiz Capitulino         if (load) {
16736f382ed2SLuiz Capitulino             /* tray close */
16746f382ed2SLuiz Capitulino             bdrv_emit_qmp_eject_event(bs, false);
16756f382ed2SLuiz Capitulino         }
1676145feb17SMarkus Armbruster     }
1677145feb17SMarkus Armbruster }
1678145feb17SMarkus Armbruster 
16792c6942faSMarkus Armbruster bool bdrv_dev_has_removable_media(BlockDriverState *bs)
16802c6942faSMarkus Armbruster {
16812c6942faSMarkus Armbruster     return !bs->dev || (bs->dev_ops && bs->dev_ops->change_media_cb);
16822c6942faSMarkus Armbruster }
16832c6942faSMarkus Armbruster 
1684025ccaa7SPaolo Bonzini void bdrv_dev_eject_request(BlockDriverState *bs, bool force)
1685025ccaa7SPaolo Bonzini {
1686025ccaa7SPaolo Bonzini     if (bs->dev_ops && bs->dev_ops->eject_request_cb) {
1687025ccaa7SPaolo Bonzini         bs->dev_ops->eject_request_cb(bs->dev_opaque, force);
1688025ccaa7SPaolo Bonzini     }
1689025ccaa7SPaolo Bonzini }
1690025ccaa7SPaolo Bonzini 
1691e4def80bSMarkus Armbruster bool bdrv_dev_is_tray_open(BlockDriverState *bs)
1692e4def80bSMarkus Armbruster {
1693e4def80bSMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->is_tray_open) {
1694e4def80bSMarkus Armbruster         return bs->dev_ops->is_tray_open(bs->dev_opaque);
1695e4def80bSMarkus Armbruster     }
1696e4def80bSMarkus Armbruster     return false;
1697e4def80bSMarkus Armbruster }
1698e4def80bSMarkus Armbruster 
1699145feb17SMarkus Armbruster static void bdrv_dev_resize_cb(BlockDriverState *bs)
1700145feb17SMarkus Armbruster {
1701145feb17SMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->resize_cb) {
1702145feb17SMarkus Armbruster         bs->dev_ops->resize_cb(bs->dev_opaque);
17030e49de52SMarkus Armbruster     }
17040e49de52SMarkus Armbruster }
17050e49de52SMarkus Armbruster 
1706f107639aSMarkus Armbruster bool bdrv_dev_is_medium_locked(BlockDriverState *bs)
1707f107639aSMarkus Armbruster {
1708f107639aSMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->is_medium_locked) {
1709f107639aSMarkus Armbruster         return bs->dev_ops->is_medium_locked(bs->dev_opaque);
1710f107639aSMarkus Armbruster     }
1711f107639aSMarkus Armbruster     return false;
1712f107639aSMarkus Armbruster }
1713f107639aSMarkus Armbruster 
1714e97fc193Saliguori /*
1715e97fc193Saliguori  * Run consistency checks on an image
1716e97fc193Saliguori  *
1717e076f338SKevin Wolf  * Returns 0 if the check could be completed (it doesn't mean that the image is
1718a1c7273bSStefan Weil  * free of errors) or -errno when an internal error occurred. The results of the
1719e076f338SKevin Wolf  * check are stored in res.
1720e97fc193Saliguori  */
17214534ff54SKevin Wolf int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix)
1722e97fc193Saliguori {
1723e97fc193Saliguori     if (bs->drv->bdrv_check == NULL) {
1724e97fc193Saliguori         return -ENOTSUP;
1725e97fc193Saliguori     }
1726e97fc193Saliguori 
1727e076f338SKevin Wolf     memset(res, 0, sizeof(*res));
17284534ff54SKevin Wolf     return bs->drv->bdrv_check(bs, res, fix);
1729e97fc193Saliguori }
1730e97fc193Saliguori 
17318a426614SKevin Wolf #define COMMIT_BUF_SECTORS 2048
17328a426614SKevin Wolf 
173333e3963eSbellard /* commit COW file into the raw image */
173433e3963eSbellard int bdrv_commit(BlockDriverState *bs)
173533e3963eSbellard {
173619cb3738Sbellard     BlockDriver *drv = bs->drv;
17378a426614SKevin Wolf     int64_t sector, total_sectors;
17388a426614SKevin Wolf     int n, ro, open_flags;
17390bce597dSJeff Cody     int ret = 0;
17408a426614SKevin Wolf     uint8_t *buf;
1741c2cba3d9SJim Meyering     char filename[PATH_MAX];
174233e3963eSbellard 
174319cb3738Sbellard     if (!drv)
174419cb3738Sbellard         return -ENOMEDIUM;
174533e3963eSbellard 
17464dca4b63SNaphtali Sprei     if (!bs->backing_hd) {
17474dca4b63SNaphtali Sprei         return -ENOTSUP;
17484dca4b63SNaphtali Sprei     }
17494dca4b63SNaphtali Sprei 
17502d3735d3SStefan Hajnoczi     if (bdrv_in_use(bs) || bdrv_in_use(bs->backing_hd)) {
17512d3735d3SStefan Hajnoczi         return -EBUSY;
17522d3735d3SStefan Hajnoczi     }
17532d3735d3SStefan Hajnoczi 
17544dca4b63SNaphtali Sprei     ro = bs->backing_hd->read_only;
1755c2cba3d9SJim Meyering     /* Use pstrcpy (not strncpy): filename must be NUL-terminated. */
1756c2cba3d9SJim Meyering     pstrcpy(filename, sizeof(filename), bs->backing_hd->filename);
17574dca4b63SNaphtali Sprei     open_flags =  bs->backing_hd->open_flags;
17584dca4b63SNaphtali Sprei 
17594dca4b63SNaphtali Sprei     if (ro) {
17600bce597dSJeff Cody         if (bdrv_reopen(bs->backing_hd, open_flags | BDRV_O_RDWR, NULL)) {
17610bce597dSJeff Cody             return -EACCES;
17624dca4b63SNaphtali Sprei         }
1763ea2384d3Sbellard     }
1764ea2384d3Sbellard 
17656ea44308SJan Kiszka     total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
17667267c094SAnthony Liguori     buf = g_malloc(COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE);
17678a426614SKevin Wolf 
17688a426614SKevin Wolf     for (sector = 0; sector < total_sectors; sector += n) {
176905c4af54SStefan Hajnoczi         if (bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n)) {
17708a426614SKevin Wolf 
17718a426614SKevin Wolf             if (bdrv_read(bs, sector, buf, n) != 0) {
17724dca4b63SNaphtali Sprei                 ret = -EIO;
17734dca4b63SNaphtali Sprei                 goto ro_cleanup;
177433e3963eSbellard             }
177533e3963eSbellard 
17768a426614SKevin Wolf             if (bdrv_write(bs->backing_hd, sector, buf, n) != 0) {
17774dca4b63SNaphtali Sprei                 ret = -EIO;
17784dca4b63SNaphtali Sprei                 goto ro_cleanup;
177933e3963eSbellard             }
178033e3963eSbellard         }
178133e3963eSbellard     }
178295389c86Sbellard 
17831d44952fSChristoph Hellwig     if (drv->bdrv_make_empty) {
17841d44952fSChristoph Hellwig         ret = drv->bdrv_make_empty(bs);
17851d44952fSChristoph Hellwig         bdrv_flush(bs);
17861d44952fSChristoph Hellwig     }
178795389c86Sbellard 
17883f5075aeSChristoph Hellwig     /*
17893f5075aeSChristoph Hellwig      * Make sure all data we wrote to the backing device is actually
17903f5075aeSChristoph Hellwig      * stable on disk.
17913f5075aeSChristoph Hellwig      */
17923f5075aeSChristoph Hellwig     if (bs->backing_hd)
17933f5075aeSChristoph Hellwig         bdrv_flush(bs->backing_hd);
17944dca4b63SNaphtali Sprei 
17954dca4b63SNaphtali Sprei ro_cleanup:
17967267c094SAnthony Liguori     g_free(buf);
17974dca4b63SNaphtali Sprei 
17984dca4b63SNaphtali Sprei     if (ro) {
17990bce597dSJeff Cody         /* ignoring error return here */
18000bce597dSJeff Cody         bdrv_reopen(bs->backing_hd, open_flags & ~BDRV_O_RDWR, NULL);
18014dca4b63SNaphtali Sprei     }
18024dca4b63SNaphtali Sprei 
18031d44952fSChristoph Hellwig     return ret;
180433e3963eSbellard }
180533e3963eSbellard 
1806e8877497SStefan Hajnoczi int bdrv_commit_all(void)
18076ab4b5abSMarkus Armbruster {
18086ab4b5abSMarkus Armbruster     BlockDriverState *bs;
18096ab4b5abSMarkus Armbruster 
18106ab4b5abSMarkus Armbruster     QTAILQ_FOREACH(bs, &bdrv_states, list) {
1811272d2d8eSJeff Cody         if (bs->drv && bs->backing_hd) {
1812e8877497SStefan Hajnoczi             int ret = bdrv_commit(bs);
1813e8877497SStefan Hajnoczi             if (ret < 0) {
1814e8877497SStefan Hajnoczi                 return ret;
18156ab4b5abSMarkus Armbruster             }
18166ab4b5abSMarkus Armbruster         }
1817272d2d8eSJeff Cody     }
1818e8877497SStefan Hajnoczi     return 0;
1819e8877497SStefan Hajnoczi }
18206ab4b5abSMarkus Armbruster 
1821dbffbdcfSStefan Hajnoczi struct BdrvTrackedRequest {
1822dbffbdcfSStefan Hajnoczi     BlockDriverState *bs;
1823dbffbdcfSStefan Hajnoczi     int64_t sector_num;
1824dbffbdcfSStefan Hajnoczi     int nb_sectors;
1825dbffbdcfSStefan Hajnoczi     bool is_write;
1826dbffbdcfSStefan Hajnoczi     QLIST_ENTRY(BdrvTrackedRequest) list;
18275f8b6491SStefan Hajnoczi     Coroutine *co; /* owner, used for deadlock detection */
1828f4658285SStefan Hajnoczi     CoQueue wait_queue; /* coroutines blocked on this request */
1829dbffbdcfSStefan Hajnoczi };
1830dbffbdcfSStefan Hajnoczi 
1831dbffbdcfSStefan Hajnoczi /**
1832dbffbdcfSStefan Hajnoczi  * Remove an active request from the tracked requests list
1833dbffbdcfSStefan Hajnoczi  *
1834dbffbdcfSStefan Hajnoczi  * This function should be called when a tracked request is completing.
1835dbffbdcfSStefan Hajnoczi  */
1836dbffbdcfSStefan Hajnoczi static void tracked_request_end(BdrvTrackedRequest *req)
1837dbffbdcfSStefan Hajnoczi {
1838dbffbdcfSStefan Hajnoczi     QLIST_REMOVE(req, list);
1839f4658285SStefan Hajnoczi     qemu_co_queue_restart_all(&req->wait_queue);
1840dbffbdcfSStefan Hajnoczi }
1841dbffbdcfSStefan Hajnoczi 
1842dbffbdcfSStefan Hajnoczi /**
1843dbffbdcfSStefan Hajnoczi  * Add an active request to the tracked requests list
1844dbffbdcfSStefan Hajnoczi  */
1845dbffbdcfSStefan Hajnoczi static void tracked_request_begin(BdrvTrackedRequest *req,
1846dbffbdcfSStefan Hajnoczi                                   BlockDriverState *bs,
1847dbffbdcfSStefan Hajnoczi                                   int64_t sector_num,
1848dbffbdcfSStefan Hajnoczi                                   int nb_sectors, bool is_write)
1849dbffbdcfSStefan Hajnoczi {
1850dbffbdcfSStefan Hajnoczi     *req = (BdrvTrackedRequest){
1851dbffbdcfSStefan Hajnoczi         .bs = bs,
1852dbffbdcfSStefan Hajnoczi         .sector_num = sector_num,
1853dbffbdcfSStefan Hajnoczi         .nb_sectors = nb_sectors,
1854dbffbdcfSStefan Hajnoczi         .is_write = is_write,
18555f8b6491SStefan Hajnoczi         .co = qemu_coroutine_self(),
1856dbffbdcfSStefan Hajnoczi     };
1857dbffbdcfSStefan Hajnoczi 
1858f4658285SStefan Hajnoczi     qemu_co_queue_init(&req->wait_queue);
1859f4658285SStefan Hajnoczi 
1860dbffbdcfSStefan Hajnoczi     QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
1861dbffbdcfSStefan Hajnoczi }
1862dbffbdcfSStefan Hajnoczi 
1863d83947acSStefan Hajnoczi /**
1864d83947acSStefan Hajnoczi  * Round a region to cluster boundaries
1865d83947acSStefan Hajnoczi  */
1866343bded4SPaolo Bonzini void bdrv_round_to_clusters(BlockDriverState *bs,
1867d83947acSStefan Hajnoczi                             int64_t sector_num, int nb_sectors,
1868d83947acSStefan Hajnoczi                             int64_t *cluster_sector_num,
1869d83947acSStefan Hajnoczi                             int *cluster_nb_sectors)
1870d83947acSStefan Hajnoczi {
1871d83947acSStefan Hajnoczi     BlockDriverInfo bdi;
1872d83947acSStefan Hajnoczi 
1873d83947acSStefan Hajnoczi     if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
1874d83947acSStefan Hajnoczi         *cluster_sector_num = sector_num;
1875d83947acSStefan Hajnoczi         *cluster_nb_sectors = nb_sectors;
1876d83947acSStefan Hajnoczi     } else {
1877d83947acSStefan Hajnoczi         int64_t c = bdi.cluster_size / BDRV_SECTOR_SIZE;
1878d83947acSStefan Hajnoczi         *cluster_sector_num = QEMU_ALIGN_DOWN(sector_num, c);
1879d83947acSStefan Hajnoczi         *cluster_nb_sectors = QEMU_ALIGN_UP(sector_num - *cluster_sector_num +
1880d83947acSStefan Hajnoczi                                             nb_sectors, c);
1881d83947acSStefan Hajnoczi     }
1882d83947acSStefan Hajnoczi }
1883d83947acSStefan Hajnoczi 
1884f4658285SStefan Hajnoczi static bool tracked_request_overlaps(BdrvTrackedRequest *req,
1885f4658285SStefan Hajnoczi                                      int64_t sector_num, int nb_sectors) {
1886d83947acSStefan Hajnoczi     /*        aaaa   bbbb */
1887d83947acSStefan Hajnoczi     if (sector_num >= req->sector_num + req->nb_sectors) {
1888d83947acSStefan Hajnoczi         return false;
1889d83947acSStefan Hajnoczi     }
1890d83947acSStefan Hajnoczi     /* bbbb   aaaa        */
1891d83947acSStefan Hajnoczi     if (req->sector_num >= sector_num + nb_sectors) {
1892d83947acSStefan Hajnoczi         return false;
1893d83947acSStefan Hajnoczi     }
1894d83947acSStefan Hajnoczi     return true;
1895f4658285SStefan Hajnoczi }
1896f4658285SStefan Hajnoczi 
1897f4658285SStefan Hajnoczi static void coroutine_fn wait_for_overlapping_requests(BlockDriverState *bs,
1898f4658285SStefan Hajnoczi         int64_t sector_num, int nb_sectors)
1899f4658285SStefan Hajnoczi {
1900f4658285SStefan Hajnoczi     BdrvTrackedRequest *req;
1901d83947acSStefan Hajnoczi     int64_t cluster_sector_num;
1902d83947acSStefan Hajnoczi     int cluster_nb_sectors;
1903f4658285SStefan Hajnoczi     bool retry;
1904f4658285SStefan Hajnoczi 
1905d83947acSStefan Hajnoczi     /* If we touch the same cluster it counts as an overlap.  This guarantees
1906d83947acSStefan Hajnoczi      * that allocating writes will be serialized and not race with each other
1907d83947acSStefan Hajnoczi      * for the same cluster.  For example, in copy-on-read it ensures that the
1908d83947acSStefan Hajnoczi      * CoR read and write operations are atomic and guest writes cannot
1909d83947acSStefan Hajnoczi      * interleave between them.
1910d83947acSStefan Hajnoczi      */
1911343bded4SPaolo Bonzini     bdrv_round_to_clusters(bs, sector_num, nb_sectors,
1912d83947acSStefan Hajnoczi                            &cluster_sector_num, &cluster_nb_sectors);
1913d83947acSStefan Hajnoczi 
1914f4658285SStefan Hajnoczi     do {
1915f4658285SStefan Hajnoczi         retry = false;
1916f4658285SStefan Hajnoczi         QLIST_FOREACH(req, &bs->tracked_requests, list) {
1917d83947acSStefan Hajnoczi             if (tracked_request_overlaps(req, cluster_sector_num,
1918d83947acSStefan Hajnoczi                                          cluster_nb_sectors)) {
19195f8b6491SStefan Hajnoczi                 /* Hitting this means there was a reentrant request, for
19205f8b6491SStefan Hajnoczi                  * example, a block driver issuing nested requests.  This must
19215f8b6491SStefan Hajnoczi                  * never happen since it means deadlock.
19225f8b6491SStefan Hajnoczi                  */
19235f8b6491SStefan Hajnoczi                 assert(qemu_coroutine_self() != req->co);
19245f8b6491SStefan Hajnoczi 
1925f4658285SStefan Hajnoczi                 qemu_co_queue_wait(&req->wait_queue);
1926f4658285SStefan Hajnoczi                 retry = true;
1927f4658285SStefan Hajnoczi                 break;
1928f4658285SStefan Hajnoczi             }
1929f4658285SStefan Hajnoczi         }
1930f4658285SStefan Hajnoczi     } while (retry);
1931f4658285SStefan Hajnoczi }
1932f4658285SStefan Hajnoczi 
1933756e6736SKevin Wolf /*
1934756e6736SKevin Wolf  * Return values:
1935756e6736SKevin Wolf  * 0        - success
1936756e6736SKevin Wolf  * -EINVAL  - backing format specified, but no file
1937756e6736SKevin Wolf  * -ENOSPC  - can't update the backing file because no space is left in the
1938756e6736SKevin Wolf  *            image file header
1939756e6736SKevin Wolf  * -ENOTSUP - format driver doesn't support changing the backing file
1940756e6736SKevin Wolf  */
1941756e6736SKevin Wolf int bdrv_change_backing_file(BlockDriverState *bs,
1942756e6736SKevin Wolf     const char *backing_file, const char *backing_fmt)
1943756e6736SKevin Wolf {
1944756e6736SKevin Wolf     BlockDriver *drv = bs->drv;
1945469ef350SPaolo Bonzini     int ret;
1946756e6736SKevin Wolf 
19475f377794SPaolo Bonzini     /* Backing file format doesn't make sense without a backing file */
19485f377794SPaolo Bonzini     if (backing_fmt && !backing_file) {
19495f377794SPaolo Bonzini         return -EINVAL;
19505f377794SPaolo Bonzini     }
19515f377794SPaolo Bonzini 
1952756e6736SKevin Wolf     if (drv->bdrv_change_backing_file != NULL) {
1953469ef350SPaolo Bonzini         ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
1954756e6736SKevin Wolf     } else {
1955469ef350SPaolo Bonzini         ret = -ENOTSUP;
1956756e6736SKevin Wolf     }
1957469ef350SPaolo Bonzini 
1958469ef350SPaolo Bonzini     if (ret == 0) {
1959469ef350SPaolo Bonzini         pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1960469ef350SPaolo Bonzini         pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1961469ef350SPaolo Bonzini     }
1962469ef350SPaolo Bonzini     return ret;
1963756e6736SKevin Wolf }
1964756e6736SKevin Wolf 
19656ebdcee2SJeff Cody /*
19666ebdcee2SJeff Cody  * Finds the image layer in the chain that has 'bs' as its backing file.
19676ebdcee2SJeff Cody  *
19686ebdcee2SJeff Cody  * active is the current topmost image.
19696ebdcee2SJeff Cody  *
19706ebdcee2SJeff Cody  * Returns NULL if bs is not found in active's image chain,
19716ebdcee2SJeff Cody  * or if active == bs.
19726ebdcee2SJeff Cody  */
19736ebdcee2SJeff Cody BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
19746ebdcee2SJeff Cody                                     BlockDriverState *bs)
19756ebdcee2SJeff Cody {
19766ebdcee2SJeff Cody     BlockDriverState *overlay = NULL;
19776ebdcee2SJeff Cody     BlockDriverState *intermediate;
19786ebdcee2SJeff Cody 
19796ebdcee2SJeff Cody     assert(active != NULL);
19806ebdcee2SJeff Cody     assert(bs != NULL);
19816ebdcee2SJeff Cody 
19826ebdcee2SJeff Cody     /* if bs is the same as active, then by definition it has no overlay
19836ebdcee2SJeff Cody      */
19846ebdcee2SJeff Cody     if (active == bs) {
19856ebdcee2SJeff Cody         return NULL;
19866ebdcee2SJeff Cody     }
19876ebdcee2SJeff Cody 
19886ebdcee2SJeff Cody     intermediate = active;
19896ebdcee2SJeff Cody     while (intermediate->backing_hd) {
19906ebdcee2SJeff Cody         if (intermediate->backing_hd == bs) {
19916ebdcee2SJeff Cody             overlay = intermediate;
19926ebdcee2SJeff Cody             break;
19936ebdcee2SJeff Cody         }
19946ebdcee2SJeff Cody         intermediate = intermediate->backing_hd;
19956ebdcee2SJeff Cody     }
19966ebdcee2SJeff Cody 
19976ebdcee2SJeff Cody     return overlay;
19986ebdcee2SJeff Cody }
19996ebdcee2SJeff Cody 
20006ebdcee2SJeff Cody typedef struct BlkIntermediateStates {
20016ebdcee2SJeff Cody     BlockDriverState *bs;
20026ebdcee2SJeff Cody     QSIMPLEQ_ENTRY(BlkIntermediateStates) entry;
20036ebdcee2SJeff Cody } BlkIntermediateStates;
20046ebdcee2SJeff Cody 
20056ebdcee2SJeff Cody 
20066ebdcee2SJeff Cody /*
20076ebdcee2SJeff Cody  * Drops images above 'base' up to and including 'top', and sets the image
20086ebdcee2SJeff Cody  * above 'top' to have base as its backing file.
20096ebdcee2SJeff Cody  *
20106ebdcee2SJeff Cody  * Requires that the overlay to 'top' is opened r/w, so that the backing file
20116ebdcee2SJeff Cody  * information in 'bs' can be properly updated.
20126ebdcee2SJeff Cody  *
20136ebdcee2SJeff Cody  * E.g., this will convert the following chain:
20146ebdcee2SJeff Cody  * bottom <- base <- intermediate <- top <- active
20156ebdcee2SJeff Cody  *
20166ebdcee2SJeff Cody  * to
20176ebdcee2SJeff Cody  *
20186ebdcee2SJeff Cody  * bottom <- base <- active
20196ebdcee2SJeff Cody  *
20206ebdcee2SJeff Cody  * It is allowed for bottom==base, in which case it converts:
20216ebdcee2SJeff Cody  *
20226ebdcee2SJeff Cody  * base <- intermediate <- top <- active
20236ebdcee2SJeff Cody  *
20246ebdcee2SJeff Cody  * to
20256ebdcee2SJeff Cody  *
20266ebdcee2SJeff Cody  * base <- active
20276ebdcee2SJeff Cody  *
20286ebdcee2SJeff Cody  * Error conditions:
20296ebdcee2SJeff Cody  *  if active == top, that is considered an error
20306ebdcee2SJeff Cody  *
20316ebdcee2SJeff Cody  */
20326ebdcee2SJeff Cody int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
20336ebdcee2SJeff Cody                            BlockDriverState *base)
20346ebdcee2SJeff Cody {
20356ebdcee2SJeff Cody     BlockDriverState *intermediate;
20366ebdcee2SJeff Cody     BlockDriverState *base_bs = NULL;
20376ebdcee2SJeff Cody     BlockDriverState *new_top_bs = NULL;
20386ebdcee2SJeff Cody     BlkIntermediateStates *intermediate_state, *next;
20396ebdcee2SJeff Cody     int ret = -EIO;
20406ebdcee2SJeff Cody 
20416ebdcee2SJeff Cody     QSIMPLEQ_HEAD(states_to_delete, BlkIntermediateStates) states_to_delete;
20426ebdcee2SJeff Cody     QSIMPLEQ_INIT(&states_to_delete);
20436ebdcee2SJeff Cody 
20446ebdcee2SJeff Cody     if (!top->drv || !base->drv) {
20456ebdcee2SJeff Cody         goto exit;
20466ebdcee2SJeff Cody     }
20476ebdcee2SJeff Cody 
20486ebdcee2SJeff Cody     new_top_bs = bdrv_find_overlay(active, top);
20496ebdcee2SJeff Cody 
20506ebdcee2SJeff Cody     if (new_top_bs == NULL) {
20516ebdcee2SJeff Cody         /* we could not find the image above 'top', this is an error */
20526ebdcee2SJeff Cody         goto exit;
20536ebdcee2SJeff Cody     }
20546ebdcee2SJeff Cody 
20556ebdcee2SJeff Cody     /* special case of new_top_bs->backing_hd already pointing to base - nothing
20566ebdcee2SJeff Cody      * to do, no intermediate images */
20576ebdcee2SJeff Cody     if (new_top_bs->backing_hd == base) {
20586ebdcee2SJeff Cody         ret = 0;
20596ebdcee2SJeff Cody         goto exit;
20606ebdcee2SJeff Cody     }
20616ebdcee2SJeff Cody 
20626ebdcee2SJeff Cody     intermediate = top;
20636ebdcee2SJeff Cody 
20646ebdcee2SJeff Cody     /* now we will go down through the list, and add each BDS we find
20656ebdcee2SJeff Cody      * into our deletion queue, until we hit the 'base'
20666ebdcee2SJeff Cody      */
20676ebdcee2SJeff Cody     while (intermediate) {
20686ebdcee2SJeff Cody         intermediate_state = g_malloc0(sizeof(BlkIntermediateStates));
20696ebdcee2SJeff Cody         intermediate_state->bs = intermediate;
20706ebdcee2SJeff Cody         QSIMPLEQ_INSERT_TAIL(&states_to_delete, intermediate_state, entry);
20716ebdcee2SJeff Cody 
20726ebdcee2SJeff Cody         if (intermediate->backing_hd == base) {
20736ebdcee2SJeff Cody             base_bs = intermediate->backing_hd;
20746ebdcee2SJeff Cody             break;
20756ebdcee2SJeff Cody         }
20766ebdcee2SJeff Cody         intermediate = intermediate->backing_hd;
20776ebdcee2SJeff Cody     }
20786ebdcee2SJeff Cody     if (base_bs == NULL) {
20796ebdcee2SJeff Cody         /* something went wrong, we did not end at the base. safely
20806ebdcee2SJeff Cody          * unravel everything, and exit with error */
20816ebdcee2SJeff Cody         goto exit;
20826ebdcee2SJeff Cody     }
20836ebdcee2SJeff Cody 
20846ebdcee2SJeff Cody     /* success - we can delete the intermediate states, and link top->base */
20856ebdcee2SJeff Cody     ret = bdrv_change_backing_file(new_top_bs, base_bs->filename,
20866ebdcee2SJeff Cody                                    base_bs->drv ? base_bs->drv->format_name : "");
20876ebdcee2SJeff Cody     if (ret) {
20886ebdcee2SJeff Cody         goto exit;
20896ebdcee2SJeff Cody     }
20906ebdcee2SJeff Cody     new_top_bs->backing_hd = base_bs;
20916ebdcee2SJeff Cody 
20926ebdcee2SJeff Cody 
20936ebdcee2SJeff Cody     QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) {
20946ebdcee2SJeff Cody         /* so that bdrv_close() does not recursively close the chain */
20956ebdcee2SJeff Cody         intermediate_state->bs->backing_hd = NULL;
20966ebdcee2SJeff Cody         bdrv_delete(intermediate_state->bs);
20976ebdcee2SJeff Cody     }
20986ebdcee2SJeff Cody     ret = 0;
20996ebdcee2SJeff Cody 
21006ebdcee2SJeff Cody exit:
21016ebdcee2SJeff Cody     QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) {
21026ebdcee2SJeff Cody         g_free(intermediate_state);
21036ebdcee2SJeff Cody     }
21046ebdcee2SJeff Cody     return ret;
21056ebdcee2SJeff Cody }
21066ebdcee2SJeff Cody 
21076ebdcee2SJeff Cody 
210871d0770cSaliguori static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
210971d0770cSaliguori                                    size_t size)
211071d0770cSaliguori {
211171d0770cSaliguori     int64_t len;
211271d0770cSaliguori 
211371d0770cSaliguori     if (!bdrv_is_inserted(bs))
211471d0770cSaliguori         return -ENOMEDIUM;
211571d0770cSaliguori 
211671d0770cSaliguori     if (bs->growable)
211771d0770cSaliguori         return 0;
211871d0770cSaliguori 
211971d0770cSaliguori     len = bdrv_getlength(bs);
212071d0770cSaliguori 
2121fbb7b4e0SKevin Wolf     if (offset < 0)
2122fbb7b4e0SKevin Wolf         return -EIO;
2123fbb7b4e0SKevin Wolf 
2124fbb7b4e0SKevin Wolf     if ((offset > len) || (len - offset < size))
212571d0770cSaliguori         return -EIO;
212671d0770cSaliguori 
212771d0770cSaliguori     return 0;
212871d0770cSaliguori }
212971d0770cSaliguori 
213071d0770cSaliguori static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
213171d0770cSaliguori                               int nb_sectors)
213271d0770cSaliguori {
2133eb5a3165SJes Sorensen     return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
2134eb5a3165SJes Sorensen                                    nb_sectors * BDRV_SECTOR_SIZE);
213571d0770cSaliguori }
213671d0770cSaliguori 
21371c9805a3SStefan Hajnoczi typedef struct RwCo {
21381c9805a3SStefan Hajnoczi     BlockDriverState *bs;
21391c9805a3SStefan Hajnoczi     int64_t sector_num;
21401c9805a3SStefan Hajnoczi     int nb_sectors;
21411c9805a3SStefan Hajnoczi     QEMUIOVector *qiov;
21421c9805a3SStefan Hajnoczi     bool is_write;
21431c9805a3SStefan Hajnoczi     int ret;
21441c9805a3SStefan Hajnoczi } RwCo;
21451c9805a3SStefan Hajnoczi 
21461c9805a3SStefan Hajnoczi static void coroutine_fn bdrv_rw_co_entry(void *opaque)
2147fc01f7e7Sbellard {
21481c9805a3SStefan Hajnoczi     RwCo *rwco = opaque;
2149fc01f7e7Sbellard 
21501c9805a3SStefan Hajnoczi     if (!rwco->is_write) {
21511c9805a3SStefan Hajnoczi         rwco->ret = bdrv_co_do_readv(rwco->bs, rwco->sector_num,
2152470c0504SStefan Hajnoczi                                      rwco->nb_sectors, rwco->qiov, 0);
21531c9805a3SStefan Hajnoczi     } else {
21541c9805a3SStefan Hajnoczi         rwco->ret = bdrv_co_do_writev(rwco->bs, rwco->sector_num,
2155f08f2ddaSStefan Hajnoczi                                       rwco->nb_sectors, rwco->qiov, 0);
21561c9805a3SStefan Hajnoczi     }
21571c9805a3SStefan Hajnoczi }
2158e7a8a783SKevin Wolf 
21591c9805a3SStefan Hajnoczi /*
21608d3b1a2dSKevin Wolf  * Process a vectored synchronous request using coroutines
21611c9805a3SStefan Hajnoczi  */
21628d3b1a2dSKevin Wolf static int bdrv_rwv_co(BlockDriverState *bs, int64_t sector_num,
21638d3b1a2dSKevin Wolf                        QEMUIOVector *qiov, bool is_write)
21641c9805a3SStefan Hajnoczi {
21651c9805a3SStefan Hajnoczi     Coroutine *co;
21661c9805a3SStefan Hajnoczi     RwCo rwco = {
21671c9805a3SStefan Hajnoczi         .bs = bs,
21681c9805a3SStefan Hajnoczi         .sector_num = sector_num,
21698d3b1a2dSKevin Wolf         .nb_sectors = qiov->size >> BDRV_SECTOR_BITS,
21708d3b1a2dSKevin Wolf         .qiov = qiov,
21711c9805a3SStefan Hajnoczi         .is_write = is_write,
21721c9805a3SStefan Hajnoczi         .ret = NOT_DONE,
21731c9805a3SStefan Hajnoczi     };
21748d3b1a2dSKevin Wolf     assert((qiov->size & (BDRV_SECTOR_SIZE - 1)) == 0);
21751c9805a3SStefan Hajnoczi 
2176498e386cSZhi Yong Wu     /**
2177498e386cSZhi Yong Wu      * In sync call context, when the vcpu is blocked, this throttling timer
2178498e386cSZhi Yong Wu      * will not fire; so the I/O throttling function has to be disabled here
2179498e386cSZhi Yong Wu      * if it has been enabled.
2180498e386cSZhi Yong Wu      */
2181498e386cSZhi Yong Wu     if (bs->io_limits_enabled) {
2182498e386cSZhi Yong Wu         fprintf(stderr, "Disabling I/O throttling on '%s' due "
2183498e386cSZhi Yong Wu                         "to synchronous I/O.\n", bdrv_get_device_name(bs));
2184498e386cSZhi Yong Wu         bdrv_io_limits_disable(bs);
2185498e386cSZhi Yong Wu     }
2186498e386cSZhi Yong Wu 
21871c9805a3SStefan Hajnoczi     if (qemu_in_coroutine()) {
21881c9805a3SStefan Hajnoczi         /* Fast-path if already in coroutine context */
21891c9805a3SStefan Hajnoczi         bdrv_rw_co_entry(&rwco);
21901c9805a3SStefan Hajnoczi     } else {
21911c9805a3SStefan Hajnoczi         co = qemu_coroutine_create(bdrv_rw_co_entry);
21921c9805a3SStefan Hajnoczi         qemu_coroutine_enter(co, &rwco);
21931c9805a3SStefan Hajnoczi         while (rwco.ret == NOT_DONE) {
21941c9805a3SStefan Hajnoczi             qemu_aio_wait();
21951c9805a3SStefan Hajnoczi         }
21961c9805a3SStefan Hajnoczi     }
21971c9805a3SStefan Hajnoczi     return rwco.ret;
2198e7a8a783SKevin Wolf }
2199e7a8a783SKevin Wolf 
22008d3b1a2dSKevin Wolf /*
22018d3b1a2dSKevin Wolf  * Process a synchronous request using coroutines
22028d3b1a2dSKevin Wolf  */
22038d3b1a2dSKevin Wolf static int bdrv_rw_co(BlockDriverState *bs, int64_t sector_num, uint8_t *buf,
22048d3b1a2dSKevin Wolf                       int nb_sectors, bool is_write)
22058d3b1a2dSKevin Wolf {
22068d3b1a2dSKevin Wolf     QEMUIOVector qiov;
22078d3b1a2dSKevin Wolf     struct iovec iov = {
22088d3b1a2dSKevin Wolf         .iov_base = (void *)buf,
22098d3b1a2dSKevin Wolf         .iov_len = nb_sectors * BDRV_SECTOR_SIZE,
22108d3b1a2dSKevin Wolf     };
22118d3b1a2dSKevin Wolf 
22128d3b1a2dSKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
22138d3b1a2dSKevin Wolf     return bdrv_rwv_co(bs, sector_num, &qiov, is_write);
22148d3b1a2dSKevin Wolf }
22158d3b1a2dSKevin Wolf 
22161c9805a3SStefan Hajnoczi /* return < 0 if error. See bdrv_write() for the return codes */
22171c9805a3SStefan Hajnoczi int bdrv_read(BlockDriverState *bs, int64_t sector_num,
22181c9805a3SStefan Hajnoczi               uint8_t *buf, int nb_sectors)
22191c9805a3SStefan Hajnoczi {
22201c9805a3SStefan Hajnoczi     return bdrv_rw_co(bs, sector_num, buf, nb_sectors, false);
222183f64091Sbellard }
2222fc01f7e7Sbellard 
222307d27a44SMarkus Armbruster /* Just like bdrv_read(), but with I/O throttling temporarily disabled */
222407d27a44SMarkus Armbruster int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
222507d27a44SMarkus Armbruster                           uint8_t *buf, int nb_sectors)
222607d27a44SMarkus Armbruster {
222707d27a44SMarkus Armbruster     bool enabled;
222807d27a44SMarkus Armbruster     int ret;
222907d27a44SMarkus Armbruster 
223007d27a44SMarkus Armbruster     enabled = bs->io_limits_enabled;
223107d27a44SMarkus Armbruster     bs->io_limits_enabled = false;
223207d27a44SMarkus Armbruster     ret = bdrv_read(bs, 0, buf, 1);
223307d27a44SMarkus Armbruster     bs->io_limits_enabled = enabled;
223407d27a44SMarkus Armbruster     return ret;
223507d27a44SMarkus Armbruster }
223607d27a44SMarkus Armbruster 
223719cb3738Sbellard /* Return < 0 if error. Important errors are:
223819cb3738Sbellard   -EIO         generic I/O error (may happen for all errors)
223919cb3738Sbellard   -ENOMEDIUM   No media inserted.
224019cb3738Sbellard   -EINVAL      Invalid sector number or nb_sectors
224119cb3738Sbellard   -EACCES      Trying to write a read-only device
224219cb3738Sbellard */
2243fc01f7e7Sbellard int bdrv_write(BlockDriverState *bs, int64_t sector_num,
2244fc01f7e7Sbellard                const uint8_t *buf, int nb_sectors)
2245fc01f7e7Sbellard {
22461c9805a3SStefan Hajnoczi     return bdrv_rw_co(bs, sector_num, (uint8_t *)buf, nb_sectors, true);
224783f64091Sbellard }
224883f64091Sbellard 
22498d3b1a2dSKevin Wolf int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov)
22508d3b1a2dSKevin Wolf {
22518d3b1a2dSKevin Wolf     return bdrv_rwv_co(bs, sector_num, qiov, true);
22528d3b1a2dSKevin Wolf }
22538d3b1a2dSKevin Wolf 
2254eda578e5Saliguori int bdrv_pread(BlockDriverState *bs, int64_t offset,
2255eda578e5Saliguori                void *buf, int count1)
225683f64091Sbellard {
22576ea44308SJan Kiszka     uint8_t tmp_buf[BDRV_SECTOR_SIZE];
225883f64091Sbellard     int len, nb_sectors, count;
225983f64091Sbellard     int64_t sector_num;
22609a8c4cceSKevin Wolf     int ret;
226183f64091Sbellard 
226283f64091Sbellard     count = count1;
226383f64091Sbellard     /* first read to align to sector start */
22646ea44308SJan Kiszka     len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
226583f64091Sbellard     if (len > count)
226683f64091Sbellard         len = count;
22676ea44308SJan Kiszka     sector_num = offset >> BDRV_SECTOR_BITS;
226883f64091Sbellard     if (len > 0) {
22699a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
22709a8c4cceSKevin Wolf             return ret;
22716ea44308SJan Kiszka         memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
227283f64091Sbellard         count -= len;
227383f64091Sbellard         if (count == 0)
227483f64091Sbellard             return count1;
227583f64091Sbellard         sector_num++;
227683f64091Sbellard         buf += len;
227783f64091Sbellard     }
227883f64091Sbellard 
227983f64091Sbellard     /* read the sectors "in place" */
22806ea44308SJan Kiszka     nb_sectors = count >> BDRV_SECTOR_BITS;
228183f64091Sbellard     if (nb_sectors > 0) {
22829a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
22839a8c4cceSKevin Wolf             return ret;
228483f64091Sbellard         sector_num += nb_sectors;
22856ea44308SJan Kiszka         len = nb_sectors << BDRV_SECTOR_BITS;
228683f64091Sbellard         buf += len;
228783f64091Sbellard         count -= len;
228883f64091Sbellard     }
228983f64091Sbellard 
229083f64091Sbellard     /* add data from the last sector */
229183f64091Sbellard     if (count > 0) {
22929a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
22939a8c4cceSKevin Wolf             return ret;
229483f64091Sbellard         memcpy(buf, tmp_buf, count);
229583f64091Sbellard     }
229683f64091Sbellard     return count1;
229783f64091Sbellard }
229883f64091Sbellard 
22998d3b1a2dSKevin Wolf int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov)
230083f64091Sbellard {
23016ea44308SJan Kiszka     uint8_t tmp_buf[BDRV_SECTOR_SIZE];
230283f64091Sbellard     int len, nb_sectors, count;
230383f64091Sbellard     int64_t sector_num;
23049a8c4cceSKevin Wolf     int ret;
230583f64091Sbellard 
23068d3b1a2dSKevin Wolf     count = qiov->size;
23078d3b1a2dSKevin Wolf 
230883f64091Sbellard     /* first write to align to sector start */
23096ea44308SJan Kiszka     len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
231083f64091Sbellard     if (len > count)
231183f64091Sbellard         len = count;
23126ea44308SJan Kiszka     sector_num = offset >> BDRV_SECTOR_BITS;
231383f64091Sbellard     if (len > 0) {
23149a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
23159a8c4cceSKevin Wolf             return ret;
23168d3b1a2dSKevin Wolf         qemu_iovec_to_buf(qiov, 0, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)),
23178d3b1a2dSKevin Wolf                           len);
23189a8c4cceSKevin Wolf         if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
23199a8c4cceSKevin Wolf             return ret;
232083f64091Sbellard         count -= len;
232183f64091Sbellard         if (count == 0)
23228d3b1a2dSKevin Wolf             return qiov->size;
232383f64091Sbellard         sector_num++;
232483f64091Sbellard     }
232583f64091Sbellard 
232683f64091Sbellard     /* write the sectors "in place" */
23276ea44308SJan Kiszka     nb_sectors = count >> BDRV_SECTOR_BITS;
232883f64091Sbellard     if (nb_sectors > 0) {
23298d3b1a2dSKevin Wolf         QEMUIOVector qiov_inplace;
23308d3b1a2dSKevin Wolf 
23318d3b1a2dSKevin Wolf         qemu_iovec_init(&qiov_inplace, qiov->niov);
23328d3b1a2dSKevin Wolf         qemu_iovec_concat(&qiov_inplace, qiov, len,
23338d3b1a2dSKevin Wolf                           nb_sectors << BDRV_SECTOR_BITS);
23348d3b1a2dSKevin Wolf         ret = bdrv_writev(bs, sector_num, &qiov_inplace);
23358d3b1a2dSKevin Wolf         qemu_iovec_destroy(&qiov_inplace);
23368d3b1a2dSKevin Wolf         if (ret < 0) {
23379a8c4cceSKevin Wolf             return ret;
23388d3b1a2dSKevin Wolf         }
23398d3b1a2dSKevin Wolf 
234083f64091Sbellard         sector_num += nb_sectors;
23416ea44308SJan Kiszka         len = nb_sectors << BDRV_SECTOR_BITS;
234283f64091Sbellard         count -= len;
234383f64091Sbellard     }
234483f64091Sbellard 
234583f64091Sbellard     /* add data from the last sector */
234683f64091Sbellard     if (count > 0) {
23479a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
23489a8c4cceSKevin Wolf             return ret;
23498d3b1a2dSKevin Wolf         qemu_iovec_to_buf(qiov, qiov->size - count, tmp_buf, count);
23509a8c4cceSKevin Wolf         if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
23519a8c4cceSKevin Wolf             return ret;
235283f64091Sbellard     }
23538d3b1a2dSKevin Wolf     return qiov->size;
23548d3b1a2dSKevin Wolf }
23558d3b1a2dSKevin Wolf 
23568d3b1a2dSKevin Wolf int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
23578d3b1a2dSKevin Wolf                 const void *buf, int count1)
23588d3b1a2dSKevin Wolf {
23598d3b1a2dSKevin Wolf     QEMUIOVector qiov;
23608d3b1a2dSKevin Wolf     struct iovec iov = {
23618d3b1a2dSKevin Wolf         .iov_base   = (void *) buf,
23628d3b1a2dSKevin Wolf         .iov_len    = count1,
23638d3b1a2dSKevin Wolf     };
23648d3b1a2dSKevin Wolf 
23658d3b1a2dSKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
23668d3b1a2dSKevin Wolf     return bdrv_pwritev(bs, offset, &qiov);
236783f64091Sbellard }
236883f64091Sbellard 
2369f08145feSKevin Wolf /*
2370f08145feSKevin Wolf  * Writes to the file and ensures that no writes are reordered across this
2371f08145feSKevin Wolf  * request (acts as a barrier)
2372f08145feSKevin Wolf  *
2373f08145feSKevin Wolf  * Returns 0 on success, -errno in error cases.
2374f08145feSKevin Wolf  */
2375f08145feSKevin Wolf int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
2376f08145feSKevin Wolf     const void *buf, int count)
2377f08145feSKevin Wolf {
2378f08145feSKevin Wolf     int ret;
2379f08145feSKevin Wolf 
2380f08145feSKevin Wolf     ret = bdrv_pwrite(bs, offset, buf, count);
2381f08145feSKevin Wolf     if (ret < 0) {
2382f08145feSKevin Wolf         return ret;
2383f08145feSKevin Wolf     }
2384f08145feSKevin Wolf 
2385f05fa4adSPaolo Bonzini     /* No flush needed for cache modes that already do it */
2386f05fa4adSPaolo Bonzini     if (bs->enable_write_cache) {
2387f08145feSKevin Wolf         bdrv_flush(bs);
2388f08145feSKevin Wolf     }
2389f08145feSKevin Wolf 
2390f08145feSKevin Wolf     return 0;
2391f08145feSKevin Wolf }
2392f08145feSKevin Wolf 
2393470c0504SStefan Hajnoczi static int coroutine_fn bdrv_co_do_copy_on_readv(BlockDriverState *bs,
2394ab185921SStefan Hajnoczi         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
2395ab185921SStefan Hajnoczi {
2396ab185921SStefan Hajnoczi     /* Perform I/O through a temporary buffer so that users who scribble over
2397ab185921SStefan Hajnoczi      * their read buffer while the operation is in progress do not end up
2398ab185921SStefan Hajnoczi      * modifying the image file.  This is critical for zero-copy guest I/O
2399ab185921SStefan Hajnoczi      * where anything might happen inside guest memory.
2400ab185921SStefan Hajnoczi      */
2401ab185921SStefan Hajnoczi     void *bounce_buffer;
2402ab185921SStefan Hajnoczi 
240379c053bdSStefan Hajnoczi     BlockDriver *drv = bs->drv;
2404ab185921SStefan Hajnoczi     struct iovec iov;
2405ab185921SStefan Hajnoczi     QEMUIOVector bounce_qiov;
2406ab185921SStefan Hajnoczi     int64_t cluster_sector_num;
2407ab185921SStefan Hajnoczi     int cluster_nb_sectors;
2408ab185921SStefan Hajnoczi     size_t skip_bytes;
2409ab185921SStefan Hajnoczi     int ret;
2410ab185921SStefan Hajnoczi 
2411ab185921SStefan Hajnoczi     /* Cover entire cluster so no additional backing file I/O is required when
2412ab185921SStefan Hajnoczi      * allocating cluster in the image file.
2413ab185921SStefan Hajnoczi      */
2414343bded4SPaolo Bonzini     bdrv_round_to_clusters(bs, sector_num, nb_sectors,
2415ab185921SStefan Hajnoczi                            &cluster_sector_num, &cluster_nb_sectors);
2416ab185921SStefan Hajnoczi 
2417470c0504SStefan Hajnoczi     trace_bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors,
2418ab185921SStefan Hajnoczi                                    cluster_sector_num, cluster_nb_sectors);
2419ab185921SStefan Hajnoczi 
2420ab185921SStefan Hajnoczi     iov.iov_len = cluster_nb_sectors * BDRV_SECTOR_SIZE;
2421ab185921SStefan Hajnoczi     iov.iov_base = bounce_buffer = qemu_blockalign(bs, iov.iov_len);
2422ab185921SStefan Hajnoczi     qemu_iovec_init_external(&bounce_qiov, &iov, 1);
2423ab185921SStefan Hajnoczi 
242479c053bdSStefan Hajnoczi     ret = drv->bdrv_co_readv(bs, cluster_sector_num, cluster_nb_sectors,
2425ab185921SStefan Hajnoczi                              &bounce_qiov);
2426ab185921SStefan Hajnoczi     if (ret < 0) {
2427ab185921SStefan Hajnoczi         goto err;
2428ab185921SStefan Hajnoczi     }
2429ab185921SStefan Hajnoczi 
243079c053bdSStefan Hajnoczi     if (drv->bdrv_co_write_zeroes &&
243179c053bdSStefan Hajnoczi         buffer_is_zero(bounce_buffer, iov.iov_len)) {
2432621f0589SKevin Wolf         ret = bdrv_co_do_write_zeroes(bs, cluster_sector_num,
243379c053bdSStefan Hajnoczi                                       cluster_nb_sectors);
243479c053bdSStefan Hajnoczi     } else {
2435f05fa4adSPaolo Bonzini         /* This does not change the data on the disk, it is not necessary
2436f05fa4adSPaolo Bonzini          * to flush even in cache=writethrough mode.
2437f05fa4adSPaolo Bonzini          */
243879c053bdSStefan Hajnoczi         ret = drv->bdrv_co_writev(bs, cluster_sector_num, cluster_nb_sectors,
2439ab185921SStefan Hajnoczi                                   &bounce_qiov);
244079c053bdSStefan Hajnoczi     }
244179c053bdSStefan Hajnoczi 
2442ab185921SStefan Hajnoczi     if (ret < 0) {
2443ab185921SStefan Hajnoczi         /* It might be okay to ignore write errors for guest requests.  If this
2444ab185921SStefan Hajnoczi          * is a deliberate copy-on-read then we don't want to ignore the error.
2445ab185921SStefan Hajnoczi          * Simply report it in all cases.
2446ab185921SStefan Hajnoczi          */
2447ab185921SStefan Hajnoczi         goto err;
2448ab185921SStefan Hajnoczi     }
2449ab185921SStefan Hajnoczi 
2450ab185921SStefan Hajnoczi     skip_bytes = (sector_num - cluster_sector_num) * BDRV_SECTOR_SIZE;
245103396148SMichael Tokarev     qemu_iovec_from_buf(qiov, 0, bounce_buffer + skip_bytes,
2452ab185921SStefan Hajnoczi                         nb_sectors * BDRV_SECTOR_SIZE);
2453ab185921SStefan Hajnoczi 
2454ab185921SStefan Hajnoczi err:
2455ab185921SStefan Hajnoczi     qemu_vfree(bounce_buffer);
2456ab185921SStefan Hajnoczi     return ret;
2457ab185921SStefan Hajnoczi }
2458ab185921SStefan Hajnoczi 
2459c5fbe571SStefan Hajnoczi /*
2460c5fbe571SStefan Hajnoczi  * Handle a read request in coroutine context
2461c5fbe571SStefan Hajnoczi  */
2462c5fbe571SStefan Hajnoczi static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
2463470c0504SStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
2464470c0504SStefan Hajnoczi     BdrvRequestFlags flags)
2465da1fa91dSKevin Wolf {
2466da1fa91dSKevin Wolf     BlockDriver *drv = bs->drv;
2467dbffbdcfSStefan Hajnoczi     BdrvTrackedRequest req;
2468dbffbdcfSStefan Hajnoczi     int ret;
2469da1fa91dSKevin Wolf 
2470da1fa91dSKevin Wolf     if (!drv) {
2471da1fa91dSKevin Wolf         return -ENOMEDIUM;
2472da1fa91dSKevin Wolf     }
2473da1fa91dSKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors)) {
2474da1fa91dSKevin Wolf         return -EIO;
2475da1fa91dSKevin Wolf     }
2476da1fa91dSKevin Wolf 
247798f90dbaSZhi Yong Wu     /* throttling disk read I/O */
247898f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
247998f90dbaSZhi Yong Wu         bdrv_io_limits_intercept(bs, false, nb_sectors);
248098f90dbaSZhi Yong Wu     }
248198f90dbaSZhi Yong Wu 
2482f4658285SStefan Hajnoczi     if (bs->copy_on_read) {
2483470c0504SStefan Hajnoczi         flags |= BDRV_REQ_COPY_ON_READ;
2484470c0504SStefan Hajnoczi     }
2485470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2486470c0504SStefan Hajnoczi         bs->copy_on_read_in_flight++;
2487470c0504SStefan Hajnoczi     }
2488470c0504SStefan Hajnoczi 
2489470c0504SStefan Hajnoczi     if (bs->copy_on_read_in_flight) {
2490f4658285SStefan Hajnoczi         wait_for_overlapping_requests(bs, sector_num, nb_sectors);
2491f4658285SStefan Hajnoczi     }
2492f4658285SStefan Hajnoczi 
2493dbffbdcfSStefan Hajnoczi     tracked_request_begin(&req, bs, sector_num, nb_sectors, false);
2494ab185921SStefan Hajnoczi 
2495470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2496ab185921SStefan Hajnoczi         int pnum;
2497ab185921SStefan Hajnoczi 
2498ab185921SStefan Hajnoczi         ret = bdrv_co_is_allocated(bs, sector_num, nb_sectors, &pnum);
2499ab185921SStefan Hajnoczi         if (ret < 0) {
2500ab185921SStefan Hajnoczi             goto out;
2501ab185921SStefan Hajnoczi         }
2502ab185921SStefan Hajnoczi 
2503ab185921SStefan Hajnoczi         if (!ret || pnum != nb_sectors) {
2504470c0504SStefan Hajnoczi             ret = bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors, qiov);
2505ab185921SStefan Hajnoczi             goto out;
2506ab185921SStefan Hajnoczi         }
2507ab185921SStefan Hajnoczi     }
2508ab185921SStefan Hajnoczi 
2509dbffbdcfSStefan Hajnoczi     ret = drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
2510ab185921SStefan Hajnoczi 
2511ab185921SStefan Hajnoczi out:
2512dbffbdcfSStefan Hajnoczi     tracked_request_end(&req);
2513470c0504SStefan Hajnoczi 
2514470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2515470c0504SStefan Hajnoczi         bs->copy_on_read_in_flight--;
2516470c0504SStefan Hajnoczi     }
2517470c0504SStefan Hajnoczi 
2518dbffbdcfSStefan Hajnoczi     return ret;
2519da1fa91dSKevin Wolf }
2520da1fa91dSKevin Wolf 
2521c5fbe571SStefan Hajnoczi int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
2522da1fa91dSKevin Wolf     int nb_sectors, QEMUIOVector *qiov)
2523da1fa91dSKevin Wolf {
2524c5fbe571SStefan Hajnoczi     trace_bdrv_co_readv(bs, sector_num, nb_sectors);
2525da1fa91dSKevin Wolf 
2526470c0504SStefan Hajnoczi     return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov, 0);
2527470c0504SStefan Hajnoczi }
2528470c0504SStefan Hajnoczi 
2529470c0504SStefan Hajnoczi int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
2530470c0504SStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
2531470c0504SStefan Hajnoczi {
2532470c0504SStefan Hajnoczi     trace_bdrv_co_copy_on_readv(bs, sector_num, nb_sectors);
2533470c0504SStefan Hajnoczi 
2534470c0504SStefan Hajnoczi     return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov,
2535470c0504SStefan Hajnoczi                             BDRV_REQ_COPY_ON_READ);
2536c5fbe571SStefan Hajnoczi }
2537c5fbe571SStefan Hajnoczi 
2538f08f2ddaSStefan Hajnoczi static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs,
2539f08f2ddaSStefan Hajnoczi     int64_t sector_num, int nb_sectors)
2540f08f2ddaSStefan Hajnoczi {
2541f08f2ddaSStefan Hajnoczi     BlockDriver *drv = bs->drv;
2542f08f2ddaSStefan Hajnoczi     QEMUIOVector qiov;
2543f08f2ddaSStefan Hajnoczi     struct iovec iov;
2544f08f2ddaSStefan Hajnoczi     int ret;
2545f08f2ddaSStefan Hajnoczi 
2546621f0589SKevin Wolf     /* TODO Emulate only part of misaligned requests instead of letting block
2547621f0589SKevin Wolf      * drivers return -ENOTSUP and emulate everything */
2548621f0589SKevin Wolf 
2549f08f2ddaSStefan Hajnoczi     /* First try the efficient write zeroes operation */
2550f08f2ddaSStefan Hajnoczi     if (drv->bdrv_co_write_zeroes) {
2551621f0589SKevin Wolf         ret = drv->bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
2552621f0589SKevin Wolf         if (ret != -ENOTSUP) {
2553621f0589SKevin Wolf             return ret;
2554621f0589SKevin Wolf         }
2555f08f2ddaSStefan Hajnoczi     }
2556f08f2ddaSStefan Hajnoczi 
2557f08f2ddaSStefan Hajnoczi     /* Fall back to bounce buffer if write zeroes is unsupported */
2558f08f2ddaSStefan Hajnoczi     iov.iov_len  = nb_sectors * BDRV_SECTOR_SIZE;
2559f08f2ddaSStefan Hajnoczi     iov.iov_base = qemu_blockalign(bs, iov.iov_len);
2560f08f2ddaSStefan Hajnoczi     memset(iov.iov_base, 0, iov.iov_len);
2561f08f2ddaSStefan Hajnoczi     qemu_iovec_init_external(&qiov, &iov, 1);
2562f08f2ddaSStefan Hajnoczi 
2563f08f2ddaSStefan Hajnoczi     ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, &qiov);
2564f08f2ddaSStefan Hajnoczi 
2565f08f2ddaSStefan Hajnoczi     qemu_vfree(iov.iov_base);
2566f08f2ddaSStefan Hajnoczi     return ret;
2567f08f2ddaSStefan Hajnoczi }
2568f08f2ddaSStefan Hajnoczi 
2569c5fbe571SStefan Hajnoczi /*
2570c5fbe571SStefan Hajnoczi  * Handle a write request in coroutine context
2571c5fbe571SStefan Hajnoczi  */
2572c5fbe571SStefan Hajnoczi static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
2573f08f2ddaSStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
2574f08f2ddaSStefan Hajnoczi     BdrvRequestFlags flags)
2575c5fbe571SStefan Hajnoczi {
2576c5fbe571SStefan Hajnoczi     BlockDriver *drv = bs->drv;
2577dbffbdcfSStefan Hajnoczi     BdrvTrackedRequest req;
25786b7cb247SStefan Hajnoczi     int ret;
2579da1fa91dSKevin Wolf 
2580da1fa91dSKevin Wolf     if (!bs->drv) {
2581da1fa91dSKevin Wolf         return -ENOMEDIUM;
2582da1fa91dSKevin Wolf     }
2583da1fa91dSKevin Wolf     if (bs->read_only) {
2584da1fa91dSKevin Wolf         return -EACCES;
2585da1fa91dSKevin Wolf     }
2586da1fa91dSKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors)) {
2587da1fa91dSKevin Wolf         return -EIO;
2588da1fa91dSKevin Wolf     }
2589da1fa91dSKevin Wolf 
259098f90dbaSZhi Yong Wu     /* throttling disk write I/O */
259198f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
259298f90dbaSZhi Yong Wu         bdrv_io_limits_intercept(bs, true, nb_sectors);
259398f90dbaSZhi Yong Wu     }
259498f90dbaSZhi Yong Wu 
2595470c0504SStefan Hajnoczi     if (bs->copy_on_read_in_flight) {
2596f4658285SStefan Hajnoczi         wait_for_overlapping_requests(bs, sector_num, nb_sectors);
2597f4658285SStefan Hajnoczi     }
2598f4658285SStefan Hajnoczi 
2599dbffbdcfSStefan Hajnoczi     tracked_request_begin(&req, bs, sector_num, nb_sectors, true);
2600dbffbdcfSStefan Hajnoczi 
2601f08f2ddaSStefan Hajnoczi     if (flags & BDRV_REQ_ZERO_WRITE) {
2602f08f2ddaSStefan Hajnoczi         ret = bdrv_co_do_write_zeroes(bs, sector_num, nb_sectors);
2603f08f2ddaSStefan Hajnoczi     } else {
26046b7cb247SStefan Hajnoczi         ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
2605f08f2ddaSStefan Hajnoczi     }
26066b7cb247SStefan Hajnoczi 
2607f05fa4adSPaolo Bonzini     if (ret == 0 && !bs->enable_write_cache) {
2608f05fa4adSPaolo Bonzini         ret = bdrv_co_flush(bs);
2609f05fa4adSPaolo Bonzini     }
2610f05fa4adSPaolo Bonzini 
2611da1fa91dSKevin Wolf     if (bs->dirty_bitmap) {
26121755da16SPaolo Bonzini         bdrv_set_dirty(bs, sector_num, nb_sectors);
2613da1fa91dSKevin Wolf     }
2614da1fa91dSKevin Wolf 
2615da1fa91dSKevin Wolf     if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
2616da1fa91dSKevin Wolf         bs->wr_highest_sector = sector_num + nb_sectors - 1;
2617da1fa91dSKevin Wolf     }
2618da1fa91dSKevin Wolf 
2619dbffbdcfSStefan Hajnoczi     tracked_request_end(&req);
2620dbffbdcfSStefan Hajnoczi 
26216b7cb247SStefan Hajnoczi     return ret;
2622da1fa91dSKevin Wolf }
2623da1fa91dSKevin Wolf 
2624c5fbe571SStefan Hajnoczi int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
2625c5fbe571SStefan Hajnoczi     int nb_sectors, QEMUIOVector *qiov)
2626c5fbe571SStefan Hajnoczi {
2627c5fbe571SStefan Hajnoczi     trace_bdrv_co_writev(bs, sector_num, nb_sectors);
2628c5fbe571SStefan Hajnoczi 
2629f08f2ddaSStefan Hajnoczi     return bdrv_co_do_writev(bs, sector_num, nb_sectors, qiov, 0);
2630f08f2ddaSStefan Hajnoczi }
2631f08f2ddaSStefan Hajnoczi 
2632f08f2ddaSStefan Hajnoczi int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs,
2633f08f2ddaSStefan Hajnoczi                                       int64_t sector_num, int nb_sectors)
2634f08f2ddaSStefan Hajnoczi {
2635f08f2ddaSStefan Hajnoczi     trace_bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
2636f08f2ddaSStefan Hajnoczi 
2637f08f2ddaSStefan Hajnoczi     return bdrv_co_do_writev(bs, sector_num, nb_sectors, NULL,
2638f08f2ddaSStefan Hajnoczi                              BDRV_REQ_ZERO_WRITE);
2639c5fbe571SStefan Hajnoczi }
2640c5fbe571SStefan Hajnoczi 
264183f64091Sbellard /**
264283f64091Sbellard  * Truncate file to 'offset' bytes (needed only for file protocols)
264383f64091Sbellard  */
264483f64091Sbellard int bdrv_truncate(BlockDriverState *bs, int64_t offset)
264583f64091Sbellard {
264683f64091Sbellard     BlockDriver *drv = bs->drv;
264751762288SStefan Hajnoczi     int ret;
264883f64091Sbellard     if (!drv)
264919cb3738Sbellard         return -ENOMEDIUM;
265083f64091Sbellard     if (!drv->bdrv_truncate)
265183f64091Sbellard         return -ENOTSUP;
265259f2689dSNaphtali Sprei     if (bs->read_only)
265359f2689dSNaphtali Sprei         return -EACCES;
26548591675fSMarcelo Tosatti     if (bdrv_in_use(bs))
26558591675fSMarcelo Tosatti         return -EBUSY;
265651762288SStefan Hajnoczi     ret = drv->bdrv_truncate(bs, offset);
265751762288SStefan Hajnoczi     if (ret == 0) {
265851762288SStefan Hajnoczi         ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
2659145feb17SMarkus Armbruster         bdrv_dev_resize_cb(bs);
266051762288SStefan Hajnoczi     }
266151762288SStefan Hajnoczi     return ret;
266283f64091Sbellard }
266383f64091Sbellard 
266483f64091Sbellard /**
26654a1d5e1fSFam Zheng  * Length of a allocated file in bytes. Sparse files are counted by actual
26664a1d5e1fSFam Zheng  * allocated space. Return < 0 if error or unknown.
26674a1d5e1fSFam Zheng  */
26684a1d5e1fSFam Zheng int64_t bdrv_get_allocated_file_size(BlockDriverState *bs)
26694a1d5e1fSFam Zheng {
26704a1d5e1fSFam Zheng     BlockDriver *drv = bs->drv;
26714a1d5e1fSFam Zheng     if (!drv) {
26724a1d5e1fSFam Zheng         return -ENOMEDIUM;
26734a1d5e1fSFam Zheng     }
26744a1d5e1fSFam Zheng     if (drv->bdrv_get_allocated_file_size) {
26754a1d5e1fSFam Zheng         return drv->bdrv_get_allocated_file_size(bs);
26764a1d5e1fSFam Zheng     }
26774a1d5e1fSFam Zheng     if (bs->file) {
26784a1d5e1fSFam Zheng         return bdrv_get_allocated_file_size(bs->file);
26794a1d5e1fSFam Zheng     }
26804a1d5e1fSFam Zheng     return -ENOTSUP;
26814a1d5e1fSFam Zheng }
26824a1d5e1fSFam Zheng 
26834a1d5e1fSFam Zheng /**
268483f64091Sbellard  * Length of a file in bytes. Return < 0 if error or unknown.
268583f64091Sbellard  */
268683f64091Sbellard int64_t bdrv_getlength(BlockDriverState *bs)
268783f64091Sbellard {
268883f64091Sbellard     BlockDriver *drv = bs->drv;
268983f64091Sbellard     if (!drv)
269019cb3738Sbellard         return -ENOMEDIUM;
269151762288SStefan Hajnoczi 
26922c6942faSMarkus Armbruster     if (bs->growable || bdrv_dev_has_removable_media(bs)) {
269346a4e4e6SStefan Hajnoczi         if (drv->bdrv_getlength) {
269483f64091Sbellard             return drv->bdrv_getlength(bs);
2695fc01f7e7Sbellard         }
269646a4e4e6SStefan Hajnoczi     }
269746a4e4e6SStefan Hajnoczi     return bs->total_sectors * BDRV_SECTOR_SIZE;
269846a4e4e6SStefan Hajnoczi }
2699fc01f7e7Sbellard 
270019cb3738Sbellard /* return 0 as number of sectors if no device present or error */
270196b8f136Sths void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
2702fc01f7e7Sbellard {
270319cb3738Sbellard     int64_t length;
270419cb3738Sbellard     length = bdrv_getlength(bs);
270519cb3738Sbellard     if (length < 0)
270619cb3738Sbellard         length = 0;
270719cb3738Sbellard     else
27086ea44308SJan Kiszka         length = length >> BDRV_SECTOR_BITS;
270919cb3738Sbellard     *nb_sectors_ptr = length;
2710fc01f7e7Sbellard }
2711cf98951bSbellard 
27120563e191SZhi Yong Wu /* throttling disk io limits */
27130563e191SZhi Yong Wu void bdrv_set_io_limits(BlockDriverState *bs,
27140563e191SZhi Yong Wu                         BlockIOLimit *io_limits)
27150563e191SZhi Yong Wu {
27160563e191SZhi Yong Wu     bs->io_limits = *io_limits;
27170563e191SZhi Yong Wu     bs->io_limits_enabled = bdrv_io_limits_enabled(bs);
27180563e191SZhi Yong Wu }
27190563e191SZhi Yong Wu 
2720ff06f5f3SPaolo Bonzini void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
2721ff06f5f3SPaolo Bonzini                        BlockdevOnError on_write_error)
2722abd7f68dSMarkus Armbruster {
2723abd7f68dSMarkus Armbruster     bs->on_read_error = on_read_error;
2724abd7f68dSMarkus Armbruster     bs->on_write_error = on_write_error;
2725abd7f68dSMarkus Armbruster }
2726abd7f68dSMarkus Armbruster 
27271ceee0d5SPaolo Bonzini BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read)
2728abd7f68dSMarkus Armbruster {
2729abd7f68dSMarkus Armbruster     return is_read ? bs->on_read_error : bs->on_write_error;
2730abd7f68dSMarkus Armbruster }
2731abd7f68dSMarkus Armbruster 
27323e1caa5fSPaolo Bonzini BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error)
27333e1caa5fSPaolo Bonzini {
27343e1caa5fSPaolo Bonzini     BlockdevOnError on_err = is_read ? bs->on_read_error : bs->on_write_error;
27353e1caa5fSPaolo Bonzini 
27363e1caa5fSPaolo Bonzini     switch (on_err) {
27373e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_ENOSPC:
27383e1caa5fSPaolo Bonzini         return (error == ENOSPC) ? BDRV_ACTION_STOP : BDRV_ACTION_REPORT;
27393e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_STOP:
27403e1caa5fSPaolo Bonzini         return BDRV_ACTION_STOP;
27413e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_REPORT:
27423e1caa5fSPaolo Bonzini         return BDRV_ACTION_REPORT;
27433e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_IGNORE:
27443e1caa5fSPaolo Bonzini         return BDRV_ACTION_IGNORE;
27453e1caa5fSPaolo Bonzini     default:
27463e1caa5fSPaolo Bonzini         abort();
27473e1caa5fSPaolo Bonzini     }
27483e1caa5fSPaolo Bonzini }
27493e1caa5fSPaolo Bonzini 
27503e1caa5fSPaolo Bonzini /* This is done by device models because, while the block layer knows
27513e1caa5fSPaolo Bonzini  * about the error, it does not know whether an operation comes from
27523e1caa5fSPaolo Bonzini  * the device or the block layer (from a job, for example).
27533e1caa5fSPaolo Bonzini  */
27543e1caa5fSPaolo Bonzini void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
27553e1caa5fSPaolo Bonzini                        bool is_read, int error)
27563e1caa5fSPaolo Bonzini {
27573e1caa5fSPaolo Bonzini     assert(error >= 0);
275832c81a4aSPaolo Bonzini     bdrv_emit_qmp_error_event(bs, QEVENT_BLOCK_IO_ERROR, action, is_read);
27593e1caa5fSPaolo Bonzini     if (action == BDRV_ACTION_STOP) {
27603e1caa5fSPaolo Bonzini         vm_stop(RUN_STATE_IO_ERROR);
27613e1caa5fSPaolo Bonzini         bdrv_iostatus_set_err(bs, error);
27623e1caa5fSPaolo Bonzini     }
27633e1caa5fSPaolo Bonzini }
27643e1caa5fSPaolo Bonzini 
2765b338082bSbellard int bdrv_is_read_only(BlockDriverState *bs)
2766b338082bSbellard {
2767b338082bSbellard     return bs->read_only;
2768b338082bSbellard }
2769b338082bSbellard 
2770985a03b0Sths int bdrv_is_sg(BlockDriverState *bs)
2771985a03b0Sths {
2772985a03b0Sths     return bs->sg;
2773985a03b0Sths }
2774985a03b0Sths 
2775e900a7b7SChristoph Hellwig int bdrv_enable_write_cache(BlockDriverState *bs)
2776e900a7b7SChristoph Hellwig {
2777e900a7b7SChristoph Hellwig     return bs->enable_write_cache;
2778e900a7b7SChristoph Hellwig }
2779e900a7b7SChristoph Hellwig 
2780425b0148SPaolo Bonzini void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce)
2781425b0148SPaolo Bonzini {
2782425b0148SPaolo Bonzini     bs->enable_write_cache = wce;
278355b110f2SJeff Cody 
278455b110f2SJeff Cody     /* so a reopen() will preserve wce */
278555b110f2SJeff Cody     if (wce) {
278655b110f2SJeff Cody         bs->open_flags |= BDRV_O_CACHE_WB;
278755b110f2SJeff Cody     } else {
278855b110f2SJeff Cody         bs->open_flags &= ~BDRV_O_CACHE_WB;
278955b110f2SJeff Cody     }
2790425b0148SPaolo Bonzini }
2791425b0148SPaolo Bonzini 
2792ea2384d3Sbellard int bdrv_is_encrypted(BlockDriverState *bs)
2793ea2384d3Sbellard {
2794ea2384d3Sbellard     if (bs->backing_hd && bs->backing_hd->encrypted)
2795ea2384d3Sbellard         return 1;
2796ea2384d3Sbellard     return bs->encrypted;
2797ea2384d3Sbellard }
2798ea2384d3Sbellard 
2799c0f4ce77Saliguori int bdrv_key_required(BlockDriverState *bs)
2800c0f4ce77Saliguori {
2801c0f4ce77Saliguori     BlockDriverState *backing_hd = bs->backing_hd;
2802c0f4ce77Saliguori 
2803c0f4ce77Saliguori     if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
2804c0f4ce77Saliguori         return 1;
2805c0f4ce77Saliguori     return (bs->encrypted && !bs->valid_key);
2806c0f4ce77Saliguori }
2807c0f4ce77Saliguori 
2808ea2384d3Sbellard int bdrv_set_key(BlockDriverState *bs, const char *key)
2809ea2384d3Sbellard {
2810ea2384d3Sbellard     int ret;
2811ea2384d3Sbellard     if (bs->backing_hd && bs->backing_hd->encrypted) {
2812ea2384d3Sbellard         ret = bdrv_set_key(bs->backing_hd, key);
2813ea2384d3Sbellard         if (ret < 0)
2814ea2384d3Sbellard             return ret;
2815ea2384d3Sbellard         if (!bs->encrypted)
2816ea2384d3Sbellard             return 0;
2817ea2384d3Sbellard     }
2818fd04a2aeSShahar Havivi     if (!bs->encrypted) {
2819fd04a2aeSShahar Havivi         return -EINVAL;
2820fd04a2aeSShahar Havivi     } else if (!bs->drv || !bs->drv->bdrv_set_key) {
2821fd04a2aeSShahar Havivi         return -ENOMEDIUM;
2822fd04a2aeSShahar Havivi     }
2823c0f4ce77Saliguori     ret = bs->drv->bdrv_set_key(bs, key);
2824bb5fc20fSaliguori     if (ret < 0) {
2825bb5fc20fSaliguori         bs->valid_key = 0;
2826bb5fc20fSaliguori     } else if (!bs->valid_key) {
2827bb5fc20fSaliguori         bs->valid_key = 1;
2828bb5fc20fSaliguori         /* call the change callback now, we skipped it on open */
28297d4b4ba5SMarkus Armbruster         bdrv_dev_change_media_cb(bs, true);
2830bb5fc20fSaliguori     }
2831c0f4ce77Saliguori     return ret;
2832ea2384d3Sbellard }
2833ea2384d3Sbellard 
2834f8d6bba1SMarkus Armbruster const char *bdrv_get_format_name(BlockDriverState *bs)
2835ea2384d3Sbellard {
2836f8d6bba1SMarkus Armbruster     return bs->drv ? bs->drv->format_name : NULL;
2837ea2384d3Sbellard }
2838ea2384d3Sbellard 
2839ea2384d3Sbellard void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
2840ea2384d3Sbellard                          void *opaque)
2841ea2384d3Sbellard {
2842ea2384d3Sbellard     BlockDriver *drv;
2843ea2384d3Sbellard 
28448a22f02aSStefan Hajnoczi     QLIST_FOREACH(drv, &bdrv_drivers, list) {
2845ea2384d3Sbellard         it(opaque, drv->format_name);
2846ea2384d3Sbellard     }
2847ea2384d3Sbellard }
2848ea2384d3Sbellard 
2849b338082bSbellard BlockDriverState *bdrv_find(const char *name)
2850b338082bSbellard {
2851b338082bSbellard     BlockDriverState *bs;
2852b338082bSbellard 
28531b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
28541b7bdbc1SStefan Hajnoczi         if (!strcmp(name, bs->device_name)) {
2855b338082bSbellard             return bs;
2856b338082bSbellard         }
28571b7bdbc1SStefan Hajnoczi     }
2858b338082bSbellard     return NULL;
2859b338082bSbellard }
2860b338082bSbellard 
28612f399b0aSMarkus Armbruster BlockDriverState *bdrv_next(BlockDriverState *bs)
28622f399b0aSMarkus Armbruster {
28632f399b0aSMarkus Armbruster     if (!bs) {
28642f399b0aSMarkus Armbruster         return QTAILQ_FIRST(&bdrv_states);
28652f399b0aSMarkus Armbruster     }
28662f399b0aSMarkus Armbruster     return QTAILQ_NEXT(bs, list);
28672f399b0aSMarkus Armbruster }
28682f399b0aSMarkus Armbruster 
286951de9760Saliguori void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
287081d0912dSbellard {
287181d0912dSbellard     BlockDriverState *bs;
287281d0912dSbellard 
28731b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
287451de9760Saliguori         it(opaque, bs);
287581d0912dSbellard     }
287681d0912dSbellard }
287781d0912dSbellard 
2878ea2384d3Sbellard const char *bdrv_get_device_name(BlockDriverState *bs)
2879ea2384d3Sbellard {
2880ea2384d3Sbellard     return bs->device_name;
2881ea2384d3Sbellard }
2882ea2384d3Sbellard 
2883c8433287SMarkus Armbruster int bdrv_get_flags(BlockDriverState *bs)
2884c8433287SMarkus Armbruster {
2885c8433287SMarkus Armbruster     return bs->open_flags;
2886c8433287SMarkus Armbruster }
2887c8433287SMarkus Armbruster 
2888c6ca28d6Saliguori void bdrv_flush_all(void)
2889c6ca28d6Saliguori {
2890c6ca28d6Saliguori     BlockDriverState *bs;
2891c6ca28d6Saliguori 
28921b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
2893c6ca28d6Saliguori         bdrv_flush(bs);
2894c6ca28d6Saliguori     }
28951b7bdbc1SStefan Hajnoczi }
2896c6ca28d6Saliguori 
2897f2feebbdSKevin Wolf int bdrv_has_zero_init(BlockDriverState *bs)
2898f2feebbdSKevin Wolf {
2899f2feebbdSKevin Wolf     assert(bs->drv);
2900f2feebbdSKevin Wolf 
2901336c1c12SKevin Wolf     if (bs->drv->bdrv_has_zero_init) {
2902336c1c12SKevin Wolf         return bs->drv->bdrv_has_zero_init(bs);
2903f2feebbdSKevin Wolf     }
2904f2feebbdSKevin Wolf 
2905f2feebbdSKevin Wolf     return 1;
2906f2feebbdSKevin Wolf }
2907f2feebbdSKevin Wolf 
2908376ae3f1SStefan Hajnoczi typedef struct BdrvCoIsAllocatedData {
2909376ae3f1SStefan Hajnoczi     BlockDriverState *bs;
2910b35b2bbaSMiroslav Rezanina     BlockDriverState *base;
2911376ae3f1SStefan Hajnoczi     int64_t sector_num;
2912376ae3f1SStefan Hajnoczi     int nb_sectors;
2913376ae3f1SStefan Hajnoczi     int *pnum;
2914376ae3f1SStefan Hajnoczi     int ret;
2915376ae3f1SStefan Hajnoczi     bool done;
2916376ae3f1SStefan Hajnoczi } BdrvCoIsAllocatedData;
2917376ae3f1SStefan Hajnoczi 
2918f58c7b35Sths /*
2919f58c7b35Sths  * Returns true iff the specified sector is present in the disk image. Drivers
2920f58c7b35Sths  * not implementing the functionality are assumed to not support backing files,
2921f58c7b35Sths  * hence all their sectors are reported as allocated.
2922f58c7b35Sths  *
2923bd9533e3SStefan Hajnoczi  * If 'sector_num' is beyond the end of the disk image the return value is 0
2924bd9533e3SStefan Hajnoczi  * and 'pnum' is set to 0.
2925bd9533e3SStefan Hajnoczi  *
2926f58c7b35Sths  * 'pnum' is set to the number of sectors (including and immediately following
2927f58c7b35Sths  * the specified sector) that are known to be in the same
2928f58c7b35Sths  * allocated/unallocated state.
2929f58c7b35Sths  *
2930bd9533e3SStefan Hajnoczi  * 'nb_sectors' is the max value 'pnum' should be set to.  If nb_sectors goes
2931bd9533e3SStefan Hajnoczi  * beyond the end of the disk image it will be clamped.
2932f58c7b35Sths  */
2933060f51c9SStefan Hajnoczi int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
2934060f51c9SStefan Hajnoczi                                       int nb_sectors, int *pnum)
2935f58c7b35Sths {
2936f58c7b35Sths     int64_t n;
2937bd9533e3SStefan Hajnoczi 
29386aebab14SStefan Hajnoczi     if (sector_num >= bs->total_sectors) {
29396aebab14SStefan Hajnoczi         *pnum = 0;
29406aebab14SStefan Hajnoczi         return 0;
29416aebab14SStefan Hajnoczi     }
2942bd9533e3SStefan Hajnoczi 
29436aebab14SStefan Hajnoczi     n = bs->total_sectors - sector_num;
2944bd9533e3SStefan Hajnoczi     if (n < nb_sectors) {
2945bd9533e3SStefan Hajnoczi         nb_sectors = n;
2946bd9533e3SStefan Hajnoczi     }
2947bd9533e3SStefan Hajnoczi 
2948bd9533e3SStefan Hajnoczi     if (!bs->drv->bdrv_co_is_allocated) {
2949bd9533e3SStefan Hajnoczi         *pnum = nb_sectors;
29506aebab14SStefan Hajnoczi         return 1;
29516aebab14SStefan Hajnoczi     }
29526aebab14SStefan Hajnoczi 
2953060f51c9SStefan Hajnoczi     return bs->drv->bdrv_co_is_allocated(bs, sector_num, nb_sectors, pnum);
2954060f51c9SStefan Hajnoczi }
2955060f51c9SStefan Hajnoczi 
2956060f51c9SStefan Hajnoczi /* Coroutine wrapper for bdrv_is_allocated() */
2957060f51c9SStefan Hajnoczi static void coroutine_fn bdrv_is_allocated_co_entry(void *opaque)
2958060f51c9SStefan Hajnoczi {
2959060f51c9SStefan Hajnoczi     BdrvCoIsAllocatedData *data = opaque;
2960060f51c9SStefan Hajnoczi     BlockDriverState *bs = data->bs;
2961060f51c9SStefan Hajnoczi 
2962060f51c9SStefan Hajnoczi     data->ret = bdrv_co_is_allocated(bs, data->sector_num, data->nb_sectors,
2963060f51c9SStefan Hajnoczi                                      data->pnum);
2964060f51c9SStefan Hajnoczi     data->done = true;
2965060f51c9SStefan Hajnoczi }
2966060f51c9SStefan Hajnoczi 
2967060f51c9SStefan Hajnoczi /*
2968060f51c9SStefan Hajnoczi  * Synchronous wrapper around bdrv_co_is_allocated().
2969060f51c9SStefan Hajnoczi  *
2970060f51c9SStefan Hajnoczi  * See bdrv_co_is_allocated() for details.
2971060f51c9SStefan Hajnoczi  */
2972060f51c9SStefan Hajnoczi int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
2973060f51c9SStefan Hajnoczi                       int *pnum)
2974060f51c9SStefan Hajnoczi {
2975376ae3f1SStefan Hajnoczi     Coroutine *co;
2976376ae3f1SStefan Hajnoczi     BdrvCoIsAllocatedData data = {
2977376ae3f1SStefan Hajnoczi         .bs = bs,
2978376ae3f1SStefan Hajnoczi         .sector_num = sector_num,
2979376ae3f1SStefan Hajnoczi         .nb_sectors = nb_sectors,
2980376ae3f1SStefan Hajnoczi         .pnum = pnum,
2981376ae3f1SStefan Hajnoczi         .done = false,
2982376ae3f1SStefan Hajnoczi     };
2983376ae3f1SStefan Hajnoczi 
2984376ae3f1SStefan Hajnoczi     co = qemu_coroutine_create(bdrv_is_allocated_co_entry);
2985376ae3f1SStefan Hajnoczi     qemu_coroutine_enter(co, &data);
2986376ae3f1SStefan Hajnoczi     while (!data.done) {
2987376ae3f1SStefan Hajnoczi         qemu_aio_wait();
2988376ae3f1SStefan Hajnoczi     }
2989376ae3f1SStefan Hajnoczi     return data.ret;
2990376ae3f1SStefan Hajnoczi }
2991f58c7b35Sths 
2992188a7bbfSPaolo Bonzini /*
2993188a7bbfSPaolo Bonzini  * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
2994188a7bbfSPaolo Bonzini  *
2995188a7bbfSPaolo Bonzini  * Return true if the given sector is allocated in any image between
2996188a7bbfSPaolo Bonzini  * BASE and TOP (inclusive).  BASE can be NULL to check if the given
2997188a7bbfSPaolo Bonzini  * sector is allocated in any image of the chain.  Return false otherwise.
2998188a7bbfSPaolo Bonzini  *
2999188a7bbfSPaolo Bonzini  * 'pnum' is set to the number of sectors (including and immediately following
3000188a7bbfSPaolo Bonzini  *  the specified sector) that are known to be in the same
3001188a7bbfSPaolo Bonzini  *  allocated/unallocated state.
3002188a7bbfSPaolo Bonzini  *
3003188a7bbfSPaolo Bonzini  */
3004188a7bbfSPaolo Bonzini int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
3005188a7bbfSPaolo Bonzini                                             BlockDriverState *base,
3006188a7bbfSPaolo Bonzini                                             int64_t sector_num,
3007188a7bbfSPaolo Bonzini                                             int nb_sectors, int *pnum)
3008188a7bbfSPaolo Bonzini {
3009188a7bbfSPaolo Bonzini     BlockDriverState *intermediate;
3010188a7bbfSPaolo Bonzini     int ret, n = nb_sectors;
3011188a7bbfSPaolo Bonzini 
3012188a7bbfSPaolo Bonzini     intermediate = top;
3013188a7bbfSPaolo Bonzini     while (intermediate && intermediate != base) {
3014188a7bbfSPaolo Bonzini         int pnum_inter;
3015188a7bbfSPaolo Bonzini         ret = bdrv_co_is_allocated(intermediate, sector_num, nb_sectors,
3016188a7bbfSPaolo Bonzini                                    &pnum_inter);
3017188a7bbfSPaolo Bonzini         if (ret < 0) {
3018188a7bbfSPaolo Bonzini             return ret;
3019188a7bbfSPaolo Bonzini         } else if (ret) {
3020188a7bbfSPaolo Bonzini             *pnum = pnum_inter;
3021188a7bbfSPaolo Bonzini             return 1;
3022188a7bbfSPaolo Bonzini         }
3023188a7bbfSPaolo Bonzini 
3024188a7bbfSPaolo Bonzini         /*
3025188a7bbfSPaolo Bonzini          * [sector_num, nb_sectors] is unallocated on top but intermediate
3026188a7bbfSPaolo Bonzini          * might have
3027188a7bbfSPaolo Bonzini          *
3028188a7bbfSPaolo Bonzini          * [sector_num+x, nr_sectors] allocated.
3029188a7bbfSPaolo Bonzini          */
303063ba17d3SVishvananda Ishaya         if (n > pnum_inter &&
303163ba17d3SVishvananda Ishaya             (intermediate == top ||
303263ba17d3SVishvananda Ishaya              sector_num + pnum_inter < intermediate->total_sectors)) {
3033188a7bbfSPaolo Bonzini             n = pnum_inter;
3034188a7bbfSPaolo Bonzini         }
3035188a7bbfSPaolo Bonzini 
3036188a7bbfSPaolo Bonzini         intermediate = intermediate->backing_hd;
3037188a7bbfSPaolo Bonzini     }
3038188a7bbfSPaolo Bonzini 
3039188a7bbfSPaolo Bonzini     *pnum = n;
3040188a7bbfSPaolo Bonzini     return 0;
3041188a7bbfSPaolo Bonzini }
3042188a7bbfSPaolo Bonzini 
3043b35b2bbaSMiroslav Rezanina /* Coroutine wrapper for bdrv_is_allocated_above() */
3044b35b2bbaSMiroslav Rezanina static void coroutine_fn bdrv_is_allocated_above_co_entry(void *opaque)
3045b35b2bbaSMiroslav Rezanina {
3046b35b2bbaSMiroslav Rezanina     BdrvCoIsAllocatedData *data = opaque;
3047b35b2bbaSMiroslav Rezanina     BlockDriverState *top = data->bs;
3048b35b2bbaSMiroslav Rezanina     BlockDriverState *base = data->base;
3049b35b2bbaSMiroslav Rezanina 
3050b35b2bbaSMiroslav Rezanina     data->ret = bdrv_co_is_allocated_above(top, base, data->sector_num,
3051b35b2bbaSMiroslav Rezanina                                            data->nb_sectors, data->pnum);
3052b35b2bbaSMiroslav Rezanina     data->done = true;
3053b35b2bbaSMiroslav Rezanina }
3054b35b2bbaSMiroslav Rezanina 
3055b35b2bbaSMiroslav Rezanina /*
3056b35b2bbaSMiroslav Rezanina  * Synchronous wrapper around bdrv_co_is_allocated_above().
3057b35b2bbaSMiroslav Rezanina  *
3058b35b2bbaSMiroslav Rezanina  * See bdrv_co_is_allocated_above() for details.
3059b35b2bbaSMiroslav Rezanina  */
3060b35b2bbaSMiroslav Rezanina int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
3061b35b2bbaSMiroslav Rezanina                             int64_t sector_num, int nb_sectors, int *pnum)
3062b35b2bbaSMiroslav Rezanina {
3063b35b2bbaSMiroslav Rezanina     Coroutine *co;
3064b35b2bbaSMiroslav Rezanina     BdrvCoIsAllocatedData data = {
3065b35b2bbaSMiroslav Rezanina         .bs = top,
3066b35b2bbaSMiroslav Rezanina         .base = base,
3067b35b2bbaSMiroslav Rezanina         .sector_num = sector_num,
3068b35b2bbaSMiroslav Rezanina         .nb_sectors = nb_sectors,
3069b35b2bbaSMiroslav Rezanina         .pnum = pnum,
3070b35b2bbaSMiroslav Rezanina         .done = false,
3071b35b2bbaSMiroslav Rezanina     };
3072b35b2bbaSMiroslav Rezanina 
3073b35b2bbaSMiroslav Rezanina     co = qemu_coroutine_create(bdrv_is_allocated_above_co_entry);
3074b35b2bbaSMiroslav Rezanina     qemu_coroutine_enter(co, &data);
3075b35b2bbaSMiroslav Rezanina     while (!data.done) {
3076b35b2bbaSMiroslav Rezanina         qemu_aio_wait();
3077b35b2bbaSMiroslav Rezanina     }
3078b35b2bbaSMiroslav Rezanina     return data.ret;
3079b35b2bbaSMiroslav Rezanina }
3080b35b2bbaSMiroslav Rezanina 
3081ac84adacSPaolo Bonzini BlockInfo *bdrv_query_info(BlockDriverState *bs)
3082ac84adacSPaolo Bonzini {
3083ac84adacSPaolo Bonzini     BlockInfo *info = g_malloc0(sizeof(*info));
3084ac84adacSPaolo Bonzini     info->device = g_strdup(bs->device_name);
3085ac84adacSPaolo Bonzini     info->type = g_strdup("unknown");
3086ac84adacSPaolo Bonzini     info->locked = bdrv_dev_is_medium_locked(bs);
3087ac84adacSPaolo Bonzini     info->removable = bdrv_dev_has_removable_media(bs);
3088ac84adacSPaolo Bonzini 
3089ac84adacSPaolo Bonzini     if (bdrv_dev_has_removable_media(bs)) {
3090ac84adacSPaolo Bonzini         info->has_tray_open = true;
3091ac84adacSPaolo Bonzini         info->tray_open = bdrv_dev_is_tray_open(bs);
3092ac84adacSPaolo Bonzini     }
3093ac84adacSPaolo Bonzini 
3094ac84adacSPaolo Bonzini     if (bdrv_iostatus_is_enabled(bs)) {
3095ac84adacSPaolo Bonzini         info->has_io_status = true;
3096ac84adacSPaolo Bonzini         info->io_status = bs->iostatus;
3097ac84adacSPaolo Bonzini     }
3098ac84adacSPaolo Bonzini 
3099b9a9b3a4SPaolo Bonzini     if (bs->dirty_bitmap) {
3100b9a9b3a4SPaolo Bonzini         info->has_dirty = true;
3101b9a9b3a4SPaolo Bonzini         info->dirty = g_malloc0(sizeof(*info->dirty));
3102acc906c6SPaolo Bonzini         info->dirty->count = bdrv_get_dirty_count(bs) * BDRV_SECTOR_SIZE;
310350717e94SPaolo Bonzini         info->dirty->granularity =
310450717e94SPaolo Bonzini             ((int64_t) BDRV_SECTOR_SIZE << hbitmap_granularity(bs->dirty_bitmap));
3105b9a9b3a4SPaolo Bonzini     }
3106b9a9b3a4SPaolo Bonzini 
3107ac84adacSPaolo Bonzini     if (bs->drv) {
3108ac84adacSPaolo Bonzini         info->has_inserted = true;
3109ac84adacSPaolo Bonzini         info->inserted = g_malloc0(sizeof(*info->inserted));
3110ac84adacSPaolo Bonzini         info->inserted->file = g_strdup(bs->filename);
3111ac84adacSPaolo Bonzini         info->inserted->ro = bs->read_only;
3112ac84adacSPaolo Bonzini         info->inserted->drv = g_strdup(bs->drv->format_name);
3113ac84adacSPaolo Bonzini         info->inserted->encrypted = bs->encrypted;
3114ac84adacSPaolo Bonzini         info->inserted->encryption_key_missing = bdrv_key_required(bs);
3115ac84adacSPaolo Bonzini 
3116ac84adacSPaolo Bonzini         if (bs->backing_file[0]) {
3117ac84adacSPaolo Bonzini             info->inserted->has_backing_file = true;
3118ac84adacSPaolo Bonzini             info->inserted->backing_file = g_strdup(bs->backing_file);
3119ac84adacSPaolo Bonzini         }
3120ac84adacSPaolo Bonzini 
3121ac84adacSPaolo Bonzini         info->inserted->backing_file_depth = bdrv_get_backing_file_depth(bs);
3122ac84adacSPaolo Bonzini 
3123ac84adacSPaolo Bonzini         if (bs->io_limits_enabled) {
3124ac84adacSPaolo Bonzini             info->inserted->bps =
3125ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
3126ac84adacSPaolo Bonzini             info->inserted->bps_rd =
3127ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_READ];
3128ac84adacSPaolo Bonzini             info->inserted->bps_wr =
3129ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_WRITE];
3130ac84adacSPaolo Bonzini             info->inserted->iops =
3131ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
3132ac84adacSPaolo Bonzini             info->inserted->iops_rd =
3133ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_READ];
3134ac84adacSPaolo Bonzini             info->inserted->iops_wr =
3135ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_WRITE];
3136ac84adacSPaolo Bonzini         }
3137ac84adacSPaolo Bonzini     }
3138ac84adacSPaolo Bonzini     return info;
3139ac84adacSPaolo Bonzini }
3140ac84adacSPaolo Bonzini 
3141b2023818SLuiz Capitulino BlockInfoList *qmp_query_block(Error **errp)
3142b338082bSbellard {
3143ac84adacSPaolo Bonzini     BlockInfoList *head = NULL, **p_next = &head;
3144d15e5465SLuiz Capitulino     BlockDriverState *bs;
3145d15e5465SLuiz Capitulino 
31461b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
3147b2023818SLuiz Capitulino         BlockInfoList *info = g_malloc0(sizeof(*info));
3148ac84adacSPaolo Bonzini         info->value = bdrv_query_info(bs);
3149d15e5465SLuiz Capitulino 
3150ac84adacSPaolo Bonzini         *p_next = info;
3151ac84adacSPaolo Bonzini         p_next = &info->next;
3152d15e5465SLuiz Capitulino     }
3153d15e5465SLuiz Capitulino 
3154b2023818SLuiz Capitulino     return head;
3155b338082bSbellard }
3156a36e69ddSths 
31579887b616SPaolo Bonzini BlockStats *bdrv_query_stats(const BlockDriverState *bs)
3158a36e69ddSths {
3159f11f57e4SLuiz Capitulino     BlockStats *s;
3160218a536aSLuiz Capitulino 
3161f11f57e4SLuiz Capitulino     s = g_malloc0(sizeof(*s));
3162218a536aSLuiz Capitulino 
3163f11f57e4SLuiz Capitulino     if (bs->device_name[0]) {
3164f11f57e4SLuiz Capitulino         s->has_device = true;
3165f11f57e4SLuiz Capitulino         s->device = g_strdup(bs->device_name);
3166218a536aSLuiz Capitulino     }
3167218a536aSLuiz Capitulino 
3168f11f57e4SLuiz Capitulino     s->stats = g_malloc0(sizeof(*s->stats));
3169f11f57e4SLuiz Capitulino     s->stats->rd_bytes = bs->nr_bytes[BDRV_ACCT_READ];
3170f11f57e4SLuiz Capitulino     s->stats->wr_bytes = bs->nr_bytes[BDRV_ACCT_WRITE];
3171f11f57e4SLuiz Capitulino     s->stats->rd_operations = bs->nr_ops[BDRV_ACCT_READ];
3172f11f57e4SLuiz Capitulino     s->stats->wr_operations = bs->nr_ops[BDRV_ACCT_WRITE];
3173f11f57e4SLuiz Capitulino     s->stats->wr_highest_offset = bs->wr_highest_sector * BDRV_SECTOR_SIZE;
3174f11f57e4SLuiz Capitulino     s->stats->flush_operations = bs->nr_ops[BDRV_ACCT_FLUSH];
3175f11f57e4SLuiz Capitulino     s->stats->wr_total_time_ns = bs->total_time_ns[BDRV_ACCT_WRITE];
3176f11f57e4SLuiz Capitulino     s->stats->rd_total_time_ns = bs->total_time_ns[BDRV_ACCT_READ];
3177f11f57e4SLuiz Capitulino     s->stats->flush_total_time_ns = bs->total_time_ns[BDRV_ACCT_FLUSH];
3178294cc35fSKevin Wolf 
3179294cc35fSKevin Wolf     if (bs->file) {
3180f11f57e4SLuiz Capitulino         s->has_parent = true;
31819887b616SPaolo Bonzini         s->parent = bdrv_query_stats(bs->file);
3182294cc35fSKevin Wolf     }
3183294cc35fSKevin Wolf 
3184f11f57e4SLuiz Capitulino     return s;
3185294cc35fSKevin Wolf }
3186294cc35fSKevin Wolf 
3187f11f57e4SLuiz Capitulino BlockStatsList *qmp_query_blockstats(Error **errp)
3188218a536aSLuiz Capitulino {
31899887b616SPaolo Bonzini     BlockStatsList *head = NULL, **p_next = &head;
3190a36e69ddSths     BlockDriverState *bs;
3191a36e69ddSths 
31921b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
3193f11f57e4SLuiz Capitulino         BlockStatsList *info = g_malloc0(sizeof(*info));
31949887b616SPaolo Bonzini         info->value = bdrv_query_stats(bs);
3195f11f57e4SLuiz Capitulino 
31969887b616SPaolo Bonzini         *p_next = info;
31979887b616SPaolo Bonzini         p_next = &info->next;
3198a36e69ddSths     }
3199218a536aSLuiz Capitulino 
3200f11f57e4SLuiz Capitulino     return head;
3201a36e69ddSths }
3202ea2384d3Sbellard 
3203045df330Saliguori const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
3204045df330Saliguori {
3205045df330Saliguori     if (bs->backing_hd && bs->backing_hd->encrypted)
3206045df330Saliguori         return bs->backing_file;
3207045df330Saliguori     else if (bs->encrypted)
3208045df330Saliguori         return bs->filename;
3209045df330Saliguori     else
3210045df330Saliguori         return NULL;
3211045df330Saliguori }
3212045df330Saliguori 
321383f64091Sbellard void bdrv_get_backing_filename(BlockDriverState *bs,
321483f64091Sbellard                                char *filename, int filename_size)
321583f64091Sbellard {
321683f64091Sbellard     pstrcpy(filename, filename_size, bs->backing_file);
321783f64091Sbellard }
321883f64091Sbellard 
3219faea38e7Sbellard int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
3220faea38e7Sbellard                           const uint8_t *buf, int nb_sectors)
3221faea38e7Sbellard {
3222faea38e7Sbellard     BlockDriver *drv = bs->drv;
3223faea38e7Sbellard     if (!drv)
322419cb3738Sbellard         return -ENOMEDIUM;
3225faea38e7Sbellard     if (!drv->bdrv_write_compressed)
3226faea38e7Sbellard         return -ENOTSUP;
3227fbb7b4e0SKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors))
3228fbb7b4e0SKevin Wolf         return -EIO;
32297cd1e32aSlirans@il.ibm.com 
32301755da16SPaolo Bonzini     assert(!bs->dirty_bitmap);
32317cd1e32aSlirans@il.ibm.com 
3232faea38e7Sbellard     return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
3233faea38e7Sbellard }
3234faea38e7Sbellard 
3235faea38e7Sbellard int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
3236faea38e7Sbellard {
3237faea38e7Sbellard     BlockDriver *drv = bs->drv;
3238faea38e7Sbellard     if (!drv)
323919cb3738Sbellard         return -ENOMEDIUM;
3240faea38e7Sbellard     if (!drv->bdrv_get_info)
3241faea38e7Sbellard         return -ENOTSUP;
3242faea38e7Sbellard     memset(bdi, 0, sizeof(*bdi));
3243faea38e7Sbellard     return drv->bdrv_get_info(bs, bdi);
3244faea38e7Sbellard }
3245faea38e7Sbellard 
324645566e9cSChristoph Hellwig int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
324745566e9cSChristoph Hellwig                       int64_t pos, int size)
3248178e08a5Saliguori {
3249cf8074b3SKevin Wolf     QEMUIOVector qiov;
3250cf8074b3SKevin Wolf     struct iovec iov = {
3251cf8074b3SKevin Wolf         .iov_base   = (void *) buf,
3252cf8074b3SKevin Wolf         .iov_len    = size,
3253cf8074b3SKevin Wolf     };
3254cf8074b3SKevin Wolf 
3255cf8074b3SKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
3256cf8074b3SKevin Wolf     return bdrv_writev_vmstate(bs, &qiov, pos);
3257cf8074b3SKevin Wolf }
3258cf8074b3SKevin Wolf 
3259cf8074b3SKevin Wolf int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
3260cf8074b3SKevin Wolf {
3261178e08a5Saliguori     BlockDriver *drv = bs->drv;
3262cf8074b3SKevin Wolf 
3263cf8074b3SKevin Wolf     if (!drv) {
3264178e08a5Saliguori         return -ENOMEDIUM;
3265cf8074b3SKevin Wolf     } else if (drv->bdrv_save_vmstate) {
3266cf8074b3SKevin Wolf         return drv->bdrv_save_vmstate(bs, qiov, pos);
3267cf8074b3SKevin Wolf     } else if (bs->file) {
3268cf8074b3SKevin Wolf         return bdrv_writev_vmstate(bs->file, qiov, pos);
3269cf8074b3SKevin Wolf     }
3270cf8074b3SKevin Wolf 
32717cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3272178e08a5Saliguori }
3273178e08a5Saliguori 
327445566e9cSChristoph Hellwig int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
327545566e9cSChristoph Hellwig                       int64_t pos, int size)
3276178e08a5Saliguori {
3277178e08a5Saliguori     BlockDriver *drv = bs->drv;
3278178e08a5Saliguori     if (!drv)
3279178e08a5Saliguori         return -ENOMEDIUM;
32807cdb1f6dSMORITA Kazutaka     if (drv->bdrv_load_vmstate)
328145566e9cSChristoph Hellwig         return drv->bdrv_load_vmstate(bs, buf, pos, size);
32827cdb1f6dSMORITA Kazutaka     if (bs->file)
32837cdb1f6dSMORITA Kazutaka         return bdrv_load_vmstate(bs->file, buf, pos, size);
32847cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3285178e08a5Saliguori }
3286178e08a5Saliguori 
32878b9b0cc2SKevin Wolf void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
32888b9b0cc2SKevin Wolf {
32898b9b0cc2SKevin Wolf     BlockDriver *drv = bs->drv;
32908b9b0cc2SKevin Wolf 
32918b9b0cc2SKevin Wolf     if (!drv || !drv->bdrv_debug_event) {
32928b9b0cc2SKevin Wolf         return;
32938b9b0cc2SKevin Wolf     }
32948b9b0cc2SKevin Wolf 
32950ed8b6f6SBlue Swirl     drv->bdrv_debug_event(bs, event);
329641c695c7SKevin Wolf }
32978b9b0cc2SKevin Wolf 
329841c695c7SKevin Wolf int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
329941c695c7SKevin Wolf                           const char *tag)
330041c695c7SKevin Wolf {
330141c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) {
330241c695c7SKevin Wolf         bs = bs->file;
330341c695c7SKevin Wolf     }
330441c695c7SKevin Wolf 
330541c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) {
330641c695c7SKevin Wolf         return bs->drv->bdrv_debug_breakpoint(bs, event, tag);
330741c695c7SKevin Wolf     }
330841c695c7SKevin Wolf 
330941c695c7SKevin Wolf     return -ENOTSUP;
331041c695c7SKevin Wolf }
331141c695c7SKevin Wolf 
331241c695c7SKevin Wolf int bdrv_debug_resume(BlockDriverState *bs, const char *tag)
331341c695c7SKevin Wolf {
331441c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_resume) {
331541c695c7SKevin Wolf         bs = bs->file;
331641c695c7SKevin Wolf     }
331741c695c7SKevin Wolf 
331841c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_resume) {
331941c695c7SKevin Wolf         return bs->drv->bdrv_debug_resume(bs, tag);
332041c695c7SKevin Wolf     }
332141c695c7SKevin Wolf 
332241c695c7SKevin Wolf     return -ENOTSUP;
332341c695c7SKevin Wolf }
332441c695c7SKevin Wolf 
332541c695c7SKevin Wolf bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag)
332641c695c7SKevin Wolf {
332741c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) {
332841c695c7SKevin Wolf         bs = bs->file;
332941c695c7SKevin Wolf     }
333041c695c7SKevin Wolf 
333141c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) {
333241c695c7SKevin Wolf         return bs->drv->bdrv_debug_is_suspended(bs, tag);
333341c695c7SKevin Wolf     }
333441c695c7SKevin Wolf 
333541c695c7SKevin Wolf     return false;
33368b9b0cc2SKevin Wolf }
33378b9b0cc2SKevin Wolf 
3338faea38e7Sbellard /**************************************************************/
3339faea38e7Sbellard /* handling of snapshots */
3340faea38e7Sbellard 
3341feeee5acSMiguel Di Ciurcio Filho int bdrv_can_snapshot(BlockDriverState *bs)
3342feeee5acSMiguel Di Ciurcio Filho {
3343feeee5acSMiguel Di Ciurcio Filho     BlockDriver *drv = bs->drv;
334407b70bfbSMarkus Armbruster     if (!drv || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
3345feeee5acSMiguel Di Ciurcio Filho         return 0;
3346feeee5acSMiguel Di Ciurcio Filho     }
3347feeee5acSMiguel Di Ciurcio Filho 
3348feeee5acSMiguel Di Ciurcio Filho     if (!drv->bdrv_snapshot_create) {
3349feeee5acSMiguel Di Ciurcio Filho         if (bs->file != NULL) {
3350feeee5acSMiguel Di Ciurcio Filho             return bdrv_can_snapshot(bs->file);
3351feeee5acSMiguel Di Ciurcio Filho         }
3352feeee5acSMiguel Di Ciurcio Filho         return 0;
3353feeee5acSMiguel Di Ciurcio Filho     }
3354feeee5acSMiguel Di Ciurcio Filho 
3355feeee5acSMiguel Di Ciurcio Filho     return 1;
3356feeee5acSMiguel Di Ciurcio Filho }
3357feeee5acSMiguel Di Ciurcio Filho 
3358199630b6SBlue Swirl int bdrv_is_snapshot(BlockDriverState *bs)
3359199630b6SBlue Swirl {
3360199630b6SBlue Swirl     return !!(bs->open_flags & BDRV_O_SNAPSHOT);
3361199630b6SBlue Swirl }
3362199630b6SBlue Swirl 
3363f9092b10SMarkus Armbruster BlockDriverState *bdrv_snapshots(void)
3364f9092b10SMarkus Armbruster {
3365f9092b10SMarkus Armbruster     BlockDriverState *bs;
3366f9092b10SMarkus Armbruster 
33673ac906f7SMarkus Armbruster     if (bs_snapshots) {
3368f9092b10SMarkus Armbruster         return bs_snapshots;
33693ac906f7SMarkus Armbruster     }
3370f9092b10SMarkus Armbruster 
3371f9092b10SMarkus Armbruster     bs = NULL;
3372f9092b10SMarkus Armbruster     while ((bs = bdrv_next(bs))) {
3373f9092b10SMarkus Armbruster         if (bdrv_can_snapshot(bs)) {
33743ac906f7SMarkus Armbruster             bs_snapshots = bs;
33753ac906f7SMarkus Armbruster             return bs;
3376f9092b10SMarkus Armbruster         }
3377f9092b10SMarkus Armbruster     }
3378f9092b10SMarkus Armbruster     return NULL;
3379f9092b10SMarkus Armbruster }
3380f9092b10SMarkus Armbruster 
3381faea38e7Sbellard int bdrv_snapshot_create(BlockDriverState *bs,
3382faea38e7Sbellard                          QEMUSnapshotInfo *sn_info)
3383faea38e7Sbellard {
3384faea38e7Sbellard     BlockDriver *drv = bs->drv;
3385faea38e7Sbellard     if (!drv)
338619cb3738Sbellard         return -ENOMEDIUM;
33877cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_create)
3388faea38e7Sbellard         return drv->bdrv_snapshot_create(bs, sn_info);
33897cdb1f6dSMORITA Kazutaka     if (bs->file)
33907cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_create(bs->file, sn_info);
33917cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3392faea38e7Sbellard }
3393faea38e7Sbellard 
3394faea38e7Sbellard int bdrv_snapshot_goto(BlockDriverState *bs,
3395faea38e7Sbellard                        const char *snapshot_id)
3396faea38e7Sbellard {
3397faea38e7Sbellard     BlockDriver *drv = bs->drv;
33987cdb1f6dSMORITA Kazutaka     int ret, open_ret;
33997cdb1f6dSMORITA Kazutaka 
3400faea38e7Sbellard     if (!drv)
340119cb3738Sbellard         return -ENOMEDIUM;
34027cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_goto)
3403faea38e7Sbellard         return drv->bdrv_snapshot_goto(bs, snapshot_id);
34047cdb1f6dSMORITA Kazutaka 
34057cdb1f6dSMORITA Kazutaka     if (bs->file) {
34067cdb1f6dSMORITA Kazutaka         drv->bdrv_close(bs);
34077cdb1f6dSMORITA Kazutaka         ret = bdrv_snapshot_goto(bs->file, snapshot_id);
34081a86938fSKevin Wolf         open_ret = drv->bdrv_open(bs, NULL, bs->open_flags);
34097cdb1f6dSMORITA Kazutaka         if (open_ret < 0) {
34107cdb1f6dSMORITA Kazutaka             bdrv_delete(bs->file);
34117cdb1f6dSMORITA Kazutaka             bs->drv = NULL;
34127cdb1f6dSMORITA Kazutaka             return open_ret;
34137cdb1f6dSMORITA Kazutaka         }
34147cdb1f6dSMORITA Kazutaka         return ret;
34157cdb1f6dSMORITA Kazutaka     }
34167cdb1f6dSMORITA Kazutaka 
34177cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3418faea38e7Sbellard }
3419faea38e7Sbellard 
3420faea38e7Sbellard int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
3421faea38e7Sbellard {
3422faea38e7Sbellard     BlockDriver *drv = bs->drv;
3423faea38e7Sbellard     if (!drv)
342419cb3738Sbellard         return -ENOMEDIUM;
34257cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_delete)
3426faea38e7Sbellard         return drv->bdrv_snapshot_delete(bs, snapshot_id);
34277cdb1f6dSMORITA Kazutaka     if (bs->file)
34287cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_delete(bs->file, snapshot_id);
34297cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3430faea38e7Sbellard }
3431faea38e7Sbellard 
3432faea38e7Sbellard int bdrv_snapshot_list(BlockDriverState *bs,
3433faea38e7Sbellard                        QEMUSnapshotInfo **psn_info)
3434faea38e7Sbellard {
3435faea38e7Sbellard     BlockDriver *drv = bs->drv;
3436faea38e7Sbellard     if (!drv)
343719cb3738Sbellard         return -ENOMEDIUM;
34387cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_list)
3439faea38e7Sbellard         return drv->bdrv_snapshot_list(bs, psn_info);
34407cdb1f6dSMORITA Kazutaka     if (bs->file)
34417cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_list(bs->file, psn_info);
34427cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3443faea38e7Sbellard }
3444faea38e7Sbellard 
344551ef6727Sedison int bdrv_snapshot_load_tmp(BlockDriverState *bs,
344651ef6727Sedison         const char *snapshot_name)
344751ef6727Sedison {
344851ef6727Sedison     BlockDriver *drv = bs->drv;
344951ef6727Sedison     if (!drv) {
345051ef6727Sedison         return -ENOMEDIUM;
345151ef6727Sedison     }
345251ef6727Sedison     if (!bs->read_only) {
345351ef6727Sedison         return -EINVAL;
345451ef6727Sedison     }
345551ef6727Sedison     if (drv->bdrv_snapshot_load_tmp) {
345651ef6727Sedison         return drv->bdrv_snapshot_load_tmp(bs, snapshot_name);
345751ef6727Sedison     }
345851ef6727Sedison     return -ENOTSUP;
345951ef6727Sedison }
346051ef6727Sedison 
3461b1b1d783SJeff Cody /* backing_file can either be relative, or absolute, or a protocol.  If it is
3462b1b1d783SJeff Cody  * relative, it must be relative to the chain.  So, passing in bs->filename
3463b1b1d783SJeff Cody  * from a BDS as backing_file should not be done, as that may be relative to
3464b1b1d783SJeff Cody  * the CWD rather than the chain. */
3465e8a6bb9cSMarcelo Tosatti BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
3466e8a6bb9cSMarcelo Tosatti         const char *backing_file)
3467e8a6bb9cSMarcelo Tosatti {
3468b1b1d783SJeff Cody     char *filename_full = NULL;
3469b1b1d783SJeff Cody     char *backing_file_full = NULL;
3470b1b1d783SJeff Cody     char *filename_tmp = NULL;
3471b1b1d783SJeff Cody     int is_protocol = 0;
3472b1b1d783SJeff Cody     BlockDriverState *curr_bs = NULL;
3473b1b1d783SJeff Cody     BlockDriverState *retval = NULL;
3474b1b1d783SJeff Cody 
3475b1b1d783SJeff Cody     if (!bs || !bs->drv || !backing_file) {
3476e8a6bb9cSMarcelo Tosatti         return NULL;
3477e8a6bb9cSMarcelo Tosatti     }
3478e8a6bb9cSMarcelo Tosatti 
3479b1b1d783SJeff Cody     filename_full     = g_malloc(PATH_MAX);
3480b1b1d783SJeff Cody     backing_file_full = g_malloc(PATH_MAX);
3481b1b1d783SJeff Cody     filename_tmp      = g_malloc(PATH_MAX);
3482b1b1d783SJeff Cody 
3483b1b1d783SJeff Cody     is_protocol = path_has_protocol(backing_file);
3484b1b1d783SJeff Cody 
3485b1b1d783SJeff Cody     for (curr_bs = bs; curr_bs->backing_hd; curr_bs = curr_bs->backing_hd) {
3486b1b1d783SJeff Cody 
3487b1b1d783SJeff Cody         /* If either of the filename paths is actually a protocol, then
3488b1b1d783SJeff Cody          * compare unmodified paths; otherwise make paths relative */
3489b1b1d783SJeff Cody         if (is_protocol || path_has_protocol(curr_bs->backing_file)) {
3490b1b1d783SJeff Cody             if (strcmp(backing_file, curr_bs->backing_file) == 0) {
3491b1b1d783SJeff Cody                 retval = curr_bs->backing_hd;
3492b1b1d783SJeff Cody                 break;
3493b1b1d783SJeff Cody             }
3494e8a6bb9cSMarcelo Tosatti         } else {
3495b1b1d783SJeff Cody             /* If not an absolute filename path, make it relative to the current
3496b1b1d783SJeff Cody              * image's filename path */
3497b1b1d783SJeff Cody             path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3498b1b1d783SJeff Cody                          backing_file);
3499b1b1d783SJeff Cody 
3500b1b1d783SJeff Cody             /* We are going to compare absolute pathnames */
3501b1b1d783SJeff Cody             if (!realpath(filename_tmp, filename_full)) {
3502b1b1d783SJeff Cody                 continue;
3503b1b1d783SJeff Cody             }
3504b1b1d783SJeff Cody 
3505b1b1d783SJeff Cody             /* We need to make sure the backing filename we are comparing against
3506b1b1d783SJeff Cody              * is relative to the current image filename (or absolute) */
3507b1b1d783SJeff Cody             path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3508b1b1d783SJeff Cody                          curr_bs->backing_file);
3509b1b1d783SJeff Cody 
3510b1b1d783SJeff Cody             if (!realpath(filename_tmp, backing_file_full)) {
3511b1b1d783SJeff Cody                 continue;
3512b1b1d783SJeff Cody             }
3513b1b1d783SJeff Cody 
3514b1b1d783SJeff Cody             if (strcmp(backing_file_full, filename_full) == 0) {
3515b1b1d783SJeff Cody                 retval = curr_bs->backing_hd;
3516b1b1d783SJeff Cody                 break;
3517b1b1d783SJeff Cody             }
3518e8a6bb9cSMarcelo Tosatti         }
3519e8a6bb9cSMarcelo Tosatti     }
3520e8a6bb9cSMarcelo Tosatti 
3521b1b1d783SJeff Cody     g_free(filename_full);
3522b1b1d783SJeff Cody     g_free(backing_file_full);
3523b1b1d783SJeff Cody     g_free(filename_tmp);
3524b1b1d783SJeff Cody     return retval;
3525e8a6bb9cSMarcelo Tosatti }
3526e8a6bb9cSMarcelo Tosatti 
3527f198fd1cSBenoît Canet int bdrv_get_backing_file_depth(BlockDriverState *bs)
3528f198fd1cSBenoît Canet {
3529f198fd1cSBenoît Canet     if (!bs->drv) {
3530f198fd1cSBenoît Canet         return 0;
3531f198fd1cSBenoît Canet     }
3532f198fd1cSBenoît Canet 
3533f198fd1cSBenoît Canet     if (!bs->backing_hd) {
3534f198fd1cSBenoît Canet         return 0;
3535f198fd1cSBenoît Canet     }
3536f198fd1cSBenoît Canet 
3537f198fd1cSBenoît Canet     return 1 + bdrv_get_backing_file_depth(bs->backing_hd);
3538f198fd1cSBenoît Canet }
3539f198fd1cSBenoît Canet 
354079fac568SJeff Cody BlockDriverState *bdrv_find_base(BlockDriverState *bs)
354179fac568SJeff Cody {
354279fac568SJeff Cody     BlockDriverState *curr_bs = NULL;
354379fac568SJeff Cody 
354479fac568SJeff Cody     if (!bs) {
354579fac568SJeff Cody         return NULL;
354679fac568SJeff Cody     }
354779fac568SJeff Cody 
354879fac568SJeff Cody     curr_bs = bs;
354979fac568SJeff Cody 
355079fac568SJeff Cody     while (curr_bs->backing_hd) {
355179fac568SJeff Cody         curr_bs = curr_bs->backing_hd;
355279fac568SJeff Cody     }
355379fac568SJeff Cody     return curr_bs;
355479fac568SJeff Cody }
355579fac568SJeff Cody 
3556faea38e7Sbellard #define NB_SUFFIXES 4
3557faea38e7Sbellard 
3558faea38e7Sbellard char *get_human_readable_size(char *buf, int buf_size, int64_t size)
3559faea38e7Sbellard {
3560faea38e7Sbellard     static const char suffixes[NB_SUFFIXES] = "KMGT";
3561faea38e7Sbellard     int64_t base;
3562faea38e7Sbellard     int i;
3563faea38e7Sbellard 
3564faea38e7Sbellard     if (size <= 999) {
3565faea38e7Sbellard         snprintf(buf, buf_size, "%" PRId64, size);
3566faea38e7Sbellard     } else {
3567faea38e7Sbellard         base = 1024;
3568faea38e7Sbellard         for(i = 0; i < NB_SUFFIXES; i++) {
3569faea38e7Sbellard             if (size < (10 * base)) {
3570faea38e7Sbellard                 snprintf(buf, buf_size, "%0.1f%c",
3571faea38e7Sbellard                          (double)size / base,
3572faea38e7Sbellard                          suffixes[i]);
3573faea38e7Sbellard                 break;
3574faea38e7Sbellard             } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
3575faea38e7Sbellard                 snprintf(buf, buf_size, "%" PRId64 "%c",
3576faea38e7Sbellard                          ((size + (base >> 1)) / base),
3577faea38e7Sbellard                          suffixes[i]);
3578faea38e7Sbellard                 break;
3579faea38e7Sbellard             }
3580faea38e7Sbellard             base = base * 1024;
3581faea38e7Sbellard         }
3582faea38e7Sbellard     }
3583faea38e7Sbellard     return buf;
3584faea38e7Sbellard }
3585faea38e7Sbellard 
3586faea38e7Sbellard char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
3587faea38e7Sbellard {
3588faea38e7Sbellard     char buf1[128], date_buf[128], clock_buf[128];
3589faea38e7Sbellard     struct tm tm;
3590faea38e7Sbellard     time_t ti;
3591faea38e7Sbellard     int64_t secs;
3592faea38e7Sbellard 
3593faea38e7Sbellard     if (!sn) {
3594faea38e7Sbellard         snprintf(buf, buf_size,
3595faea38e7Sbellard                  "%-10s%-20s%7s%20s%15s",
3596faea38e7Sbellard                  "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
3597faea38e7Sbellard     } else {
3598faea38e7Sbellard         ti = sn->date_sec;
3599faea38e7Sbellard         localtime_r(&ti, &tm);
3600faea38e7Sbellard         strftime(date_buf, sizeof(date_buf),
3601faea38e7Sbellard                  "%Y-%m-%d %H:%M:%S", &tm);
3602faea38e7Sbellard         secs = sn->vm_clock_nsec / 1000000000;
3603faea38e7Sbellard         snprintf(clock_buf, sizeof(clock_buf),
3604faea38e7Sbellard                  "%02d:%02d:%02d.%03d",
3605faea38e7Sbellard                  (int)(secs / 3600),
3606faea38e7Sbellard                  (int)((secs / 60) % 60),
3607faea38e7Sbellard                  (int)(secs % 60),
3608faea38e7Sbellard                  (int)((sn->vm_clock_nsec / 1000000) % 1000));
3609faea38e7Sbellard         snprintf(buf, buf_size,
3610faea38e7Sbellard                  "%-10s%-20s%7s%20s%15s",
3611faea38e7Sbellard                  sn->id_str, sn->name,
3612faea38e7Sbellard                  get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
3613faea38e7Sbellard                  date_buf,
3614faea38e7Sbellard                  clock_buf);
3615faea38e7Sbellard     }
3616faea38e7Sbellard     return buf;
3617faea38e7Sbellard }
3618faea38e7Sbellard 
3619ea2384d3Sbellard /**************************************************************/
362083f64091Sbellard /* async I/Os */
3621ea2384d3Sbellard 
36223b69e4b9Saliguori BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
3623f141eafeSaliguori                                  QEMUIOVector *qiov, int nb_sectors,
362483f64091Sbellard                                  BlockDriverCompletionFunc *cb, void *opaque)
3625ea2384d3Sbellard {
3626bbf0a440SStefan Hajnoczi     trace_bdrv_aio_readv(bs, sector_num, nb_sectors, opaque);
3627bbf0a440SStefan Hajnoczi 
3628b2a61371SStefan Hajnoczi     return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
36298c5873d6SStefan Hajnoczi                                  cb, opaque, false);
363083f64091Sbellard }
363183f64091Sbellard 
3632f141eafeSaliguori BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
3633f141eafeSaliguori                                   QEMUIOVector *qiov, int nb_sectors,
363483f64091Sbellard                                   BlockDriverCompletionFunc *cb, void *opaque)
36357674e7bfSbellard {
3636bbf0a440SStefan Hajnoczi     trace_bdrv_aio_writev(bs, sector_num, nb_sectors, opaque);
3637bbf0a440SStefan Hajnoczi 
36381a6e115bSStefan Hajnoczi     return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
36398c5873d6SStefan Hajnoczi                                  cb, opaque, true);
364083f64091Sbellard }
364183f64091Sbellard 
364240b4f539SKevin Wolf 
364340b4f539SKevin Wolf typedef struct MultiwriteCB {
364440b4f539SKevin Wolf     int error;
364540b4f539SKevin Wolf     int num_requests;
364640b4f539SKevin Wolf     int num_callbacks;
364740b4f539SKevin Wolf     struct {
364840b4f539SKevin Wolf         BlockDriverCompletionFunc *cb;
364940b4f539SKevin Wolf         void *opaque;
365040b4f539SKevin Wolf         QEMUIOVector *free_qiov;
365140b4f539SKevin Wolf     } callbacks[];
365240b4f539SKevin Wolf } MultiwriteCB;
365340b4f539SKevin Wolf 
365440b4f539SKevin Wolf static void multiwrite_user_cb(MultiwriteCB *mcb)
365540b4f539SKevin Wolf {
365640b4f539SKevin Wolf     int i;
365740b4f539SKevin Wolf 
365840b4f539SKevin Wolf     for (i = 0; i < mcb->num_callbacks; i++) {
365940b4f539SKevin Wolf         mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
36601e1ea48dSStefan Hajnoczi         if (mcb->callbacks[i].free_qiov) {
36611e1ea48dSStefan Hajnoczi             qemu_iovec_destroy(mcb->callbacks[i].free_qiov);
36621e1ea48dSStefan Hajnoczi         }
36637267c094SAnthony Liguori         g_free(mcb->callbacks[i].free_qiov);
366440b4f539SKevin Wolf     }
366540b4f539SKevin Wolf }
366640b4f539SKevin Wolf 
366740b4f539SKevin Wolf static void multiwrite_cb(void *opaque, int ret)
366840b4f539SKevin Wolf {
366940b4f539SKevin Wolf     MultiwriteCB *mcb = opaque;
367040b4f539SKevin Wolf 
36716d519a5fSStefan Hajnoczi     trace_multiwrite_cb(mcb, ret);
36726d519a5fSStefan Hajnoczi 
3673cb6d3ca0SKevin Wolf     if (ret < 0 && !mcb->error) {
367440b4f539SKevin Wolf         mcb->error = ret;
367540b4f539SKevin Wolf     }
367640b4f539SKevin Wolf 
367740b4f539SKevin Wolf     mcb->num_requests--;
367840b4f539SKevin Wolf     if (mcb->num_requests == 0) {
367940b4f539SKevin Wolf         multiwrite_user_cb(mcb);
36807267c094SAnthony Liguori         g_free(mcb);
368140b4f539SKevin Wolf     }
368240b4f539SKevin Wolf }
368340b4f539SKevin Wolf 
368440b4f539SKevin Wolf static int multiwrite_req_compare(const void *a, const void *b)
368540b4f539SKevin Wolf {
368677be4366SChristoph Hellwig     const BlockRequest *req1 = a, *req2 = b;
368777be4366SChristoph Hellwig 
368877be4366SChristoph Hellwig     /*
368977be4366SChristoph Hellwig      * Note that we can't simply subtract req2->sector from req1->sector
369077be4366SChristoph Hellwig      * here as that could overflow the return value.
369177be4366SChristoph Hellwig      */
369277be4366SChristoph Hellwig     if (req1->sector > req2->sector) {
369377be4366SChristoph Hellwig         return 1;
369477be4366SChristoph Hellwig     } else if (req1->sector < req2->sector) {
369577be4366SChristoph Hellwig         return -1;
369677be4366SChristoph Hellwig     } else {
369777be4366SChristoph Hellwig         return 0;
369877be4366SChristoph Hellwig     }
369940b4f539SKevin Wolf }
370040b4f539SKevin Wolf 
370140b4f539SKevin Wolf /*
370240b4f539SKevin Wolf  * Takes a bunch of requests and tries to merge them. Returns the number of
370340b4f539SKevin Wolf  * requests that remain after merging.
370440b4f539SKevin Wolf  */
370540b4f539SKevin Wolf static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
370640b4f539SKevin Wolf     int num_reqs, MultiwriteCB *mcb)
370740b4f539SKevin Wolf {
370840b4f539SKevin Wolf     int i, outidx;
370940b4f539SKevin Wolf 
371040b4f539SKevin Wolf     // Sort requests by start sector
371140b4f539SKevin Wolf     qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);
371240b4f539SKevin Wolf 
371340b4f539SKevin Wolf     // Check if adjacent requests touch the same clusters. If so, combine them,
371440b4f539SKevin Wolf     // filling up gaps with zero sectors.
371540b4f539SKevin Wolf     outidx = 0;
371640b4f539SKevin Wolf     for (i = 1; i < num_reqs; i++) {
371740b4f539SKevin Wolf         int merge = 0;
371840b4f539SKevin Wolf         int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;
371940b4f539SKevin Wolf 
3720b6a127a1SPaolo Bonzini         // Handle exactly sequential writes and overlapping writes.
372140b4f539SKevin Wolf         if (reqs[i].sector <= oldreq_last) {
372240b4f539SKevin Wolf             merge = 1;
372340b4f539SKevin Wolf         }
372440b4f539SKevin Wolf 
3725e2a305fbSChristoph Hellwig         if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
3726e2a305fbSChristoph Hellwig             merge = 0;
3727e2a305fbSChristoph Hellwig         }
3728e2a305fbSChristoph Hellwig 
372940b4f539SKevin Wolf         if (merge) {
373040b4f539SKevin Wolf             size_t size;
37317267c094SAnthony Liguori             QEMUIOVector *qiov = g_malloc0(sizeof(*qiov));
373240b4f539SKevin Wolf             qemu_iovec_init(qiov,
373340b4f539SKevin Wolf                 reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);
373440b4f539SKevin Wolf 
373540b4f539SKevin Wolf             // Add the first request to the merged one. If the requests are
373640b4f539SKevin Wolf             // overlapping, drop the last sectors of the first request.
373740b4f539SKevin Wolf             size = (reqs[i].sector - reqs[outidx].sector) << 9;
37381b093c48SMichael Tokarev             qemu_iovec_concat(qiov, reqs[outidx].qiov, 0, size);
373940b4f539SKevin Wolf 
3740b6a127a1SPaolo Bonzini             // We should need to add any zeros between the two requests
3741b6a127a1SPaolo Bonzini             assert (reqs[i].sector <= oldreq_last);
374240b4f539SKevin Wolf 
374340b4f539SKevin Wolf             // Add the second request
37441b093c48SMichael Tokarev             qemu_iovec_concat(qiov, reqs[i].qiov, 0, reqs[i].qiov->size);
374540b4f539SKevin Wolf 
3746cbf1dff2SKevin Wolf             reqs[outidx].nb_sectors = qiov->size >> 9;
374740b4f539SKevin Wolf             reqs[outidx].qiov = qiov;
374840b4f539SKevin Wolf 
374940b4f539SKevin Wolf             mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
375040b4f539SKevin Wolf         } else {
375140b4f539SKevin Wolf             outidx++;
375240b4f539SKevin Wolf             reqs[outidx].sector     = reqs[i].sector;
375340b4f539SKevin Wolf             reqs[outidx].nb_sectors = reqs[i].nb_sectors;
375440b4f539SKevin Wolf             reqs[outidx].qiov       = reqs[i].qiov;
375540b4f539SKevin Wolf         }
375640b4f539SKevin Wolf     }
375740b4f539SKevin Wolf 
375840b4f539SKevin Wolf     return outidx + 1;
375940b4f539SKevin Wolf }
376040b4f539SKevin Wolf 
376140b4f539SKevin Wolf /*
376240b4f539SKevin Wolf  * Submit multiple AIO write requests at once.
376340b4f539SKevin Wolf  *
376440b4f539SKevin Wolf  * On success, the function returns 0 and all requests in the reqs array have
376540b4f539SKevin Wolf  * been submitted. In error case this function returns -1, and any of the
376640b4f539SKevin Wolf  * requests may or may not be submitted yet. In particular, this means that the
376740b4f539SKevin Wolf  * callback will be called for some of the requests, for others it won't. The
376840b4f539SKevin Wolf  * caller must check the error field of the BlockRequest to wait for the right
376940b4f539SKevin Wolf  * callbacks (if error != 0, no callback will be called).
377040b4f539SKevin Wolf  *
377140b4f539SKevin Wolf  * The implementation may modify the contents of the reqs array, e.g. to merge
377240b4f539SKevin Wolf  * requests. However, the fields opaque and error are left unmodified as they
377340b4f539SKevin Wolf  * are used to signal failure for a single request to the caller.
377440b4f539SKevin Wolf  */
377540b4f539SKevin Wolf int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
377640b4f539SKevin Wolf {
377740b4f539SKevin Wolf     MultiwriteCB *mcb;
377840b4f539SKevin Wolf     int i;
377940b4f539SKevin Wolf 
3780301db7c2SRyan Harper     /* don't submit writes if we don't have a medium */
3781301db7c2SRyan Harper     if (bs->drv == NULL) {
3782301db7c2SRyan Harper         for (i = 0; i < num_reqs; i++) {
3783301db7c2SRyan Harper             reqs[i].error = -ENOMEDIUM;
3784301db7c2SRyan Harper         }
3785301db7c2SRyan Harper         return -1;
3786301db7c2SRyan Harper     }
3787301db7c2SRyan Harper 
378840b4f539SKevin Wolf     if (num_reqs == 0) {
378940b4f539SKevin Wolf         return 0;
379040b4f539SKevin Wolf     }
379140b4f539SKevin Wolf 
379240b4f539SKevin Wolf     // Create MultiwriteCB structure
37937267c094SAnthony Liguori     mcb = g_malloc0(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
379440b4f539SKevin Wolf     mcb->num_requests = 0;
379540b4f539SKevin Wolf     mcb->num_callbacks = num_reqs;
379640b4f539SKevin Wolf 
379740b4f539SKevin Wolf     for (i = 0; i < num_reqs; i++) {
379840b4f539SKevin Wolf         mcb->callbacks[i].cb = reqs[i].cb;
379940b4f539SKevin Wolf         mcb->callbacks[i].opaque = reqs[i].opaque;
380040b4f539SKevin Wolf     }
380140b4f539SKevin Wolf 
380240b4f539SKevin Wolf     // Check for mergable requests
380340b4f539SKevin Wolf     num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);
380440b4f539SKevin Wolf 
38056d519a5fSStefan Hajnoczi     trace_bdrv_aio_multiwrite(mcb, mcb->num_callbacks, num_reqs);
38066d519a5fSStefan Hajnoczi 
3807df9309fbSPaolo Bonzini     /* Run the aio requests. */
3808df9309fbSPaolo Bonzini     mcb->num_requests = num_reqs;
380940b4f539SKevin Wolf     for (i = 0; i < num_reqs; i++) {
3810ad54ae80SPaolo Bonzini         bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
381140b4f539SKevin Wolf             reqs[i].nb_sectors, multiwrite_cb, mcb);
381240b4f539SKevin Wolf     }
381340b4f539SKevin Wolf 
381440b4f539SKevin Wolf     return 0;
381540b4f539SKevin Wolf }
381640b4f539SKevin Wolf 
381783f64091Sbellard void bdrv_aio_cancel(BlockDriverAIOCB *acb)
381883f64091Sbellard {
3819d7331bedSStefan Hajnoczi     acb->aiocb_info->cancel(acb);
382083f64091Sbellard }
382183f64091Sbellard 
382298f90dbaSZhi Yong Wu /* block I/O throttling */
382398f90dbaSZhi Yong Wu static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
382498f90dbaSZhi Yong Wu                  bool is_write, double elapsed_time, uint64_t *wait)
382598f90dbaSZhi Yong Wu {
382698f90dbaSZhi Yong Wu     uint64_t bps_limit = 0;
3827ae29d6c6SStefan Hajnoczi     uint64_t extension;
382898f90dbaSZhi Yong Wu     double   bytes_limit, bytes_base, bytes_res;
382998f90dbaSZhi Yong Wu     double   slice_time, wait_time;
383098f90dbaSZhi Yong Wu 
383198f90dbaSZhi Yong Wu     if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
383298f90dbaSZhi Yong Wu         bps_limit = bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
383398f90dbaSZhi Yong Wu     } else if (bs->io_limits.bps[is_write]) {
383498f90dbaSZhi Yong Wu         bps_limit = bs->io_limits.bps[is_write];
383598f90dbaSZhi Yong Wu     } else {
383698f90dbaSZhi Yong Wu         if (wait) {
383798f90dbaSZhi Yong Wu             *wait = 0;
383898f90dbaSZhi Yong Wu         }
383998f90dbaSZhi Yong Wu 
384098f90dbaSZhi Yong Wu         return false;
384198f90dbaSZhi Yong Wu     }
384298f90dbaSZhi Yong Wu 
384398f90dbaSZhi Yong Wu     slice_time = bs->slice_end - bs->slice_start;
384498f90dbaSZhi Yong Wu     slice_time /= (NANOSECONDS_PER_SECOND);
384598f90dbaSZhi Yong Wu     bytes_limit = bps_limit * slice_time;
38465905fbc9SStefan Hajnoczi     bytes_base  = bs->slice_submitted.bytes[is_write];
384798f90dbaSZhi Yong Wu     if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
38485905fbc9SStefan Hajnoczi         bytes_base += bs->slice_submitted.bytes[!is_write];
384998f90dbaSZhi Yong Wu     }
385098f90dbaSZhi Yong Wu 
385198f90dbaSZhi Yong Wu     /* bytes_base: the bytes of data which have been read/written; and
385298f90dbaSZhi Yong Wu      *             it is obtained from the history statistic info.
385398f90dbaSZhi Yong Wu      * bytes_res: the remaining bytes of data which need to be read/written.
385498f90dbaSZhi Yong Wu      * (bytes_base + bytes_res) / bps_limit: used to calcuate
385598f90dbaSZhi Yong Wu      *             the total time for completing reading/writting all data.
385698f90dbaSZhi Yong Wu      */
385798f90dbaSZhi Yong Wu     bytes_res   = (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
385898f90dbaSZhi Yong Wu 
385998f90dbaSZhi Yong Wu     if (bytes_base + bytes_res <= bytes_limit) {
386098f90dbaSZhi Yong Wu         if (wait) {
386198f90dbaSZhi Yong Wu             *wait = 0;
386298f90dbaSZhi Yong Wu         }
386398f90dbaSZhi Yong Wu 
386498f90dbaSZhi Yong Wu         return false;
386598f90dbaSZhi Yong Wu     }
386698f90dbaSZhi Yong Wu 
386798f90dbaSZhi Yong Wu     /* Calc approx time to dispatch */
386898f90dbaSZhi Yong Wu     wait_time = (bytes_base + bytes_res) / bps_limit - elapsed_time;
386998f90dbaSZhi Yong Wu 
387098f90dbaSZhi Yong Wu     /* When the I/O rate at runtime exceeds the limits,
387198f90dbaSZhi Yong Wu      * bs->slice_end need to be extended in order that the current statistic
387298f90dbaSZhi Yong Wu      * info can be kept until the timer fire, so it is increased and tuned
387398f90dbaSZhi Yong Wu      * based on the result of experiment.
387498f90dbaSZhi Yong Wu      */
3875ae29d6c6SStefan Hajnoczi     extension = wait_time * NANOSECONDS_PER_SECOND;
3876ae29d6c6SStefan Hajnoczi     extension = DIV_ROUND_UP(extension, BLOCK_IO_SLICE_TIME) *
3877ae29d6c6SStefan Hajnoczi                 BLOCK_IO_SLICE_TIME;
3878ae29d6c6SStefan Hajnoczi     bs->slice_end += extension;
387998f90dbaSZhi Yong Wu     if (wait) {
38800775437fSStefan Hajnoczi         *wait = wait_time * NANOSECONDS_PER_SECOND;
388198f90dbaSZhi Yong Wu     }
388298f90dbaSZhi Yong Wu 
388398f90dbaSZhi Yong Wu     return true;
388498f90dbaSZhi Yong Wu }
388598f90dbaSZhi Yong Wu 
388698f90dbaSZhi Yong Wu static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
388798f90dbaSZhi Yong Wu                              double elapsed_time, uint64_t *wait)
388898f90dbaSZhi Yong Wu {
388998f90dbaSZhi Yong Wu     uint64_t iops_limit = 0;
389098f90dbaSZhi Yong Wu     double   ios_limit, ios_base;
389198f90dbaSZhi Yong Wu     double   slice_time, wait_time;
389298f90dbaSZhi Yong Wu 
389398f90dbaSZhi Yong Wu     if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
389498f90dbaSZhi Yong Wu         iops_limit = bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
389598f90dbaSZhi Yong Wu     } else if (bs->io_limits.iops[is_write]) {
389698f90dbaSZhi Yong Wu         iops_limit = bs->io_limits.iops[is_write];
389798f90dbaSZhi Yong Wu     } else {
389898f90dbaSZhi Yong Wu         if (wait) {
389998f90dbaSZhi Yong Wu             *wait = 0;
390098f90dbaSZhi Yong Wu         }
390198f90dbaSZhi Yong Wu 
390298f90dbaSZhi Yong Wu         return false;
390398f90dbaSZhi Yong Wu     }
390498f90dbaSZhi Yong Wu 
390598f90dbaSZhi Yong Wu     slice_time = bs->slice_end - bs->slice_start;
390698f90dbaSZhi Yong Wu     slice_time /= (NANOSECONDS_PER_SECOND);
390798f90dbaSZhi Yong Wu     ios_limit  = iops_limit * slice_time;
39085905fbc9SStefan Hajnoczi     ios_base   = bs->slice_submitted.ios[is_write];
390998f90dbaSZhi Yong Wu     if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
39105905fbc9SStefan Hajnoczi         ios_base += bs->slice_submitted.ios[!is_write];
391198f90dbaSZhi Yong Wu     }
391298f90dbaSZhi Yong Wu 
391398f90dbaSZhi Yong Wu     if (ios_base + 1 <= ios_limit) {
391498f90dbaSZhi Yong Wu         if (wait) {
391598f90dbaSZhi Yong Wu             *wait = 0;
391698f90dbaSZhi Yong Wu         }
391798f90dbaSZhi Yong Wu 
391898f90dbaSZhi Yong Wu         return false;
391998f90dbaSZhi Yong Wu     }
392098f90dbaSZhi Yong Wu 
39210775437fSStefan Hajnoczi     /* Calc approx time to dispatch, in seconds */
392298f90dbaSZhi Yong Wu     wait_time = (ios_base + 1) / iops_limit;
392398f90dbaSZhi Yong Wu     if (wait_time > elapsed_time) {
392498f90dbaSZhi Yong Wu         wait_time = wait_time - elapsed_time;
392598f90dbaSZhi Yong Wu     } else {
392698f90dbaSZhi Yong Wu         wait_time = 0;
392798f90dbaSZhi Yong Wu     }
392898f90dbaSZhi Yong Wu 
3929ae29d6c6SStefan Hajnoczi     /* Exceeded current slice, extend it by another slice time */
3930ae29d6c6SStefan Hajnoczi     bs->slice_end += BLOCK_IO_SLICE_TIME;
393198f90dbaSZhi Yong Wu     if (wait) {
39320775437fSStefan Hajnoczi         *wait = wait_time * NANOSECONDS_PER_SECOND;
393398f90dbaSZhi Yong Wu     }
393498f90dbaSZhi Yong Wu 
393598f90dbaSZhi Yong Wu     return true;
393698f90dbaSZhi Yong Wu }
393798f90dbaSZhi Yong Wu 
393898f90dbaSZhi Yong Wu static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
393998f90dbaSZhi Yong Wu                            bool is_write, int64_t *wait)
394098f90dbaSZhi Yong Wu {
394198f90dbaSZhi Yong Wu     int64_t  now, max_wait;
394298f90dbaSZhi Yong Wu     uint64_t bps_wait = 0, iops_wait = 0;
394398f90dbaSZhi Yong Wu     double   elapsed_time;
394498f90dbaSZhi Yong Wu     int      bps_ret, iops_ret;
394598f90dbaSZhi Yong Wu 
394698f90dbaSZhi Yong Wu     now = qemu_get_clock_ns(vm_clock);
3947e660fb8bSStefan Hajnoczi     if (now > bs->slice_end) {
394898f90dbaSZhi Yong Wu         bs->slice_start = now;
3949ae29d6c6SStefan Hajnoczi         bs->slice_end   = now + BLOCK_IO_SLICE_TIME;
39505905fbc9SStefan Hajnoczi         memset(&bs->slice_submitted, 0, sizeof(bs->slice_submitted));
395198f90dbaSZhi Yong Wu     }
395298f90dbaSZhi Yong Wu 
395398f90dbaSZhi Yong Wu     elapsed_time  = now - bs->slice_start;
395498f90dbaSZhi Yong Wu     elapsed_time  /= (NANOSECONDS_PER_SECOND);
395598f90dbaSZhi Yong Wu 
395698f90dbaSZhi Yong Wu     bps_ret  = bdrv_exceed_bps_limits(bs, nb_sectors,
395798f90dbaSZhi Yong Wu                                       is_write, elapsed_time, &bps_wait);
395898f90dbaSZhi Yong Wu     iops_ret = bdrv_exceed_iops_limits(bs, is_write,
395998f90dbaSZhi Yong Wu                                       elapsed_time, &iops_wait);
396098f90dbaSZhi Yong Wu     if (bps_ret || iops_ret) {
396198f90dbaSZhi Yong Wu         max_wait = bps_wait > iops_wait ? bps_wait : iops_wait;
396298f90dbaSZhi Yong Wu         if (wait) {
396398f90dbaSZhi Yong Wu             *wait = max_wait;
396498f90dbaSZhi Yong Wu         }
396598f90dbaSZhi Yong Wu 
396698f90dbaSZhi Yong Wu         now = qemu_get_clock_ns(vm_clock);
396798f90dbaSZhi Yong Wu         if (bs->slice_end < now + max_wait) {
396898f90dbaSZhi Yong Wu             bs->slice_end = now + max_wait;
396998f90dbaSZhi Yong Wu         }
397098f90dbaSZhi Yong Wu 
397198f90dbaSZhi Yong Wu         return true;
397298f90dbaSZhi Yong Wu     }
397398f90dbaSZhi Yong Wu 
397498f90dbaSZhi Yong Wu     if (wait) {
397598f90dbaSZhi Yong Wu         *wait = 0;
397698f90dbaSZhi Yong Wu     }
397798f90dbaSZhi Yong Wu 
39785905fbc9SStefan Hajnoczi     bs->slice_submitted.bytes[is_write] += (int64_t)nb_sectors *
39795905fbc9SStefan Hajnoczi                                            BDRV_SECTOR_SIZE;
39805905fbc9SStefan Hajnoczi     bs->slice_submitted.ios[is_write]++;
39815905fbc9SStefan Hajnoczi 
398298f90dbaSZhi Yong Wu     return false;
398398f90dbaSZhi Yong Wu }
398483f64091Sbellard 
398583f64091Sbellard /**************************************************************/
398683f64091Sbellard /* async block device emulation */
398783f64091Sbellard 
3988c16b5a2cSChristoph Hellwig typedef struct BlockDriverAIOCBSync {
3989c16b5a2cSChristoph Hellwig     BlockDriverAIOCB common;
3990c16b5a2cSChristoph Hellwig     QEMUBH *bh;
3991c16b5a2cSChristoph Hellwig     int ret;
3992c16b5a2cSChristoph Hellwig     /* vector translation state */
3993c16b5a2cSChristoph Hellwig     QEMUIOVector *qiov;
3994c16b5a2cSChristoph Hellwig     uint8_t *bounce;
3995c16b5a2cSChristoph Hellwig     int is_write;
3996c16b5a2cSChristoph Hellwig } BlockDriverAIOCBSync;
3997c16b5a2cSChristoph Hellwig 
3998c16b5a2cSChristoph Hellwig static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
3999c16b5a2cSChristoph Hellwig {
4000b666d239SKevin Wolf     BlockDriverAIOCBSync *acb =
4001b666d239SKevin Wolf         container_of(blockacb, BlockDriverAIOCBSync, common);
40026a7ad299SDor Laor     qemu_bh_delete(acb->bh);
400336afc451SAvi Kivity     acb->bh = NULL;
4004c16b5a2cSChristoph Hellwig     qemu_aio_release(acb);
4005c16b5a2cSChristoph Hellwig }
4006c16b5a2cSChristoph Hellwig 
4007d7331bedSStefan Hajnoczi static const AIOCBInfo bdrv_em_aiocb_info = {
4008c16b5a2cSChristoph Hellwig     .aiocb_size         = sizeof(BlockDriverAIOCBSync),
4009c16b5a2cSChristoph Hellwig     .cancel             = bdrv_aio_cancel_em,
4010c16b5a2cSChristoph Hellwig };
4011c16b5a2cSChristoph Hellwig 
401283f64091Sbellard static void bdrv_aio_bh_cb(void *opaque)
4013beac80cdSbellard {
4014ce1a14dcSpbrook     BlockDriverAIOCBSync *acb = opaque;
4015f141eafeSaliguori 
4016f141eafeSaliguori     if (!acb->is_write)
401703396148SMichael Tokarev         qemu_iovec_from_buf(acb->qiov, 0, acb->bounce, acb->qiov->size);
4018ceb42de8Saliguori     qemu_vfree(acb->bounce);
4019ce1a14dcSpbrook     acb->common.cb(acb->common.opaque, acb->ret);
40206a7ad299SDor Laor     qemu_bh_delete(acb->bh);
402136afc451SAvi Kivity     acb->bh = NULL;
4022ce1a14dcSpbrook     qemu_aio_release(acb);
4023beac80cdSbellard }
4024beac80cdSbellard 
4025f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
4026f141eafeSaliguori                                             int64_t sector_num,
4027f141eafeSaliguori                                             QEMUIOVector *qiov,
4028f141eafeSaliguori                                             int nb_sectors,
4029f141eafeSaliguori                                             BlockDriverCompletionFunc *cb,
4030f141eafeSaliguori                                             void *opaque,
4031f141eafeSaliguori                                             int is_write)
4032f141eafeSaliguori 
4033ea2384d3Sbellard {
4034ce1a14dcSpbrook     BlockDriverAIOCBSync *acb;
403583f64091Sbellard 
4036d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_aiocb_info, bs, cb, opaque);
4037f141eafeSaliguori     acb->is_write = is_write;
4038f141eafeSaliguori     acb->qiov = qiov;
4039e268ca52Saliguori     acb->bounce = qemu_blockalign(bs, qiov->size);
4040ce1a14dcSpbrook     acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
4041f141eafeSaliguori 
4042f141eafeSaliguori     if (is_write) {
4043d5e6b161SMichael Tokarev         qemu_iovec_to_buf(acb->qiov, 0, acb->bounce, qiov->size);
40441ed20acfSStefan Hajnoczi         acb->ret = bs->drv->bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
4045f141eafeSaliguori     } else {
40461ed20acfSStefan Hajnoczi         acb->ret = bs->drv->bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
4047f141eafeSaliguori     }
4048f141eafeSaliguori 
4049ce1a14dcSpbrook     qemu_bh_schedule(acb->bh);
4050f141eafeSaliguori 
4051ce1a14dcSpbrook     return &acb->common;
40527a6cba61Spbrook }
40537a6cba61Spbrook 
4054f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
4055f141eafeSaliguori         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
4056ce1a14dcSpbrook         BlockDriverCompletionFunc *cb, void *opaque)
405783f64091Sbellard {
4058f141eafeSaliguori     return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
405983f64091Sbellard }
406083f64091Sbellard 
4061f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
4062f141eafeSaliguori         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
4063f141eafeSaliguori         BlockDriverCompletionFunc *cb, void *opaque)
4064f141eafeSaliguori {
4065f141eafeSaliguori     return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
4066f141eafeSaliguori }
4067f141eafeSaliguori 
406868485420SKevin Wolf 
406968485420SKevin Wolf typedef struct BlockDriverAIOCBCoroutine {
407068485420SKevin Wolf     BlockDriverAIOCB common;
407168485420SKevin Wolf     BlockRequest req;
407268485420SKevin Wolf     bool is_write;
4073d318aea9SKevin Wolf     bool *done;
407468485420SKevin Wolf     QEMUBH* bh;
407568485420SKevin Wolf } BlockDriverAIOCBCoroutine;
407668485420SKevin Wolf 
407768485420SKevin Wolf static void bdrv_aio_co_cancel_em(BlockDriverAIOCB *blockacb)
407868485420SKevin Wolf {
4079d318aea9SKevin Wolf     BlockDriverAIOCBCoroutine *acb =
4080d318aea9SKevin Wolf         container_of(blockacb, BlockDriverAIOCBCoroutine, common);
4081d318aea9SKevin Wolf     bool done = false;
4082d318aea9SKevin Wolf 
4083d318aea9SKevin Wolf     acb->done = &done;
4084d318aea9SKevin Wolf     while (!done) {
4085d318aea9SKevin Wolf         qemu_aio_wait();
4086d318aea9SKevin Wolf     }
408768485420SKevin Wolf }
408868485420SKevin Wolf 
4089d7331bedSStefan Hajnoczi static const AIOCBInfo bdrv_em_co_aiocb_info = {
409068485420SKevin Wolf     .aiocb_size         = sizeof(BlockDriverAIOCBCoroutine),
409168485420SKevin Wolf     .cancel             = bdrv_aio_co_cancel_em,
409268485420SKevin Wolf };
409368485420SKevin Wolf 
409435246a68SPaolo Bonzini static void bdrv_co_em_bh(void *opaque)
409568485420SKevin Wolf {
409668485420SKevin Wolf     BlockDriverAIOCBCoroutine *acb = opaque;
409768485420SKevin Wolf 
409868485420SKevin Wolf     acb->common.cb(acb->common.opaque, acb->req.error);
4099d318aea9SKevin Wolf 
4100d318aea9SKevin Wolf     if (acb->done) {
4101d318aea9SKevin Wolf         *acb->done = true;
4102d318aea9SKevin Wolf     }
4103d318aea9SKevin Wolf 
410468485420SKevin Wolf     qemu_bh_delete(acb->bh);
410568485420SKevin Wolf     qemu_aio_release(acb);
410668485420SKevin Wolf }
410768485420SKevin Wolf 
4108b2a61371SStefan Hajnoczi /* Invoke bdrv_co_do_readv/bdrv_co_do_writev */
4109b2a61371SStefan Hajnoczi static void coroutine_fn bdrv_co_do_rw(void *opaque)
4110b2a61371SStefan Hajnoczi {
4111b2a61371SStefan Hajnoczi     BlockDriverAIOCBCoroutine *acb = opaque;
4112b2a61371SStefan Hajnoczi     BlockDriverState *bs = acb->common.bs;
4113b2a61371SStefan Hajnoczi 
4114b2a61371SStefan Hajnoczi     if (!acb->is_write) {
4115b2a61371SStefan Hajnoczi         acb->req.error = bdrv_co_do_readv(bs, acb->req.sector,
4116470c0504SStefan Hajnoczi             acb->req.nb_sectors, acb->req.qiov, 0);
4117b2a61371SStefan Hajnoczi     } else {
4118b2a61371SStefan Hajnoczi         acb->req.error = bdrv_co_do_writev(bs, acb->req.sector,
4119f08f2ddaSStefan Hajnoczi             acb->req.nb_sectors, acb->req.qiov, 0);
4120b2a61371SStefan Hajnoczi     }
4121b2a61371SStefan Hajnoczi 
412235246a68SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
4123b2a61371SStefan Hajnoczi     qemu_bh_schedule(acb->bh);
4124b2a61371SStefan Hajnoczi }
4125b2a61371SStefan Hajnoczi 
412668485420SKevin Wolf static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
412768485420SKevin Wolf                                                int64_t sector_num,
412868485420SKevin Wolf                                                QEMUIOVector *qiov,
412968485420SKevin Wolf                                                int nb_sectors,
413068485420SKevin Wolf                                                BlockDriverCompletionFunc *cb,
413168485420SKevin Wolf                                                void *opaque,
41328c5873d6SStefan Hajnoczi                                                bool is_write)
413368485420SKevin Wolf {
413468485420SKevin Wolf     Coroutine *co;
413568485420SKevin Wolf     BlockDriverAIOCBCoroutine *acb;
413668485420SKevin Wolf 
4137d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
413868485420SKevin Wolf     acb->req.sector = sector_num;
413968485420SKevin Wolf     acb->req.nb_sectors = nb_sectors;
414068485420SKevin Wolf     acb->req.qiov = qiov;
414168485420SKevin Wolf     acb->is_write = is_write;
4142d318aea9SKevin Wolf     acb->done = NULL;
414368485420SKevin Wolf 
41448c5873d6SStefan Hajnoczi     co = qemu_coroutine_create(bdrv_co_do_rw);
414568485420SKevin Wolf     qemu_coroutine_enter(co, acb);
414668485420SKevin Wolf 
414768485420SKevin Wolf     return &acb->common;
414868485420SKevin Wolf }
414968485420SKevin Wolf 
415007f07615SPaolo Bonzini static void coroutine_fn bdrv_aio_flush_co_entry(void *opaque)
4151b2e12bc6SChristoph Hellwig {
415207f07615SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb = opaque;
415307f07615SPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
4154b2e12bc6SChristoph Hellwig 
415507f07615SPaolo Bonzini     acb->req.error = bdrv_co_flush(bs);
415607f07615SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
4157b2e12bc6SChristoph Hellwig     qemu_bh_schedule(acb->bh);
4158b2e12bc6SChristoph Hellwig }
4159b2e12bc6SChristoph Hellwig 
416007f07615SPaolo Bonzini BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
4161016f5cf6SAlexander Graf         BlockDriverCompletionFunc *cb, void *opaque)
4162016f5cf6SAlexander Graf {
416307f07615SPaolo Bonzini     trace_bdrv_aio_flush(bs, opaque);
4164016f5cf6SAlexander Graf 
416507f07615SPaolo Bonzini     Coroutine *co;
416607f07615SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb;
4167016f5cf6SAlexander Graf 
4168d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
4169d318aea9SKevin Wolf     acb->done = NULL;
4170d318aea9SKevin Wolf 
417107f07615SPaolo Bonzini     co = qemu_coroutine_create(bdrv_aio_flush_co_entry);
417207f07615SPaolo Bonzini     qemu_coroutine_enter(co, acb);
4173016f5cf6SAlexander Graf 
4174016f5cf6SAlexander Graf     return &acb->common;
4175016f5cf6SAlexander Graf }
4176016f5cf6SAlexander Graf 
41774265d620SPaolo Bonzini static void coroutine_fn bdrv_aio_discard_co_entry(void *opaque)
41784265d620SPaolo Bonzini {
41794265d620SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb = opaque;
41804265d620SPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
41814265d620SPaolo Bonzini 
41824265d620SPaolo Bonzini     acb->req.error = bdrv_co_discard(bs, acb->req.sector, acb->req.nb_sectors);
41834265d620SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
41844265d620SPaolo Bonzini     qemu_bh_schedule(acb->bh);
41854265d620SPaolo Bonzini }
41864265d620SPaolo Bonzini 
41874265d620SPaolo Bonzini BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
41884265d620SPaolo Bonzini         int64_t sector_num, int nb_sectors,
41894265d620SPaolo Bonzini         BlockDriverCompletionFunc *cb, void *opaque)
41904265d620SPaolo Bonzini {
41914265d620SPaolo Bonzini     Coroutine *co;
41924265d620SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb;
41934265d620SPaolo Bonzini 
41944265d620SPaolo Bonzini     trace_bdrv_aio_discard(bs, sector_num, nb_sectors, opaque);
41954265d620SPaolo Bonzini 
4196d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
41974265d620SPaolo Bonzini     acb->req.sector = sector_num;
41984265d620SPaolo Bonzini     acb->req.nb_sectors = nb_sectors;
4199d318aea9SKevin Wolf     acb->done = NULL;
42004265d620SPaolo Bonzini     co = qemu_coroutine_create(bdrv_aio_discard_co_entry);
42014265d620SPaolo Bonzini     qemu_coroutine_enter(co, acb);
42024265d620SPaolo Bonzini 
42034265d620SPaolo Bonzini     return &acb->common;
42044265d620SPaolo Bonzini }
42054265d620SPaolo Bonzini 
4206ea2384d3Sbellard void bdrv_init(void)
4207ea2384d3Sbellard {
42085efa9d5aSAnthony Liguori     module_call_init(MODULE_INIT_BLOCK);
4209ea2384d3Sbellard }
4210ce1a14dcSpbrook 
4211eb852011SMarkus Armbruster void bdrv_init_with_whitelist(void)
4212eb852011SMarkus Armbruster {
4213eb852011SMarkus Armbruster     use_bdrv_whitelist = 1;
4214eb852011SMarkus Armbruster     bdrv_init();
4215eb852011SMarkus Armbruster }
4216eb852011SMarkus Armbruster 
4217d7331bedSStefan Hajnoczi void *qemu_aio_get(const AIOCBInfo *aiocb_info, BlockDriverState *bs,
42186bbff9a0Saliguori                    BlockDriverCompletionFunc *cb, void *opaque)
42196bbff9a0Saliguori {
4220ce1a14dcSpbrook     BlockDriverAIOCB *acb;
4221ce1a14dcSpbrook 
4222d7331bedSStefan Hajnoczi     acb = g_slice_alloc(aiocb_info->aiocb_size);
4223d7331bedSStefan Hajnoczi     acb->aiocb_info = aiocb_info;
4224ce1a14dcSpbrook     acb->bs = bs;
4225ce1a14dcSpbrook     acb->cb = cb;
4226ce1a14dcSpbrook     acb->opaque = opaque;
4227ce1a14dcSpbrook     return acb;
4228ce1a14dcSpbrook }
4229ce1a14dcSpbrook 
4230ce1a14dcSpbrook void qemu_aio_release(void *p)
4231ce1a14dcSpbrook {
4232d37c975fSStefan Hajnoczi     BlockDriverAIOCB *acb = p;
4233d7331bedSStefan Hajnoczi     g_slice_free1(acb->aiocb_info->aiocb_size, acb);
4234ce1a14dcSpbrook }
423519cb3738Sbellard 
423619cb3738Sbellard /**************************************************************/
4237f9f05dc5SKevin Wolf /* Coroutine block device emulation */
4238f9f05dc5SKevin Wolf 
4239f9f05dc5SKevin Wolf typedef struct CoroutineIOCompletion {
4240f9f05dc5SKevin Wolf     Coroutine *coroutine;
4241f9f05dc5SKevin Wolf     int ret;
4242f9f05dc5SKevin Wolf } CoroutineIOCompletion;
4243f9f05dc5SKevin Wolf 
4244f9f05dc5SKevin Wolf static void bdrv_co_io_em_complete(void *opaque, int ret)
4245f9f05dc5SKevin Wolf {
4246f9f05dc5SKevin Wolf     CoroutineIOCompletion *co = opaque;
4247f9f05dc5SKevin Wolf 
4248f9f05dc5SKevin Wolf     co->ret = ret;
4249f9f05dc5SKevin Wolf     qemu_coroutine_enter(co->coroutine, NULL);
4250f9f05dc5SKevin Wolf }
4251f9f05dc5SKevin Wolf 
4252f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_io_em(BlockDriverState *bs, int64_t sector_num,
4253f9f05dc5SKevin Wolf                                       int nb_sectors, QEMUIOVector *iov,
4254f9f05dc5SKevin Wolf                                       bool is_write)
4255f9f05dc5SKevin Wolf {
4256f9f05dc5SKevin Wolf     CoroutineIOCompletion co = {
4257f9f05dc5SKevin Wolf         .coroutine = qemu_coroutine_self(),
4258f9f05dc5SKevin Wolf     };
4259f9f05dc5SKevin Wolf     BlockDriverAIOCB *acb;
4260f9f05dc5SKevin Wolf 
4261f9f05dc5SKevin Wolf     if (is_write) {
4262a652d160SStefan Hajnoczi         acb = bs->drv->bdrv_aio_writev(bs, sector_num, iov, nb_sectors,
4263f9f05dc5SKevin Wolf                                        bdrv_co_io_em_complete, &co);
4264f9f05dc5SKevin Wolf     } else {
4265a652d160SStefan Hajnoczi         acb = bs->drv->bdrv_aio_readv(bs, sector_num, iov, nb_sectors,
4266f9f05dc5SKevin Wolf                                       bdrv_co_io_em_complete, &co);
4267f9f05dc5SKevin Wolf     }
4268f9f05dc5SKevin Wolf 
426959370aaaSStefan Hajnoczi     trace_bdrv_co_io_em(bs, sector_num, nb_sectors, is_write, acb);
4270f9f05dc5SKevin Wolf     if (!acb) {
4271f9f05dc5SKevin Wolf         return -EIO;
4272f9f05dc5SKevin Wolf     }
4273f9f05dc5SKevin Wolf     qemu_coroutine_yield();
4274f9f05dc5SKevin Wolf 
4275f9f05dc5SKevin Wolf     return co.ret;
4276f9f05dc5SKevin Wolf }
4277f9f05dc5SKevin Wolf 
4278f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
4279f9f05dc5SKevin Wolf                                          int64_t sector_num, int nb_sectors,
4280f9f05dc5SKevin Wolf                                          QEMUIOVector *iov)
4281f9f05dc5SKevin Wolf {
4282f9f05dc5SKevin Wolf     return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, false);
4283f9f05dc5SKevin Wolf }
4284f9f05dc5SKevin Wolf 
4285f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
4286f9f05dc5SKevin Wolf                                          int64_t sector_num, int nb_sectors,
4287f9f05dc5SKevin Wolf                                          QEMUIOVector *iov)
4288f9f05dc5SKevin Wolf {
4289f9f05dc5SKevin Wolf     return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, true);
4290f9f05dc5SKevin Wolf }
4291f9f05dc5SKevin Wolf 
429207f07615SPaolo Bonzini static void coroutine_fn bdrv_flush_co_entry(void *opaque)
4293e7a8a783SKevin Wolf {
429407f07615SPaolo Bonzini     RwCo *rwco = opaque;
429507f07615SPaolo Bonzini 
429607f07615SPaolo Bonzini     rwco->ret = bdrv_co_flush(rwco->bs);
429707f07615SPaolo Bonzini }
429807f07615SPaolo Bonzini 
429907f07615SPaolo Bonzini int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
430007f07615SPaolo Bonzini {
4301eb489bb1SKevin Wolf     int ret;
4302eb489bb1SKevin Wolf 
430329cdb251SPaolo Bonzini     if (!bs || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
430407f07615SPaolo Bonzini         return 0;
4305eb489bb1SKevin Wolf     }
4306eb489bb1SKevin Wolf 
4307ca716364SKevin Wolf     /* Write back cached data to the OS even with cache=unsafe */
4308eb489bb1SKevin Wolf     if (bs->drv->bdrv_co_flush_to_os) {
4309eb489bb1SKevin Wolf         ret = bs->drv->bdrv_co_flush_to_os(bs);
4310eb489bb1SKevin Wolf         if (ret < 0) {
4311eb489bb1SKevin Wolf             return ret;
4312eb489bb1SKevin Wolf         }
4313eb489bb1SKevin Wolf     }
4314eb489bb1SKevin Wolf 
4315ca716364SKevin Wolf     /* But don't actually force it to the disk with cache=unsafe */
4316ca716364SKevin Wolf     if (bs->open_flags & BDRV_O_NO_FLUSH) {
4317d4c82329SKevin Wolf         goto flush_parent;
4318ca716364SKevin Wolf     }
4319ca716364SKevin Wolf 
4320eb489bb1SKevin Wolf     if (bs->drv->bdrv_co_flush_to_disk) {
432129cdb251SPaolo Bonzini         ret = bs->drv->bdrv_co_flush_to_disk(bs);
432207f07615SPaolo Bonzini     } else if (bs->drv->bdrv_aio_flush) {
432307f07615SPaolo Bonzini         BlockDriverAIOCB *acb;
4324e7a8a783SKevin Wolf         CoroutineIOCompletion co = {
4325e7a8a783SKevin Wolf             .coroutine = qemu_coroutine_self(),
4326e7a8a783SKevin Wolf         };
4327e7a8a783SKevin Wolf 
432807f07615SPaolo Bonzini         acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co);
432907f07615SPaolo Bonzini         if (acb == NULL) {
433029cdb251SPaolo Bonzini             ret = -EIO;
433107f07615SPaolo Bonzini         } else {
4332e7a8a783SKevin Wolf             qemu_coroutine_yield();
433329cdb251SPaolo Bonzini             ret = co.ret;
4334e7a8a783SKevin Wolf         }
433507f07615SPaolo Bonzini     } else {
433607f07615SPaolo Bonzini         /*
433707f07615SPaolo Bonzini          * Some block drivers always operate in either writethrough or unsafe
433807f07615SPaolo Bonzini          * mode and don't support bdrv_flush therefore. Usually qemu doesn't
433907f07615SPaolo Bonzini          * know how the server works (because the behaviour is hardcoded or
434007f07615SPaolo Bonzini          * depends on server-side configuration), so we can't ensure that
434107f07615SPaolo Bonzini          * everything is safe on disk. Returning an error doesn't work because
434207f07615SPaolo Bonzini          * that would break guests even if the server operates in writethrough
434307f07615SPaolo Bonzini          * mode.
434407f07615SPaolo Bonzini          *
434507f07615SPaolo Bonzini          * Let's hope the user knows what he's doing.
434607f07615SPaolo Bonzini          */
434729cdb251SPaolo Bonzini         ret = 0;
434807f07615SPaolo Bonzini     }
434929cdb251SPaolo Bonzini     if (ret < 0) {
435029cdb251SPaolo Bonzini         return ret;
435129cdb251SPaolo Bonzini     }
435229cdb251SPaolo Bonzini 
435329cdb251SPaolo Bonzini     /* Now flush the underlying protocol.  It will also have BDRV_O_NO_FLUSH
435429cdb251SPaolo Bonzini      * in the case of cache=unsafe, so there are no useless flushes.
435529cdb251SPaolo Bonzini      */
4356d4c82329SKevin Wolf flush_parent:
435729cdb251SPaolo Bonzini     return bdrv_co_flush(bs->file);
435807f07615SPaolo Bonzini }
435907f07615SPaolo Bonzini 
43600f15423cSAnthony Liguori void bdrv_invalidate_cache(BlockDriverState *bs)
43610f15423cSAnthony Liguori {
43620f15423cSAnthony Liguori     if (bs->drv && bs->drv->bdrv_invalidate_cache) {
43630f15423cSAnthony Liguori         bs->drv->bdrv_invalidate_cache(bs);
43640f15423cSAnthony Liguori     }
43650f15423cSAnthony Liguori }
43660f15423cSAnthony Liguori 
43670f15423cSAnthony Liguori void bdrv_invalidate_cache_all(void)
43680f15423cSAnthony Liguori {
43690f15423cSAnthony Liguori     BlockDriverState *bs;
43700f15423cSAnthony Liguori 
43710f15423cSAnthony Liguori     QTAILQ_FOREACH(bs, &bdrv_states, list) {
43720f15423cSAnthony Liguori         bdrv_invalidate_cache(bs);
43730f15423cSAnthony Liguori     }
43740f15423cSAnthony Liguori }
43750f15423cSAnthony Liguori 
437607789269SBenoît Canet void bdrv_clear_incoming_migration_all(void)
437707789269SBenoît Canet {
437807789269SBenoît Canet     BlockDriverState *bs;
437907789269SBenoît Canet 
438007789269SBenoît Canet     QTAILQ_FOREACH(bs, &bdrv_states, list) {
438107789269SBenoît Canet         bs->open_flags = bs->open_flags & ~(BDRV_O_INCOMING);
438207789269SBenoît Canet     }
438307789269SBenoît Canet }
438407789269SBenoît Canet 
438507f07615SPaolo Bonzini int bdrv_flush(BlockDriverState *bs)
438607f07615SPaolo Bonzini {
438707f07615SPaolo Bonzini     Coroutine *co;
438807f07615SPaolo Bonzini     RwCo rwco = {
438907f07615SPaolo Bonzini         .bs = bs,
439007f07615SPaolo Bonzini         .ret = NOT_DONE,
439107f07615SPaolo Bonzini     };
439207f07615SPaolo Bonzini 
439307f07615SPaolo Bonzini     if (qemu_in_coroutine()) {
439407f07615SPaolo Bonzini         /* Fast-path if already in coroutine context */
439507f07615SPaolo Bonzini         bdrv_flush_co_entry(&rwco);
439607f07615SPaolo Bonzini     } else {
439707f07615SPaolo Bonzini         co = qemu_coroutine_create(bdrv_flush_co_entry);
439807f07615SPaolo Bonzini         qemu_coroutine_enter(co, &rwco);
439907f07615SPaolo Bonzini         while (rwco.ret == NOT_DONE) {
440007f07615SPaolo Bonzini             qemu_aio_wait();
440107f07615SPaolo Bonzini         }
440207f07615SPaolo Bonzini     }
440307f07615SPaolo Bonzini 
440407f07615SPaolo Bonzini     return rwco.ret;
440507f07615SPaolo Bonzini }
4406e7a8a783SKevin Wolf 
44074265d620SPaolo Bonzini static void coroutine_fn bdrv_discard_co_entry(void *opaque)
44084265d620SPaolo Bonzini {
44094265d620SPaolo Bonzini     RwCo *rwco = opaque;
44104265d620SPaolo Bonzini 
44114265d620SPaolo Bonzini     rwco->ret = bdrv_co_discard(rwco->bs, rwco->sector_num, rwco->nb_sectors);
44124265d620SPaolo Bonzini }
44134265d620SPaolo Bonzini 
44144265d620SPaolo Bonzini int coroutine_fn bdrv_co_discard(BlockDriverState *bs, int64_t sector_num,
44154265d620SPaolo Bonzini                                  int nb_sectors)
44164265d620SPaolo Bonzini {
44174265d620SPaolo Bonzini     if (!bs->drv) {
44184265d620SPaolo Bonzini         return -ENOMEDIUM;
44194265d620SPaolo Bonzini     } else if (bdrv_check_request(bs, sector_num, nb_sectors)) {
44204265d620SPaolo Bonzini         return -EIO;
44214265d620SPaolo Bonzini     } else if (bs->read_only) {
44224265d620SPaolo Bonzini         return -EROFS;
4423df702c9bSPaolo Bonzini     }
4424df702c9bSPaolo Bonzini 
4425df702c9bSPaolo Bonzini     if (bs->dirty_bitmap) {
44268f0720ecSPaolo Bonzini         bdrv_reset_dirty(bs, sector_num, nb_sectors);
4427df702c9bSPaolo Bonzini     }
4428df702c9bSPaolo Bonzini 
44299e8f1835SPaolo Bonzini     /* Do nothing if disabled.  */
44309e8f1835SPaolo Bonzini     if (!(bs->open_flags & BDRV_O_UNMAP)) {
44319e8f1835SPaolo Bonzini         return 0;
44329e8f1835SPaolo Bonzini     }
44339e8f1835SPaolo Bonzini 
4434df702c9bSPaolo Bonzini     if (bs->drv->bdrv_co_discard) {
44354265d620SPaolo Bonzini         return bs->drv->bdrv_co_discard(bs, sector_num, nb_sectors);
44364265d620SPaolo Bonzini     } else if (bs->drv->bdrv_aio_discard) {
44374265d620SPaolo Bonzini         BlockDriverAIOCB *acb;
44384265d620SPaolo Bonzini         CoroutineIOCompletion co = {
44394265d620SPaolo Bonzini             .coroutine = qemu_coroutine_self(),
44404265d620SPaolo Bonzini         };
44414265d620SPaolo Bonzini 
44424265d620SPaolo Bonzini         acb = bs->drv->bdrv_aio_discard(bs, sector_num, nb_sectors,
44434265d620SPaolo Bonzini                                         bdrv_co_io_em_complete, &co);
44444265d620SPaolo Bonzini         if (acb == NULL) {
44454265d620SPaolo Bonzini             return -EIO;
44464265d620SPaolo Bonzini         } else {
44474265d620SPaolo Bonzini             qemu_coroutine_yield();
44484265d620SPaolo Bonzini             return co.ret;
44494265d620SPaolo Bonzini         }
44504265d620SPaolo Bonzini     } else {
44514265d620SPaolo Bonzini         return 0;
44524265d620SPaolo Bonzini     }
44534265d620SPaolo Bonzini }
44544265d620SPaolo Bonzini 
44554265d620SPaolo Bonzini int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors)
44564265d620SPaolo Bonzini {
44574265d620SPaolo Bonzini     Coroutine *co;
44584265d620SPaolo Bonzini     RwCo rwco = {
44594265d620SPaolo Bonzini         .bs = bs,
44604265d620SPaolo Bonzini         .sector_num = sector_num,
44614265d620SPaolo Bonzini         .nb_sectors = nb_sectors,
44624265d620SPaolo Bonzini         .ret = NOT_DONE,
44634265d620SPaolo Bonzini     };
44644265d620SPaolo Bonzini 
44654265d620SPaolo Bonzini     if (qemu_in_coroutine()) {
44664265d620SPaolo Bonzini         /* Fast-path if already in coroutine context */
44674265d620SPaolo Bonzini         bdrv_discard_co_entry(&rwco);
44684265d620SPaolo Bonzini     } else {
44694265d620SPaolo Bonzini         co = qemu_coroutine_create(bdrv_discard_co_entry);
44704265d620SPaolo Bonzini         qemu_coroutine_enter(co, &rwco);
44714265d620SPaolo Bonzini         while (rwco.ret == NOT_DONE) {
44724265d620SPaolo Bonzini             qemu_aio_wait();
44734265d620SPaolo Bonzini         }
44744265d620SPaolo Bonzini     }
44754265d620SPaolo Bonzini 
44764265d620SPaolo Bonzini     return rwco.ret;
44774265d620SPaolo Bonzini }
44784265d620SPaolo Bonzini 
4479f9f05dc5SKevin Wolf /**************************************************************/
448019cb3738Sbellard /* removable device support */
448119cb3738Sbellard 
448219cb3738Sbellard /**
448319cb3738Sbellard  * Return TRUE if the media is present
448419cb3738Sbellard  */
448519cb3738Sbellard int bdrv_is_inserted(BlockDriverState *bs)
448619cb3738Sbellard {
448719cb3738Sbellard     BlockDriver *drv = bs->drv;
4488a1aff5bfSMarkus Armbruster 
448919cb3738Sbellard     if (!drv)
449019cb3738Sbellard         return 0;
449119cb3738Sbellard     if (!drv->bdrv_is_inserted)
4492a1aff5bfSMarkus Armbruster         return 1;
4493a1aff5bfSMarkus Armbruster     return drv->bdrv_is_inserted(bs);
449419cb3738Sbellard }
449519cb3738Sbellard 
449619cb3738Sbellard /**
44978e49ca46SMarkus Armbruster  * Return whether the media changed since the last call to this
44988e49ca46SMarkus Armbruster  * function, or -ENOTSUP if we don't know.  Most drivers don't know.
449919cb3738Sbellard  */
450019cb3738Sbellard int bdrv_media_changed(BlockDriverState *bs)
450119cb3738Sbellard {
450219cb3738Sbellard     BlockDriver *drv = bs->drv;
450319cb3738Sbellard 
45048e49ca46SMarkus Armbruster     if (drv && drv->bdrv_media_changed) {
45058e49ca46SMarkus Armbruster         return drv->bdrv_media_changed(bs);
45068e49ca46SMarkus Armbruster     }
45078e49ca46SMarkus Armbruster     return -ENOTSUP;
450819cb3738Sbellard }
450919cb3738Sbellard 
451019cb3738Sbellard /**
451119cb3738Sbellard  * If eject_flag is TRUE, eject the media. Otherwise, close the tray
451219cb3738Sbellard  */
4513f36f3949SLuiz Capitulino void bdrv_eject(BlockDriverState *bs, bool eject_flag)
451419cb3738Sbellard {
451519cb3738Sbellard     BlockDriver *drv = bs->drv;
451619cb3738Sbellard 
4517822e1cd1SMarkus Armbruster     if (drv && drv->bdrv_eject) {
4518822e1cd1SMarkus Armbruster         drv->bdrv_eject(bs, eject_flag);
451919cb3738Sbellard     }
45206f382ed2SLuiz Capitulino 
45216f382ed2SLuiz Capitulino     if (bs->device_name[0] != '\0') {
45226f382ed2SLuiz Capitulino         bdrv_emit_qmp_eject_event(bs, eject_flag);
45236f382ed2SLuiz Capitulino     }
452419cb3738Sbellard }
452519cb3738Sbellard 
452619cb3738Sbellard /**
452719cb3738Sbellard  * Lock or unlock the media (if it is locked, the user won't be able
452819cb3738Sbellard  * to eject it manually).
452919cb3738Sbellard  */
4530025e849aSMarkus Armbruster void bdrv_lock_medium(BlockDriverState *bs, bool locked)
453119cb3738Sbellard {
453219cb3738Sbellard     BlockDriver *drv = bs->drv;
453319cb3738Sbellard 
4534025e849aSMarkus Armbruster     trace_bdrv_lock_medium(bs, locked);
4535b8c6d095SStefan Hajnoczi 
4536025e849aSMarkus Armbruster     if (drv && drv->bdrv_lock_medium) {
4537025e849aSMarkus Armbruster         drv->bdrv_lock_medium(bs, locked);
453819cb3738Sbellard     }
453919cb3738Sbellard }
4540985a03b0Sths 
4541985a03b0Sths /* needed for generic scsi interface */
4542985a03b0Sths 
4543985a03b0Sths int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
4544985a03b0Sths {
4545985a03b0Sths     BlockDriver *drv = bs->drv;
4546985a03b0Sths 
4547985a03b0Sths     if (drv && drv->bdrv_ioctl)
4548985a03b0Sths         return drv->bdrv_ioctl(bs, req, buf);
4549985a03b0Sths     return -ENOTSUP;
4550985a03b0Sths }
45517d780669Saliguori 
4552221f715dSaliguori BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
4553221f715dSaliguori         unsigned long int req, void *buf,
45547d780669Saliguori         BlockDriverCompletionFunc *cb, void *opaque)
45557d780669Saliguori {
4556221f715dSaliguori     BlockDriver *drv = bs->drv;
45577d780669Saliguori 
4558221f715dSaliguori     if (drv && drv->bdrv_aio_ioctl)
4559221f715dSaliguori         return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
4560221f715dSaliguori     return NULL;
45617d780669Saliguori }
4562e268ca52Saliguori 
45637b6f9300SMarkus Armbruster void bdrv_set_buffer_alignment(BlockDriverState *bs, int align)
45647b6f9300SMarkus Armbruster {
45657b6f9300SMarkus Armbruster     bs->buffer_alignment = align;
45667b6f9300SMarkus Armbruster }
45677cd1e32aSlirans@il.ibm.com 
4568e268ca52Saliguori void *qemu_blockalign(BlockDriverState *bs, size_t size)
4569e268ca52Saliguori {
4570e268ca52Saliguori     return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
4571e268ca52Saliguori }
45727cd1e32aSlirans@il.ibm.com 
4573c53b1c51SStefan Hajnoczi /*
4574c53b1c51SStefan Hajnoczi  * Check if all memory in this vector is sector aligned.
4575c53b1c51SStefan Hajnoczi  */
4576c53b1c51SStefan Hajnoczi bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov)
4577c53b1c51SStefan Hajnoczi {
4578c53b1c51SStefan Hajnoczi     int i;
4579c53b1c51SStefan Hajnoczi 
4580c53b1c51SStefan Hajnoczi     for (i = 0; i < qiov->niov; i++) {
4581c53b1c51SStefan Hajnoczi         if ((uintptr_t) qiov->iov[i].iov_base % bs->buffer_alignment) {
4582c53b1c51SStefan Hajnoczi             return false;
4583c53b1c51SStefan Hajnoczi         }
4584c53b1c51SStefan Hajnoczi     }
4585c53b1c51SStefan Hajnoczi 
4586c53b1c51SStefan Hajnoczi     return true;
4587c53b1c51SStefan Hajnoczi }
4588c53b1c51SStefan Hajnoczi 
458950717e94SPaolo Bonzini void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity)
45907cd1e32aSlirans@il.ibm.com {
45917cd1e32aSlirans@il.ibm.com     int64_t bitmap_size;
4592a55eb92cSJan Kiszka 
459350717e94SPaolo Bonzini     assert((granularity & (granularity - 1)) == 0);
459450717e94SPaolo Bonzini 
459550717e94SPaolo Bonzini     if (granularity) {
459650717e94SPaolo Bonzini         granularity >>= BDRV_SECTOR_BITS;
459750717e94SPaolo Bonzini         assert(!bs->dirty_bitmap);
45988f0720ecSPaolo Bonzini         bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS);
459950717e94SPaolo Bonzini         bs->dirty_bitmap = hbitmap_alloc(bitmap_size, ffs(granularity) - 1);
46007cd1e32aSlirans@il.ibm.com     } else {
4601c6d22830SJan Kiszka         if (bs->dirty_bitmap) {
46028f0720ecSPaolo Bonzini             hbitmap_free(bs->dirty_bitmap);
4603c6d22830SJan Kiszka             bs->dirty_bitmap = NULL;
46047cd1e32aSlirans@il.ibm.com         }
46057cd1e32aSlirans@il.ibm.com     }
46067cd1e32aSlirans@il.ibm.com }
46077cd1e32aSlirans@il.ibm.com 
46087cd1e32aSlirans@il.ibm.com int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
46097cd1e32aSlirans@il.ibm.com {
46108f0720ecSPaolo Bonzini     if (bs->dirty_bitmap) {
46118f0720ecSPaolo Bonzini         return hbitmap_get(bs->dirty_bitmap, sector);
46127cd1e32aSlirans@il.ibm.com     } else {
46137cd1e32aSlirans@il.ibm.com         return 0;
46147cd1e32aSlirans@il.ibm.com     }
46157cd1e32aSlirans@il.ibm.com }
46167cd1e32aSlirans@il.ibm.com 
46178f0720ecSPaolo Bonzini void bdrv_dirty_iter_init(BlockDriverState *bs, HBitmapIter *hbi)
46181755da16SPaolo Bonzini {
46198f0720ecSPaolo Bonzini     hbitmap_iter_init(hbi, bs->dirty_bitmap, 0);
46201755da16SPaolo Bonzini }
46211755da16SPaolo Bonzini 
46221755da16SPaolo Bonzini void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector,
46231755da16SPaolo Bonzini                     int nr_sectors)
46241755da16SPaolo Bonzini {
46258f0720ecSPaolo Bonzini     hbitmap_set(bs->dirty_bitmap, cur_sector, nr_sectors);
46261755da16SPaolo Bonzini }
46271755da16SPaolo Bonzini 
46287cd1e32aSlirans@il.ibm.com void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
46297cd1e32aSlirans@il.ibm.com                       int nr_sectors)
46307cd1e32aSlirans@il.ibm.com {
46318f0720ecSPaolo Bonzini     hbitmap_reset(bs->dirty_bitmap, cur_sector, nr_sectors);
46327cd1e32aSlirans@il.ibm.com }
4633aaa0eb75SLiran Schour 
4634aaa0eb75SLiran Schour int64_t bdrv_get_dirty_count(BlockDriverState *bs)
4635aaa0eb75SLiran Schour {
46368f0720ecSPaolo Bonzini     if (bs->dirty_bitmap) {
4637acc906c6SPaolo Bonzini         return hbitmap_count(bs->dirty_bitmap);
46388f0720ecSPaolo Bonzini     } else {
46398f0720ecSPaolo Bonzini         return 0;
46408f0720ecSPaolo Bonzini     }
4641aaa0eb75SLiran Schour }
4642f88e1a42SJes Sorensen 
4643db593f25SMarcelo Tosatti void bdrv_set_in_use(BlockDriverState *bs, int in_use)
4644db593f25SMarcelo Tosatti {
4645db593f25SMarcelo Tosatti     assert(bs->in_use != in_use);
4646db593f25SMarcelo Tosatti     bs->in_use = in_use;
4647db593f25SMarcelo Tosatti }
4648db593f25SMarcelo Tosatti 
4649db593f25SMarcelo Tosatti int bdrv_in_use(BlockDriverState *bs)
4650db593f25SMarcelo Tosatti {
4651db593f25SMarcelo Tosatti     return bs->in_use;
4652db593f25SMarcelo Tosatti }
4653db593f25SMarcelo Tosatti 
465428a7282aSLuiz Capitulino void bdrv_iostatus_enable(BlockDriverState *bs)
465528a7282aSLuiz Capitulino {
4656d6bf279eSLuiz Capitulino     bs->iostatus_enabled = true;
465758e21ef5SLuiz Capitulino     bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
465828a7282aSLuiz Capitulino }
465928a7282aSLuiz Capitulino 
466028a7282aSLuiz Capitulino /* The I/O status is only enabled if the drive explicitly
466128a7282aSLuiz Capitulino  * enables it _and_ the VM is configured to stop on errors */
466228a7282aSLuiz Capitulino bool bdrv_iostatus_is_enabled(const BlockDriverState *bs)
466328a7282aSLuiz Capitulino {
4664d6bf279eSLuiz Capitulino     return (bs->iostatus_enabled &&
466592aa5c6dSPaolo Bonzini            (bs->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
466692aa5c6dSPaolo Bonzini             bs->on_write_error == BLOCKDEV_ON_ERROR_STOP   ||
466792aa5c6dSPaolo Bonzini             bs->on_read_error == BLOCKDEV_ON_ERROR_STOP));
466828a7282aSLuiz Capitulino }
466928a7282aSLuiz Capitulino 
467028a7282aSLuiz Capitulino void bdrv_iostatus_disable(BlockDriverState *bs)
467128a7282aSLuiz Capitulino {
4672d6bf279eSLuiz Capitulino     bs->iostatus_enabled = false;
467328a7282aSLuiz Capitulino }
467428a7282aSLuiz Capitulino 
467528a7282aSLuiz Capitulino void bdrv_iostatus_reset(BlockDriverState *bs)
467628a7282aSLuiz Capitulino {
467728a7282aSLuiz Capitulino     if (bdrv_iostatus_is_enabled(bs)) {
467858e21ef5SLuiz Capitulino         bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
46793bd293c3SPaolo Bonzini         if (bs->job) {
46803bd293c3SPaolo Bonzini             block_job_iostatus_reset(bs->job);
46813bd293c3SPaolo Bonzini         }
468228a7282aSLuiz Capitulino     }
468328a7282aSLuiz Capitulino }
468428a7282aSLuiz Capitulino 
468528a7282aSLuiz Capitulino void bdrv_iostatus_set_err(BlockDriverState *bs, int error)
468628a7282aSLuiz Capitulino {
46873e1caa5fSPaolo Bonzini     assert(bdrv_iostatus_is_enabled(bs));
46883e1caa5fSPaolo Bonzini     if (bs->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
468958e21ef5SLuiz Capitulino         bs->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
469058e21ef5SLuiz Capitulino                                          BLOCK_DEVICE_IO_STATUS_FAILED;
469128a7282aSLuiz Capitulino     }
469228a7282aSLuiz Capitulino }
469328a7282aSLuiz Capitulino 
4694a597e79cSChristoph Hellwig void
4695a597e79cSChristoph Hellwig bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, int64_t bytes,
4696a597e79cSChristoph Hellwig         enum BlockAcctType type)
4697a597e79cSChristoph Hellwig {
4698a597e79cSChristoph Hellwig     assert(type < BDRV_MAX_IOTYPE);
4699a597e79cSChristoph Hellwig 
4700a597e79cSChristoph Hellwig     cookie->bytes = bytes;
4701c488c7f6SChristoph Hellwig     cookie->start_time_ns = get_clock();
4702a597e79cSChristoph Hellwig     cookie->type = type;
4703a597e79cSChristoph Hellwig }
4704a597e79cSChristoph Hellwig 
4705a597e79cSChristoph Hellwig void
4706a597e79cSChristoph Hellwig bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie)
4707a597e79cSChristoph Hellwig {
4708a597e79cSChristoph Hellwig     assert(cookie->type < BDRV_MAX_IOTYPE);
4709a597e79cSChristoph Hellwig 
4710a597e79cSChristoph Hellwig     bs->nr_bytes[cookie->type] += cookie->bytes;
4711a597e79cSChristoph Hellwig     bs->nr_ops[cookie->type]++;
4712c488c7f6SChristoph Hellwig     bs->total_time_ns[cookie->type] += get_clock() - cookie->start_time_ns;
4713a597e79cSChristoph Hellwig }
4714a597e79cSChristoph Hellwig 
4715d92ada22SLuiz Capitulino void bdrv_img_create(const char *filename, const char *fmt,
4716f88e1a42SJes Sorensen                      const char *base_filename, const char *base_fmt,
4717f382d43aSMiroslav Rezanina                      char *options, uint64_t img_size, int flags,
4718f382d43aSMiroslav Rezanina                      Error **errp, bool quiet)
4719f88e1a42SJes Sorensen {
4720f88e1a42SJes Sorensen     QEMUOptionParameter *param = NULL, *create_options = NULL;
4721d220894eSKevin Wolf     QEMUOptionParameter *backing_fmt, *backing_file, *size;
4722f88e1a42SJes Sorensen     BlockDriverState *bs = NULL;
4723f88e1a42SJes Sorensen     BlockDriver *drv, *proto_drv;
472496df67d1SStefan Hajnoczi     BlockDriver *backing_drv = NULL;
4725f88e1a42SJes Sorensen     int ret = 0;
4726f88e1a42SJes Sorensen 
4727f88e1a42SJes Sorensen     /* Find driver and parse its options */
4728f88e1a42SJes Sorensen     drv = bdrv_find_format(fmt);
4729f88e1a42SJes Sorensen     if (!drv) {
473071c79813SLuiz Capitulino         error_setg(errp, "Unknown file format '%s'", fmt);
4731d92ada22SLuiz Capitulino         return;
4732f88e1a42SJes Sorensen     }
4733f88e1a42SJes Sorensen 
4734f88e1a42SJes Sorensen     proto_drv = bdrv_find_protocol(filename);
4735f88e1a42SJes Sorensen     if (!proto_drv) {
473671c79813SLuiz Capitulino         error_setg(errp, "Unknown protocol '%s'", filename);
4737d92ada22SLuiz Capitulino         return;
4738f88e1a42SJes Sorensen     }
4739f88e1a42SJes Sorensen 
4740f88e1a42SJes Sorensen     create_options = append_option_parameters(create_options,
4741f88e1a42SJes Sorensen                                               drv->create_options);
4742f88e1a42SJes Sorensen     create_options = append_option_parameters(create_options,
4743f88e1a42SJes Sorensen                                               proto_drv->create_options);
4744f88e1a42SJes Sorensen 
4745f88e1a42SJes Sorensen     /* Create parameter list with default values */
4746f88e1a42SJes Sorensen     param = parse_option_parameters("", create_options, param);
4747f88e1a42SJes Sorensen 
4748f88e1a42SJes Sorensen     set_option_parameter_int(param, BLOCK_OPT_SIZE, img_size);
4749f88e1a42SJes Sorensen 
4750f88e1a42SJes Sorensen     /* Parse -o options */
4751f88e1a42SJes Sorensen     if (options) {
4752f88e1a42SJes Sorensen         param = parse_option_parameters(options, create_options, param);
4753f88e1a42SJes Sorensen         if (param == NULL) {
475471c79813SLuiz Capitulino             error_setg(errp, "Invalid options for file format '%s'.", fmt);
4755f88e1a42SJes Sorensen             goto out;
4756f88e1a42SJes Sorensen         }
4757f88e1a42SJes Sorensen     }
4758f88e1a42SJes Sorensen 
4759f88e1a42SJes Sorensen     if (base_filename) {
4760f88e1a42SJes Sorensen         if (set_option_parameter(param, BLOCK_OPT_BACKING_FILE,
4761f88e1a42SJes Sorensen                                  base_filename)) {
476271c79813SLuiz Capitulino             error_setg(errp, "Backing file not supported for file format '%s'",
476371c79813SLuiz Capitulino                        fmt);
4764f88e1a42SJes Sorensen             goto out;
4765f88e1a42SJes Sorensen         }
4766f88e1a42SJes Sorensen     }
4767f88e1a42SJes Sorensen 
4768f88e1a42SJes Sorensen     if (base_fmt) {
4769f88e1a42SJes Sorensen         if (set_option_parameter(param, BLOCK_OPT_BACKING_FMT, base_fmt)) {
477071c79813SLuiz Capitulino             error_setg(errp, "Backing file format not supported for file "
477171c79813SLuiz Capitulino                              "format '%s'", fmt);
4772f88e1a42SJes Sorensen             goto out;
4773f88e1a42SJes Sorensen         }
4774f88e1a42SJes Sorensen     }
4775f88e1a42SJes Sorensen 
4776792da93aSJes Sorensen     backing_file = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
4777792da93aSJes Sorensen     if (backing_file && backing_file->value.s) {
4778792da93aSJes Sorensen         if (!strcmp(filename, backing_file->value.s)) {
477971c79813SLuiz Capitulino             error_setg(errp, "Error: Trying to create an image with the "
478071c79813SLuiz Capitulino                              "same filename as the backing file");
4781792da93aSJes Sorensen             goto out;
4782792da93aSJes Sorensen         }
4783792da93aSJes Sorensen     }
4784792da93aSJes Sorensen 
4785f88e1a42SJes Sorensen     backing_fmt = get_option_parameter(param, BLOCK_OPT_BACKING_FMT);
4786f88e1a42SJes Sorensen     if (backing_fmt && backing_fmt->value.s) {
478796df67d1SStefan Hajnoczi         backing_drv = bdrv_find_format(backing_fmt->value.s);
478896df67d1SStefan Hajnoczi         if (!backing_drv) {
478971c79813SLuiz Capitulino             error_setg(errp, "Unknown backing file format '%s'",
479071c79813SLuiz Capitulino                        backing_fmt->value.s);
4791f88e1a42SJes Sorensen             goto out;
4792f88e1a42SJes Sorensen         }
4793f88e1a42SJes Sorensen     }
4794f88e1a42SJes Sorensen 
4795f88e1a42SJes Sorensen     // The size for the image must always be specified, with one exception:
4796f88e1a42SJes Sorensen     // If we are using a backing file, we can obtain the size from there
4797d220894eSKevin Wolf     size = get_option_parameter(param, BLOCK_OPT_SIZE);
4798d220894eSKevin Wolf     if (size && size->value.n == -1) {
4799f88e1a42SJes Sorensen         if (backing_file && backing_file->value.s) {
4800f88e1a42SJes Sorensen             uint64_t size;
4801f88e1a42SJes Sorensen             char buf[32];
480263090dacSPaolo Bonzini             int back_flags;
480363090dacSPaolo Bonzini 
480463090dacSPaolo Bonzini             /* backing files always opened read-only */
480563090dacSPaolo Bonzini             back_flags =
480663090dacSPaolo Bonzini                 flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
4807f88e1a42SJes Sorensen 
4808f88e1a42SJes Sorensen             bs = bdrv_new("");
4809f88e1a42SJes Sorensen 
4810de9c0cecSKevin Wolf             ret = bdrv_open(bs, backing_file->value.s, NULL, back_flags,
4811de9c0cecSKevin Wolf                             backing_drv);
4812f88e1a42SJes Sorensen             if (ret < 0) {
481371c79813SLuiz Capitulino                 error_setg_errno(errp, -ret, "Could not open '%s'",
481471c79813SLuiz Capitulino                                  backing_file->value.s);
4815f88e1a42SJes Sorensen                 goto out;
4816f88e1a42SJes Sorensen             }
4817f88e1a42SJes Sorensen             bdrv_get_geometry(bs, &size);
4818f88e1a42SJes Sorensen             size *= 512;
4819f88e1a42SJes Sorensen 
4820f88e1a42SJes Sorensen             snprintf(buf, sizeof(buf), "%" PRId64, size);
4821f88e1a42SJes Sorensen             set_option_parameter(param, BLOCK_OPT_SIZE, buf);
4822f88e1a42SJes Sorensen         } else {
482371c79813SLuiz Capitulino             error_setg(errp, "Image creation needs a size parameter");
4824f88e1a42SJes Sorensen             goto out;
4825f88e1a42SJes Sorensen         }
4826f88e1a42SJes Sorensen     }
4827f88e1a42SJes Sorensen 
4828f382d43aSMiroslav Rezanina     if (!quiet) {
4829f88e1a42SJes Sorensen         printf("Formatting '%s', fmt=%s ", filename, fmt);
4830f88e1a42SJes Sorensen         print_option_parameters(param);
4831f88e1a42SJes Sorensen         puts("");
4832f382d43aSMiroslav Rezanina     }
4833f88e1a42SJes Sorensen     ret = bdrv_create(drv, filename, param);
4834f88e1a42SJes Sorensen     if (ret < 0) {
4835f88e1a42SJes Sorensen         if (ret == -ENOTSUP) {
483671c79813SLuiz Capitulino             error_setg(errp,"Formatting or formatting option not supported for "
483771c79813SLuiz Capitulino                             "file format '%s'", fmt);
4838f88e1a42SJes Sorensen         } else if (ret == -EFBIG) {
483971c79813SLuiz Capitulino             error_setg(errp, "The image size is too large for file format '%s'",
484071c79813SLuiz Capitulino                        fmt);
4841f88e1a42SJes Sorensen         } else {
484271c79813SLuiz Capitulino             error_setg(errp, "%s: error while creating %s: %s", filename, fmt,
484371c79813SLuiz Capitulino                        strerror(-ret));
4844f88e1a42SJes Sorensen         }
4845f88e1a42SJes Sorensen     }
4846f88e1a42SJes Sorensen 
4847f88e1a42SJes Sorensen out:
4848f88e1a42SJes Sorensen     free_option_parameters(create_options);
4849f88e1a42SJes Sorensen     free_option_parameters(param);
4850f88e1a42SJes Sorensen 
4851f88e1a42SJes Sorensen     if (bs) {
4852f88e1a42SJes Sorensen         bdrv_delete(bs);
4853f88e1a42SJes Sorensen     }
4854f88e1a42SJes Sorensen }
485585d126f3SStefan Hajnoczi 
485685d126f3SStefan Hajnoczi AioContext *bdrv_get_aio_context(BlockDriverState *bs)
485785d126f3SStefan Hajnoczi {
485885d126f3SStefan Hajnoczi     /* Currently BlockDriverState always uses the main loop AioContext */
485985d126f3SStefan Hajnoczi     return qemu_get_aio_context();
486085d126f3SStefan Hajnoczi }
4861