xref: /openbmc/qemu/block.c (revision 2af5ef70af9fdc823407ddc4ae14766806d4837a)
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 {
721*2af5ef70SKevin Wolf         if (file == NULL) {
722*2af5ef70SKevin Wolf             qerror_report(ERROR_CLASS_GENERIC_ERROR, "Can't use '%s' as a "
723*2af5ef70SKevin Wolf                           "block driver for the protocol level",
724*2af5ef70SKevin Wolf                           drv->format_name);
725*2af5ef70SKevin Wolf             ret = -EINVAL;
726*2af5ef70SKevin Wolf             goto free_and_fail;
727*2af5ef70SKevin 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 
8489156df12SPaolo Bonzini int bdrv_open_backing_file(BlockDriverState *bs)
8499156df12SPaolo Bonzini {
8509156df12SPaolo Bonzini     char backing_filename[PATH_MAX];
8519156df12SPaolo Bonzini     int back_flags, ret;
8529156df12SPaolo Bonzini     BlockDriver *back_drv = NULL;
8539156df12SPaolo Bonzini 
8549156df12SPaolo Bonzini     if (bs->backing_hd != NULL) {
8559156df12SPaolo Bonzini         return 0;
8569156df12SPaolo Bonzini     }
8579156df12SPaolo Bonzini 
8589156df12SPaolo Bonzini     bs->open_flags &= ~BDRV_O_NO_BACKING;
8599156df12SPaolo Bonzini     if (bs->backing_file[0] == '\0') {
8609156df12SPaolo Bonzini         return 0;
8619156df12SPaolo Bonzini     }
8629156df12SPaolo Bonzini 
8639156df12SPaolo Bonzini     bs->backing_hd = bdrv_new("");
8649156df12SPaolo Bonzini     bdrv_get_full_backing_filename(bs, backing_filename,
8659156df12SPaolo Bonzini                                    sizeof(backing_filename));
8669156df12SPaolo Bonzini 
8679156df12SPaolo Bonzini     if (bs->backing_format[0] != '\0') {
8689156df12SPaolo Bonzini         back_drv = bdrv_find_format(bs->backing_format);
8699156df12SPaolo Bonzini     }
8709156df12SPaolo Bonzini 
8719156df12SPaolo Bonzini     /* backing files always opened read-only */
8729156df12SPaolo Bonzini     back_flags = bs->open_flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT);
8739156df12SPaolo Bonzini 
874de9c0cecSKevin Wolf     ret = bdrv_open(bs->backing_hd, backing_filename, NULL,
875de9c0cecSKevin Wolf                     back_flags, back_drv);
8769156df12SPaolo Bonzini     if (ret < 0) {
8779156df12SPaolo Bonzini         bdrv_delete(bs->backing_hd);
8789156df12SPaolo Bonzini         bs->backing_hd = NULL;
8799156df12SPaolo Bonzini         bs->open_flags |= BDRV_O_NO_BACKING;
8809156df12SPaolo Bonzini         return ret;
8819156df12SPaolo Bonzini     }
8829156df12SPaolo Bonzini     return 0;
8839156df12SPaolo Bonzini }
8849156df12SPaolo Bonzini 
885707ff828SKevin Wolf static void extract_subqdict(QDict *src, QDict **dst, const char *start)
886707ff828SKevin Wolf {
887707ff828SKevin Wolf     const QDictEntry *entry, *next;
888707ff828SKevin Wolf     const char *p;
889707ff828SKevin Wolf 
890707ff828SKevin Wolf     *dst = qdict_new();
891707ff828SKevin Wolf     entry = qdict_first(src);
892707ff828SKevin Wolf 
893707ff828SKevin Wolf     while (entry != NULL) {
894707ff828SKevin Wolf         next = qdict_next(src, entry);
895707ff828SKevin Wolf         if (strstart(entry->key, start, &p)) {
896707ff828SKevin Wolf             qobject_incref(entry->value);
897707ff828SKevin Wolf             qdict_put_obj(*dst, p, entry->value);
898707ff828SKevin Wolf             qdict_del(src, entry->key);
899707ff828SKevin Wolf         }
900707ff828SKevin Wolf         entry = next;
901707ff828SKevin Wolf     }
902707ff828SKevin Wolf }
903707ff828SKevin Wolf 
904b6ce07aaSKevin Wolf /*
905b6ce07aaSKevin Wolf  * Opens a disk image (raw, qcow2, vmdk, ...)
906de9c0cecSKevin Wolf  *
907de9c0cecSKevin Wolf  * options is a QDict of options to pass to the block drivers, or NULL for an
908de9c0cecSKevin Wolf  * empty set of options. The reference to the QDict belongs to the block layer
909de9c0cecSKevin Wolf  * after the call (even on failure), so if the caller intends to reuse the
910de9c0cecSKevin Wolf  * dictionary, it needs to use QINCREF() before calling bdrv_open.
911b6ce07aaSKevin Wolf  */
912de9c0cecSKevin Wolf int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options,
913de9c0cecSKevin Wolf               int flags, BlockDriver *drv)
914ea2384d3Sbellard {
915b6ce07aaSKevin Wolf     int ret;
91689c9bc3dSStefan Weil     /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */
91789c9bc3dSStefan Weil     char tmp_filename[PATH_MAX + 1];
918f500a6d3SKevin Wolf     BlockDriverState *file = NULL;
919707ff828SKevin Wolf     QDict *file_options = NULL;
92033e3963eSbellard 
921de9c0cecSKevin Wolf     /* NULL means an empty set of options */
922de9c0cecSKevin Wolf     if (options == NULL) {
923de9c0cecSKevin Wolf         options = qdict_new();
924de9c0cecSKevin Wolf     }
925de9c0cecSKevin Wolf 
926de9c0cecSKevin Wolf     bs->options = options;
927b6ad491aSKevin Wolf     options = qdict_clone_shallow(options);
928de9c0cecSKevin Wolf 
929de9c0cecSKevin Wolf     /* For snapshot=on, create a temporary qcow2 overlay */
93083f64091Sbellard     if (flags & BDRV_O_SNAPSHOT) {
931ea2384d3Sbellard         BlockDriverState *bs1;
932ea2384d3Sbellard         int64_t total_size;
93391a073a9SKevin Wolf         BlockDriver *bdrv_qcow2;
93408b392e1SKevin Wolf         QEMUOptionParameter *create_options;
935b6ce07aaSKevin Wolf         char backing_filename[PATH_MAX];
93633e3963eSbellard 
937c2ad1b0cSKevin Wolf         if (qdict_size(options) != 0) {
938c2ad1b0cSKevin Wolf             error_report("Can't use snapshot=on with driver-specific options");
939c2ad1b0cSKevin Wolf             ret = -EINVAL;
940c2ad1b0cSKevin Wolf             goto fail;
941c2ad1b0cSKevin Wolf         }
942c2ad1b0cSKevin Wolf         assert(filename != NULL);
943c2ad1b0cSKevin Wolf 
944ea2384d3Sbellard         /* if snapshot, we create a temporary backing file and open it
945ea2384d3Sbellard            instead of opening 'filename' directly */
946ea2384d3Sbellard 
947ea2384d3Sbellard         /* if there is a backing file, use it */
948ea2384d3Sbellard         bs1 = bdrv_new("");
949de9c0cecSKevin Wolf         ret = bdrv_open(bs1, filename, NULL, 0, drv);
95051d7c00cSaliguori         if (ret < 0) {
951ea2384d3Sbellard             bdrv_delete(bs1);
952de9c0cecSKevin Wolf             goto fail;
953ea2384d3Sbellard         }
9543e82990bSJes Sorensen         total_size = bdrv_getlength(bs1) & BDRV_SECTOR_MASK;
9557c96d46eSaliguori 
956ea2384d3Sbellard         bdrv_delete(bs1);
957ea2384d3Sbellard 
958eba25057SJim Meyering         ret = get_tmp_filename(tmp_filename, sizeof(tmp_filename));
959eba25057SJim Meyering         if (ret < 0) {
960de9c0cecSKevin Wolf             goto fail;
961eba25057SJim Meyering         }
9627c96d46eSaliguori 
9637c96d46eSaliguori         /* Real path is meaningless for protocols */
9644d70655bSStefan Hajnoczi         if (path_has_protocol(filename)) {
9657c96d46eSaliguori             snprintf(backing_filename, sizeof(backing_filename),
9667c96d46eSaliguori                      "%s", filename);
967de9c0cecSKevin Wolf         } else if (!realpath(filename, backing_filename)) {
968de9c0cecSKevin Wolf             ret = -errno;
969de9c0cecSKevin Wolf             goto fail;
970de9c0cecSKevin Wolf         }
9717c96d46eSaliguori 
97291a073a9SKevin Wolf         bdrv_qcow2 = bdrv_find_format("qcow2");
97308b392e1SKevin Wolf         create_options = parse_option_parameters("", bdrv_qcow2->create_options,
97408b392e1SKevin Wolf                                                  NULL);
97591a073a9SKevin Wolf 
97608b392e1SKevin Wolf         set_option_parameter_int(create_options, BLOCK_OPT_SIZE, total_size);
97708b392e1SKevin Wolf         set_option_parameter(create_options, BLOCK_OPT_BACKING_FILE,
97808b392e1SKevin Wolf                              backing_filename);
97991a073a9SKevin Wolf         if (drv) {
98008b392e1SKevin Wolf             set_option_parameter(create_options, BLOCK_OPT_BACKING_FMT,
98191a073a9SKevin Wolf                 drv->format_name);
98291a073a9SKevin Wolf         }
98391a073a9SKevin Wolf 
98408b392e1SKevin Wolf         ret = bdrv_create(bdrv_qcow2, tmp_filename, create_options);
98508b392e1SKevin Wolf         free_option_parameters(create_options);
98651d7c00cSaliguori         if (ret < 0) {
987de9c0cecSKevin Wolf             goto fail;
988ea2384d3Sbellard         }
98991a073a9SKevin Wolf 
990ea2384d3Sbellard         filename = tmp_filename;
99191a073a9SKevin Wolf         drv = bdrv_qcow2;
992ea2384d3Sbellard         bs->is_temporary = 1;
993ea2384d3Sbellard     }
994ea2384d3Sbellard 
995f500a6d3SKevin Wolf     /* Open image file without format layer */
996be028adcSJeff Cody     if (flags & BDRV_O_RDWR) {
997be028adcSJeff Cody         flags |= BDRV_O_ALLOW_RDWR;
998be028adcSJeff Cody     }
999be028adcSJeff Cody 
1000707ff828SKevin Wolf     extract_subqdict(options, &file_options, "file.");
1001707ff828SKevin Wolf 
1002707ff828SKevin Wolf     ret = bdrv_file_open(&file, filename, file_options,
1003707ff828SKevin Wolf                          bdrv_open_flags(bs, flags));
1004f500a6d3SKevin Wolf     if (ret < 0) {
1005de9c0cecSKevin Wolf         goto fail;
1006f500a6d3SKevin Wolf     }
1007f500a6d3SKevin Wolf 
1008f500a6d3SKevin Wolf     /* Find the right image format driver */
1009f500a6d3SKevin Wolf     if (!drv) {
1010f500a6d3SKevin Wolf         ret = find_image_format(file, filename, &drv);
1011f500a6d3SKevin Wolf     }
1012f500a6d3SKevin Wolf 
1013f500a6d3SKevin Wolf     if (!drv) {
1014f500a6d3SKevin Wolf         goto unlink_and_fail;
1015f500a6d3SKevin Wolf     }
1016f500a6d3SKevin Wolf 
1017b6ce07aaSKevin Wolf     /* Open the image */
1018b6ad491aSKevin Wolf     ret = bdrv_open_common(bs, file, filename, options, flags, drv);
1019b6ce07aaSKevin Wolf     if (ret < 0) {
10206987307cSChristoph Hellwig         goto unlink_and_fail;
10216987307cSChristoph Hellwig     }
10226987307cSChristoph Hellwig 
1023f500a6d3SKevin Wolf     if (bs->file != file) {
1024f500a6d3SKevin Wolf         bdrv_delete(file);
1025f500a6d3SKevin Wolf         file = NULL;
1026f500a6d3SKevin Wolf     }
1027f500a6d3SKevin Wolf 
1028b6ce07aaSKevin Wolf     /* If there is a backing file, use it */
10299156df12SPaolo Bonzini     if ((flags & BDRV_O_NO_BACKING) == 0) {
10309156df12SPaolo Bonzini         ret = bdrv_open_backing_file(bs);
1031b6ce07aaSKevin Wolf         if (ret < 0) {
1032b6ad491aSKevin Wolf             goto close_and_fail;
1033b6ce07aaSKevin Wolf         }
1034b6ce07aaSKevin Wolf     }
1035b6ce07aaSKevin Wolf 
1036b6ad491aSKevin Wolf     /* Check if any unknown options were used */
1037b6ad491aSKevin Wolf     if (qdict_size(options) != 0) {
1038b6ad491aSKevin Wolf         const QDictEntry *entry = qdict_first(options);
1039b6ad491aSKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR, "Block format '%s' used by "
1040b6ad491aSKevin Wolf             "device '%s' doesn't support the option '%s'",
1041b6ad491aSKevin Wolf             drv->format_name, bs->device_name, entry->key);
1042b6ad491aSKevin Wolf 
1043b6ad491aSKevin Wolf         ret = -EINVAL;
1044b6ad491aSKevin Wolf         goto close_and_fail;
1045b6ad491aSKevin Wolf     }
1046b6ad491aSKevin Wolf     QDECREF(options);
1047b6ad491aSKevin Wolf 
1048b6ce07aaSKevin Wolf     if (!bdrv_key_required(bs)) {
10497d4b4ba5SMarkus Armbruster         bdrv_dev_change_media_cb(bs, true);
1050b6ce07aaSKevin Wolf     }
1051b6ce07aaSKevin Wolf 
105298f90dbaSZhi Yong Wu     /* throttling disk I/O limits */
105398f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
105498f90dbaSZhi Yong Wu         bdrv_io_limits_enable(bs);
105598f90dbaSZhi Yong Wu     }
105698f90dbaSZhi Yong Wu 
1057b6ce07aaSKevin Wolf     return 0;
1058b6ce07aaSKevin Wolf 
1059b6ce07aaSKevin Wolf unlink_and_fail:
1060f500a6d3SKevin Wolf     if (file != NULL) {
1061f500a6d3SKevin Wolf         bdrv_delete(file);
1062f500a6d3SKevin Wolf     }
1063b6ce07aaSKevin Wolf     if (bs->is_temporary) {
1064b6ce07aaSKevin Wolf         unlink(filename);
1065b6ce07aaSKevin Wolf     }
1066de9c0cecSKevin Wolf fail:
1067de9c0cecSKevin Wolf     QDECREF(bs->options);
1068b6ad491aSKevin Wolf     QDECREF(options);
1069de9c0cecSKevin Wolf     bs->options = NULL;
1070b6ad491aSKevin Wolf     return ret;
1071de9c0cecSKevin Wolf 
1072b6ad491aSKevin Wolf close_and_fail:
1073b6ad491aSKevin Wolf     bdrv_close(bs);
1074b6ad491aSKevin Wolf     QDECREF(options);
1075b6ce07aaSKevin Wolf     return ret;
1076b6ce07aaSKevin Wolf }
1077b6ce07aaSKevin Wolf 
1078e971aa12SJeff Cody typedef struct BlockReopenQueueEntry {
1079e971aa12SJeff Cody      bool prepared;
1080e971aa12SJeff Cody      BDRVReopenState state;
1081e971aa12SJeff Cody      QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry;
1082e971aa12SJeff Cody } BlockReopenQueueEntry;
1083e971aa12SJeff Cody 
1084e971aa12SJeff Cody /*
1085e971aa12SJeff Cody  * Adds a BlockDriverState to a simple queue for an atomic, transactional
1086e971aa12SJeff Cody  * reopen of multiple devices.
1087e971aa12SJeff Cody  *
1088e971aa12SJeff Cody  * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT
1089e971aa12SJeff Cody  * already performed, or alternatively may be NULL a new BlockReopenQueue will
1090e971aa12SJeff Cody  * be created and initialized. This newly created BlockReopenQueue should be
1091e971aa12SJeff Cody  * passed back in for subsequent calls that are intended to be of the same
1092e971aa12SJeff Cody  * atomic 'set'.
1093e971aa12SJeff Cody  *
1094e971aa12SJeff Cody  * bs is the BlockDriverState to add to the reopen queue.
1095e971aa12SJeff Cody  *
1096e971aa12SJeff Cody  * flags contains the open flags for the associated bs
1097e971aa12SJeff Cody  *
1098e971aa12SJeff Cody  * returns a pointer to bs_queue, which is either the newly allocated
1099e971aa12SJeff Cody  * bs_queue, or the existing bs_queue being used.
1100e971aa12SJeff Cody  *
1101e971aa12SJeff Cody  */
1102e971aa12SJeff Cody BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
1103e971aa12SJeff Cody                                     BlockDriverState *bs, int flags)
1104e971aa12SJeff Cody {
1105e971aa12SJeff Cody     assert(bs != NULL);
1106e971aa12SJeff Cody 
1107e971aa12SJeff Cody     BlockReopenQueueEntry *bs_entry;
1108e971aa12SJeff Cody     if (bs_queue == NULL) {
1109e971aa12SJeff Cody         bs_queue = g_new0(BlockReopenQueue, 1);
1110e971aa12SJeff Cody         QSIMPLEQ_INIT(bs_queue);
1111e971aa12SJeff Cody     }
1112e971aa12SJeff Cody 
1113e971aa12SJeff Cody     if (bs->file) {
1114e971aa12SJeff Cody         bdrv_reopen_queue(bs_queue, bs->file, flags);
1115e971aa12SJeff Cody     }
1116e971aa12SJeff Cody 
1117e971aa12SJeff Cody     bs_entry = g_new0(BlockReopenQueueEntry, 1);
1118e971aa12SJeff Cody     QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry);
1119e971aa12SJeff Cody 
1120e971aa12SJeff Cody     bs_entry->state.bs = bs;
1121e971aa12SJeff Cody     bs_entry->state.flags = flags;
1122e971aa12SJeff Cody 
1123e971aa12SJeff Cody     return bs_queue;
1124e971aa12SJeff Cody }
1125e971aa12SJeff Cody 
1126e971aa12SJeff Cody /*
1127e971aa12SJeff Cody  * Reopen multiple BlockDriverStates atomically & transactionally.
1128e971aa12SJeff Cody  *
1129e971aa12SJeff Cody  * The queue passed in (bs_queue) must have been built up previous
1130e971aa12SJeff Cody  * via bdrv_reopen_queue().
1131e971aa12SJeff Cody  *
1132e971aa12SJeff Cody  * Reopens all BDS specified in the queue, with the appropriate
1133e971aa12SJeff Cody  * flags.  All devices are prepared for reopen, and failure of any
1134e971aa12SJeff Cody  * device will cause all device changes to be abandonded, and intermediate
1135e971aa12SJeff Cody  * data cleaned up.
1136e971aa12SJeff Cody  *
1137e971aa12SJeff Cody  * If all devices prepare successfully, then the changes are committed
1138e971aa12SJeff Cody  * to all devices.
1139e971aa12SJeff Cody  *
1140e971aa12SJeff Cody  */
1141e971aa12SJeff Cody int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp)
1142e971aa12SJeff Cody {
1143e971aa12SJeff Cody     int ret = -1;
1144e971aa12SJeff Cody     BlockReopenQueueEntry *bs_entry, *next;
1145e971aa12SJeff Cody     Error *local_err = NULL;
1146e971aa12SJeff Cody 
1147e971aa12SJeff Cody     assert(bs_queue != NULL);
1148e971aa12SJeff Cody 
1149e971aa12SJeff Cody     bdrv_drain_all();
1150e971aa12SJeff Cody 
1151e971aa12SJeff Cody     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
1152e971aa12SJeff Cody         if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) {
1153e971aa12SJeff Cody             error_propagate(errp, local_err);
1154e971aa12SJeff Cody             goto cleanup;
1155e971aa12SJeff Cody         }
1156e971aa12SJeff Cody         bs_entry->prepared = true;
1157e971aa12SJeff Cody     }
1158e971aa12SJeff Cody 
1159e971aa12SJeff Cody     /* If we reach this point, we have success and just need to apply the
1160e971aa12SJeff Cody      * changes
1161e971aa12SJeff Cody      */
1162e971aa12SJeff Cody     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
1163e971aa12SJeff Cody         bdrv_reopen_commit(&bs_entry->state);
1164e971aa12SJeff Cody     }
1165e971aa12SJeff Cody 
1166e971aa12SJeff Cody     ret = 0;
1167e971aa12SJeff Cody 
1168e971aa12SJeff Cody cleanup:
1169e971aa12SJeff Cody     QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) {
1170e971aa12SJeff Cody         if (ret && bs_entry->prepared) {
1171e971aa12SJeff Cody             bdrv_reopen_abort(&bs_entry->state);
1172e971aa12SJeff Cody         }
1173e971aa12SJeff Cody         g_free(bs_entry);
1174e971aa12SJeff Cody     }
1175e971aa12SJeff Cody     g_free(bs_queue);
1176e971aa12SJeff Cody     return ret;
1177e971aa12SJeff Cody }
1178e971aa12SJeff Cody 
1179e971aa12SJeff Cody 
1180e971aa12SJeff Cody /* Reopen a single BlockDriverState with the specified flags. */
1181e971aa12SJeff Cody int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp)
1182e971aa12SJeff Cody {
1183e971aa12SJeff Cody     int ret = -1;
1184e971aa12SJeff Cody     Error *local_err = NULL;
1185e971aa12SJeff Cody     BlockReopenQueue *queue = bdrv_reopen_queue(NULL, bs, bdrv_flags);
1186e971aa12SJeff Cody 
1187e971aa12SJeff Cody     ret = bdrv_reopen_multiple(queue, &local_err);
1188e971aa12SJeff Cody     if (local_err != NULL) {
1189e971aa12SJeff Cody         error_propagate(errp, local_err);
1190e971aa12SJeff Cody     }
1191e971aa12SJeff Cody     return ret;
1192e971aa12SJeff Cody }
1193e971aa12SJeff Cody 
1194e971aa12SJeff Cody 
1195e971aa12SJeff Cody /*
1196e971aa12SJeff Cody  * Prepares a BlockDriverState for reopen. All changes are staged in the
1197e971aa12SJeff Cody  * 'opaque' field of the BDRVReopenState, which is used and allocated by
1198e971aa12SJeff Cody  * the block driver layer .bdrv_reopen_prepare()
1199e971aa12SJeff Cody  *
1200e971aa12SJeff Cody  * bs is the BlockDriverState to reopen
1201e971aa12SJeff Cody  * flags are the new open flags
1202e971aa12SJeff Cody  * queue is the reopen queue
1203e971aa12SJeff Cody  *
1204e971aa12SJeff Cody  * Returns 0 on success, non-zero on error.  On error errp will be set
1205e971aa12SJeff Cody  * as well.
1206e971aa12SJeff Cody  *
1207e971aa12SJeff Cody  * On failure, bdrv_reopen_abort() will be called to clean up any data.
1208e971aa12SJeff Cody  * It is the responsibility of the caller to then call the abort() or
1209e971aa12SJeff Cody  * commit() for any other BDS that have been left in a prepare() state
1210e971aa12SJeff Cody  *
1211e971aa12SJeff Cody  */
1212e971aa12SJeff Cody int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue,
1213e971aa12SJeff Cody                         Error **errp)
1214e971aa12SJeff Cody {
1215e971aa12SJeff Cody     int ret = -1;
1216e971aa12SJeff Cody     Error *local_err = NULL;
1217e971aa12SJeff Cody     BlockDriver *drv;
1218e971aa12SJeff Cody 
1219e971aa12SJeff Cody     assert(reopen_state != NULL);
1220e971aa12SJeff Cody     assert(reopen_state->bs->drv != NULL);
1221e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1222e971aa12SJeff Cody 
1223e971aa12SJeff Cody     /* if we are to stay read-only, do not allow permission change
1224e971aa12SJeff Cody      * to r/w */
1225e971aa12SJeff Cody     if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) &&
1226e971aa12SJeff Cody         reopen_state->flags & BDRV_O_RDWR) {
1227e971aa12SJeff Cody         error_set(errp, QERR_DEVICE_IS_READ_ONLY,
1228e971aa12SJeff Cody                   reopen_state->bs->device_name);
1229e971aa12SJeff Cody         goto error;
1230e971aa12SJeff Cody     }
1231e971aa12SJeff Cody 
1232e971aa12SJeff Cody 
1233e971aa12SJeff Cody     ret = bdrv_flush(reopen_state->bs);
1234e971aa12SJeff Cody     if (ret) {
1235e971aa12SJeff Cody         error_set(errp, ERROR_CLASS_GENERIC_ERROR, "Error (%s) flushing drive",
1236e971aa12SJeff Cody                   strerror(-ret));
1237e971aa12SJeff Cody         goto error;
1238e971aa12SJeff Cody     }
1239e971aa12SJeff Cody 
1240e971aa12SJeff Cody     if (drv->bdrv_reopen_prepare) {
1241e971aa12SJeff Cody         ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err);
1242e971aa12SJeff Cody         if (ret) {
1243e971aa12SJeff Cody             if (local_err != NULL) {
1244e971aa12SJeff Cody                 error_propagate(errp, local_err);
1245e971aa12SJeff Cody             } else {
1246e971aa12SJeff Cody                 error_set(errp, QERR_OPEN_FILE_FAILED,
1247e971aa12SJeff Cody                           reopen_state->bs->filename);
1248e971aa12SJeff Cody             }
1249e971aa12SJeff Cody             goto error;
1250e971aa12SJeff Cody         }
1251e971aa12SJeff Cody     } else {
1252e971aa12SJeff Cody         /* It is currently mandatory to have a bdrv_reopen_prepare()
1253e971aa12SJeff Cody          * handler for each supported drv. */
1254e971aa12SJeff Cody         error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1255e971aa12SJeff Cody                   drv->format_name, reopen_state->bs->device_name,
1256e971aa12SJeff Cody                  "reopening of file");
1257e971aa12SJeff Cody         ret = -1;
1258e971aa12SJeff Cody         goto error;
1259e971aa12SJeff Cody     }
1260e971aa12SJeff Cody 
1261e971aa12SJeff Cody     ret = 0;
1262e971aa12SJeff Cody 
1263e971aa12SJeff Cody error:
1264e971aa12SJeff Cody     return ret;
1265e971aa12SJeff Cody }
1266e971aa12SJeff Cody 
1267e971aa12SJeff Cody /*
1268e971aa12SJeff Cody  * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and
1269e971aa12SJeff Cody  * makes them final by swapping the staging BlockDriverState contents into
1270e971aa12SJeff Cody  * the active BlockDriverState contents.
1271e971aa12SJeff Cody  */
1272e971aa12SJeff Cody void bdrv_reopen_commit(BDRVReopenState *reopen_state)
1273e971aa12SJeff Cody {
1274e971aa12SJeff Cody     BlockDriver *drv;
1275e971aa12SJeff Cody 
1276e971aa12SJeff Cody     assert(reopen_state != NULL);
1277e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1278e971aa12SJeff Cody     assert(drv != NULL);
1279e971aa12SJeff Cody 
1280e971aa12SJeff Cody     /* If there are any driver level actions to take */
1281e971aa12SJeff Cody     if (drv->bdrv_reopen_commit) {
1282e971aa12SJeff Cody         drv->bdrv_reopen_commit(reopen_state);
1283e971aa12SJeff Cody     }
1284e971aa12SJeff Cody 
1285e971aa12SJeff Cody     /* set BDS specific flags now */
1286e971aa12SJeff Cody     reopen_state->bs->open_flags         = reopen_state->flags;
1287e971aa12SJeff Cody     reopen_state->bs->enable_write_cache = !!(reopen_state->flags &
1288e971aa12SJeff Cody                                               BDRV_O_CACHE_WB);
1289e971aa12SJeff Cody     reopen_state->bs->read_only = !(reopen_state->flags & BDRV_O_RDWR);
1290e971aa12SJeff Cody }
1291e971aa12SJeff Cody 
1292e971aa12SJeff Cody /*
1293e971aa12SJeff Cody  * Abort the reopen, and delete and free the staged changes in
1294e971aa12SJeff Cody  * reopen_state
1295e971aa12SJeff Cody  */
1296e971aa12SJeff Cody void bdrv_reopen_abort(BDRVReopenState *reopen_state)
1297e971aa12SJeff Cody {
1298e971aa12SJeff Cody     BlockDriver *drv;
1299e971aa12SJeff Cody 
1300e971aa12SJeff Cody     assert(reopen_state != NULL);
1301e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1302e971aa12SJeff Cody     assert(drv != NULL);
1303e971aa12SJeff Cody 
1304e971aa12SJeff Cody     if (drv->bdrv_reopen_abort) {
1305e971aa12SJeff Cody         drv->bdrv_reopen_abort(reopen_state);
1306e971aa12SJeff Cody     }
1307e971aa12SJeff Cody }
1308e971aa12SJeff Cody 
1309e971aa12SJeff Cody 
1310fc01f7e7Sbellard void bdrv_close(BlockDriverState *bs)
1311fc01f7e7Sbellard {
131280ccf93bSLiu Yuan     bdrv_flush(bs);
13133e914655SPaolo Bonzini     if (bs->job) {
13143e914655SPaolo Bonzini         block_job_cancel_sync(bs->job);
13153e914655SPaolo Bonzini     }
13167094f12fSKevin Wolf     bdrv_drain_all();
1317d7d512f6SPaolo Bonzini     notifier_list_notify(&bs->close_notifiers, bs);
13187094f12fSKevin Wolf 
13193cbc002cSPaolo Bonzini     if (bs->drv) {
1320f9092b10SMarkus Armbruster         if (bs == bs_snapshots) {
1321f9092b10SMarkus Armbruster             bs_snapshots = NULL;
1322f9092b10SMarkus Armbruster         }
1323557df6acSStefan Hajnoczi         if (bs->backing_hd) {
1324ea2384d3Sbellard             bdrv_delete(bs->backing_hd);
1325557df6acSStefan Hajnoczi             bs->backing_hd = NULL;
1326557df6acSStefan Hajnoczi         }
1327ea2384d3Sbellard         bs->drv->bdrv_close(bs);
13287267c094SAnthony Liguori         g_free(bs->opaque);
1329ea2384d3Sbellard #ifdef _WIN32
1330ea2384d3Sbellard         if (bs->is_temporary) {
1331ea2384d3Sbellard             unlink(bs->filename);
1332ea2384d3Sbellard         }
133367b915a5Sbellard #endif
1334ea2384d3Sbellard         bs->opaque = NULL;
1335ea2384d3Sbellard         bs->drv = NULL;
133653fec9d3SStefan Hajnoczi         bs->copy_on_read = 0;
1337a275fa42SPaolo Bonzini         bs->backing_file[0] = '\0';
1338a275fa42SPaolo Bonzini         bs->backing_format[0] = '\0';
13396405875cSPaolo Bonzini         bs->total_sectors = 0;
13406405875cSPaolo Bonzini         bs->encrypted = 0;
13416405875cSPaolo Bonzini         bs->valid_key = 0;
13426405875cSPaolo Bonzini         bs->sg = 0;
13436405875cSPaolo Bonzini         bs->growable = 0;
1344de9c0cecSKevin Wolf         QDECREF(bs->options);
1345de9c0cecSKevin Wolf         bs->options = NULL;
1346b338082bSbellard 
134766f82ceeSKevin Wolf         if (bs->file != NULL) {
13480ac9377dSPaolo Bonzini             bdrv_delete(bs->file);
13490ac9377dSPaolo Bonzini             bs->file = NULL;
135066f82ceeSKevin Wolf         }
13519ca11154SPavel Hrdina     }
135266f82ceeSKevin Wolf 
13537d4b4ba5SMarkus Armbruster     bdrv_dev_change_media_cb(bs, false);
135498f90dbaSZhi Yong Wu 
135598f90dbaSZhi Yong Wu     /*throttling disk I/O limits*/
135698f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
135798f90dbaSZhi Yong Wu         bdrv_io_limits_disable(bs);
135898f90dbaSZhi Yong Wu     }
1359b338082bSbellard }
1360b338082bSbellard 
13612bc93fedSMORITA Kazutaka void bdrv_close_all(void)
13622bc93fedSMORITA Kazutaka {
13632bc93fedSMORITA Kazutaka     BlockDriverState *bs;
13642bc93fedSMORITA Kazutaka 
13652bc93fedSMORITA Kazutaka     QTAILQ_FOREACH(bs, &bdrv_states, list) {
13662bc93fedSMORITA Kazutaka         bdrv_close(bs);
13672bc93fedSMORITA Kazutaka     }
13682bc93fedSMORITA Kazutaka }
13692bc93fedSMORITA Kazutaka 
1370922453bcSStefan Hajnoczi /*
1371922453bcSStefan Hajnoczi  * Wait for pending requests to complete across all BlockDriverStates
1372922453bcSStefan Hajnoczi  *
1373922453bcSStefan Hajnoczi  * This function does not flush data to disk, use bdrv_flush_all() for that
1374922453bcSStefan Hajnoczi  * after calling this function.
13754c355d53SZhi Yong Wu  *
13764c355d53SZhi Yong Wu  * Note that completion of an asynchronous I/O operation can trigger any
13774c355d53SZhi Yong Wu  * number of other I/O operations on other devices---for example a coroutine
13784c355d53SZhi Yong Wu  * can be arbitrarily complex and a constant flow of I/O can come until the
13794c355d53SZhi Yong Wu  * coroutine is complete.  Because of this, it is not possible to have a
13804c355d53SZhi Yong Wu  * function to drain a single device's I/O queue.
1381922453bcSStefan Hajnoczi  */
1382922453bcSStefan Hajnoczi void bdrv_drain_all(void)
1383922453bcSStefan Hajnoczi {
1384922453bcSStefan Hajnoczi     BlockDriverState *bs;
13854c355d53SZhi Yong Wu     bool busy;
1386922453bcSStefan Hajnoczi 
13874c355d53SZhi Yong Wu     do {
13884c355d53SZhi Yong Wu         busy = qemu_aio_wait();
13894c355d53SZhi Yong Wu 
13904c355d53SZhi Yong Wu         /* FIXME: We do not have timer support here, so this is effectively
13914c355d53SZhi Yong Wu          * a busy wait.
13924c355d53SZhi Yong Wu          */
13934c355d53SZhi Yong Wu         QTAILQ_FOREACH(bs, &bdrv_states, list) {
13944c355d53SZhi Yong Wu             if (!qemu_co_queue_empty(&bs->throttled_reqs)) {
13954c355d53SZhi Yong Wu                 qemu_co_queue_restart_all(&bs->throttled_reqs);
13964c355d53SZhi Yong Wu                 busy = true;
13974c355d53SZhi Yong Wu             }
13984c355d53SZhi Yong Wu         }
13994c355d53SZhi Yong Wu     } while (busy);
1400922453bcSStefan Hajnoczi 
1401922453bcSStefan Hajnoczi     /* If requests are still pending there is a bug somewhere */
1402922453bcSStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
1403922453bcSStefan Hajnoczi         assert(QLIST_EMPTY(&bs->tracked_requests));
1404922453bcSStefan Hajnoczi         assert(qemu_co_queue_empty(&bs->throttled_reqs));
1405922453bcSStefan Hajnoczi     }
1406922453bcSStefan Hajnoczi }
1407922453bcSStefan Hajnoczi 
1408d22b2f41SRyan Harper /* make a BlockDriverState anonymous by removing from bdrv_state list.
1409d22b2f41SRyan Harper    Also, NULL terminate the device_name to prevent double remove */
1410d22b2f41SRyan Harper void bdrv_make_anon(BlockDriverState *bs)
1411d22b2f41SRyan Harper {
1412d22b2f41SRyan Harper     if (bs->device_name[0] != '\0') {
1413d22b2f41SRyan Harper         QTAILQ_REMOVE(&bdrv_states, bs, list);
1414d22b2f41SRyan Harper     }
1415d22b2f41SRyan Harper     bs->device_name[0] = '\0';
1416d22b2f41SRyan Harper }
1417d22b2f41SRyan Harper 
1418e023b2e2SPaolo Bonzini static void bdrv_rebind(BlockDriverState *bs)
1419e023b2e2SPaolo Bonzini {
1420e023b2e2SPaolo Bonzini     if (bs->drv && bs->drv->bdrv_rebind) {
1421e023b2e2SPaolo Bonzini         bs->drv->bdrv_rebind(bs);
1422e023b2e2SPaolo Bonzini     }
1423e023b2e2SPaolo Bonzini }
1424e023b2e2SPaolo Bonzini 
14254ddc07caSPaolo Bonzini static void bdrv_move_feature_fields(BlockDriverState *bs_dest,
14264ddc07caSPaolo Bonzini                                      BlockDriverState *bs_src)
14274ddc07caSPaolo Bonzini {
14284ddc07caSPaolo Bonzini     /* move some fields that need to stay attached to the device */
14294ddc07caSPaolo Bonzini     bs_dest->open_flags         = bs_src->open_flags;
14304ddc07caSPaolo Bonzini 
14314ddc07caSPaolo Bonzini     /* dev info */
14324ddc07caSPaolo Bonzini     bs_dest->dev_ops            = bs_src->dev_ops;
14334ddc07caSPaolo Bonzini     bs_dest->dev_opaque         = bs_src->dev_opaque;
14344ddc07caSPaolo Bonzini     bs_dest->dev                = bs_src->dev;
14354ddc07caSPaolo Bonzini     bs_dest->buffer_alignment   = bs_src->buffer_alignment;
14364ddc07caSPaolo Bonzini     bs_dest->copy_on_read       = bs_src->copy_on_read;
14374ddc07caSPaolo Bonzini 
14384ddc07caSPaolo Bonzini     bs_dest->enable_write_cache = bs_src->enable_write_cache;
14394ddc07caSPaolo Bonzini 
14404ddc07caSPaolo Bonzini     /* i/o timing parameters */
14414ddc07caSPaolo Bonzini     bs_dest->slice_start        = bs_src->slice_start;
14424ddc07caSPaolo Bonzini     bs_dest->slice_end          = bs_src->slice_end;
14435905fbc9SStefan Hajnoczi     bs_dest->slice_submitted    = bs_src->slice_submitted;
14444ddc07caSPaolo Bonzini     bs_dest->io_limits          = bs_src->io_limits;
14454ddc07caSPaolo Bonzini     bs_dest->throttled_reqs     = bs_src->throttled_reqs;
14464ddc07caSPaolo Bonzini     bs_dest->block_timer        = bs_src->block_timer;
14474ddc07caSPaolo Bonzini     bs_dest->io_limits_enabled  = bs_src->io_limits_enabled;
14484ddc07caSPaolo Bonzini 
14494ddc07caSPaolo Bonzini     /* r/w error */
14504ddc07caSPaolo Bonzini     bs_dest->on_read_error      = bs_src->on_read_error;
14514ddc07caSPaolo Bonzini     bs_dest->on_write_error     = bs_src->on_write_error;
14524ddc07caSPaolo Bonzini 
14534ddc07caSPaolo Bonzini     /* i/o status */
14544ddc07caSPaolo Bonzini     bs_dest->iostatus_enabled   = bs_src->iostatus_enabled;
14554ddc07caSPaolo Bonzini     bs_dest->iostatus           = bs_src->iostatus;
14564ddc07caSPaolo Bonzini 
14574ddc07caSPaolo Bonzini     /* dirty bitmap */
14584ddc07caSPaolo Bonzini     bs_dest->dirty_bitmap       = bs_src->dirty_bitmap;
14594ddc07caSPaolo Bonzini 
14604ddc07caSPaolo Bonzini     /* job */
14614ddc07caSPaolo Bonzini     bs_dest->in_use             = bs_src->in_use;
14624ddc07caSPaolo Bonzini     bs_dest->job                = bs_src->job;
14634ddc07caSPaolo Bonzini 
14644ddc07caSPaolo Bonzini     /* keep the same entry in bdrv_states */
14654ddc07caSPaolo Bonzini     pstrcpy(bs_dest->device_name, sizeof(bs_dest->device_name),
14664ddc07caSPaolo Bonzini             bs_src->device_name);
14674ddc07caSPaolo Bonzini     bs_dest->list = bs_src->list;
14684ddc07caSPaolo Bonzini }
14694ddc07caSPaolo Bonzini 
14704ddc07caSPaolo Bonzini /*
14714ddc07caSPaolo Bonzini  * Swap bs contents for two image chains while they are live,
14724ddc07caSPaolo Bonzini  * while keeping required fields on the BlockDriverState that is
14734ddc07caSPaolo Bonzini  * actually attached to a device.
14744ddc07caSPaolo Bonzini  *
14754ddc07caSPaolo Bonzini  * This will modify the BlockDriverState fields, and swap contents
14764ddc07caSPaolo Bonzini  * between bs_new and bs_old. Both bs_new and bs_old are modified.
14774ddc07caSPaolo Bonzini  *
14784ddc07caSPaolo Bonzini  * bs_new is required to be anonymous.
14794ddc07caSPaolo Bonzini  *
14804ddc07caSPaolo Bonzini  * This function does not create any image files.
14814ddc07caSPaolo Bonzini  */
14824ddc07caSPaolo Bonzini void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old)
14834ddc07caSPaolo Bonzini {
14844ddc07caSPaolo Bonzini     BlockDriverState tmp;
14854ddc07caSPaolo Bonzini 
14864ddc07caSPaolo Bonzini     /* bs_new must be anonymous and shouldn't have anything fancy enabled */
14874ddc07caSPaolo Bonzini     assert(bs_new->device_name[0] == '\0');
14884ddc07caSPaolo Bonzini     assert(bs_new->dirty_bitmap == NULL);
14894ddc07caSPaolo Bonzini     assert(bs_new->job == NULL);
14904ddc07caSPaolo Bonzini     assert(bs_new->dev == NULL);
14914ddc07caSPaolo Bonzini     assert(bs_new->in_use == 0);
14924ddc07caSPaolo Bonzini     assert(bs_new->io_limits_enabled == false);
14934ddc07caSPaolo Bonzini     assert(bs_new->block_timer == NULL);
14944ddc07caSPaolo Bonzini 
14954ddc07caSPaolo Bonzini     tmp = *bs_new;
14964ddc07caSPaolo Bonzini     *bs_new = *bs_old;
14974ddc07caSPaolo Bonzini     *bs_old = tmp;
14984ddc07caSPaolo Bonzini 
14994ddc07caSPaolo Bonzini     /* there are some fields that should not be swapped, move them back */
15004ddc07caSPaolo Bonzini     bdrv_move_feature_fields(&tmp, bs_old);
15014ddc07caSPaolo Bonzini     bdrv_move_feature_fields(bs_old, bs_new);
15024ddc07caSPaolo Bonzini     bdrv_move_feature_fields(bs_new, &tmp);
15034ddc07caSPaolo Bonzini 
15044ddc07caSPaolo Bonzini     /* bs_new shouldn't be in bdrv_states even after the swap!  */
15054ddc07caSPaolo Bonzini     assert(bs_new->device_name[0] == '\0');
15064ddc07caSPaolo Bonzini 
15074ddc07caSPaolo Bonzini     /* Check a few fields that should remain attached to the device */
15084ddc07caSPaolo Bonzini     assert(bs_new->dev == NULL);
15094ddc07caSPaolo Bonzini     assert(bs_new->job == 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     bdrv_rebind(bs_new);
15154ddc07caSPaolo Bonzini     bdrv_rebind(bs_old);
15164ddc07caSPaolo Bonzini }
15174ddc07caSPaolo Bonzini 
15188802d1fdSJeff Cody /*
15198802d1fdSJeff Cody  * Add new bs contents at the top of an image chain while the chain is
15208802d1fdSJeff Cody  * live, while keeping required fields on the top layer.
15218802d1fdSJeff Cody  *
15228802d1fdSJeff Cody  * This will modify the BlockDriverState fields, and swap contents
15238802d1fdSJeff Cody  * between bs_new and bs_top. Both bs_new and bs_top are modified.
15248802d1fdSJeff Cody  *
1525f6801b83SJeff Cody  * bs_new is required to be anonymous.
1526f6801b83SJeff Cody  *
15278802d1fdSJeff Cody  * This function does not create any image files.
15288802d1fdSJeff Cody  */
15298802d1fdSJeff Cody void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top)
15308802d1fdSJeff Cody {
15314ddc07caSPaolo Bonzini     bdrv_swap(bs_new, bs_top);
15328802d1fdSJeff Cody 
15338802d1fdSJeff Cody     /* The contents of 'tmp' will become bs_top, as we are
15348802d1fdSJeff Cody      * swapping bs_new and bs_top contents. */
15354ddc07caSPaolo Bonzini     bs_top->backing_hd = bs_new;
15364ddc07caSPaolo Bonzini     bs_top->open_flags &= ~BDRV_O_NO_BACKING;
15374ddc07caSPaolo Bonzini     pstrcpy(bs_top->backing_file, sizeof(bs_top->backing_file),
15384ddc07caSPaolo Bonzini             bs_new->filename);
15394ddc07caSPaolo Bonzini     pstrcpy(bs_top->backing_format, sizeof(bs_top->backing_format),
15404ddc07caSPaolo Bonzini             bs_new->drv ? bs_new->drv->format_name : "");
15418802d1fdSJeff Cody }
15428802d1fdSJeff Cody 
1543b338082bSbellard void bdrv_delete(BlockDriverState *bs)
1544b338082bSbellard {
1545fa879d62SMarkus Armbruster     assert(!bs->dev);
15463e914655SPaolo Bonzini     assert(!bs->job);
15473e914655SPaolo Bonzini     assert(!bs->in_use);
154818846deeSMarkus Armbruster 
15491b7bdbc1SStefan Hajnoczi     /* remove from list, if necessary */
1550d22b2f41SRyan Harper     bdrv_make_anon(bs);
155134c6f050Saurel32 
1552b338082bSbellard     bdrv_close(bs);
155366f82ceeSKevin Wolf 
1554f9092b10SMarkus Armbruster     assert(bs != bs_snapshots);
15557267c094SAnthony Liguori     g_free(bs);
1556fc01f7e7Sbellard }
1557fc01f7e7Sbellard 
1558fa879d62SMarkus Armbruster int bdrv_attach_dev(BlockDriverState *bs, void *dev)
1559fa879d62SMarkus Armbruster /* TODO change to DeviceState *dev when all users are qdevified */
156018846deeSMarkus Armbruster {
1561fa879d62SMarkus Armbruster     if (bs->dev) {
156218846deeSMarkus Armbruster         return -EBUSY;
156318846deeSMarkus Armbruster     }
1564fa879d62SMarkus Armbruster     bs->dev = dev;
156528a7282aSLuiz Capitulino     bdrv_iostatus_reset(bs);
156618846deeSMarkus Armbruster     return 0;
156718846deeSMarkus Armbruster }
156818846deeSMarkus Armbruster 
1569fa879d62SMarkus Armbruster /* TODO qdevified devices don't use this, remove when devices are qdevified */
1570fa879d62SMarkus Armbruster void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev)
157118846deeSMarkus Armbruster {
1572fa879d62SMarkus Armbruster     if (bdrv_attach_dev(bs, dev) < 0) {
1573fa879d62SMarkus Armbruster         abort();
1574fa879d62SMarkus Armbruster     }
1575fa879d62SMarkus Armbruster }
1576fa879d62SMarkus Armbruster 
1577fa879d62SMarkus Armbruster void bdrv_detach_dev(BlockDriverState *bs, void *dev)
1578fa879d62SMarkus Armbruster /* TODO change to DeviceState *dev when all users are qdevified */
1579fa879d62SMarkus Armbruster {
1580fa879d62SMarkus Armbruster     assert(bs->dev == dev);
1581fa879d62SMarkus Armbruster     bs->dev = NULL;
15820e49de52SMarkus Armbruster     bs->dev_ops = NULL;
15830e49de52SMarkus Armbruster     bs->dev_opaque = NULL;
158429e05f20SMarkus Armbruster     bs->buffer_alignment = 512;
158518846deeSMarkus Armbruster }
158618846deeSMarkus Armbruster 
1587fa879d62SMarkus Armbruster /* TODO change to return DeviceState * when all users are qdevified */
1588fa879d62SMarkus Armbruster void *bdrv_get_attached_dev(BlockDriverState *bs)
158918846deeSMarkus Armbruster {
1590fa879d62SMarkus Armbruster     return bs->dev;
159118846deeSMarkus Armbruster }
159218846deeSMarkus Armbruster 
15930e49de52SMarkus Armbruster void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
15940e49de52SMarkus Armbruster                       void *opaque)
15950e49de52SMarkus Armbruster {
15960e49de52SMarkus Armbruster     bs->dev_ops = ops;
15970e49de52SMarkus Armbruster     bs->dev_opaque = opaque;
15982c6942faSMarkus Armbruster     if (bdrv_dev_has_removable_media(bs) && bs == bs_snapshots) {
15992c6942faSMarkus Armbruster         bs_snapshots = NULL;
16002c6942faSMarkus Armbruster     }
16010e49de52SMarkus Armbruster }
16020e49de52SMarkus Armbruster 
160332c81a4aSPaolo Bonzini void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
160432c81a4aSPaolo Bonzini                                enum MonitorEvent ev,
16051ceee0d5SPaolo Bonzini                                BlockErrorAction action, bool is_read)
1606329c0a48SLuiz Capitulino {
1607329c0a48SLuiz Capitulino     QObject *data;
1608329c0a48SLuiz Capitulino     const char *action_str;
1609329c0a48SLuiz Capitulino 
1610329c0a48SLuiz Capitulino     switch (action) {
1611329c0a48SLuiz Capitulino     case BDRV_ACTION_REPORT:
1612329c0a48SLuiz Capitulino         action_str = "report";
1613329c0a48SLuiz Capitulino         break;
1614329c0a48SLuiz Capitulino     case BDRV_ACTION_IGNORE:
1615329c0a48SLuiz Capitulino         action_str = "ignore";
1616329c0a48SLuiz Capitulino         break;
1617329c0a48SLuiz Capitulino     case BDRV_ACTION_STOP:
1618329c0a48SLuiz Capitulino         action_str = "stop";
1619329c0a48SLuiz Capitulino         break;
1620329c0a48SLuiz Capitulino     default:
1621329c0a48SLuiz Capitulino         abort();
1622329c0a48SLuiz Capitulino     }
1623329c0a48SLuiz Capitulino 
1624329c0a48SLuiz Capitulino     data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
1625329c0a48SLuiz Capitulino                               bdrv->device_name,
1626329c0a48SLuiz Capitulino                               action_str,
1627329c0a48SLuiz Capitulino                               is_read ? "read" : "write");
162832c81a4aSPaolo Bonzini     monitor_protocol_event(ev, data);
1629329c0a48SLuiz Capitulino 
1630329c0a48SLuiz Capitulino     qobject_decref(data);
1631329c0a48SLuiz Capitulino }
1632329c0a48SLuiz Capitulino 
16336f382ed2SLuiz Capitulino static void bdrv_emit_qmp_eject_event(BlockDriverState *bs, bool ejected)
16346f382ed2SLuiz Capitulino {
16356f382ed2SLuiz Capitulino     QObject *data;
16366f382ed2SLuiz Capitulino 
16376f382ed2SLuiz Capitulino     data = qobject_from_jsonf("{ 'device': %s, 'tray-open': %i }",
16386f382ed2SLuiz Capitulino                               bdrv_get_device_name(bs), ejected);
16396f382ed2SLuiz Capitulino     monitor_protocol_event(QEVENT_DEVICE_TRAY_MOVED, data);
16406f382ed2SLuiz Capitulino 
16416f382ed2SLuiz Capitulino     qobject_decref(data);
16426f382ed2SLuiz Capitulino }
16436f382ed2SLuiz Capitulino 
16447d4b4ba5SMarkus Armbruster static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load)
16450e49de52SMarkus Armbruster {
1646145feb17SMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->change_media_cb) {
16476f382ed2SLuiz Capitulino         bool tray_was_closed = !bdrv_dev_is_tray_open(bs);
16487d4b4ba5SMarkus Armbruster         bs->dev_ops->change_media_cb(bs->dev_opaque, load);
16496f382ed2SLuiz Capitulino         if (tray_was_closed) {
16506f382ed2SLuiz Capitulino             /* tray open */
16516f382ed2SLuiz Capitulino             bdrv_emit_qmp_eject_event(bs, true);
16526f382ed2SLuiz Capitulino         }
16536f382ed2SLuiz Capitulino         if (load) {
16546f382ed2SLuiz Capitulino             /* tray close */
16556f382ed2SLuiz Capitulino             bdrv_emit_qmp_eject_event(bs, false);
16566f382ed2SLuiz Capitulino         }
1657145feb17SMarkus Armbruster     }
1658145feb17SMarkus Armbruster }
1659145feb17SMarkus Armbruster 
16602c6942faSMarkus Armbruster bool bdrv_dev_has_removable_media(BlockDriverState *bs)
16612c6942faSMarkus Armbruster {
16622c6942faSMarkus Armbruster     return !bs->dev || (bs->dev_ops && bs->dev_ops->change_media_cb);
16632c6942faSMarkus Armbruster }
16642c6942faSMarkus Armbruster 
1665025ccaa7SPaolo Bonzini void bdrv_dev_eject_request(BlockDriverState *bs, bool force)
1666025ccaa7SPaolo Bonzini {
1667025ccaa7SPaolo Bonzini     if (bs->dev_ops && bs->dev_ops->eject_request_cb) {
1668025ccaa7SPaolo Bonzini         bs->dev_ops->eject_request_cb(bs->dev_opaque, force);
1669025ccaa7SPaolo Bonzini     }
1670025ccaa7SPaolo Bonzini }
1671025ccaa7SPaolo Bonzini 
1672e4def80bSMarkus Armbruster bool bdrv_dev_is_tray_open(BlockDriverState *bs)
1673e4def80bSMarkus Armbruster {
1674e4def80bSMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->is_tray_open) {
1675e4def80bSMarkus Armbruster         return bs->dev_ops->is_tray_open(bs->dev_opaque);
1676e4def80bSMarkus Armbruster     }
1677e4def80bSMarkus Armbruster     return false;
1678e4def80bSMarkus Armbruster }
1679e4def80bSMarkus Armbruster 
1680145feb17SMarkus Armbruster static void bdrv_dev_resize_cb(BlockDriverState *bs)
1681145feb17SMarkus Armbruster {
1682145feb17SMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->resize_cb) {
1683145feb17SMarkus Armbruster         bs->dev_ops->resize_cb(bs->dev_opaque);
16840e49de52SMarkus Armbruster     }
16850e49de52SMarkus Armbruster }
16860e49de52SMarkus Armbruster 
1687f107639aSMarkus Armbruster bool bdrv_dev_is_medium_locked(BlockDriverState *bs)
1688f107639aSMarkus Armbruster {
1689f107639aSMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->is_medium_locked) {
1690f107639aSMarkus Armbruster         return bs->dev_ops->is_medium_locked(bs->dev_opaque);
1691f107639aSMarkus Armbruster     }
1692f107639aSMarkus Armbruster     return false;
1693f107639aSMarkus Armbruster }
1694f107639aSMarkus Armbruster 
1695e97fc193Saliguori /*
1696e97fc193Saliguori  * Run consistency checks on an image
1697e97fc193Saliguori  *
1698e076f338SKevin Wolf  * Returns 0 if the check could be completed (it doesn't mean that the image is
1699a1c7273bSStefan Weil  * free of errors) or -errno when an internal error occurred. The results of the
1700e076f338SKevin Wolf  * check are stored in res.
1701e97fc193Saliguori  */
17024534ff54SKevin Wolf int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix)
1703e97fc193Saliguori {
1704e97fc193Saliguori     if (bs->drv->bdrv_check == NULL) {
1705e97fc193Saliguori         return -ENOTSUP;
1706e97fc193Saliguori     }
1707e97fc193Saliguori 
1708e076f338SKevin Wolf     memset(res, 0, sizeof(*res));
17094534ff54SKevin Wolf     return bs->drv->bdrv_check(bs, res, fix);
1710e97fc193Saliguori }
1711e97fc193Saliguori 
17128a426614SKevin Wolf #define COMMIT_BUF_SECTORS 2048
17138a426614SKevin Wolf 
171433e3963eSbellard /* commit COW file into the raw image */
171533e3963eSbellard int bdrv_commit(BlockDriverState *bs)
171633e3963eSbellard {
171719cb3738Sbellard     BlockDriver *drv = bs->drv;
17188a426614SKevin Wolf     int64_t sector, total_sectors;
17198a426614SKevin Wolf     int n, ro, open_flags;
17200bce597dSJeff Cody     int ret = 0;
17218a426614SKevin Wolf     uint8_t *buf;
1722c2cba3d9SJim Meyering     char filename[PATH_MAX];
172333e3963eSbellard 
172419cb3738Sbellard     if (!drv)
172519cb3738Sbellard         return -ENOMEDIUM;
172633e3963eSbellard 
17274dca4b63SNaphtali Sprei     if (!bs->backing_hd) {
17284dca4b63SNaphtali Sprei         return -ENOTSUP;
17294dca4b63SNaphtali Sprei     }
17304dca4b63SNaphtali Sprei 
17312d3735d3SStefan Hajnoczi     if (bdrv_in_use(bs) || bdrv_in_use(bs->backing_hd)) {
17322d3735d3SStefan Hajnoczi         return -EBUSY;
17332d3735d3SStefan Hajnoczi     }
17342d3735d3SStefan Hajnoczi 
17354dca4b63SNaphtali Sprei     ro = bs->backing_hd->read_only;
1736c2cba3d9SJim Meyering     /* Use pstrcpy (not strncpy): filename must be NUL-terminated. */
1737c2cba3d9SJim Meyering     pstrcpy(filename, sizeof(filename), bs->backing_hd->filename);
17384dca4b63SNaphtali Sprei     open_flags =  bs->backing_hd->open_flags;
17394dca4b63SNaphtali Sprei 
17404dca4b63SNaphtali Sprei     if (ro) {
17410bce597dSJeff Cody         if (bdrv_reopen(bs->backing_hd, open_flags | BDRV_O_RDWR, NULL)) {
17420bce597dSJeff Cody             return -EACCES;
17434dca4b63SNaphtali Sprei         }
1744ea2384d3Sbellard     }
1745ea2384d3Sbellard 
17466ea44308SJan Kiszka     total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
17477267c094SAnthony Liguori     buf = g_malloc(COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE);
17488a426614SKevin Wolf 
17498a426614SKevin Wolf     for (sector = 0; sector < total_sectors; sector += n) {
175005c4af54SStefan Hajnoczi         if (bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n)) {
17518a426614SKevin Wolf 
17528a426614SKevin Wolf             if (bdrv_read(bs, sector, buf, n) != 0) {
17534dca4b63SNaphtali Sprei                 ret = -EIO;
17544dca4b63SNaphtali Sprei                 goto ro_cleanup;
175533e3963eSbellard             }
175633e3963eSbellard 
17578a426614SKevin Wolf             if (bdrv_write(bs->backing_hd, sector, buf, n) != 0) {
17584dca4b63SNaphtali Sprei                 ret = -EIO;
17594dca4b63SNaphtali Sprei                 goto ro_cleanup;
176033e3963eSbellard             }
176133e3963eSbellard         }
176233e3963eSbellard     }
176395389c86Sbellard 
17641d44952fSChristoph Hellwig     if (drv->bdrv_make_empty) {
17651d44952fSChristoph Hellwig         ret = drv->bdrv_make_empty(bs);
17661d44952fSChristoph Hellwig         bdrv_flush(bs);
17671d44952fSChristoph Hellwig     }
176895389c86Sbellard 
17693f5075aeSChristoph Hellwig     /*
17703f5075aeSChristoph Hellwig      * Make sure all data we wrote to the backing device is actually
17713f5075aeSChristoph Hellwig      * stable on disk.
17723f5075aeSChristoph Hellwig      */
17733f5075aeSChristoph Hellwig     if (bs->backing_hd)
17743f5075aeSChristoph Hellwig         bdrv_flush(bs->backing_hd);
17754dca4b63SNaphtali Sprei 
17764dca4b63SNaphtali Sprei ro_cleanup:
17777267c094SAnthony Liguori     g_free(buf);
17784dca4b63SNaphtali Sprei 
17794dca4b63SNaphtali Sprei     if (ro) {
17800bce597dSJeff Cody         /* ignoring error return here */
17810bce597dSJeff Cody         bdrv_reopen(bs->backing_hd, open_flags & ~BDRV_O_RDWR, NULL);
17824dca4b63SNaphtali Sprei     }
17834dca4b63SNaphtali Sprei 
17841d44952fSChristoph Hellwig     return ret;
178533e3963eSbellard }
178633e3963eSbellard 
1787e8877497SStefan Hajnoczi int bdrv_commit_all(void)
17886ab4b5abSMarkus Armbruster {
17896ab4b5abSMarkus Armbruster     BlockDriverState *bs;
17906ab4b5abSMarkus Armbruster 
17916ab4b5abSMarkus Armbruster     QTAILQ_FOREACH(bs, &bdrv_states, list) {
1792272d2d8eSJeff Cody         if (bs->drv && bs->backing_hd) {
1793e8877497SStefan Hajnoczi             int ret = bdrv_commit(bs);
1794e8877497SStefan Hajnoczi             if (ret < 0) {
1795e8877497SStefan Hajnoczi                 return ret;
17966ab4b5abSMarkus Armbruster             }
17976ab4b5abSMarkus Armbruster         }
1798272d2d8eSJeff Cody     }
1799e8877497SStefan Hajnoczi     return 0;
1800e8877497SStefan Hajnoczi }
18016ab4b5abSMarkus Armbruster 
1802dbffbdcfSStefan Hajnoczi struct BdrvTrackedRequest {
1803dbffbdcfSStefan Hajnoczi     BlockDriverState *bs;
1804dbffbdcfSStefan Hajnoczi     int64_t sector_num;
1805dbffbdcfSStefan Hajnoczi     int nb_sectors;
1806dbffbdcfSStefan Hajnoczi     bool is_write;
1807dbffbdcfSStefan Hajnoczi     QLIST_ENTRY(BdrvTrackedRequest) list;
18085f8b6491SStefan Hajnoczi     Coroutine *co; /* owner, used for deadlock detection */
1809f4658285SStefan Hajnoczi     CoQueue wait_queue; /* coroutines blocked on this request */
1810dbffbdcfSStefan Hajnoczi };
1811dbffbdcfSStefan Hajnoczi 
1812dbffbdcfSStefan Hajnoczi /**
1813dbffbdcfSStefan Hajnoczi  * Remove an active request from the tracked requests list
1814dbffbdcfSStefan Hajnoczi  *
1815dbffbdcfSStefan Hajnoczi  * This function should be called when a tracked request is completing.
1816dbffbdcfSStefan Hajnoczi  */
1817dbffbdcfSStefan Hajnoczi static void tracked_request_end(BdrvTrackedRequest *req)
1818dbffbdcfSStefan Hajnoczi {
1819dbffbdcfSStefan Hajnoczi     QLIST_REMOVE(req, list);
1820f4658285SStefan Hajnoczi     qemu_co_queue_restart_all(&req->wait_queue);
1821dbffbdcfSStefan Hajnoczi }
1822dbffbdcfSStefan Hajnoczi 
1823dbffbdcfSStefan Hajnoczi /**
1824dbffbdcfSStefan Hajnoczi  * Add an active request to the tracked requests list
1825dbffbdcfSStefan Hajnoczi  */
1826dbffbdcfSStefan Hajnoczi static void tracked_request_begin(BdrvTrackedRequest *req,
1827dbffbdcfSStefan Hajnoczi                                   BlockDriverState *bs,
1828dbffbdcfSStefan Hajnoczi                                   int64_t sector_num,
1829dbffbdcfSStefan Hajnoczi                                   int nb_sectors, bool is_write)
1830dbffbdcfSStefan Hajnoczi {
1831dbffbdcfSStefan Hajnoczi     *req = (BdrvTrackedRequest){
1832dbffbdcfSStefan Hajnoczi         .bs = bs,
1833dbffbdcfSStefan Hajnoczi         .sector_num = sector_num,
1834dbffbdcfSStefan Hajnoczi         .nb_sectors = nb_sectors,
1835dbffbdcfSStefan Hajnoczi         .is_write = is_write,
18365f8b6491SStefan Hajnoczi         .co = qemu_coroutine_self(),
1837dbffbdcfSStefan Hajnoczi     };
1838dbffbdcfSStefan Hajnoczi 
1839f4658285SStefan Hajnoczi     qemu_co_queue_init(&req->wait_queue);
1840f4658285SStefan Hajnoczi 
1841dbffbdcfSStefan Hajnoczi     QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
1842dbffbdcfSStefan Hajnoczi }
1843dbffbdcfSStefan Hajnoczi 
1844d83947acSStefan Hajnoczi /**
1845d83947acSStefan Hajnoczi  * Round a region to cluster boundaries
1846d83947acSStefan Hajnoczi  */
1847343bded4SPaolo Bonzini void bdrv_round_to_clusters(BlockDriverState *bs,
1848d83947acSStefan Hajnoczi                             int64_t sector_num, int nb_sectors,
1849d83947acSStefan Hajnoczi                             int64_t *cluster_sector_num,
1850d83947acSStefan Hajnoczi                             int *cluster_nb_sectors)
1851d83947acSStefan Hajnoczi {
1852d83947acSStefan Hajnoczi     BlockDriverInfo bdi;
1853d83947acSStefan Hajnoczi 
1854d83947acSStefan Hajnoczi     if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
1855d83947acSStefan Hajnoczi         *cluster_sector_num = sector_num;
1856d83947acSStefan Hajnoczi         *cluster_nb_sectors = nb_sectors;
1857d83947acSStefan Hajnoczi     } else {
1858d83947acSStefan Hajnoczi         int64_t c = bdi.cluster_size / BDRV_SECTOR_SIZE;
1859d83947acSStefan Hajnoczi         *cluster_sector_num = QEMU_ALIGN_DOWN(sector_num, c);
1860d83947acSStefan Hajnoczi         *cluster_nb_sectors = QEMU_ALIGN_UP(sector_num - *cluster_sector_num +
1861d83947acSStefan Hajnoczi                                             nb_sectors, c);
1862d83947acSStefan Hajnoczi     }
1863d83947acSStefan Hajnoczi }
1864d83947acSStefan Hajnoczi 
1865f4658285SStefan Hajnoczi static bool tracked_request_overlaps(BdrvTrackedRequest *req,
1866f4658285SStefan Hajnoczi                                      int64_t sector_num, int nb_sectors) {
1867d83947acSStefan Hajnoczi     /*        aaaa   bbbb */
1868d83947acSStefan Hajnoczi     if (sector_num >= req->sector_num + req->nb_sectors) {
1869d83947acSStefan Hajnoczi         return false;
1870d83947acSStefan Hajnoczi     }
1871d83947acSStefan Hajnoczi     /* bbbb   aaaa        */
1872d83947acSStefan Hajnoczi     if (req->sector_num >= sector_num + nb_sectors) {
1873d83947acSStefan Hajnoczi         return false;
1874d83947acSStefan Hajnoczi     }
1875d83947acSStefan Hajnoczi     return true;
1876f4658285SStefan Hajnoczi }
1877f4658285SStefan Hajnoczi 
1878f4658285SStefan Hajnoczi static void coroutine_fn wait_for_overlapping_requests(BlockDriverState *bs,
1879f4658285SStefan Hajnoczi         int64_t sector_num, int nb_sectors)
1880f4658285SStefan Hajnoczi {
1881f4658285SStefan Hajnoczi     BdrvTrackedRequest *req;
1882d83947acSStefan Hajnoczi     int64_t cluster_sector_num;
1883d83947acSStefan Hajnoczi     int cluster_nb_sectors;
1884f4658285SStefan Hajnoczi     bool retry;
1885f4658285SStefan Hajnoczi 
1886d83947acSStefan Hajnoczi     /* If we touch the same cluster it counts as an overlap.  This guarantees
1887d83947acSStefan Hajnoczi      * that allocating writes will be serialized and not race with each other
1888d83947acSStefan Hajnoczi      * for the same cluster.  For example, in copy-on-read it ensures that the
1889d83947acSStefan Hajnoczi      * CoR read and write operations are atomic and guest writes cannot
1890d83947acSStefan Hajnoczi      * interleave between them.
1891d83947acSStefan Hajnoczi      */
1892343bded4SPaolo Bonzini     bdrv_round_to_clusters(bs, sector_num, nb_sectors,
1893d83947acSStefan Hajnoczi                            &cluster_sector_num, &cluster_nb_sectors);
1894d83947acSStefan Hajnoczi 
1895f4658285SStefan Hajnoczi     do {
1896f4658285SStefan Hajnoczi         retry = false;
1897f4658285SStefan Hajnoczi         QLIST_FOREACH(req, &bs->tracked_requests, list) {
1898d83947acSStefan Hajnoczi             if (tracked_request_overlaps(req, cluster_sector_num,
1899d83947acSStefan Hajnoczi                                          cluster_nb_sectors)) {
19005f8b6491SStefan Hajnoczi                 /* Hitting this means there was a reentrant request, for
19015f8b6491SStefan Hajnoczi                  * example, a block driver issuing nested requests.  This must
19025f8b6491SStefan Hajnoczi                  * never happen since it means deadlock.
19035f8b6491SStefan Hajnoczi                  */
19045f8b6491SStefan Hajnoczi                 assert(qemu_coroutine_self() != req->co);
19055f8b6491SStefan Hajnoczi 
1906f4658285SStefan Hajnoczi                 qemu_co_queue_wait(&req->wait_queue);
1907f4658285SStefan Hajnoczi                 retry = true;
1908f4658285SStefan Hajnoczi                 break;
1909f4658285SStefan Hajnoczi             }
1910f4658285SStefan Hajnoczi         }
1911f4658285SStefan Hajnoczi     } while (retry);
1912f4658285SStefan Hajnoczi }
1913f4658285SStefan Hajnoczi 
1914756e6736SKevin Wolf /*
1915756e6736SKevin Wolf  * Return values:
1916756e6736SKevin Wolf  * 0        - success
1917756e6736SKevin Wolf  * -EINVAL  - backing format specified, but no file
1918756e6736SKevin Wolf  * -ENOSPC  - can't update the backing file because no space is left in the
1919756e6736SKevin Wolf  *            image file header
1920756e6736SKevin Wolf  * -ENOTSUP - format driver doesn't support changing the backing file
1921756e6736SKevin Wolf  */
1922756e6736SKevin Wolf int bdrv_change_backing_file(BlockDriverState *bs,
1923756e6736SKevin Wolf     const char *backing_file, const char *backing_fmt)
1924756e6736SKevin Wolf {
1925756e6736SKevin Wolf     BlockDriver *drv = bs->drv;
1926469ef350SPaolo Bonzini     int ret;
1927756e6736SKevin Wolf 
19285f377794SPaolo Bonzini     /* Backing file format doesn't make sense without a backing file */
19295f377794SPaolo Bonzini     if (backing_fmt && !backing_file) {
19305f377794SPaolo Bonzini         return -EINVAL;
19315f377794SPaolo Bonzini     }
19325f377794SPaolo Bonzini 
1933756e6736SKevin Wolf     if (drv->bdrv_change_backing_file != NULL) {
1934469ef350SPaolo Bonzini         ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
1935756e6736SKevin Wolf     } else {
1936469ef350SPaolo Bonzini         ret = -ENOTSUP;
1937756e6736SKevin Wolf     }
1938469ef350SPaolo Bonzini 
1939469ef350SPaolo Bonzini     if (ret == 0) {
1940469ef350SPaolo Bonzini         pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1941469ef350SPaolo Bonzini         pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1942469ef350SPaolo Bonzini     }
1943469ef350SPaolo Bonzini     return ret;
1944756e6736SKevin Wolf }
1945756e6736SKevin Wolf 
19466ebdcee2SJeff Cody /*
19476ebdcee2SJeff Cody  * Finds the image layer in the chain that has 'bs' as its backing file.
19486ebdcee2SJeff Cody  *
19496ebdcee2SJeff Cody  * active is the current topmost image.
19506ebdcee2SJeff Cody  *
19516ebdcee2SJeff Cody  * Returns NULL if bs is not found in active's image chain,
19526ebdcee2SJeff Cody  * or if active == bs.
19536ebdcee2SJeff Cody  */
19546ebdcee2SJeff Cody BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
19556ebdcee2SJeff Cody                                     BlockDriverState *bs)
19566ebdcee2SJeff Cody {
19576ebdcee2SJeff Cody     BlockDriverState *overlay = NULL;
19586ebdcee2SJeff Cody     BlockDriverState *intermediate;
19596ebdcee2SJeff Cody 
19606ebdcee2SJeff Cody     assert(active != NULL);
19616ebdcee2SJeff Cody     assert(bs != NULL);
19626ebdcee2SJeff Cody 
19636ebdcee2SJeff Cody     /* if bs is the same as active, then by definition it has no overlay
19646ebdcee2SJeff Cody      */
19656ebdcee2SJeff Cody     if (active == bs) {
19666ebdcee2SJeff Cody         return NULL;
19676ebdcee2SJeff Cody     }
19686ebdcee2SJeff Cody 
19696ebdcee2SJeff Cody     intermediate = active;
19706ebdcee2SJeff Cody     while (intermediate->backing_hd) {
19716ebdcee2SJeff Cody         if (intermediate->backing_hd == bs) {
19726ebdcee2SJeff Cody             overlay = intermediate;
19736ebdcee2SJeff Cody             break;
19746ebdcee2SJeff Cody         }
19756ebdcee2SJeff Cody         intermediate = intermediate->backing_hd;
19766ebdcee2SJeff Cody     }
19776ebdcee2SJeff Cody 
19786ebdcee2SJeff Cody     return overlay;
19796ebdcee2SJeff Cody }
19806ebdcee2SJeff Cody 
19816ebdcee2SJeff Cody typedef struct BlkIntermediateStates {
19826ebdcee2SJeff Cody     BlockDriverState *bs;
19836ebdcee2SJeff Cody     QSIMPLEQ_ENTRY(BlkIntermediateStates) entry;
19846ebdcee2SJeff Cody } BlkIntermediateStates;
19856ebdcee2SJeff Cody 
19866ebdcee2SJeff Cody 
19876ebdcee2SJeff Cody /*
19886ebdcee2SJeff Cody  * Drops images above 'base' up to and including 'top', and sets the image
19896ebdcee2SJeff Cody  * above 'top' to have base as its backing file.
19906ebdcee2SJeff Cody  *
19916ebdcee2SJeff Cody  * Requires that the overlay to 'top' is opened r/w, so that the backing file
19926ebdcee2SJeff Cody  * information in 'bs' can be properly updated.
19936ebdcee2SJeff Cody  *
19946ebdcee2SJeff Cody  * E.g., this will convert the following chain:
19956ebdcee2SJeff Cody  * bottom <- base <- intermediate <- top <- active
19966ebdcee2SJeff Cody  *
19976ebdcee2SJeff Cody  * to
19986ebdcee2SJeff Cody  *
19996ebdcee2SJeff Cody  * bottom <- base <- active
20006ebdcee2SJeff Cody  *
20016ebdcee2SJeff Cody  * It is allowed for bottom==base, in which case it converts:
20026ebdcee2SJeff Cody  *
20036ebdcee2SJeff Cody  * base <- intermediate <- top <- active
20046ebdcee2SJeff Cody  *
20056ebdcee2SJeff Cody  * to
20066ebdcee2SJeff Cody  *
20076ebdcee2SJeff Cody  * base <- active
20086ebdcee2SJeff Cody  *
20096ebdcee2SJeff Cody  * Error conditions:
20106ebdcee2SJeff Cody  *  if active == top, that is considered an error
20116ebdcee2SJeff Cody  *
20126ebdcee2SJeff Cody  */
20136ebdcee2SJeff Cody int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
20146ebdcee2SJeff Cody                            BlockDriverState *base)
20156ebdcee2SJeff Cody {
20166ebdcee2SJeff Cody     BlockDriverState *intermediate;
20176ebdcee2SJeff Cody     BlockDriverState *base_bs = NULL;
20186ebdcee2SJeff Cody     BlockDriverState *new_top_bs = NULL;
20196ebdcee2SJeff Cody     BlkIntermediateStates *intermediate_state, *next;
20206ebdcee2SJeff Cody     int ret = -EIO;
20216ebdcee2SJeff Cody 
20226ebdcee2SJeff Cody     QSIMPLEQ_HEAD(states_to_delete, BlkIntermediateStates) states_to_delete;
20236ebdcee2SJeff Cody     QSIMPLEQ_INIT(&states_to_delete);
20246ebdcee2SJeff Cody 
20256ebdcee2SJeff Cody     if (!top->drv || !base->drv) {
20266ebdcee2SJeff Cody         goto exit;
20276ebdcee2SJeff Cody     }
20286ebdcee2SJeff Cody 
20296ebdcee2SJeff Cody     new_top_bs = bdrv_find_overlay(active, top);
20306ebdcee2SJeff Cody 
20316ebdcee2SJeff Cody     if (new_top_bs == NULL) {
20326ebdcee2SJeff Cody         /* we could not find the image above 'top', this is an error */
20336ebdcee2SJeff Cody         goto exit;
20346ebdcee2SJeff Cody     }
20356ebdcee2SJeff Cody 
20366ebdcee2SJeff Cody     /* special case of new_top_bs->backing_hd already pointing to base - nothing
20376ebdcee2SJeff Cody      * to do, no intermediate images */
20386ebdcee2SJeff Cody     if (new_top_bs->backing_hd == base) {
20396ebdcee2SJeff Cody         ret = 0;
20406ebdcee2SJeff Cody         goto exit;
20416ebdcee2SJeff Cody     }
20426ebdcee2SJeff Cody 
20436ebdcee2SJeff Cody     intermediate = top;
20446ebdcee2SJeff Cody 
20456ebdcee2SJeff Cody     /* now we will go down through the list, and add each BDS we find
20466ebdcee2SJeff Cody      * into our deletion queue, until we hit the 'base'
20476ebdcee2SJeff Cody      */
20486ebdcee2SJeff Cody     while (intermediate) {
20496ebdcee2SJeff Cody         intermediate_state = g_malloc0(sizeof(BlkIntermediateStates));
20506ebdcee2SJeff Cody         intermediate_state->bs = intermediate;
20516ebdcee2SJeff Cody         QSIMPLEQ_INSERT_TAIL(&states_to_delete, intermediate_state, entry);
20526ebdcee2SJeff Cody 
20536ebdcee2SJeff Cody         if (intermediate->backing_hd == base) {
20546ebdcee2SJeff Cody             base_bs = intermediate->backing_hd;
20556ebdcee2SJeff Cody             break;
20566ebdcee2SJeff Cody         }
20576ebdcee2SJeff Cody         intermediate = intermediate->backing_hd;
20586ebdcee2SJeff Cody     }
20596ebdcee2SJeff Cody     if (base_bs == NULL) {
20606ebdcee2SJeff Cody         /* something went wrong, we did not end at the base. safely
20616ebdcee2SJeff Cody          * unravel everything, and exit with error */
20626ebdcee2SJeff Cody         goto exit;
20636ebdcee2SJeff Cody     }
20646ebdcee2SJeff Cody 
20656ebdcee2SJeff Cody     /* success - we can delete the intermediate states, and link top->base */
20666ebdcee2SJeff Cody     ret = bdrv_change_backing_file(new_top_bs, base_bs->filename,
20676ebdcee2SJeff Cody                                    base_bs->drv ? base_bs->drv->format_name : "");
20686ebdcee2SJeff Cody     if (ret) {
20696ebdcee2SJeff Cody         goto exit;
20706ebdcee2SJeff Cody     }
20716ebdcee2SJeff Cody     new_top_bs->backing_hd = base_bs;
20726ebdcee2SJeff Cody 
20736ebdcee2SJeff Cody 
20746ebdcee2SJeff Cody     QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) {
20756ebdcee2SJeff Cody         /* so that bdrv_close() does not recursively close the chain */
20766ebdcee2SJeff Cody         intermediate_state->bs->backing_hd = NULL;
20776ebdcee2SJeff Cody         bdrv_delete(intermediate_state->bs);
20786ebdcee2SJeff Cody     }
20796ebdcee2SJeff Cody     ret = 0;
20806ebdcee2SJeff Cody 
20816ebdcee2SJeff Cody exit:
20826ebdcee2SJeff Cody     QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) {
20836ebdcee2SJeff Cody         g_free(intermediate_state);
20846ebdcee2SJeff Cody     }
20856ebdcee2SJeff Cody     return ret;
20866ebdcee2SJeff Cody }
20876ebdcee2SJeff Cody 
20886ebdcee2SJeff Cody 
208971d0770cSaliguori static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
209071d0770cSaliguori                                    size_t size)
209171d0770cSaliguori {
209271d0770cSaliguori     int64_t len;
209371d0770cSaliguori 
209471d0770cSaliguori     if (!bdrv_is_inserted(bs))
209571d0770cSaliguori         return -ENOMEDIUM;
209671d0770cSaliguori 
209771d0770cSaliguori     if (bs->growable)
209871d0770cSaliguori         return 0;
209971d0770cSaliguori 
210071d0770cSaliguori     len = bdrv_getlength(bs);
210171d0770cSaliguori 
2102fbb7b4e0SKevin Wolf     if (offset < 0)
2103fbb7b4e0SKevin Wolf         return -EIO;
2104fbb7b4e0SKevin Wolf 
2105fbb7b4e0SKevin Wolf     if ((offset > len) || (len - offset < size))
210671d0770cSaliguori         return -EIO;
210771d0770cSaliguori 
210871d0770cSaliguori     return 0;
210971d0770cSaliguori }
211071d0770cSaliguori 
211171d0770cSaliguori static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
211271d0770cSaliguori                               int nb_sectors)
211371d0770cSaliguori {
2114eb5a3165SJes Sorensen     return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
2115eb5a3165SJes Sorensen                                    nb_sectors * BDRV_SECTOR_SIZE);
211671d0770cSaliguori }
211771d0770cSaliguori 
21181c9805a3SStefan Hajnoczi typedef struct RwCo {
21191c9805a3SStefan Hajnoczi     BlockDriverState *bs;
21201c9805a3SStefan Hajnoczi     int64_t sector_num;
21211c9805a3SStefan Hajnoczi     int nb_sectors;
21221c9805a3SStefan Hajnoczi     QEMUIOVector *qiov;
21231c9805a3SStefan Hajnoczi     bool is_write;
21241c9805a3SStefan Hajnoczi     int ret;
21251c9805a3SStefan Hajnoczi } RwCo;
21261c9805a3SStefan Hajnoczi 
21271c9805a3SStefan Hajnoczi static void coroutine_fn bdrv_rw_co_entry(void *opaque)
2128fc01f7e7Sbellard {
21291c9805a3SStefan Hajnoczi     RwCo *rwco = opaque;
2130fc01f7e7Sbellard 
21311c9805a3SStefan Hajnoczi     if (!rwco->is_write) {
21321c9805a3SStefan Hajnoczi         rwco->ret = bdrv_co_do_readv(rwco->bs, rwco->sector_num,
2133470c0504SStefan Hajnoczi                                      rwco->nb_sectors, rwco->qiov, 0);
21341c9805a3SStefan Hajnoczi     } else {
21351c9805a3SStefan Hajnoczi         rwco->ret = bdrv_co_do_writev(rwco->bs, rwco->sector_num,
2136f08f2ddaSStefan Hajnoczi                                       rwco->nb_sectors, rwco->qiov, 0);
21371c9805a3SStefan Hajnoczi     }
21381c9805a3SStefan Hajnoczi }
2139e7a8a783SKevin Wolf 
21401c9805a3SStefan Hajnoczi /*
21418d3b1a2dSKevin Wolf  * Process a vectored synchronous request using coroutines
21421c9805a3SStefan Hajnoczi  */
21438d3b1a2dSKevin Wolf static int bdrv_rwv_co(BlockDriverState *bs, int64_t sector_num,
21448d3b1a2dSKevin Wolf                        QEMUIOVector *qiov, bool is_write)
21451c9805a3SStefan Hajnoczi {
21461c9805a3SStefan Hajnoczi     Coroutine *co;
21471c9805a3SStefan Hajnoczi     RwCo rwco = {
21481c9805a3SStefan Hajnoczi         .bs = bs,
21491c9805a3SStefan Hajnoczi         .sector_num = sector_num,
21508d3b1a2dSKevin Wolf         .nb_sectors = qiov->size >> BDRV_SECTOR_BITS,
21518d3b1a2dSKevin Wolf         .qiov = qiov,
21521c9805a3SStefan Hajnoczi         .is_write = is_write,
21531c9805a3SStefan Hajnoczi         .ret = NOT_DONE,
21541c9805a3SStefan Hajnoczi     };
21558d3b1a2dSKevin Wolf     assert((qiov->size & (BDRV_SECTOR_SIZE - 1)) == 0);
21561c9805a3SStefan Hajnoczi 
2157498e386cSZhi Yong Wu     /**
2158498e386cSZhi Yong Wu      * In sync call context, when the vcpu is blocked, this throttling timer
2159498e386cSZhi Yong Wu      * will not fire; so the I/O throttling function has to be disabled here
2160498e386cSZhi Yong Wu      * if it has been enabled.
2161498e386cSZhi Yong Wu      */
2162498e386cSZhi Yong Wu     if (bs->io_limits_enabled) {
2163498e386cSZhi Yong Wu         fprintf(stderr, "Disabling I/O throttling on '%s' due "
2164498e386cSZhi Yong Wu                         "to synchronous I/O.\n", bdrv_get_device_name(bs));
2165498e386cSZhi Yong Wu         bdrv_io_limits_disable(bs);
2166498e386cSZhi Yong Wu     }
2167498e386cSZhi Yong Wu 
21681c9805a3SStefan Hajnoczi     if (qemu_in_coroutine()) {
21691c9805a3SStefan Hajnoczi         /* Fast-path if already in coroutine context */
21701c9805a3SStefan Hajnoczi         bdrv_rw_co_entry(&rwco);
21711c9805a3SStefan Hajnoczi     } else {
21721c9805a3SStefan Hajnoczi         co = qemu_coroutine_create(bdrv_rw_co_entry);
21731c9805a3SStefan Hajnoczi         qemu_coroutine_enter(co, &rwco);
21741c9805a3SStefan Hajnoczi         while (rwco.ret == NOT_DONE) {
21751c9805a3SStefan Hajnoczi             qemu_aio_wait();
21761c9805a3SStefan Hajnoczi         }
21771c9805a3SStefan Hajnoczi     }
21781c9805a3SStefan Hajnoczi     return rwco.ret;
2179e7a8a783SKevin Wolf }
2180e7a8a783SKevin Wolf 
21818d3b1a2dSKevin Wolf /*
21828d3b1a2dSKevin Wolf  * Process a synchronous request using coroutines
21838d3b1a2dSKevin Wolf  */
21848d3b1a2dSKevin Wolf static int bdrv_rw_co(BlockDriverState *bs, int64_t sector_num, uint8_t *buf,
21858d3b1a2dSKevin Wolf                       int nb_sectors, bool is_write)
21868d3b1a2dSKevin Wolf {
21878d3b1a2dSKevin Wolf     QEMUIOVector qiov;
21888d3b1a2dSKevin Wolf     struct iovec iov = {
21898d3b1a2dSKevin Wolf         .iov_base = (void *)buf,
21908d3b1a2dSKevin Wolf         .iov_len = nb_sectors * BDRV_SECTOR_SIZE,
21918d3b1a2dSKevin Wolf     };
21928d3b1a2dSKevin Wolf 
21938d3b1a2dSKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
21948d3b1a2dSKevin Wolf     return bdrv_rwv_co(bs, sector_num, &qiov, is_write);
21958d3b1a2dSKevin Wolf }
21968d3b1a2dSKevin Wolf 
21971c9805a3SStefan Hajnoczi /* return < 0 if error. See bdrv_write() for the return codes */
21981c9805a3SStefan Hajnoczi int bdrv_read(BlockDriverState *bs, int64_t sector_num,
21991c9805a3SStefan Hajnoczi               uint8_t *buf, int nb_sectors)
22001c9805a3SStefan Hajnoczi {
22011c9805a3SStefan Hajnoczi     return bdrv_rw_co(bs, sector_num, buf, nb_sectors, false);
220283f64091Sbellard }
2203fc01f7e7Sbellard 
220407d27a44SMarkus Armbruster /* Just like bdrv_read(), but with I/O throttling temporarily disabled */
220507d27a44SMarkus Armbruster int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
220607d27a44SMarkus Armbruster                           uint8_t *buf, int nb_sectors)
220707d27a44SMarkus Armbruster {
220807d27a44SMarkus Armbruster     bool enabled;
220907d27a44SMarkus Armbruster     int ret;
221007d27a44SMarkus Armbruster 
221107d27a44SMarkus Armbruster     enabled = bs->io_limits_enabled;
221207d27a44SMarkus Armbruster     bs->io_limits_enabled = false;
221307d27a44SMarkus Armbruster     ret = bdrv_read(bs, 0, buf, 1);
221407d27a44SMarkus Armbruster     bs->io_limits_enabled = enabled;
221507d27a44SMarkus Armbruster     return ret;
221607d27a44SMarkus Armbruster }
221707d27a44SMarkus Armbruster 
221819cb3738Sbellard /* Return < 0 if error. Important errors are:
221919cb3738Sbellard   -EIO         generic I/O error (may happen for all errors)
222019cb3738Sbellard   -ENOMEDIUM   No media inserted.
222119cb3738Sbellard   -EINVAL      Invalid sector number or nb_sectors
222219cb3738Sbellard   -EACCES      Trying to write a read-only device
222319cb3738Sbellard */
2224fc01f7e7Sbellard int bdrv_write(BlockDriverState *bs, int64_t sector_num,
2225fc01f7e7Sbellard                const uint8_t *buf, int nb_sectors)
2226fc01f7e7Sbellard {
22271c9805a3SStefan Hajnoczi     return bdrv_rw_co(bs, sector_num, (uint8_t *)buf, nb_sectors, true);
222883f64091Sbellard }
222983f64091Sbellard 
22308d3b1a2dSKevin Wolf int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov)
22318d3b1a2dSKevin Wolf {
22328d3b1a2dSKevin Wolf     return bdrv_rwv_co(bs, sector_num, qiov, true);
22338d3b1a2dSKevin Wolf }
22348d3b1a2dSKevin Wolf 
2235eda578e5Saliguori int bdrv_pread(BlockDriverState *bs, int64_t offset,
2236eda578e5Saliguori                void *buf, int count1)
223783f64091Sbellard {
22386ea44308SJan Kiszka     uint8_t tmp_buf[BDRV_SECTOR_SIZE];
223983f64091Sbellard     int len, nb_sectors, count;
224083f64091Sbellard     int64_t sector_num;
22419a8c4cceSKevin Wolf     int ret;
224283f64091Sbellard 
224383f64091Sbellard     count = count1;
224483f64091Sbellard     /* first read to align to sector start */
22456ea44308SJan Kiszka     len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
224683f64091Sbellard     if (len > count)
224783f64091Sbellard         len = count;
22486ea44308SJan Kiszka     sector_num = offset >> BDRV_SECTOR_BITS;
224983f64091Sbellard     if (len > 0) {
22509a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
22519a8c4cceSKevin Wolf             return ret;
22526ea44308SJan Kiszka         memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
225383f64091Sbellard         count -= len;
225483f64091Sbellard         if (count == 0)
225583f64091Sbellard             return count1;
225683f64091Sbellard         sector_num++;
225783f64091Sbellard         buf += len;
225883f64091Sbellard     }
225983f64091Sbellard 
226083f64091Sbellard     /* read the sectors "in place" */
22616ea44308SJan Kiszka     nb_sectors = count >> BDRV_SECTOR_BITS;
226283f64091Sbellard     if (nb_sectors > 0) {
22639a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
22649a8c4cceSKevin Wolf             return ret;
226583f64091Sbellard         sector_num += nb_sectors;
22666ea44308SJan Kiszka         len = nb_sectors << BDRV_SECTOR_BITS;
226783f64091Sbellard         buf += len;
226883f64091Sbellard         count -= len;
226983f64091Sbellard     }
227083f64091Sbellard 
227183f64091Sbellard     /* add data from the last sector */
227283f64091Sbellard     if (count > 0) {
22739a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
22749a8c4cceSKevin Wolf             return ret;
227583f64091Sbellard         memcpy(buf, tmp_buf, count);
227683f64091Sbellard     }
227783f64091Sbellard     return count1;
227883f64091Sbellard }
227983f64091Sbellard 
22808d3b1a2dSKevin Wolf int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov)
228183f64091Sbellard {
22826ea44308SJan Kiszka     uint8_t tmp_buf[BDRV_SECTOR_SIZE];
228383f64091Sbellard     int len, nb_sectors, count;
228483f64091Sbellard     int64_t sector_num;
22859a8c4cceSKevin Wolf     int ret;
228683f64091Sbellard 
22878d3b1a2dSKevin Wolf     count = qiov->size;
22888d3b1a2dSKevin Wolf 
228983f64091Sbellard     /* first write to align to sector start */
22906ea44308SJan Kiszka     len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
229183f64091Sbellard     if (len > count)
229283f64091Sbellard         len = count;
22936ea44308SJan Kiszka     sector_num = offset >> BDRV_SECTOR_BITS;
229483f64091Sbellard     if (len > 0) {
22959a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
22969a8c4cceSKevin Wolf             return ret;
22978d3b1a2dSKevin Wolf         qemu_iovec_to_buf(qiov, 0, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)),
22988d3b1a2dSKevin Wolf                           len);
22999a8c4cceSKevin Wolf         if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
23009a8c4cceSKevin Wolf             return ret;
230183f64091Sbellard         count -= len;
230283f64091Sbellard         if (count == 0)
23038d3b1a2dSKevin Wolf             return qiov->size;
230483f64091Sbellard         sector_num++;
230583f64091Sbellard     }
230683f64091Sbellard 
230783f64091Sbellard     /* write the sectors "in place" */
23086ea44308SJan Kiszka     nb_sectors = count >> BDRV_SECTOR_BITS;
230983f64091Sbellard     if (nb_sectors > 0) {
23108d3b1a2dSKevin Wolf         QEMUIOVector qiov_inplace;
23118d3b1a2dSKevin Wolf 
23128d3b1a2dSKevin Wolf         qemu_iovec_init(&qiov_inplace, qiov->niov);
23138d3b1a2dSKevin Wolf         qemu_iovec_concat(&qiov_inplace, qiov, len,
23148d3b1a2dSKevin Wolf                           nb_sectors << BDRV_SECTOR_BITS);
23158d3b1a2dSKevin Wolf         ret = bdrv_writev(bs, sector_num, &qiov_inplace);
23168d3b1a2dSKevin Wolf         qemu_iovec_destroy(&qiov_inplace);
23178d3b1a2dSKevin Wolf         if (ret < 0) {
23189a8c4cceSKevin Wolf             return ret;
23198d3b1a2dSKevin Wolf         }
23208d3b1a2dSKevin Wolf 
232183f64091Sbellard         sector_num += nb_sectors;
23226ea44308SJan Kiszka         len = nb_sectors << BDRV_SECTOR_BITS;
232383f64091Sbellard         count -= len;
232483f64091Sbellard     }
232583f64091Sbellard 
232683f64091Sbellard     /* add data from the last sector */
232783f64091Sbellard     if (count > 0) {
23289a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
23299a8c4cceSKevin Wolf             return ret;
23308d3b1a2dSKevin Wolf         qemu_iovec_to_buf(qiov, qiov->size - count, tmp_buf, count);
23319a8c4cceSKevin Wolf         if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
23329a8c4cceSKevin Wolf             return ret;
233383f64091Sbellard     }
23348d3b1a2dSKevin Wolf     return qiov->size;
23358d3b1a2dSKevin Wolf }
23368d3b1a2dSKevin Wolf 
23378d3b1a2dSKevin Wolf int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
23388d3b1a2dSKevin Wolf                 const void *buf, int count1)
23398d3b1a2dSKevin Wolf {
23408d3b1a2dSKevin Wolf     QEMUIOVector qiov;
23418d3b1a2dSKevin Wolf     struct iovec iov = {
23428d3b1a2dSKevin Wolf         .iov_base   = (void *) buf,
23438d3b1a2dSKevin Wolf         .iov_len    = count1,
23448d3b1a2dSKevin Wolf     };
23458d3b1a2dSKevin Wolf 
23468d3b1a2dSKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
23478d3b1a2dSKevin Wolf     return bdrv_pwritev(bs, offset, &qiov);
234883f64091Sbellard }
234983f64091Sbellard 
2350f08145feSKevin Wolf /*
2351f08145feSKevin Wolf  * Writes to the file and ensures that no writes are reordered across this
2352f08145feSKevin Wolf  * request (acts as a barrier)
2353f08145feSKevin Wolf  *
2354f08145feSKevin Wolf  * Returns 0 on success, -errno in error cases.
2355f08145feSKevin Wolf  */
2356f08145feSKevin Wolf int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
2357f08145feSKevin Wolf     const void *buf, int count)
2358f08145feSKevin Wolf {
2359f08145feSKevin Wolf     int ret;
2360f08145feSKevin Wolf 
2361f08145feSKevin Wolf     ret = bdrv_pwrite(bs, offset, buf, count);
2362f08145feSKevin Wolf     if (ret < 0) {
2363f08145feSKevin Wolf         return ret;
2364f08145feSKevin Wolf     }
2365f08145feSKevin Wolf 
2366f05fa4adSPaolo Bonzini     /* No flush needed for cache modes that already do it */
2367f05fa4adSPaolo Bonzini     if (bs->enable_write_cache) {
2368f08145feSKevin Wolf         bdrv_flush(bs);
2369f08145feSKevin Wolf     }
2370f08145feSKevin Wolf 
2371f08145feSKevin Wolf     return 0;
2372f08145feSKevin Wolf }
2373f08145feSKevin Wolf 
2374470c0504SStefan Hajnoczi static int coroutine_fn bdrv_co_do_copy_on_readv(BlockDriverState *bs,
2375ab185921SStefan Hajnoczi         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
2376ab185921SStefan Hajnoczi {
2377ab185921SStefan Hajnoczi     /* Perform I/O through a temporary buffer so that users who scribble over
2378ab185921SStefan Hajnoczi      * their read buffer while the operation is in progress do not end up
2379ab185921SStefan Hajnoczi      * modifying the image file.  This is critical for zero-copy guest I/O
2380ab185921SStefan Hajnoczi      * where anything might happen inside guest memory.
2381ab185921SStefan Hajnoczi      */
2382ab185921SStefan Hajnoczi     void *bounce_buffer;
2383ab185921SStefan Hajnoczi 
238479c053bdSStefan Hajnoczi     BlockDriver *drv = bs->drv;
2385ab185921SStefan Hajnoczi     struct iovec iov;
2386ab185921SStefan Hajnoczi     QEMUIOVector bounce_qiov;
2387ab185921SStefan Hajnoczi     int64_t cluster_sector_num;
2388ab185921SStefan Hajnoczi     int cluster_nb_sectors;
2389ab185921SStefan Hajnoczi     size_t skip_bytes;
2390ab185921SStefan Hajnoczi     int ret;
2391ab185921SStefan Hajnoczi 
2392ab185921SStefan Hajnoczi     /* Cover entire cluster so no additional backing file I/O is required when
2393ab185921SStefan Hajnoczi      * allocating cluster in the image file.
2394ab185921SStefan Hajnoczi      */
2395343bded4SPaolo Bonzini     bdrv_round_to_clusters(bs, sector_num, nb_sectors,
2396ab185921SStefan Hajnoczi                            &cluster_sector_num, &cluster_nb_sectors);
2397ab185921SStefan Hajnoczi 
2398470c0504SStefan Hajnoczi     trace_bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors,
2399ab185921SStefan Hajnoczi                                    cluster_sector_num, cluster_nb_sectors);
2400ab185921SStefan Hajnoczi 
2401ab185921SStefan Hajnoczi     iov.iov_len = cluster_nb_sectors * BDRV_SECTOR_SIZE;
2402ab185921SStefan Hajnoczi     iov.iov_base = bounce_buffer = qemu_blockalign(bs, iov.iov_len);
2403ab185921SStefan Hajnoczi     qemu_iovec_init_external(&bounce_qiov, &iov, 1);
2404ab185921SStefan Hajnoczi 
240579c053bdSStefan Hajnoczi     ret = drv->bdrv_co_readv(bs, cluster_sector_num, cluster_nb_sectors,
2406ab185921SStefan Hajnoczi                              &bounce_qiov);
2407ab185921SStefan Hajnoczi     if (ret < 0) {
2408ab185921SStefan Hajnoczi         goto err;
2409ab185921SStefan Hajnoczi     }
2410ab185921SStefan Hajnoczi 
241179c053bdSStefan Hajnoczi     if (drv->bdrv_co_write_zeroes &&
241279c053bdSStefan Hajnoczi         buffer_is_zero(bounce_buffer, iov.iov_len)) {
2413621f0589SKevin Wolf         ret = bdrv_co_do_write_zeroes(bs, cluster_sector_num,
241479c053bdSStefan Hajnoczi                                       cluster_nb_sectors);
241579c053bdSStefan Hajnoczi     } else {
2416f05fa4adSPaolo Bonzini         /* This does not change the data on the disk, it is not necessary
2417f05fa4adSPaolo Bonzini          * to flush even in cache=writethrough mode.
2418f05fa4adSPaolo Bonzini          */
241979c053bdSStefan Hajnoczi         ret = drv->bdrv_co_writev(bs, cluster_sector_num, cluster_nb_sectors,
2420ab185921SStefan Hajnoczi                                   &bounce_qiov);
242179c053bdSStefan Hajnoczi     }
242279c053bdSStefan Hajnoczi 
2423ab185921SStefan Hajnoczi     if (ret < 0) {
2424ab185921SStefan Hajnoczi         /* It might be okay to ignore write errors for guest requests.  If this
2425ab185921SStefan Hajnoczi          * is a deliberate copy-on-read then we don't want to ignore the error.
2426ab185921SStefan Hajnoczi          * Simply report it in all cases.
2427ab185921SStefan Hajnoczi          */
2428ab185921SStefan Hajnoczi         goto err;
2429ab185921SStefan Hajnoczi     }
2430ab185921SStefan Hajnoczi 
2431ab185921SStefan Hajnoczi     skip_bytes = (sector_num - cluster_sector_num) * BDRV_SECTOR_SIZE;
243203396148SMichael Tokarev     qemu_iovec_from_buf(qiov, 0, bounce_buffer + skip_bytes,
2433ab185921SStefan Hajnoczi                         nb_sectors * BDRV_SECTOR_SIZE);
2434ab185921SStefan Hajnoczi 
2435ab185921SStefan Hajnoczi err:
2436ab185921SStefan Hajnoczi     qemu_vfree(bounce_buffer);
2437ab185921SStefan Hajnoczi     return ret;
2438ab185921SStefan Hajnoczi }
2439ab185921SStefan Hajnoczi 
2440c5fbe571SStefan Hajnoczi /*
2441c5fbe571SStefan Hajnoczi  * Handle a read request in coroutine context
2442c5fbe571SStefan Hajnoczi  */
2443c5fbe571SStefan Hajnoczi static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
2444470c0504SStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
2445470c0504SStefan Hajnoczi     BdrvRequestFlags flags)
2446da1fa91dSKevin Wolf {
2447da1fa91dSKevin Wolf     BlockDriver *drv = bs->drv;
2448dbffbdcfSStefan Hajnoczi     BdrvTrackedRequest req;
2449dbffbdcfSStefan Hajnoczi     int ret;
2450da1fa91dSKevin Wolf 
2451da1fa91dSKevin Wolf     if (!drv) {
2452da1fa91dSKevin Wolf         return -ENOMEDIUM;
2453da1fa91dSKevin Wolf     }
2454da1fa91dSKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors)) {
2455da1fa91dSKevin Wolf         return -EIO;
2456da1fa91dSKevin Wolf     }
2457da1fa91dSKevin Wolf 
245898f90dbaSZhi Yong Wu     /* throttling disk read I/O */
245998f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
246098f90dbaSZhi Yong Wu         bdrv_io_limits_intercept(bs, false, nb_sectors);
246198f90dbaSZhi Yong Wu     }
246298f90dbaSZhi Yong Wu 
2463f4658285SStefan Hajnoczi     if (bs->copy_on_read) {
2464470c0504SStefan Hajnoczi         flags |= BDRV_REQ_COPY_ON_READ;
2465470c0504SStefan Hajnoczi     }
2466470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2467470c0504SStefan Hajnoczi         bs->copy_on_read_in_flight++;
2468470c0504SStefan Hajnoczi     }
2469470c0504SStefan Hajnoczi 
2470470c0504SStefan Hajnoczi     if (bs->copy_on_read_in_flight) {
2471f4658285SStefan Hajnoczi         wait_for_overlapping_requests(bs, sector_num, nb_sectors);
2472f4658285SStefan Hajnoczi     }
2473f4658285SStefan Hajnoczi 
2474dbffbdcfSStefan Hajnoczi     tracked_request_begin(&req, bs, sector_num, nb_sectors, false);
2475ab185921SStefan Hajnoczi 
2476470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2477ab185921SStefan Hajnoczi         int pnum;
2478ab185921SStefan Hajnoczi 
2479ab185921SStefan Hajnoczi         ret = bdrv_co_is_allocated(bs, sector_num, nb_sectors, &pnum);
2480ab185921SStefan Hajnoczi         if (ret < 0) {
2481ab185921SStefan Hajnoczi             goto out;
2482ab185921SStefan Hajnoczi         }
2483ab185921SStefan Hajnoczi 
2484ab185921SStefan Hajnoczi         if (!ret || pnum != nb_sectors) {
2485470c0504SStefan Hajnoczi             ret = bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors, qiov);
2486ab185921SStefan Hajnoczi             goto out;
2487ab185921SStefan Hajnoczi         }
2488ab185921SStefan Hajnoczi     }
2489ab185921SStefan Hajnoczi 
2490dbffbdcfSStefan Hajnoczi     ret = drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
2491ab185921SStefan Hajnoczi 
2492ab185921SStefan Hajnoczi out:
2493dbffbdcfSStefan Hajnoczi     tracked_request_end(&req);
2494470c0504SStefan Hajnoczi 
2495470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2496470c0504SStefan Hajnoczi         bs->copy_on_read_in_flight--;
2497470c0504SStefan Hajnoczi     }
2498470c0504SStefan Hajnoczi 
2499dbffbdcfSStefan Hajnoczi     return ret;
2500da1fa91dSKevin Wolf }
2501da1fa91dSKevin Wolf 
2502c5fbe571SStefan Hajnoczi int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
2503da1fa91dSKevin Wolf     int nb_sectors, QEMUIOVector *qiov)
2504da1fa91dSKevin Wolf {
2505c5fbe571SStefan Hajnoczi     trace_bdrv_co_readv(bs, sector_num, nb_sectors);
2506da1fa91dSKevin Wolf 
2507470c0504SStefan Hajnoczi     return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov, 0);
2508470c0504SStefan Hajnoczi }
2509470c0504SStefan Hajnoczi 
2510470c0504SStefan Hajnoczi int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
2511470c0504SStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
2512470c0504SStefan Hajnoczi {
2513470c0504SStefan Hajnoczi     trace_bdrv_co_copy_on_readv(bs, sector_num, nb_sectors);
2514470c0504SStefan Hajnoczi 
2515470c0504SStefan Hajnoczi     return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov,
2516470c0504SStefan Hajnoczi                             BDRV_REQ_COPY_ON_READ);
2517c5fbe571SStefan Hajnoczi }
2518c5fbe571SStefan Hajnoczi 
2519f08f2ddaSStefan Hajnoczi static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs,
2520f08f2ddaSStefan Hajnoczi     int64_t sector_num, int nb_sectors)
2521f08f2ddaSStefan Hajnoczi {
2522f08f2ddaSStefan Hajnoczi     BlockDriver *drv = bs->drv;
2523f08f2ddaSStefan Hajnoczi     QEMUIOVector qiov;
2524f08f2ddaSStefan Hajnoczi     struct iovec iov;
2525f08f2ddaSStefan Hajnoczi     int ret;
2526f08f2ddaSStefan Hajnoczi 
2527621f0589SKevin Wolf     /* TODO Emulate only part of misaligned requests instead of letting block
2528621f0589SKevin Wolf      * drivers return -ENOTSUP and emulate everything */
2529621f0589SKevin Wolf 
2530f08f2ddaSStefan Hajnoczi     /* First try the efficient write zeroes operation */
2531f08f2ddaSStefan Hajnoczi     if (drv->bdrv_co_write_zeroes) {
2532621f0589SKevin Wolf         ret = drv->bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
2533621f0589SKevin Wolf         if (ret != -ENOTSUP) {
2534621f0589SKevin Wolf             return ret;
2535621f0589SKevin Wolf         }
2536f08f2ddaSStefan Hajnoczi     }
2537f08f2ddaSStefan Hajnoczi 
2538f08f2ddaSStefan Hajnoczi     /* Fall back to bounce buffer if write zeroes is unsupported */
2539f08f2ddaSStefan Hajnoczi     iov.iov_len  = nb_sectors * BDRV_SECTOR_SIZE;
2540f08f2ddaSStefan Hajnoczi     iov.iov_base = qemu_blockalign(bs, iov.iov_len);
2541f08f2ddaSStefan Hajnoczi     memset(iov.iov_base, 0, iov.iov_len);
2542f08f2ddaSStefan Hajnoczi     qemu_iovec_init_external(&qiov, &iov, 1);
2543f08f2ddaSStefan Hajnoczi 
2544f08f2ddaSStefan Hajnoczi     ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, &qiov);
2545f08f2ddaSStefan Hajnoczi 
2546f08f2ddaSStefan Hajnoczi     qemu_vfree(iov.iov_base);
2547f08f2ddaSStefan Hajnoczi     return ret;
2548f08f2ddaSStefan Hajnoczi }
2549f08f2ddaSStefan Hajnoczi 
2550c5fbe571SStefan Hajnoczi /*
2551c5fbe571SStefan Hajnoczi  * Handle a write request in coroutine context
2552c5fbe571SStefan Hajnoczi  */
2553c5fbe571SStefan Hajnoczi static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
2554f08f2ddaSStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
2555f08f2ddaSStefan Hajnoczi     BdrvRequestFlags flags)
2556c5fbe571SStefan Hajnoczi {
2557c5fbe571SStefan Hajnoczi     BlockDriver *drv = bs->drv;
2558dbffbdcfSStefan Hajnoczi     BdrvTrackedRequest req;
25596b7cb247SStefan Hajnoczi     int ret;
2560da1fa91dSKevin Wolf 
2561da1fa91dSKevin Wolf     if (!bs->drv) {
2562da1fa91dSKevin Wolf         return -ENOMEDIUM;
2563da1fa91dSKevin Wolf     }
2564da1fa91dSKevin Wolf     if (bs->read_only) {
2565da1fa91dSKevin Wolf         return -EACCES;
2566da1fa91dSKevin Wolf     }
2567da1fa91dSKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors)) {
2568da1fa91dSKevin Wolf         return -EIO;
2569da1fa91dSKevin Wolf     }
2570da1fa91dSKevin Wolf 
257198f90dbaSZhi Yong Wu     /* throttling disk write I/O */
257298f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
257398f90dbaSZhi Yong Wu         bdrv_io_limits_intercept(bs, true, nb_sectors);
257498f90dbaSZhi Yong Wu     }
257598f90dbaSZhi Yong Wu 
2576470c0504SStefan Hajnoczi     if (bs->copy_on_read_in_flight) {
2577f4658285SStefan Hajnoczi         wait_for_overlapping_requests(bs, sector_num, nb_sectors);
2578f4658285SStefan Hajnoczi     }
2579f4658285SStefan Hajnoczi 
2580dbffbdcfSStefan Hajnoczi     tracked_request_begin(&req, bs, sector_num, nb_sectors, true);
2581dbffbdcfSStefan Hajnoczi 
2582f08f2ddaSStefan Hajnoczi     if (flags & BDRV_REQ_ZERO_WRITE) {
2583f08f2ddaSStefan Hajnoczi         ret = bdrv_co_do_write_zeroes(bs, sector_num, nb_sectors);
2584f08f2ddaSStefan Hajnoczi     } else {
25856b7cb247SStefan Hajnoczi         ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
2586f08f2ddaSStefan Hajnoczi     }
25876b7cb247SStefan Hajnoczi 
2588f05fa4adSPaolo Bonzini     if (ret == 0 && !bs->enable_write_cache) {
2589f05fa4adSPaolo Bonzini         ret = bdrv_co_flush(bs);
2590f05fa4adSPaolo Bonzini     }
2591f05fa4adSPaolo Bonzini 
2592da1fa91dSKevin Wolf     if (bs->dirty_bitmap) {
25931755da16SPaolo Bonzini         bdrv_set_dirty(bs, sector_num, nb_sectors);
2594da1fa91dSKevin Wolf     }
2595da1fa91dSKevin Wolf 
2596da1fa91dSKevin Wolf     if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
2597da1fa91dSKevin Wolf         bs->wr_highest_sector = sector_num + nb_sectors - 1;
2598da1fa91dSKevin Wolf     }
2599da1fa91dSKevin Wolf 
2600dbffbdcfSStefan Hajnoczi     tracked_request_end(&req);
2601dbffbdcfSStefan Hajnoczi 
26026b7cb247SStefan Hajnoczi     return ret;
2603da1fa91dSKevin Wolf }
2604da1fa91dSKevin Wolf 
2605c5fbe571SStefan Hajnoczi int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
2606c5fbe571SStefan Hajnoczi     int nb_sectors, QEMUIOVector *qiov)
2607c5fbe571SStefan Hajnoczi {
2608c5fbe571SStefan Hajnoczi     trace_bdrv_co_writev(bs, sector_num, nb_sectors);
2609c5fbe571SStefan Hajnoczi 
2610f08f2ddaSStefan Hajnoczi     return bdrv_co_do_writev(bs, sector_num, nb_sectors, qiov, 0);
2611f08f2ddaSStefan Hajnoczi }
2612f08f2ddaSStefan Hajnoczi 
2613f08f2ddaSStefan Hajnoczi int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs,
2614f08f2ddaSStefan Hajnoczi                                       int64_t sector_num, int nb_sectors)
2615f08f2ddaSStefan Hajnoczi {
2616f08f2ddaSStefan Hajnoczi     trace_bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
2617f08f2ddaSStefan Hajnoczi 
2618f08f2ddaSStefan Hajnoczi     return bdrv_co_do_writev(bs, sector_num, nb_sectors, NULL,
2619f08f2ddaSStefan Hajnoczi                              BDRV_REQ_ZERO_WRITE);
2620c5fbe571SStefan Hajnoczi }
2621c5fbe571SStefan Hajnoczi 
262283f64091Sbellard /**
262383f64091Sbellard  * Truncate file to 'offset' bytes (needed only for file protocols)
262483f64091Sbellard  */
262583f64091Sbellard int bdrv_truncate(BlockDriverState *bs, int64_t offset)
262683f64091Sbellard {
262783f64091Sbellard     BlockDriver *drv = bs->drv;
262851762288SStefan Hajnoczi     int ret;
262983f64091Sbellard     if (!drv)
263019cb3738Sbellard         return -ENOMEDIUM;
263183f64091Sbellard     if (!drv->bdrv_truncate)
263283f64091Sbellard         return -ENOTSUP;
263359f2689dSNaphtali Sprei     if (bs->read_only)
263459f2689dSNaphtali Sprei         return -EACCES;
26358591675fSMarcelo Tosatti     if (bdrv_in_use(bs))
26368591675fSMarcelo Tosatti         return -EBUSY;
263751762288SStefan Hajnoczi     ret = drv->bdrv_truncate(bs, offset);
263851762288SStefan Hajnoczi     if (ret == 0) {
263951762288SStefan Hajnoczi         ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
2640145feb17SMarkus Armbruster         bdrv_dev_resize_cb(bs);
264151762288SStefan Hajnoczi     }
264251762288SStefan Hajnoczi     return ret;
264383f64091Sbellard }
264483f64091Sbellard 
264583f64091Sbellard /**
26464a1d5e1fSFam Zheng  * Length of a allocated file in bytes. Sparse files are counted by actual
26474a1d5e1fSFam Zheng  * allocated space. Return < 0 if error or unknown.
26484a1d5e1fSFam Zheng  */
26494a1d5e1fSFam Zheng int64_t bdrv_get_allocated_file_size(BlockDriverState *bs)
26504a1d5e1fSFam Zheng {
26514a1d5e1fSFam Zheng     BlockDriver *drv = bs->drv;
26524a1d5e1fSFam Zheng     if (!drv) {
26534a1d5e1fSFam Zheng         return -ENOMEDIUM;
26544a1d5e1fSFam Zheng     }
26554a1d5e1fSFam Zheng     if (drv->bdrv_get_allocated_file_size) {
26564a1d5e1fSFam Zheng         return drv->bdrv_get_allocated_file_size(bs);
26574a1d5e1fSFam Zheng     }
26584a1d5e1fSFam Zheng     if (bs->file) {
26594a1d5e1fSFam Zheng         return bdrv_get_allocated_file_size(bs->file);
26604a1d5e1fSFam Zheng     }
26614a1d5e1fSFam Zheng     return -ENOTSUP;
26624a1d5e1fSFam Zheng }
26634a1d5e1fSFam Zheng 
26644a1d5e1fSFam Zheng /**
266583f64091Sbellard  * Length of a file in bytes. Return < 0 if error or unknown.
266683f64091Sbellard  */
266783f64091Sbellard int64_t bdrv_getlength(BlockDriverState *bs)
266883f64091Sbellard {
266983f64091Sbellard     BlockDriver *drv = bs->drv;
267083f64091Sbellard     if (!drv)
267119cb3738Sbellard         return -ENOMEDIUM;
267251762288SStefan Hajnoczi 
26732c6942faSMarkus Armbruster     if (bs->growable || bdrv_dev_has_removable_media(bs)) {
267446a4e4e6SStefan Hajnoczi         if (drv->bdrv_getlength) {
267583f64091Sbellard             return drv->bdrv_getlength(bs);
2676fc01f7e7Sbellard         }
267746a4e4e6SStefan Hajnoczi     }
267846a4e4e6SStefan Hajnoczi     return bs->total_sectors * BDRV_SECTOR_SIZE;
267946a4e4e6SStefan Hajnoczi }
2680fc01f7e7Sbellard 
268119cb3738Sbellard /* return 0 as number of sectors if no device present or error */
268296b8f136Sths void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
2683fc01f7e7Sbellard {
268419cb3738Sbellard     int64_t length;
268519cb3738Sbellard     length = bdrv_getlength(bs);
268619cb3738Sbellard     if (length < 0)
268719cb3738Sbellard         length = 0;
268819cb3738Sbellard     else
26896ea44308SJan Kiszka         length = length >> BDRV_SECTOR_BITS;
269019cb3738Sbellard     *nb_sectors_ptr = length;
2691fc01f7e7Sbellard }
2692cf98951bSbellard 
26930563e191SZhi Yong Wu /* throttling disk io limits */
26940563e191SZhi Yong Wu void bdrv_set_io_limits(BlockDriverState *bs,
26950563e191SZhi Yong Wu                         BlockIOLimit *io_limits)
26960563e191SZhi Yong Wu {
26970563e191SZhi Yong Wu     bs->io_limits = *io_limits;
26980563e191SZhi Yong Wu     bs->io_limits_enabled = bdrv_io_limits_enabled(bs);
26990563e191SZhi Yong Wu }
27000563e191SZhi Yong Wu 
2701ff06f5f3SPaolo Bonzini void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
2702ff06f5f3SPaolo Bonzini                        BlockdevOnError on_write_error)
2703abd7f68dSMarkus Armbruster {
2704abd7f68dSMarkus Armbruster     bs->on_read_error = on_read_error;
2705abd7f68dSMarkus Armbruster     bs->on_write_error = on_write_error;
2706abd7f68dSMarkus Armbruster }
2707abd7f68dSMarkus Armbruster 
27081ceee0d5SPaolo Bonzini BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read)
2709abd7f68dSMarkus Armbruster {
2710abd7f68dSMarkus Armbruster     return is_read ? bs->on_read_error : bs->on_write_error;
2711abd7f68dSMarkus Armbruster }
2712abd7f68dSMarkus Armbruster 
27133e1caa5fSPaolo Bonzini BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error)
27143e1caa5fSPaolo Bonzini {
27153e1caa5fSPaolo Bonzini     BlockdevOnError on_err = is_read ? bs->on_read_error : bs->on_write_error;
27163e1caa5fSPaolo Bonzini 
27173e1caa5fSPaolo Bonzini     switch (on_err) {
27183e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_ENOSPC:
27193e1caa5fSPaolo Bonzini         return (error == ENOSPC) ? BDRV_ACTION_STOP : BDRV_ACTION_REPORT;
27203e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_STOP:
27213e1caa5fSPaolo Bonzini         return BDRV_ACTION_STOP;
27223e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_REPORT:
27233e1caa5fSPaolo Bonzini         return BDRV_ACTION_REPORT;
27243e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_IGNORE:
27253e1caa5fSPaolo Bonzini         return BDRV_ACTION_IGNORE;
27263e1caa5fSPaolo Bonzini     default:
27273e1caa5fSPaolo Bonzini         abort();
27283e1caa5fSPaolo Bonzini     }
27293e1caa5fSPaolo Bonzini }
27303e1caa5fSPaolo Bonzini 
27313e1caa5fSPaolo Bonzini /* This is done by device models because, while the block layer knows
27323e1caa5fSPaolo Bonzini  * about the error, it does not know whether an operation comes from
27333e1caa5fSPaolo Bonzini  * the device or the block layer (from a job, for example).
27343e1caa5fSPaolo Bonzini  */
27353e1caa5fSPaolo Bonzini void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
27363e1caa5fSPaolo Bonzini                        bool is_read, int error)
27373e1caa5fSPaolo Bonzini {
27383e1caa5fSPaolo Bonzini     assert(error >= 0);
273932c81a4aSPaolo Bonzini     bdrv_emit_qmp_error_event(bs, QEVENT_BLOCK_IO_ERROR, action, is_read);
27403e1caa5fSPaolo Bonzini     if (action == BDRV_ACTION_STOP) {
27413e1caa5fSPaolo Bonzini         vm_stop(RUN_STATE_IO_ERROR);
27423e1caa5fSPaolo Bonzini         bdrv_iostatus_set_err(bs, error);
27433e1caa5fSPaolo Bonzini     }
27443e1caa5fSPaolo Bonzini }
27453e1caa5fSPaolo Bonzini 
2746b338082bSbellard int bdrv_is_read_only(BlockDriverState *bs)
2747b338082bSbellard {
2748b338082bSbellard     return bs->read_only;
2749b338082bSbellard }
2750b338082bSbellard 
2751985a03b0Sths int bdrv_is_sg(BlockDriverState *bs)
2752985a03b0Sths {
2753985a03b0Sths     return bs->sg;
2754985a03b0Sths }
2755985a03b0Sths 
2756e900a7b7SChristoph Hellwig int bdrv_enable_write_cache(BlockDriverState *bs)
2757e900a7b7SChristoph Hellwig {
2758e900a7b7SChristoph Hellwig     return bs->enable_write_cache;
2759e900a7b7SChristoph Hellwig }
2760e900a7b7SChristoph Hellwig 
2761425b0148SPaolo Bonzini void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce)
2762425b0148SPaolo Bonzini {
2763425b0148SPaolo Bonzini     bs->enable_write_cache = wce;
276455b110f2SJeff Cody 
276555b110f2SJeff Cody     /* so a reopen() will preserve wce */
276655b110f2SJeff Cody     if (wce) {
276755b110f2SJeff Cody         bs->open_flags |= BDRV_O_CACHE_WB;
276855b110f2SJeff Cody     } else {
276955b110f2SJeff Cody         bs->open_flags &= ~BDRV_O_CACHE_WB;
277055b110f2SJeff Cody     }
2771425b0148SPaolo Bonzini }
2772425b0148SPaolo Bonzini 
2773ea2384d3Sbellard int bdrv_is_encrypted(BlockDriverState *bs)
2774ea2384d3Sbellard {
2775ea2384d3Sbellard     if (bs->backing_hd && bs->backing_hd->encrypted)
2776ea2384d3Sbellard         return 1;
2777ea2384d3Sbellard     return bs->encrypted;
2778ea2384d3Sbellard }
2779ea2384d3Sbellard 
2780c0f4ce77Saliguori int bdrv_key_required(BlockDriverState *bs)
2781c0f4ce77Saliguori {
2782c0f4ce77Saliguori     BlockDriverState *backing_hd = bs->backing_hd;
2783c0f4ce77Saliguori 
2784c0f4ce77Saliguori     if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
2785c0f4ce77Saliguori         return 1;
2786c0f4ce77Saliguori     return (bs->encrypted && !bs->valid_key);
2787c0f4ce77Saliguori }
2788c0f4ce77Saliguori 
2789ea2384d3Sbellard int bdrv_set_key(BlockDriverState *bs, const char *key)
2790ea2384d3Sbellard {
2791ea2384d3Sbellard     int ret;
2792ea2384d3Sbellard     if (bs->backing_hd && bs->backing_hd->encrypted) {
2793ea2384d3Sbellard         ret = bdrv_set_key(bs->backing_hd, key);
2794ea2384d3Sbellard         if (ret < 0)
2795ea2384d3Sbellard             return ret;
2796ea2384d3Sbellard         if (!bs->encrypted)
2797ea2384d3Sbellard             return 0;
2798ea2384d3Sbellard     }
2799fd04a2aeSShahar Havivi     if (!bs->encrypted) {
2800fd04a2aeSShahar Havivi         return -EINVAL;
2801fd04a2aeSShahar Havivi     } else if (!bs->drv || !bs->drv->bdrv_set_key) {
2802fd04a2aeSShahar Havivi         return -ENOMEDIUM;
2803fd04a2aeSShahar Havivi     }
2804c0f4ce77Saliguori     ret = bs->drv->bdrv_set_key(bs, key);
2805bb5fc20fSaliguori     if (ret < 0) {
2806bb5fc20fSaliguori         bs->valid_key = 0;
2807bb5fc20fSaliguori     } else if (!bs->valid_key) {
2808bb5fc20fSaliguori         bs->valid_key = 1;
2809bb5fc20fSaliguori         /* call the change callback now, we skipped it on open */
28107d4b4ba5SMarkus Armbruster         bdrv_dev_change_media_cb(bs, true);
2811bb5fc20fSaliguori     }
2812c0f4ce77Saliguori     return ret;
2813ea2384d3Sbellard }
2814ea2384d3Sbellard 
2815f8d6bba1SMarkus Armbruster const char *bdrv_get_format_name(BlockDriverState *bs)
2816ea2384d3Sbellard {
2817f8d6bba1SMarkus Armbruster     return bs->drv ? bs->drv->format_name : NULL;
2818ea2384d3Sbellard }
2819ea2384d3Sbellard 
2820ea2384d3Sbellard void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
2821ea2384d3Sbellard                          void *opaque)
2822ea2384d3Sbellard {
2823ea2384d3Sbellard     BlockDriver *drv;
2824ea2384d3Sbellard 
28258a22f02aSStefan Hajnoczi     QLIST_FOREACH(drv, &bdrv_drivers, list) {
2826ea2384d3Sbellard         it(opaque, drv->format_name);
2827ea2384d3Sbellard     }
2828ea2384d3Sbellard }
2829ea2384d3Sbellard 
2830b338082bSbellard BlockDriverState *bdrv_find(const char *name)
2831b338082bSbellard {
2832b338082bSbellard     BlockDriverState *bs;
2833b338082bSbellard 
28341b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
28351b7bdbc1SStefan Hajnoczi         if (!strcmp(name, bs->device_name)) {
2836b338082bSbellard             return bs;
2837b338082bSbellard         }
28381b7bdbc1SStefan Hajnoczi     }
2839b338082bSbellard     return NULL;
2840b338082bSbellard }
2841b338082bSbellard 
28422f399b0aSMarkus Armbruster BlockDriverState *bdrv_next(BlockDriverState *bs)
28432f399b0aSMarkus Armbruster {
28442f399b0aSMarkus Armbruster     if (!bs) {
28452f399b0aSMarkus Armbruster         return QTAILQ_FIRST(&bdrv_states);
28462f399b0aSMarkus Armbruster     }
28472f399b0aSMarkus Armbruster     return QTAILQ_NEXT(bs, list);
28482f399b0aSMarkus Armbruster }
28492f399b0aSMarkus Armbruster 
285051de9760Saliguori void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
285181d0912dSbellard {
285281d0912dSbellard     BlockDriverState *bs;
285381d0912dSbellard 
28541b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
285551de9760Saliguori         it(opaque, bs);
285681d0912dSbellard     }
285781d0912dSbellard }
285881d0912dSbellard 
2859ea2384d3Sbellard const char *bdrv_get_device_name(BlockDriverState *bs)
2860ea2384d3Sbellard {
2861ea2384d3Sbellard     return bs->device_name;
2862ea2384d3Sbellard }
2863ea2384d3Sbellard 
2864c8433287SMarkus Armbruster int bdrv_get_flags(BlockDriverState *bs)
2865c8433287SMarkus Armbruster {
2866c8433287SMarkus Armbruster     return bs->open_flags;
2867c8433287SMarkus Armbruster }
2868c8433287SMarkus Armbruster 
2869c6ca28d6Saliguori void bdrv_flush_all(void)
2870c6ca28d6Saliguori {
2871c6ca28d6Saliguori     BlockDriverState *bs;
2872c6ca28d6Saliguori 
28731b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
2874c6ca28d6Saliguori         bdrv_flush(bs);
2875c6ca28d6Saliguori     }
28761b7bdbc1SStefan Hajnoczi }
2877c6ca28d6Saliguori 
2878f2feebbdSKevin Wolf int bdrv_has_zero_init(BlockDriverState *bs)
2879f2feebbdSKevin Wolf {
2880f2feebbdSKevin Wolf     assert(bs->drv);
2881f2feebbdSKevin Wolf 
2882336c1c12SKevin Wolf     if (bs->drv->bdrv_has_zero_init) {
2883336c1c12SKevin Wolf         return bs->drv->bdrv_has_zero_init(bs);
2884f2feebbdSKevin Wolf     }
2885f2feebbdSKevin Wolf 
2886f2feebbdSKevin Wolf     return 1;
2887f2feebbdSKevin Wolf }
2888f2feebbdSKevin Wolf 
2889376ae3f1SStefan Hajnoczi typedef struct BdrvCoIsAllocatedData {
2890376ae3f1SStefan Hajnoczi     BlockDriverState *bs;
2891b35b2bbaSMiroslav Rezanina     BlockDriverState *base;
2892376ae3f1SStefan Hajnoczi     int64_t sector_num;
2893376ae3f1SStefan Hajnoczi     int nb_sectors;
2894376ae3f1SStefan Hajnoczi     int *pnum;
2895376ae3f1SStefan Hajnoczi     int ret;
2896376ae3f1SStefan Hajnoczi     bool done;
2897376ae3f1SStefan Hajnoczi } BdrvCoIsAllocatedData;
2898376ae3f1SStefan Hajnoczi 
2899f58c7b35Sths /*
2900f58c7b35Sths  * Returns true iff the specified sector is present in the disk image. Drivers
2901f58c7b35Sths  * not implementing the functionality are assumed to not support backing files,
2902f58c7b35Sths  * hence all their sectors are reported as allocated.
2903f58c7b35Sths  *
2904bd9533e3SStefan Hajnoczi  * If 'sector_num' is beyond the end of the disk image the return value is 0
2905bd9533e3SStefan Hajnoczi  * and 'pnum' is set to 0.
2906bd9533e3SStefan Hajnoczi  *
2907f58c7b35Sths  * 'pnum' is set to the number of sectors (including and immediately following
2908f58c7b35Sths  * the specified sector) that are known to be in the same
2909f58c7b35Sths  * allocated/unallocated state.
2910f58c7b35Sths  *
2911bd9533e3SStefan Hajnoczi  * 'nb_sectors' is the max value 'pnum' should be set to.  If nb_sectors goes
2912bd9533e3SStefan Hajnoczi  * beyond the end of the disk image it will be clamped.
2913f58c7b35Sths  */
2914060f51c9SStefan Hajnoczi int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
2915060f51c9SStefan Hajnoczi                                       int nb_sectors, int *pnum)
2916f58c7b35Sths {
2917f58c7b35Sths     int64_t n;
2918bd9533e3SStefan Hajnoczi 
29196aebab14SStefan Hajnoczi     if (sector_num >= bs->total_sectors) {
29206aebab14SStefan Hajnoczi         *pnum = 0;
29216aebab14SStefan Hajnoczi         return 0;
29226aebab14SStefan Hajnoczi     }
2923bd9533e3SStefan Hajnoczi 
29246aebab14SStefan Hajnoczi     n = bs->total_sectors - sector_num;
2925bd9533e3SStefan Hajnoczi     if (n < nb_sectors) {
2926bd9533e3SStefan Hajnoczi         nb_sectors = n;
2927bd9533e3SStefan Hajnoczi     }
2928bd9533e3SStefan Hajnoczi 
2929bd9533e3SStefan Hajnoczi     if (!bs->drv->bdrv_co_is_allocated) {
2930bd9533e3SStefan Hajnoczi         *pnum = nb_sectors;
29316aebab14SStefan Hajnoczi         return 1;
29326aebab14SStefan Hajnoczi     }
29336aebab14SStefan Hajnoczi 
2934060f51c9SStefan Hajnoczi     return bs->drv->bdrv_co_is_allocated(bs, sector_num, nb_sectors, pnum);
2935060f51c9SStefan Hajnoczi }
2936060f51c9SStefan Hajnoczi 
2937060f51c9SStefan Hajnoczi /* Coroutine wrapper for bdrv_is_allocated() */
2938060f51c9SStefan Hajnoczi static void coroutine_fn bdrv_is_allocated_co_entry(void *opaque)
2939060f51c9SStefan Hajnoczi {
2940060f51c9SStefan Hajnoczi     BdrvCoIsAllocatedData *data = opaque;
2941060f51c9SStefan Hajnoczi     BlockDriverState *bs = data->bs;
2942060f51c9SStefan Hajnoczi 
2943060f51c9SStefan Hajnoczi     data->ret = bdrv_co_is_allocated(bs, data->sector_num, data->nb_sectors,
2944060f51c9SStefan Hajnoczi                                      data->pnum);
2945060f51c9SStefan Hajnoczi     data->done = true;
2946060f51c9SStefan Hajnoczi }
2947060f51c9SStefan Hajnoczi 
2948060f51c9SStefan Hajnoczi /*
2949060f51c9SStefan Hajnoczi  * Synchronous wrapper around bdrv_co_is_allocated().
2950060f51c9SStefan Hajnoczi  *
2951060f51c9SStefan Hajnoczi  * See bdrv_co_is_allocated() for details.
2952060f51c9SStefan Hajnoczi  */
2953060f51c9SStefan Hajnoczi int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
2954060f51c9SStefan Hajnoczi                       int *pnum)
2955060f51c9SStefan Hajnoczi {
2956376ae3f1SStefan Hajnoczi     Coroutine *co;
2957376ae3f1SStefan Hajnoczi     BdrvCoIsAllocatedData data = {
2958376ae3f1SStefan Hajnoczi         .bs = bs,
2959376ae3f1SStefan Hajnoczi         .sector_num = sector_num,
2960376ae3f1SStefan Hajnoczi         .nb_sectors = nb_sectors,
2961376ae3f1SStefan Hajnoczi         .pnum = pnum,
2962376ae3f1SStefan Hajnoczi         .done = false,
2963376ae3f1SStefan Hajnoczi     };
2964376ae3f1SStefan Hajnoczi 
2965376ae3f1SStefan Hajnoczi     co = qemu_coroutine_create(bdrv_is_allocated_co_entry);
2966376ae3f1SStefan Hajnoczi     qemu_coroutine_enter(co, &data);
2967376ae3f1SStefan Hajnoczi     while (!data.done) {
2968376ae3f1SStefan Hajnoczi         qemu_aio_wait();
2969376ae3f1SStefan Hajnoczi     }
2970376ae3f1SStefan Hajnoczi     return data.ret;
2971376ae3f1SStefan Hajnoczi }
2972f58c7b35Sths 
2973188a7bbfSPaolo Bonzini /*
2974188a7bbfSPaolo Bonzini  * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
2975188a7bbfSPaolo Bonzini  *
2976188a7bbfSPaolo Bonzini  * Return true if the given sector is allocated in any image between
2977188a7bbfSPaolo Bonzini  * BASE and TOP (inclusive).  BASE can be NULL to check if the given
2978188a7bbfSPaolo Bonzini  * sector is allocated in any image of the chain.  Return false otherwise.
2979188a7bbfSPaolo Bonzini  *
2980188a7bbfSPaolo Bonzini  * 'pnum' is set to the number of sectors (including and immediately following
2981188a7bbfSPaolo Bonzini  *  the specified sector) that are known to be in the same
2982188a7bbfSPaolo Bonzini  *  allocated/unallocated state.
2983188a7bbfSPaolo Bonzini  *
2984188a7bbfSPaolo Bonzini  */
2985188a7bbfSPaolo Bonzini int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
2986188a7bbfSPaolo Bonzini                                             BlockDriverState *base,
2987188a7bbfSPaolo Bonzini                                             int64_t sector_num,
2988188a7bbfSPaolo Bonzini                                             int nb_sectors, int *pnum)
2989188a7bbfSPaolo Bonzini {
2990188a7bbfSPaolo Bonzini     BlockDriverState *intermediate;
2991188a7bbfSPaolo Bonzini     int ret, n = nb_sectors;
2992188a7bbfSPaolo Bonzini 
2993188a7bbfSPaolo Bonzini     intermediate = top;
2994188a7bbfSPaolo Bonzini     while (intermediate && intermediate != base) {
2995188a7bbfSPaolo Bonzini         int pnum_inter;
2996188a7bbfSPaolo Bonzini         ret = bdrv_co_is_allocated(intermediate, sector_num, nb_sectors,
2997188a7bbfSPaolo Bonzini                                    &pnum_inter);
2998188a7bbfSPaolo Bonzini         if (ret < 0) {
2999188a7bbfSPaolo Bonzini             return ret;
3000188a7bbfSPaolo Bonzini         } else if (ret) {
3001188a7bbfSPaolo Bonzini             *pnum = pnum_inter;
3002188a7bbfSPaolo Bonzini             return 1;
3003188a7bbfSPaolo Bonzini         }
3004188a7bbfSPaolo Bonzini 
3005188a7bbfSPaolo Bonzini         /*
3006188a7bbfSPaolo Bonzini          * [sector_num, nb_sectors] is unallocated on top but intermediate
3007188a7bbfSPaolo Bonzini          * might have
3008188a7bbfSPaolo Bonzini          *
3009188a7bbfSPaolo Bonzini          * [sector_num+x, nr_sectors] allocated.
3010188a7bbfSPaolo Bonzini          */
301163ba17d3SVishvananda Ishaya         if (n > pnum_inter &&
301263ba17d3SVishvananda Ishaya             (intermediate == top ||
301363ba17d3SVishvananda Ishaya              sector_num + pnum_inter < intermediate->total_sectors)) {
3014188a7bbfSPaolo Bonzini             n = pnum_inter;
3015188a7bbfSPaolo Bonzini         }
3016188a7bbfSPaolo Bonzini 
3017188a7bbfSPaolo Bonzini         intermediate = intermediate->backing_hd;
3018188a7bbfSPaolo Bonzini     }
3019188a7bbfSPaolo Bonzini 
3020188a7bbfSPaolo Bonzini     *pnum = n;
3021188a7bbfSPaolo Bonzini     return 0;
3022188a7bbfSPaolo Bonzini }
3023188a7bbfSPaolo Bonzini 
3024b35b2bbaSMiroslav Rezanina /* Coroutine wrapper for bdrv_is_allocated_above() */
3025b35b2bbaSMiroslav Rezanina static void coroutine_fn bdrv_is_allocated_above_co_entry(void *opaque)
3026b35b2bbaSMiroslav Rezanina {
3027b35b2bbaSMiroslav Rezanina     BdrvCoIsAllocatedData *data = opaque;
3028b35b2bbaSMiroslav Rezanina     BlockDriverState *top = data->bs;
3029b35b2bbaSMiroslav Rezanina     BlockDriverState *base = data->base;
3030b35b2bbaSMiroslav Rezanina 
3031b35b2bbaSMiroslav Rezanina     data->ret = bdrv_co_is_allocated_above(top, base, data->sector_num,
3032b35b2bbaSMiroslav Rezanina                                            data->nb_sectors, data->pnum);
3033b35b2bbaSMiroslav Rezanina     data->done = true;
3034b35b2bbaSMiroslav Rezanina }
3035b35b2bbaSMiroslav Rezanina 
3036b35b2bbaSMiroslav Rezanina /*
3037b35b2bbaSMiroslav Rezanina  * Synchronous wrapper around bdrv_co_is_allocated_above().
3038b35b2bbaSMiroslav Rezanina  *
3039b35b2bbaSMiroslav Rezanina  * See bdrv_co_is_allocated_above() for details.
3040b35b2bbaSMiroslav Rezanina  */
3041b35b2bbaSMiroslav Rezanina int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
3042b35b2bbaSMiroslav Rezanina                             int64_t sector_num, int nb_sectors, int *pnum)
3043b35b2bbaSMiroslav Rezanina {
3044b35b2bbaSMiroslav Rezanina     Coroutine *co;
3045b35b2bbaSMiroslav Rezanina     BdrvCoIsAllocatedData data = {
3046b35b2bbaSMiroslav Rezanina         .bs = top,
3047b35b2bbaSMiroslav Rezanina         .base = base,
3048b35b2bbaSMiroslav Rezanina         .sector_num = sector_num,
3049b35b2bbaSMiroslav Rezanina         .nb_sectors = nb_sectors,
3050b35b2bbaSMiroslav Rezanina         .pnum = pnum,
3051b35b2bbaSMiroslav Rezanina         .done = false,
3052b35b2bbaSMiroslav Rezanina     };
3053b35b2bbaSMiroslav Rezanina 
3054b35b2bbaSMiroslav Rezanina     co = qemu_coroutine_create(bdrv_is_allocated_above_co_entry);
3055b35b2bbaSMiroslav Rezanina     qemu_coroutine_enter(co, &data);
3056b35b2bbaSMiroslav Rezanina     while (!data.done) {
3057b35b2bbaSMiroslav Rezanina         qemu_aio_wait();
3058b35b2bbaSMiroslav Rezanina     }
3059b35b2bbaSMiroslav Rezanina     return data.ret;
3060b35b2bbaSMiroslav Rezanina }
3061b35b2bbaSMiroslav Rezanina 
3062ac84adacSPaolo Bonzini BlockInfo *bdrv_query_info(BlockDriverState *bs)
3063ac84adacSPaolo Bonzini {
3064ac84adacSPaolo Bonzini     BlockInfo *info = g_malloc0(sizeof(*info));
3065ac84adacSPaolo Bonzini     info->device = g_strdup(bs->device_name);
3066ac84adacSPaolo Bonzini     info->type = g_strdup("unknown");
3067ac84adacSPaolo Bonzini     info->locked = bdrv_dev_is_medium_locked(bs);
3068ac84adacSPaolo Bonzini     info->removable = bdrv_dev_has_removable_media(bs);
3069ac84adacSPaolo Bonzini 
3070ac84adacSPaolo Bonzini     if (bdrv_dev_has_removable_media(bs)) {
3071ac84adacSPaolo Bonzini         info->has_tray_open = true;
3072ac84adacSPaolo Bonzini         info->tray_open = bdrv_dev_is_tray_open(bs);
3073ac84adacSPaolo Bonzini     }
3074ac84adacSPaolo Bonzini 
3075ac84adacSPaolo Bonzini     if (bdrv_iostatus_is_enabled(bs)) {
3076ac84adacSPaolo Bonzini         info->has_io_status = true;
3077ac84adacSPaolo Bonzini         info->io_status = bs->iostatus;
3078ac84adacSPaolo Bonzini     }
3079ac84adacSPaolo Bonzini 
3080b9a9b3a4SPaolo Bonzini     if (bs->dirty_bitmap) {
3081b9a9b3a4SPaolo Bonzini         info->has_dirty = true;
3082b9a9b3a4SPaolo Bonzini         info->dirty = g_malloc0(sizeof(*info->dirty));
3083acc906c6SPaolo Bonzini         info->dirty->count = bdrv_get_dirty_count(bs) * BDRV_SECTOR_SIZE;
308450717e94SPaolo Bonzini         info->dirty->granularity =
308550717e94SPaolo Bonzini             ((int64_t) BDRV_SECTOR_SIZE << hbitmap_granularity(bs->dirty_bitmap));
3086b9a9b3a4SPaolo Bonzini     }
3087b9a9b3a4SPaolo Bonzini 
3088ac84adacSPaolo Bonzini     if (bs->drv) {
3089ac84adacSPaolo Bonzini         info->has_inserted = true;
3090ac84adacSPaolo Bonzini         info->inserted = g_malloc0(sizeof(*info->inserted));
3091ac84adacSPaolo Bonzini         info->inserted->file = g_strdup(bs->filename);
3092ac84adacSPaolo Bonzini         info->inserted->ro = bs->read_only;
3093ac84adacSPaolo Bonzini         info->inserted->drv = g_strdup(bs->drv->format_name);
3094ac84adacSPaolo Bonzini         info->inserted->encrypted = bs->encrypted;
3095ac84adacSPaolo Bonzini         info->inserted->encryption_key_missing = bdrv_key_required(bs);
3096ac84adacSPaolo Bonzini 
3097ac84adacSPaolo Bonzini         if (bs->backing_file[0]) {
3098ac84adacSPaolo Bonzini             info->inserted->has_backing_file = true;
3099ac84adacSPaolo Bonzini             info->inserted->backing_file = g_strdup(bs->backing_file);
3100ac84adacSPaolo Bonzini         }
3101ac84adacSPaolo Bonzini 
3102ac84adacSPaolo Bonzini         info->inserted->backing_file_depth = bdrv_get_backing_file_depth(bs);
3103ac84adacSPaolo Bonzini 
3104ac84adacSPaolo Bonzini         if (bs->io_limits_enabled) {
3105ac84adacSPaolo Bonzini             info->inserted->bps =
3106ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
3107ac84adacSPaolo Bonzini             info->inserted->bps_rd =
3108ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_READ];
3109ac84adacSPaolo Bonzini             info->inserted->bps_wr =
3110ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_WRITE];
3111ac84adacSPaolo Bonzini             info->inserted->iops =
3112ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
3113ac84adacSPaolo Bonzini             info->inserted->iops_rd =
3114ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_READ];
3115ac84adacSPaolo Bonzini             info->inserted->iops_wr =
3116ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_WRITE];
3117ac84adacSPaolo Bonzini         }
3118ac84adacSPaolo Bonzini     }
3119ac84adacSPaolo Bonzini     return info;
3120ac84adacSPaolo Bonzini }
3121ac84adacSPaolo Bonzini 
3122b2023818SLuiz Capitulino BlockInfoList *qmp_query_block(Error **errp)
3123b338082bSbellard {
3124ac84adacSPaolo Bonzini     BlockInfoList *head = NULL, **p_next = &head;
3125d15e5465SLuiz Capitulino     BlockDriverState *bs;
3126d15e5465SLuiz Capitulino 
31271b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
3128b2023818SLuiz Capitulino         BlockInfoList *info = g_malloc0(sizeof(*info));
3129ac84adacSPaolo Bonzini         info->value = bdrv_query_info(bs);
3130d15e5465SLuiz Capitulino 
3131ac84adacSPaolo Bonzini         *p_next = info;
3132ac84adacSPaolo Bonzini         p_next = &info->next;
3133d15e5465SLuiz Capitulino     }
3134d15e5465SLuiz Capitulino 
3135b2023818SLuiz Capitulino     return head;
3136b338082bSbellard }
3137a36e69ddSths 
31389887b616SPaolo Bonzini BlockStats *bdrv_query_stats(const BlockDriverState *bs)
3139a36e69ddSths {
3140f11f57e4SLuiz Capitulino     BlockStats *s;
3141218a536aSLuiz Capitulino 
3142f11f57e4SLuiz Capitulino     s = g_malloc0(sizeof(*s));
3143218a536aSLuiz Capitulino 
3144f11f57e4SLuiz Capitulino     if (bs->device_name[0]) {
3145f11f57e4SLuiz Capitulino         s->has_device = true;
3146f11f57e4SLuiz Capitulino         s->device = g_strdup(bs->device_name);
3147218a536aSLuiz Capitulino     }
3148218a536aSLuiz Capitulino 
3149f11f57e4SLuiz Capitulino     s->stats = g_malloc0(sizeof(*s->stats));
3150f11f57e4SLuiz Capitulino     s->stats->rd_bytes = bs->nr_bytes[BDRV_ACCT_READ];
3151f11f57e4SLuiz Capitulino     s->stats->wr_bytes = bs->nr_bytes[BDRV_ACCT_WRITE];
3152f11f57e4SLuiz Capitulino     s->stats->rd_operations = bs->nr_ops[BDRV_ACCT_READ];
3153f11f57e4SLuiz Capitulino     s->stats->wr_operations = bs->nr_ops[BDRV_ACCT_WRITE];
3154f11f57e4SLuiz Capitulino     s->stats->wr_highest_offset = bs->wr_highest_sector * BDRV_SECTOR_SIZE;
3155f11f57e4SLuiz Capitulino     s->stats->flush_operations = bs->nr_ops[BDRV_ACCT_FLUSH];
3156f11f57e4SLuiz Capitulino     s->stats->wr_total_time_ns = bs->total_time_ns[BDRV_ACCT_WRITE];
3157f11f57e4SLuiz Capitulino     s->stats->rd_total_time_ns = bs->total_time_ns[BDRV_ACCT_READ];
3158f11f57e4SLuiz Capitulino     s->stats->flush_total_time_ns = bs->total_time_ns[BDRV_ACCT_FLUSH];
3159294cc35fSKevin Wolf 
3160294cc35fSKevin Wolf     if (bs->file) {
3161f11f57e4SLuiz Capitulino         s->has_parent = true;
31629887b616SPaolo Bonzini         s->parent = bdrv_query_stats(bs->file);
3163294cc35fSKevin Wolf     }
3164294cc35fSKevin Wolf 
3165f11f57e4SLuiz Capitulino     return s;
3166294cc35fSKevin Wolf }
3167294cc35fSKevin Wolf 
3168f11f57e4SLuiz Capitulino BlockStatsList *qmp_query_blockstats(Error **errp)
3169218a536aSLuiz Capitulino {
31709887b616SPaolo Bonzini     BlockStatsList *head = NULL, **p_next = &head;
3171a36e69ddSths     BlockDriverState *bs;
3172a36e69ddSths 
31731b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
3174f11f57e4SLuiz Capitulino         BlockStatsList *info = g_malloc0(sizeof(*info));
31759887b616SPaolo Bonzini         info->value = bdrv_query_stats(bs);
3176f11f57e4SLuiz Capitulino 
31779887b616SPaolo Bonzini         *p_next = info;
31789887b616SPaolo Bonzini         p_next = &info->next;
3179a36e69ddSths     }
3180218a536aSLuiz Capitulino 
3181f11f57e4SLuiz Capitulino     return head;
3182a36e69ddSths }
3183ea2384d3Sbellard 
3184045df330Saliguori const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
3185045df330Saliguori {
3186045df330Saliguori     if (bs->backing_hd && bs->backing_hd->encrypted)
3187045df330Saliguori         return bs->backing_file;
3188045df330Saliguori     else if (bs->encrypted)
3189045df330Saliguori         return bs->filename;
3190045df330Saliguori     else
3191045df330Saliguori         return NULL;
3192045df330Saliguori }
3193045df330Saliguori 
319483f64091Sbellard void bdrv_get_backing_filename(BlockDriverState *bs,
319583f64091Sbellard                                char *filename, int filename_size)
319683f64091Sbellard {
319783f64091Sbellard     pstrcpy(filename, filename_size, bs->backing_file);
319883f64091Sbellard }
319983f64091Sbellard 
3200faea38e7Sbellard int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
3201faea38e7Sbellard                           const uint8_t *buf, int nb_sectors)
3202faea38e7Sbellard {
3203faea38e7Sbellard     BlockDriver *drv = bs->drv;
3204faea38e7Sbellard     if (!drv)
320519cb3738Sbellard         return -ENOMEDIUM;
3206faea38e7Sbellard     if (!drv->bdrv_write_compressed)
3207faea38e7Sbellard         return -ENOTSUP;
3208fbb7b4e0SKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors))
3209fbb7b4e0SKevin Wolf         return -EIO;
32107cd1e32aSlirans@il.ibm.com 
32111755da16SPaolo Bonzini     assert(!bs->dirty_bitmap);
32127cd1e32aSlirans@il.ibm.com 
3213faea38e7Sbellard     return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
3214faea38e7Sbellard }
3215faea38e7Sbellard 
3216faea38e7Sbellard int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
3217faea38e7Sbellard {
3218faea38e7Sbellard     BlockDriver *drv = bs->drv;
3219faea38e7Sbellard     if (!drv)
322019cb3738Sbellard         return -ENOMEDIUM;
3221faea38e7Sbellard     if (!drv->bdrv_get_info)
3222faea38e7Sbellard         return -ENOTSUP;
3223faea38e7Sbellard     memset(bdi, 0, sizeof(*bdi));
3224faea38e7Sbellard     return drv->bdrv_get_info(bs, bdi);
3225faea38e7Sbellard }
3226faea38e7Sbellard 
322745566e9cSChristoph Hellwig int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
322845566e9cSChristoph Hellwig                       int64_t pos, int size)
3229178e08a5Saliguori {
3230cf8074b3SKevin Wolf     QEMUIOVector qiov;
3231cf8074b3SKevin Wolf     struct iovec iov = {
3232cf8074b3SKevin Wolf         .iov_base   = (void *) buf,
3233cf8074b3SKevin Wolf         .iov_len    = size,
3234cf8074b3SKevin Wolf     };
3235cf8074b3SKevin Wolf 
3236cf8074b3SKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
3237cf8074b3SKevin Wolf     return bdrv_writev_vmstate(bs, &qiov, pos);
3238cf8074b3SKevin Wolf }
3239cf8074b3SKevin Wolf 
3240cf8074b3SKevin Wolf int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
3241cf8074b3SKevin Wolf {
3242178e08a5Saliguori     BlockDriver *drv = bs->drv;
3243cf8074b3SKevin Wolf 
3244cf8074b3SKevin Wolf     if (!drv) {
3245178e08a5Saliguori         return -ENOMEDIUM;
3246cf8074b3SKevin Wolf     } else if (drv->bdrv_save_vmstate) {
3247cf8074b3SKevin Wolf         return drv->bdrv_save_vmstate(bs, qiov, pos);
3248cf8074b3SKevin Wolf     } else if (bs->file) {
3249cf8074b3SKevin Wolf         return bdrv_writev_vmstate(bs->file, qiov, pos);
3250cf8074b3SKevin Wolf     }
3251cf8074b3SKevin Wolf 
32527cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3253178e08a5Saliguori }
3254178e08a5Saliguori 
325545566e9cSChristoph Hellwig int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
325645566e9cSChristoph Hellwig                       int64_t pos, int size)
3257178e08a5Saliguori {
3258178e08a5Saliguori     BlockDriver *drv = bs->drv;
3259178e08a5Saliguori     if (!drv)
3260178e08a5Saliguori         return -ENOMEDIUM;
32617cdb1f6dSMORITA Kazutaka     if (drv->bdrv_load_vmstate)
326245566e9cSChristoph Hellwig         return drv->bdrv_load_vmstate(bs, buf, pos, size);
32637cdb1f6dSMORITA Kazutaka     if (bs->file)
32647cdb1f6dSMORITA Kazutaka         return bdrv_load_vmstate(bs->file, buf, pos, size);
32657cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3266178e08a5Saliguori }
3267178e08a5Saliguori 
32688b9b0cc2SKevin Wolf void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
32698b9b0cc2SKevin Wolf {
32708b9b0cc2SKevin Wolf     BlockDriver *drv = bs->drv;
32718b9b0cc2SKevin Wolf 
32728b9b0cc2SKevin Wolf     if (!drv || !drv->bdrv_debug_event) {
32738b9b0cc2SKevin Wolf         return;
32748b9b0cc2SKevin Wolf     }
32758b9b0cc2SKevin Wolf 
32760ed8b6f6SBlue Swirl     drv->bdrv_debug_event(bs, event);
327741c695c7SKevin Wolf }
32788b9b0cc2SKevin Wolf 
327941c695c7SKevin Wolf int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
328041c695c7SKevin Wolf                           const char *tag)
328141c695c7SKevin Wolf {
328241c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) {
328341c695c7SKevin Wolf         bs = bs->file;
328441c695c7SKevin Wolf     }
328541c695c7SKevin Wolf 
328641c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) {
328741c695c7SKevin Wolf         return bs->drv->bdrv_debug_breakpoint(bs, event, tag);
328841c695c7SKevin Wolf     }
328941c695c7SKevin Wolf 
329041c695c7SKevin Wolf     return -ENOTSUP;
329141c695c7SKevin Wolf }
329241c695c7SKevin Wolf 
329341c695c7SKevin Wolf int bdrv_debug_resume(BlockDriverState *bs, const char *tag)
329441c695c7SKevin Wolf {
329541c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_resume) {
329641c695c7SKevin Wolf         bs = bs->file;
329741c695c7SKevin Wolf     }
329841c695c7SKevin Wolf 
329941c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_resume) {
330041c695c7SKevin Wolf         return bs->drv->bdrv_debug_resume(bs, tag);
330141c695c7SKevin Wolf     }
330241c695c7SKevin Wolf 
330341c695c7SKevin Wolf     return -ENOTSUP;
330441c695c7SKevin Wolf }
330541c695c7SKevin Wolf 
330641c695c7SKevin Wolf bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag)
330741c695c7SKevin Wolf {
330841c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) {
330941c695c7SKevin Wolf         bs = bs->file;
331041c695c7SKevin Wolf     }
331141c695c7SKevin Wolf 
331241c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) {
331341c695c7SKevin Wolf         return bs->drv->bdrv_debug_is_suspended(bs, tag);
331441c695c7SKevin Wolf     }
331541c695c7SKevin Wolf 
331641c695c7SKevin Wolf     return false;
33178b9b0cc2SKevin Wolf }
33188b9b0cc2SKevin Wolf 
3319faea38e7Sbellard /**************************************************************/
3320faea38e7Sbellard /* handling of snapshots */
3321faea38e7Sbellard 
3322feeee5acSMiguel Di Ciurcio Filho int bdrv_can_snapshot(BlockDriverState *bs)
3323feeee5acSMiguel Di Ciurcio Filho {
3324feeee5acSMiguel Di Ciurcio Filho     BlockDriver *drv = bs->drv;
332507b70bfbSMarkus Armbruster     if (!drv || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
3326feeee5acSMiguel Di Ciurcio Filho         return 0;
3327feeee5acSMiguel Di Ciurcio Filho     }
3328feeee5acSMiguel Di Ciurcio Filho 
3329feeee5acSMiguel Di Ciurcio Filho     if (!drv->bdrv_snapshot_create) {
3330feeee5acSMiguel Di Ciurcio Filho         if (bs->file != NULL) {
3331feeee5acSMiguel Di Ciurcio Filho             return bdrv_can_snapshot(bs->file);
3332feeee5acSMiguel Di Ciurcio Filho         }
3333feeee5acSMiguel Di Ciurcio Filho         return 0;
3334feeee5acSMiguel Di Ciurcio Filho     }
3335feeee5acSMiguel Di Ciurcio Filho 
3336feeee5acSMiguel Di Ciurcio Filho     return 1;
3337feeee5acSMiguel Di Ciurcio Filho }
3338feeee5acSMiguel Di Ciurcio Filho 
3339199630b6SBlue Swirl int bdrv_is_snapshot(BlockDriverState *bs)
3340199630b6SBlue Swirl {
3341199630b6SBlue Swirl     return !!(bs->open_flags & BDRV_O_SNAPSHOT);
3342199630b6SBlue Swirl }
3343199630b6SBlue Swirl 
3344f9092b10SMarkus Armbruster BlockDriverState *bdrv_snapshots(void)
3345f9092b10SMarkus Armbruster {
3346f9092b10SMarkus Armbruster     BlockDriverState *bs;
3347f9092b10SMarkus Armbruster 
33483ac906f7SMarkus Armbruster     if (bs_snapshots) {
3349f9092b10SMarkus Armbruster         return bs_snapshots;
33503ac906f7SMarkus Armbruster     }
3351f9092b10SMarkus Armbruster 
3352f9092b10SMarkus Armbruster     bs = NULL;
3353f9092b10SMarkus Armbruster     while ((bs = bdrv_next(bs))) {
3354f9092b10SMarkus Armbruster         if (bdrv_can_snapshot(bs)) {
33553ac906f7SMarkus Armbruster             bs_snapshots = bs;
33563ac906f7SMarkus Armbruster             return bs;
3357f9092b10SMarkus Armbruster         }
3358f9092b10SMarkus Armbruster     }
3359f9092b10SMarkus Armbruster     return NULL;
3360f9092b10SMarkus Armbruster }
3361f9092b10SMarkus Armbruster 
3362faea38e7Sbellard int bdrv_snapshot_create(BlockDriverState *bs,
3363faea38e7Sbellard                          QEMUSnapshotInfo *sn_info)
3364faea38e7Sbellard {
3365faea38e7Sbellard     BlockDriver *drv = bs->drv;
3366faea38e7Sbellard     if (!drv)
336719cb3738Sbellard         return -ENOMEDIUM;
33687cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_create)
3369faea38e7Sbellard         return drv->bdrv_snapshot_create(bs, sn_info);
33707cdb1f6dSMORITA Kazutaka     if (bs->file)
33717cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_create(bs->file, sn_info);
33727cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3373faea38e7Sbellard }
3374faea38e7Sbellard 
3375faea38e7Sbellard int bdrv_snapshot_goto(BlockDriverState *bs,
3376faea38e7Sbellard                        const char *snapshot_id)
3377faea38e7Sbellard {
3378faea38e7Sbellard     BlockDriver *drv = bs->drv;
33797cdb1f6dSMORITA Kazutaka     int ret, open_ret;
33807cdb1f6dSMORITA Kazutaka 
3381faea38e7Sbellard     if (!drv)
338219cb3738Sbellard         return -ENOMEDIUM;
33837cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_goto)
3384faea38e7Sbellard         return drv->bdrv_snapshot_goto(bs, snapshot_id);
33857cdb1f6dSMORITA Kazutaka 
33867cdb1f6dSMORITA Kazutaka     if (bs->file) {
33877cdb1f6dSMORITA Kazutaka         drv->bdrv_close(bs);
33887cdb1f6dSMORITA Kazutaka         ret = bdrv_snapshot_goto(bs->file, snapshot_id);
33891a86938fSKevin Wolf         open_ret = drv->bdrv_open(bs, NULL, bs->open_flags);
33907cdb1f6dSMORITA Kazutaka         if (open_ret < 0) {
33917cdb1f6dSMORITA Kazutaka             bdrv_delete(bs->file);
33927cdb1f6dSMORITA Kazutaka             bs->drv = NULL;
33937cdb1f6dSMORITA Kazutaka             return open_ret;
33947cdb1f6dSMORITA Kazutaka         }
33957cdb1f6dSMORITA Kazutaka         return ret;
33967cdb1f6dSMORITA Kazutaka     }
33977cdb1f6dSMORITA Kazutaka 
33987cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3399faea38e7Sbellard }
3400faea38e7Sbellard 
3401faea38e7Sbellard int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
3402faea38e7Sbellard {
3403faea38e7Sbellard     BlockDriver *drv = bs->drv;
3404faea38e7Sbellard     if (!drv)
340519cb3738Sbellard         return -ENOMEDIUM;
34067cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_delete)
3407faea38e7Sbellard         return drv->bdrv_snapshot_delete(bs, snapshot_id);
34087cdb1f6dSMORITA Kazutaka     if (bs->file)
34097cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_delete(bs->file, snapshot_id);
34107cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3411faea38e7Sbellard }
3412faea38e7Sbellard 
3413faea38e7Sbellard int bdrv_snapshot_list(BlockDriverState *bs,
3414faea38e7Sbellard                        QEMUSnapshotInfo **psn_info)
3415faea38e7Sbellard {
3416faea38e7Sbellard     BlockDriver *drv = bs->drv;
3417faea38e7Sbellard     if (!drv)
341819cb3738Sbellard         return -ENOMEDIUM;
34197cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_list)
3420faea38e7Sbellard         return drv->bdrv_snapshot_list(bs, psn_info);
34217cdb1f6dSMORITA Kazutaka     if (bs->file)
34227cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_list(bs->file, psn_info);
34237cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3424faea38e7Sbellard }
3425faea38e7Sbellard 
342651ef6727Sedison int bdrv_snapshot_load_tmp(BlockDriverState *bs,
342751ef6727Sedison         const char *snapshot_name)
342851ef6727Sedison {
342951ef6727Sedison     BlockDriver *drv = bs->drv;
343051ef6727Sedison     if (!drv) {
343151ef6727Sedison         return -ENOMEDIUM;
343251ef6727Sedison     }
343351ef6727Sedison     if (!bs->read_only) {
343451ef6727Sedison         return -EINVAL;
343551ef6727Sedison     }
343651ef6727Sedison     if (drv->bdrv_snapshot_load_tmp) {
343751ef6727Sedison         return drv->bdrv_snapshot_load_tmp(bs, snapshot_name);
343851ef6727Sedison     }
343951ef6727Sedison     return -ENOTSUP;
344051ef6727Sedison }
344151ef6727Sedison 
3442b1b1d783SJeff Cody /* backing_file can either be relative, or absolute, or a protocol.  If it is
3443b1b1d783SJeff Cody  * relative, it must be relative to the chain.  So, passing in bs->filename
3444b1b1d783SJeff Cody  * from a BDS as backing_file should not be done, as that may be relative to
3445b1b1d783SJeff Cody  * the CWD rather than the chain. */
3446e8a6bb9cSMarcelo Tosatti BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
3447e8a6bb9cSMarcelo Tosatti         const char *backing_file)
3448e8a6bb9cSMarcelo Tosatti {
3449b1b1d783SJeff Cody     char *filename_full = NULL;
3450b1b1d783SJeff Cody     char *backing_file_full = NULL;
3451b1b1d783SJeff Cody     char *filename_tmp = NULL;
3452b1b1d783SJeff Cody     int is_protocol = 0;
3453b1b1d783SJeff Cody     BlockDriverState *curr_bs = NULL;
3454b1b1d783SJeff Cody     BlockDriverState *retval = NULL;
3455b1b1d783SJeff Cody 
3456b1b1d783SJeff Cody     if (!bs || !bs->drv || !backing_file) {
3457e8a6bb9cSMarcelo Tosatti         return NULL;
3458e8a6bb9cSMarcelo Tosatti     }
3459e8a6bb9cSMarcelo Tosatti 
3460b1b1d783SJeff Cody     filename_full     = g_malloc(PATH_MAX);
3461b1b1d783SJeff Cody     backing_file_full = g_malloc(PATH_MAX);
3462b1b1d783SJeff Cody     filename_tmp      = g_malloc(PATH_MAX);
3463b1b1d783SJeff Cody 
3464b1b1d783SJeff Cody     is_protocol = path_has_protocol(backing_file);
3465b1b1d783SJeff Cody 
3466b1b1d783SJeff Cody     for (curr_bs = bs; curr_bs->backing_hd; curr_bs = curr_bs->backing_hd) {
3467b1b1d783SJeff Cody 
3468b1b1d783SJeff Cody         /* If either of the filename paths is actually a protocol, then
3469b1b1d783SJeff Cody          * compare unmodified paths; otherwise make paths relative */
3470b1b1d783SJeff Cody         if (is_protocol || path_has_protocol(curr_bs->backing_file)) {
3471b1b1d783SJeff Cody             if (strcmp(backing_file, curr_bs->backing_file) == 0) {
3472b1b1d783SJeff Cody                 retval = curr_bs->backing_hd;
3473b1b1d783SJeff Cody                 break;
3474b1b1d783SJeff Cody             }
3475e8a6bb9cSMarcelo Tosatti         } else {
3476b1b1d783SJeff Cody             /* If not an absolute filename path, make it relative to the current
3477b1b1d783SJeff Cody              * image's filename path */
3478b1b1d783SJeff Cody             path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3479b1b1d783SJeff Cody                          backing_file);
3480b1b1d783SJeff Cody 
3481b1b1d783SJeff Cody             /* We are going to compare absolute pathnames */
3482b1b1d783SJeff Cody             if (!realpath(filename_tmp, filename_full)) {
3483b1b1d783SJeff Cody                 continue;
3484b1b1d783SJeff Cody             }
3485b1b1d783SJeff Cody 
3486b1b1d783SJeff Cody             /* We need to make sure the backing filename we are comparing against
3487b1b1d783SJeff Cody              * is relative to the current image filename (or absolute) */
3488b1b1d783SJeff Cody             path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3489b1b1d783SJeff Cody                          curr_bs->backing_file);
3490b1b1d783SJeff Cody 
3491b1b1d783SJeff Cody             if (!realpath(filename_tmp, backing_file_full)) {
3492b1b1d783SJeff Cody                 continue;
3493b1b1d783SJeff Cody             }
3494b1b1d783SJeff Cody 
3495b1b1d783SJeff Cody             if (strcmp(backing_file_full, filename_full) == 0) {
3496b1b1d783SJeff Cody                 retval = curr_bs->backing_hd;
3497b1b1d783SJeff Cody                 break;
3498b1b1d783SJeff Cody             }
3499e8a6bb9cSMarcelo Tosatti         }
3500e8a6bb9cSMarcelo Tosatti     }
3501e8a6bb9cSMarcelo Tosatti 
3502b1b1d783SJeff Cody     g_free(filename_full);
3503b1b1d783SJeff Cody     g_free(backing_file_full);
3504b1b1d783SJeff Cody     g_free(filename_tmp);
3505b1b1d783SJeff Cody     return retval;
3506e8a6bb9cSMarcelo Tosatti }
3507e8a6bb9cSMarcelo Tosatti 
3508f198fd1cSBenoît Canet int bdrv_get_backing_file_depth(BlockDriverState *bs)
3509f198fd1cSBenoît Canet {
3510f198fd1cSBenoît Canet     if (!bs->drv) {
3511f198fd1cSBenoît Canet         return 0;
3512f198fd1cSBenoît Canet     }
3513f198fd1cSBenoît Canet 
3514f198fd1cSBenoît Canet     if (!bs->backing_hd) {
3515f198fd1cSBenoît Canet         return 0;
3516f198fd1cSBenoît Canet     }
3517f198fd1cSBenoît Canet 
3518f198fd1cSBenoît Canet     return 1 + bdrv_get_backing_file_depth(bs->backing_hd);
3519f198fd1cSBenoît Canet }
3520f198fd1cSBenoît Canet 
352179fac568SJeff Cody BlockDriverState *bdrv_find_base(BlockDriverState *bs)
352279fac568SJeff Cody {
352379fac568SJeff Cody     BlockDriverState *curr_bs = NULL;
352479fac568SJeff Cody 
352579fac568SJeff Cody     if (!bs) {
352679fac568SJeff Cody         return NULL;
352779fac568SJeff Cody     }
352879fac568SJeff Cody 
352979fac568SJeff Cody     curr_bs = bs;
353079fac568SJeff Cody 
353179fac568SJeff Cody     while (curr_bs->backing_hd) {
353279fac568SJeff Cody         curr_bs = curr_bs->backing_hd;
353379fac568SJeff Cody     }
353479fac568SJeff Cody     return curr_bs;
353579fac568SJeff Cody }
353679fac568SJeff Cody 
3537faea38e7Sbellard #define NB_SUFFIXES 4
3538faea38e7Sbellard 
3539faea38e7Sbellard char *get_human_readable_size(char *buf, int buf_size, int64_t size)
3540faea38e7Sbellard {
3541faea38e7Sbellard     static const char suffixes[NB_SUFFIXES] = "KMGT";
3542faea38e7Sbellard     int64_t base;
3543faea38e7Sbellard     int i;
3544faea38e7Sbellard 
3545faea38e7Sbellard     if (size <= 999) {
3546faea38e7Sbellard         snprintf(buf, buf_size, "%" PRId64, size);
3547faea38e7Sbellard     } else {
3548faea38e7Sbellard         base = 1024;
3549faea38e7Sbellard         for(i = 0; i < NB_SUFFIXES; i++) {
3550faea38e7Sbellard             if (size < (10 * base)) {
3551faea38e7Sbellard                 snprintf(buf, buf_size, "%0.1f%c",
3552faea38e7Sbellard                          (double)size / base,
3553faea38e7Sbellard                          suffixes[i]);
3554faea38e7Sbellard                 break;
3555faea38e7Sbellard             } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
3556faea38e7Sbellard                 snprintf(buf, buf_size, "%" PRId64 "%c",
3557faea38e7Sbellard                          ((size + (base >> 1)) / base),
3558faea38e7Sbellard                          suffixes[i]);
3559faea38e7Sbellard                 break;
3560faea38e7Sbellard             }
3561faea38e7Sbellard             base = base * 1024;
3562faea38e7Sbellard         }
3563faea38e7Sbellard     }
3564faea38e7Sbellard     return buf;
3565faea38e7Sbellard }
3566faea38e7Sbellard 
3567faea38e7Sbellard char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
3568faea38e7Sbellard {
3569faea38e7Sbellard     char buf1[128], date_buf[128], clock_buf[128];
3570faea38e7Sbellard     struct tm tm;
3571faea38e7Sbellard     time_t ti;
3572faea38e7Sbellard     int64_t secs;
3573faea38e7Sbellard 
3574faea38e7Sbellard     if (!sn) {
3575faea38e7Sbellard         snprintf(buf, buf_size,
3576faea38e7Sbellard                  "%-10s%-20s%7s%20s%15s",
3577faea38e7Sbellard                  "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
3578faea38e7Sbellard     } else {
3579faea38e7Sbellard         ti = sn->date_sec;
3580faea38e7Sbellard         localtime_r(&ti, &tm);
3581faea38e7Sbellard         strftime(date_buf, sizeof(date_buf),
3582faea38e7Sbellard                  "%Y-%m-%d %H:%M:%S", &tm);
3583faea38e7Sbellard         secs = sn->vm_clock_nsec / 1000000000;
3584faea38e7Sbellard         snprintf(clock_buf, sizeof(clock_buf),
3585faea38e7Sbellard                  "%02d:%02d:%02d.%03d",
3586faea38e7Sbellard                  (int)(secs / 3600),
3587faea38e7Sbellard                  (int)((secs / 60) % 60),
3588faea38e7Sbellard                  (int)(secs % 60),
3589faea38e7Sbellard                  (int)((sn->vm_clock_nsec / 1000000) % 1000));
3590faea38e7Sbellard         snprintf(buf, buf_size,
3591faea38e7Sbellard                  "%-10s%-20s%7s%20s%15s",
3592faea38e7Sbellard                  sn->id_str, sn->name,
3593faea38e7Sbellard                  get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
3594faea38e7Sbellard                  date_buf,
3595faea38e7Sbellard                  clock_buf);
3596faea38e7Sbellard     }
3597faea38e7Sbellard     return buf;
3598faea38e7Sbellard }
3599faea38e7Sbellard 
3600ea2384d3Sbellard /**************************************************************/
360183f64091Sbellard /* async I/Os */
3602ea2384d3Sbellard 
36033b69e4b9Saliguori BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
3604f141eafeSaliguori                                  QEMUIOVector *qiov, int nb_sectors,
360583f64091Sbellard                                  BlockDriverCompletionFunc *cb, void *opaque)
3606ea2384d3Sbellard {
3607bbf0a440SStefan Hajnoczi     trace_bdrv_aio_readv(bs, sector_num, nb_sectors, opaque);
3608bbf0a440SStefan Hajnoczi 
3609b2a61371SStefan Hajnoczi     return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
36108c5873d6SStefan Hajnoczi                                  cb, opaque, false);
361183f64091Sbellard }
361283f64091Sbellard 
3613f141eafeSaliguori BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
3614f141eafeSaliguori                                   QEMUIOVector *qiov, int nb_sectors,
361583f64091Sbellard                                   BlockDriverCompletionFunc *cb, void *opaque)
36167674e7bfSbellard {
3617bbf0a440SStefan Hajnoczi     trace_bdrv_aio_writev(bs, sector_num, nb_sectors, opaque);
3618bbf0a440SStefan Hajnoczi 
36191a6e115bSStefan Hajnoczi     return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
36208c5873d6SStefan Hajnoczi                                  cb, opaque, true);
362183f64091Sbellard }
362283f64091Sbellard 
362340b4f539SKevin Wolf 
362440b4f539SKevin Wolf typedef struct MultiwriteCB {
362540b4f539SKevin Wolf     int error;
362640b4f539SKevin Wolf     int num_requests;
362740b4f539SKevin Wolf     int num_callbacks;
362840b4f539SKevin Wolf     struct {
362940b4f539SKevin Wolf         BlockDriverCompletionFunc *cb;
363040b4f539SKevin Wolf         void *opaque;
363140b4f539SKevin Wolf         QEMUIOVector *free_qiov;
363240b4f539SKevin Wolf     } callbacks[];
363340b4f539SKevin Wolf } MultiwriteCB;
363440b4f539SKevin Wolf 
363540b4f539SKevin Wolf static void multiwrite_user_cb(MultiwriteCB *mcb)
363640b4f539SKevin Wolf {
363740b4f539SKevin Wolf     int i;
363840b4f539SKevin Wolf 
363940b4f539SKevin Wolf     for (i = 0; i < mcb->num_callbacks; i++) {
364040b4f539SKevin Wolf         mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
36411e1ea48dSStefan Hajnoczi         if (mcb->callbacks[i].free_qiov) {
36421e1ea48dSStefan Hajnoczi             qemu_iovec_destroy(mcb->callbacks[i].free_qiov);
36431e1ea48dSStefan Hajnoczi         }
36447267c094SAnthony Liguori         g_free(mcb->callbacks[i].free_qiov);
364540b4f539SKevin Wolf     }
364640b4f539SKevin Wolf }
364740b4f539SKevin Wolf 
364840b4f539SKevin Wolf static void multiwrite_cb(void *opaque, int ret)
364940b4f539SKevin Wolf {
365040b4f539SKevin Wolf     MultiwriteCB *mcb = opaque;
365140b4f539SKevin Wolf 
36526d519a5fSStefan Hajnoczi     trace_multiwrite_cb(mcb, ret);
36536d519a5fSStefan Hajnoczi 
3654cb6d3ca0SKevin Wolf     if (ret < 0 && !mcb->error) {
365540b4f539SKevin Wolf         mcb->error = ret;
365640b4f539SKevin Wolf     }
365740b4f539SKevin Wolf 
365840b4f539SKevin Wolf     mcb->num_requests--;
365940b4f539SKevin Wolf     if (mcb->num_requests == 0) {
366040b4f539SKevin Wolf         multiwrite_user_cb(mcb);
36617267c094SAnthony Liguori         g_free(mcb);
366240b4f539SKevin Wolf     }
366340b4f539SKevin Wolf }
366440b4f539SKevin Wolf 
366540b4f539SKevin Wolf static int multiwrite_req_compare(const void *a, const void *b)
366640b4f539SKevin Wolf {
366777be4366SChristoph Hellwig     const BlockRequest *req1 = a, *req2 = b;
366877be4366SChristoph Hellwig 
366977be4366SChristoph Hellwig     /*
367077be4366SChristoph Hellwig      * Note that we can't simply subtract req2->sector from req1->sector
367177be4366SChristoph Hellwig      * here as that could overflow the return value.
367277be4366SChristoph Hellwig      */
367377be4366SChristoph Hellwig     if (req1->sector > req2->sector) {
367477be4366SChristoph Hellwig         return 1;
367577be4366SChristoph Hellwig     } else if (req1->sector < req2->sector) {
367677be4366SChristoph Hellwig         return -1;
367777be4366SChristoph Hellwig     } else {
367877be4366SChristoph Hellwig         return 0;
367977be4366SChristoph Hellwig     }
368040b4f539SKevin Wolf }
368140b4f539SKevin Wolf 
368240b4f539SKevin Wolf /*
368340b4f539SKevin Wolf  * Takes a bunch of requests and tries to merge them. Returns the number of
368440b4f539SKevin Wolf  * requests that remain after merging.
368540b4f539SKevin Wolf  */
368640b4f539SKevin Wolf static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
368740b4f539SKevin Wolf     int num_reqs, MultiwriteCB *mcb)
368840b4f539SKevin Wolf {
368940b4f539SKevin Wolf     int i, outidx;
369040b4f539SKevin Wolf 
369140b4f539SKevin Wolf     // Sort requests by start sector
369240b4f539SKevin Wolf     qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);
369340b4f539SKevin Wolf 
369440b4f539SKevin Wolf     // Check if adjacent requests touch the same clusters. If so, combine them,
369540b4f539SKevin Wolf     // filling up gaps with zero sectors.
369640b4f539SKevin Wolf     outidx = 0;
369740b4f539SKevin Wolf     for (i = 1; i < num_reqs; i++) {
369840b4f539SKevin Wolf         int merge = 0;
369940b4f539SKevin Wolf         int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;
370040b4f539SKevin Wolf 
3701b6a127a1SPaolo Bonzini         // Handle exactly sequential writes and overlapping writes.
370240b4f539SKevin Wolf         if (reqs[i].sector <= oldreq_last) {
370340b4f539SKevin Wolf             merge = 1;
370440b4f539SKevin Wolf         }
370540b4f539SKevin Wolf 
3706e2a305fbSChristoph Hellwig         if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
3707e2a305fbSChristoph Hellwig             merge = 0;
3708e2a305fbSChristoph Hellwig         }
3709e2a305fbSChristoph Hellwig 
371040b4f539SKevin Wolf         if (merge) {
371140b4f539SKevin Wolf             size_t size;
37127267c094SAnthony Liguori             QEMUIOVector *qiov = g_malloc0(sizeof(*qiov));
371340b4f539SKevin Wolf             qemu_iovec_init(qiov,
371440b4f539SKevin Wolf                 reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);
371540b4f539SKevin Wolf 
371640b4f539SKevin Wolf             // Add the first request to the merged one. If the requests are
371740b4f539SKevin Wolf             // overlapping, drop the last sectors of the first request.
371840b4f539SKevin Wolf             size = (reqs[i].sector - reqs[outidx].sector) << 9;
37191b093c48SMichael Tokarev             qemu_iovec_concat(qiov, reqs[outidx].qiov, 0, size);
372040b4f539SKevin Wolf 
3721b6a127a1SPaolo Bonzini             // We should need to add any zeros between the two requests
3722b6a127a1SPaolo Bonzini             assert (reqs[i].sector <= oldreq_last);
372340b4f539SKevin Wolf 
372440b4f539SKevin Wolf             // Add the second request
37251b093c48SMichael Tokarev             qemu_iovec_concat(qiov, reqs[i].qiov, 0, reqs[i].qiov->size);
372640b4f539SKevin Wolf 
3727cbf1dff2SKevin Wolf             reqs[outidx].nb_sectors = qiov->size >> 9;
372840b4f539SKevin Wolf             reqs[outidx].qiov = qiov;
372940b4f539SKevin Wolf 
373040b4f539SKevin Wolf             mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
373140b4f539SKevin Wolf         } else {
373240b4f539SKevin Wolf             outidx++;
373340b4f539SKevin Wolf             reqs[outidx].sector     = reqs[i].sector;
373440b4f539SKevin Wolf             reqs[outidx].nb_sectors = reqs[i].nb_sectors;
373540b4f539SKevin Wolf             reqs[outidx].qiov       = reqs[i].qiov;
373640b4f539SKevin Wolf         }
373740b4f539SKevin Wolf     }
373840b4f539SKevin Wolf 
373940b4f539SKevin Wolf     return outidx + 1;
374040b4f539SKevin Wolf }
374140b4f539SKevin Wolf 
374240b4f539SKevin Wolf /*
374340b4f539SKevin Wolf  * Submit multiple AIO write requests at once.
374440b4f539SKevin Wolf  *
374540b4f539SKevin Wolf  * On success, the function returns 0 and all requests in the reqs array have
374640b4f539SKevin Wolf  * been submitted. In error case this function returns -1, and any of the
374740b4f539SKevin Wolf  * requests may or may not be submitted yet. In particular, this means that the
374840b4f539SKevin Wolf  * callback will be called for some of the requests, for others it won't. The
374940b4f539SKevin Wolf  * caller must check the error field of the BlockRequest to wait for the right
375040b4f539SKevin Wolf  * callbacks (if error != 0, no callback will be called).
375140b4f539SKevin Wolf  *
375240b4f539SKevin Wolf  * The implementation may modify the contents of the reqs array, e.g. to merge
375340b4f539SKevin Wolf  * requests. However, the fields opaque and error are left unmodified as they
375440b4f539SKevin Wolf  * are used to signal failure for a single request to the caller.
375540b4f539SKevin Wolf  */
375640b4f539SKevin Wolf int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
375740b4f539SKevin Wolf {
375840b4f539SKevin Wolf     MultiwriteCB *mcb;
375940b4f539SKevin Wolf     int i;
376040b4f539SKevin Wolf 
3761301db7c2SRyan Harper     /* don't submit writes if we don't have a medium */
3762301db7c2SRyan Harper     if (bs->drv == NULL) {
3763301db7c2SRyan Harper         for (i = 0; i < num_reqs; i++) {
3764301db7c2SRyan Harper             reqs[i].error = -ENOMEDIUM;
3765301db7c2SRyan Harper         }
3766301db7c2SRyan Harper         return -1;
3767301db7c2SRyan Harper     }
3768301db7c2SRyan Harper 
376940b4f539SKevin Wolf     if (num_reqs == 0) {
377040b4f539SKevin Wolf         return 0;
377140b4f539SKevin Wolf     }
377240b4f539SKevin Wolf 
377340b4f539SKevin Wolf     // Create MultiwriteCB structure
37747267c094SAnthony Liguori     mcb = g_malloc0(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
377540b4f539SKevin Wolf     mcb->num_requests = 0;
377640b4f539SKevin Wolf     mcb->num_callbacks = num_reqs;
377740b4f539SKevin Wolf 
377840b4f539SKevin Wolf     for (i = 0; i < num_reqs; i++) {
377940b4f539SKevin Wolf         mcb->callbacks[i].cb = reqs[i].cb;
378040b4f539SKevin Wolf         mcb->callbacks[i].opaque = reqs[i].opaque;
378140b4f539SKevin Wolf     }
378240b4f539SKevin Wolf 
378340b4f539SKevin Wolf     // Check for mergable requests
378440b4f539SKevin Wolf     num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);
378540b4f539SKevin Wolf 
37866d519a5fSStefan Hajnoczi     trace_bdrv_aio_multiwrite(mcb, mcb->num_callbacks, num_reqs);
37876d519a5fSStefan Hajnoczi 
3788df9309fbSPaolo Bonzini     /* Run the aio requests. */
3789df9309fbSPaolo Bonzini     mcb->num_requests = num_reqs;
379040b4f539SKevin Wolf     for (i = 0; i < num_reqs; i++) {
3791ad54ae80SPaolo Bonzini         bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
379240b4f539SKevin Wolf             reqs[i].nb_sectors, multiwrite_cb, mcb);
379340b4f539SKevin Wolf     }
379440b4f539SKevin Wolf 
379540b4f539SKevin Wolf     return 0;
379640b4f539SKevin Wolf }
379740b4f539SKevin Wolf 
379883f64091Sbellard void bdrv_aio_cancel(BlockDriverAIOCB *acb)
379983f64091Sbellard {
3800d7331bedSStefan Hajnoczi     acb->aiocb_info->cancel(acb);
380183f64091Sbellard }
380283f64091Sbellard 
380398f90dbaSZhi Yong Wu /* block I/O throttling */
380498f90dbaSZhi Yong Wu static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
380598f90dbaSZhi Yong Wu                  bool is_write, double elapsed_time, uint64_t *wait)
380698f90dbaSZhi Yong Wu {
380798f90dbaSZhi Yong Wu     uint64_t bps_limit = 0;
3808ae29d6c6SStefan Hajnoczi     uint64_t extension;
380998f90dbaSZhi Yong Wu     double   bytes_limit, bytes_base, bytes_res;
381098f90dbaSZhi Yong Wu     double   slice_time, wait_time;
381198f90dbaSZhi Yong Wu 
381298f90dbaSZhi Yong Wu     if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
381398f90dbaSZhi Yong Wu         bps_limit = bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
381498f90dbaSZhi Yong Wu     } else if (bs->io_limits.bps[is_write]) {
381598f90dbaSZhi Yong Wu         bps_limit = bs->io_limits.bps[is_write];
381698f90dbaSZhi Yong Wu     } else {
381798f90dbaSZhi Yong Wu         if (wait) {
381898f90dbaSZhi Yong Wu             *wait = 0;
381998f90dbaSZhi Yong Wu         }
382098f90dbaSZhi Yong Wu 
382198f90dbaSZhi Yong Wu         return false;
382298f90dbaSZhi Yong Wu     }
382398f90dbaSZhi Yong Wu 
382498f90dbaSZhi Yong Wu     slice_time = bs->slice_end - bs->slice_start;
382598f90dbaSZhi Yong Wu     slice_time /= (NANOSECONDS_PER_SECOND);
382698f90dbaSZhi Yong Wu     bytes_limit = bps_limit * slice_time;
38275905fbc9SStefan Hajnoczi     bytes_base  = bs->slice_submitted.bytes[is_write];
382898f90dbaSZhi Yong Wu     if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
38295905fbc9SStefan Hajnoczi         bytes_base += bs->slice_submitted.bytes[!is_write];
383098f90dbaSZhi Yong Wu     }
383198f90dbaSZhi Yong Wu 
383298f90dbaSZhi Yong Wu     /* bytes_base: the bytes of data which have been read/written; and
383398f90dbaSZhi Yong Wu      *             it is obtained from the history statistic info.
383498f90dbaSZhi Yong Wu      * bytes_res: the remaining bytes of data which need to be read/written.
383598f90dbaSZhi Yong Wu      * (bytes_base + bytes_res) / bps_limit: used to calcuate
383698f90dbaSZhi Yong Wu      *             the total time for completing reading/writting all data.
383798f90dbaSZhi Yong Wu      */
383898f90dbaSZhi Yong Wu     bytes_res   = (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
383998f90dbaSZhi Yong Wu 
384098f90dbaSZhi Yong Wu     if (bytes_base + bytes_res <= bytes_limit) {
384198f90dbaSZhi Yong Wu         if (wait) {
384298f90dbaSZhi Yong Wu             *wait = 0;
384398f90dbaSZhi Yong Wu         }
384498f90dbaSZhi Yong Wu 
384598f90dbaSZhi Yong Wu         return false;
384698f90dbaSZhi Yong Wu     }
384798f90dbaSZhi Yong Wu 
384898f90dbaSZhi Yong Wu     /* Calc approx time to dispatch */
384998f90dbaSZhi Yong Wu     wait_time = (bytes_base + bytes_res) / bps_limit - elapsed_time;
385098f90dbaSZhi Yong Wu 
385198f90dbaSZhi Yong Wu     /* When the I/O rate at runtime exceeds the limits,
385298f90dbaSZhi Yong Wu      * bs->slice_end need to be extended in order that the current statistic
385398f90dbaSZhi Yong Wu      * info can be kept until the timer fire, so it is increased and tuned
385498f90dbaSZhi Yong Wu      * based on the result of experiment.
385598f90dbaSZhi Yong Wu      */
3856ae29d6c6SStefan Hajnoczi     extension = wait_time * NANOSECONDS_PER_SECOND;
3857ae29d6c6SStefan Hajnoczi     extension = DIV_ROUND_UP(extension, BLOCK_IO_SLICE_TIME) *
3858ae29d6c6SStefan Hajnoczi                 BLOCK_IO_SLICE_TIME;
3859ae29d6c6SStefan Hajnoczi     bs->slice_end += extension;
386098f90dbaSZhi Yong Wu     if (wait) {
38610775437fSStefan Hajnoczi         *wait = wait_time * NANOSECONDS_PER_SECOND;
386298f90dbaSZhi Yong Wu     }
386398f90dbaSZhi Yong Wu 
386498f90dbaSZhi Yong Wu     return true;
386598f90dbaSZhi Yong Wu }
386698f90dbaSZhi Yong Wu 
386798f90dbaSZhi Yong Wu static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
386898f90dbaSZhi Yong Wu                              double elapsed_time, uint64_t *wait)
386998f90dbaSZhi Yong Wu {
387098f90dbaSZhi Yong Wu     uint64_t iops_limit = 0;
387198f90dbaSZhi Yong Wu     double   ios_limit, ios_base;
387298f90dbaSZhi Yong Wu     double   slice_time, wait_time;
387398f90dbaSZhi Yong Wu 
387498f90dbaSZhi Yong Wu     if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
387598f90dbaSZhi Yong Wu         iops_limit = bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
387698f90dbaSZhi Yong Wu     } else if (bs->io_limits.iops[is_write]) {
387798f90dbaSZhi Yong Wu         iops_limit = bs->io_limits.iops[is_write];
387898f90dbaSZhi Yong Wu     } else {
387998f90dbaSZhi Yong Wu         if (wait) {
388098f90dbaSZhi Yong Wu             *wait = 0;
388198f90dbaSZhi Yong Wu         }
388298f90dbaSZhi Yong Wu 
388398f90dbaSZhi Yong Wu         return false;
388498f90dbaSZhi Yong Wu     }
388598f90dbaSZhi Yong Wu 
388698f90dbaSZhi Yong Wu     slice_time = bs->slice_end - bs->slice_start;
388798f90dbaSZhi Yong Wu     slice_time /= (NANOSECONDS_PER_SECOND);
388898f90dbaSZhi Yong Wu     ios_limit  = iops_limit * slice_time;
38895905fbc9SStefan Hajnoczi     ios_base   = bs->slice_submitted.ios[is_write];
389098f90dbaSZhi Yong Wu     if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
38915905fbc9SStefan Hajnoczi         ios_base += bs->slice_submitted.ios[!is_write];
389298f90dbaSZhi Yong Wu     }
389398f90dbaSZhi Yong Wu 
389498f90dbaSZhi Yong Wu     if (ios_base + 1 <= ios_limit) {
389598f90dbaSZhi Yong Wu         if (wait) {
389698f90dbaSZhi Yong Wu             *wait = 0;
389798f90dbaSZhi Yong Wu         }
389898f90dbaSZhi Yong Wu 
389998f90dbaSZhi Yong Wu         return false;
390098f90dbaSZhi Yong Wu     }
390198f90dbaSZhi Yong Wu 
39020775437fSStefan Hajnoczi     /* Calc approx time to dispatch, in seconds */
390398f90dbaSZhi Yong Wu     wait_time = (ios_base + 1) / iops_limit;
390498f90dbaSZhi Yong Wu     if (wait_time > elapsed_time) {
390598f90dbaSZhi Yong Wu         wait_time = wait_time - elapsed_time;
390698f90dbaSZhi Yong Wu     } else {
390798f90dbaSZhi Yong Wu         wait_time = 0;
390898f90dbaSZhi Yong Wu     }
390998f90dbaSZhi Yong Wu 
3910ae29d6c6SStefan Hajnoczi     /* Exceeded current slice, extend it by another slice time */
3911ae29d6c6SStefan Hajnoczi     bs->slice_end += BLOCK_IO_SLICE_TIME;
391298f90dbaSZhi Yong Wu     if (wait) {
39130775437fSStefan Hajnoczi         *wait = wait_time * NANOSECONDS_PER_SECOND;
391498f90dbaSZhi Yong Wu     }
391598f90dbaSZhi Yong Wu 
391698f90dbaSZhi Yong Wu     return true;
391798f90dbaSZhi Yong Wu }
391898f90dbaSZhi Yong Wu 
391998f90dbaSZhi Yong Wu static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
392098f90dbaSZhi Yong Wu                            bool is_write, int64_t *wait)
392198f90dbaSZhi Yong Wu {
392298f90dbaSZhi Yong Wu     int64_t  now, max_wait;
392398f90dbaSZhi Yong Wu     uint64_t bps_wait = 0, iops_wait = 0;
392498f90dbaSZhi Yong Wu     double   elapsed_time;
392598f90dbaSZhi Yong Wu     int      bps_ret, iops_ret;
392698f90dbaSZhi Yong Wu 
392798f90dbaSZhi Yong Wu     now = qemu_get_clock_ns(vm_clock);
3928e660fb8bSStefan Hajnoczi     if (now > bs->slice_end) {
392998f90dbaSZhi Yong Wu         bs->slice_start = now;
3930ae29d6c6SStefan Hajnoczi         bs->slice_end   = now + BLOCK_IO_SLICE_TIME;
39315905fbc9SStefan Hajnoczi         memset(&bs->slice_submitted, 0, sizeof(bs->slice_submitted));
393298f90dbaSZhi Yong Wu     }
393398f90dbaSZhi Yong Wu 
393498f90dbaSZhi Yong Wu     elapsed_time  = now - bs->slice_start;
393598f90dbaSZhi Yong Wu     elapsed_time  /= (NANOSECONDS_PER_SECOND);
393698f90dbaSZhi Yong Wu 
393798f90dbaSZhi Yong Wu     bps_ret  = bdrv_exceed_bps_limits(bs, nb_sectors,
393898f90dbaSZhi Yong Wu                                       is_write, elapsed_time, &bps_wait);
393998f90dbaSZhi Yong Wu     iops_ret = bdrv_exceed_iops_limits(bs, is_write,
394098f90dbaSZhi Yong Wu                                       elapsed_time, &iops_wait);
394198f90dbaSZhi Yong Wu     if (bps_ret || iops_ret) {
394298f90dbaSZhi Yong Wu         max_wait = bps_wait > iops_wait ? bps_wait : iops_wait;
394398f90dbaSZhi Yong Wu         if (wait) {
394498f90dbaSZhi Yong Wu             *wait = max_wait;
394598f90dbaSZhi Yong Wu         }
394698f90dbaSZhi Yong Wu 
394798f90dbaSZhi Yong Wu         now = qemu_get_clock_ns(vm_clock);
394898f90dbaSZhi Yong Wu         if (bs->slice_end < now + max_wait) {
394998f90dbaSZhi Yong Wu             bs->slice_end = now + max_wait;
395098f90dbaSZhi Yong Wu         }
395198f90dbaSZhi Yong Wu 
395298f90dbaSZhi Yong Wu         return true;
395398f90dbaSZhi Yong Wu     }
395498f90dbaSZhi Yong Wu 
395598f90dbaSZhi Yong Wu     if (wait) {
395698f90dbaSZhi Yong Wu         *wait = 0;
395798f90dbaSZhi Yong Wu     }
395898f90dbaSZhi Yong Wu 
39595905fbc9SStefan Hajnoczi     bs->slice_submitted.bytes[is_write] += (int64_t)nb_sectors *
39605905fbc9SStefan Hajnoczi                                            BDRV_SECTOR_SIZE;
39615905fbc9SStefan Hajnoczi     bs->slice_submitted.ios[is_write]++;
39625905fbc9SStefan Hajnoczi 
396398f90dbaSZhi Yong Wu     return false;
396498f90dbaSZhi Yong Wu }
396583f64091Sbellard 
396683f64091Sbellard /**************************************************************/
396783f64091Sbellard /* async block device emulation */
396883f64091Sbellard 
3969c16b5a2cSChristoph Hellwig typedef struct BlockDriverAIOCBSync {
3970c16b5a2cSChristoph Hellwig     BlockDriverAIOCB common;
3971c16b5a2cSChristoph Hellwig     QEMUBH *bh;
3972c16b5a2cSChristoph Hellwig     int ret;
3973c16b5a2cSChristoph Hellwig     /* vector translation state */
3974c16b5a2cSChristoph Hellwig     QEMUIOVector *qiov;
3975c16b5a2cSChristoph Hellwig     uint8_t *bounce;
3976c16b5a2cSChristoph Hellwig     int is_write;
3977c16b5a2cSChristoph Hellwig } BlockDriverAIOCBSync;
3978c16b5a2cSChristoph Hellwig 
3979c16b5a2cSChristoph Hellwig static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
3980c16b5a2cSChristoph Hellwig {
3981b666d239SKevin Wolf     BlockDriverAIOCBSync *acb =
3982b666d239SKevin Wolf         container_of(blockacb, BlockDriverAIOCBSync, common);
39836a7ad299SDor Laor     qemu_bh_delete(acb->bh);
398436afc451SAvi Kivity     acb->bh = NULL;
3985c16b5a2cSChristoph Hellwig     qemu_aio_release(acb);
3986c16b5a2cSChristoph Hellwig }
3987c16b5a2cSChristoph Hellwig 
3988d7331bedSStefan Hajnoczi static const AIOCBInfo bdrv_em_aiocb_info = {
3989c16b5a2cSChristoph Hellwig     .aiocb_size         = sizeof(BlockDriverAIOCBSync),
3990c16b5a2cSChristoph Hellwig     .cancel             = bdrv_aio_cancel_em,
3991c16b5a2cSChristoph Hellwig };
3992c16b5a2cSChristoph Hellwig 
399383f64091Sbellard static void bdrv_aio_bh_cb(void *opaque)
3994beac80cdSbellard {
3995ce1a14dcSpbrook     BlockDriverAIOCBSync *acb = opaque;
3996f141eafeSaliguori 
3997f141eafeSaliguori     if (!acb->is_write)
399803396148SMichael Tokarev         qemu_iovec_from_buf(acb->qiov, 0, acb->bounce, acb->qiov->size);
3999ceb42de8Saliguori     qemu_vfree(acb->bounce);
4000ce1a14dcSpbrook     acb->common.cb(acb->common.opaque, acb->ret);
40016a7ad299SDor Laor     qemu_bh_delete(acb->bh);
400236afc451SAvi Kivity     acb->bh = NULL;
4003ce1a14dcSpbrook     qemu_aio_release(acb);
4004beac80cdSbellard }
4005beac80cdSbellard 
4006f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
4007f141eafeSaliguori                                             int64_t sector_num,
4008f141eafeSaliguori                                             QEMUIOVector *qiov,
4009f141eafeSaliguori                                             int nb_sectors,
4010f141eafeSaliguori                                             BlockDriverCompletionFunc *cb,
4011f141eafeSaliguori                                             void *opaque,
4012f141eafeSaliguori                                             int is_write)
4013f141eafeSaliguori 
4014ea2384d3Sbellard {
4015ce1a14dcSpbrook     BlockDriverAIOCBSync *acb;
401683f64091Sbellard 
4017d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_aiocb_info, bs, cb, opaque);
4018f141eafeSaliguori     acb->is_write = is_write;
4019f141eafeSaliguori     acb->qiov = qiov;
4020e268ca52Saliguori     acb->bounce = qemu_blockalign(bs, qiov->size);
4021ce1a14dcSpbrook     acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
4022f141eafeSaliguori 
4023f141eafeSaliguori     if (is_write) {
4024d5e6b161SMichael Tokarev         qemu_iovec_to_buf(acb->qiov, 0, acb->bounce, qiov->size);
40251ed20acfSStefan Hajnoczi         acb->ret = bs->drv->bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
4026f141eafeSaliguori     } else {
40271ed20acfSStefan Hajnoczi         acb->ret = bs->drv->bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
4028f141eafeSaliguori     }
4029f141eafeSaliguori 
4030ce1a14dcSpbrook     qemu_bh_schedule(acb->bh);
4031f141eafeSaliguori 
4032ce1a14dcSpbrook     return &acb->common;
40337a6cba61Spbrook }
40347a6cba61Spbrook 
4035f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
4036f141eafeSaliguori         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
4037ce1a14dcSpbrook         BlockDriverCompletionFunc *cb, void *opaque)
403883f64091Sbellard {
4039f141eafeSaliguori     return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
404083f64091Sbellard }
404183f64091Sbellard 
4042f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
4043f141eafeSaliguori         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
4044f141eafeSaliguori         BlockDriverCompletionFunc *cb, void *opaque)
4045f141eafeSaliguori {
4046f141eafeSaliguori     return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
4047f141eafeSaliguori }
4048f141eafeSaliguori 
404968485420SKevin Wolf 
405068485420SKevin Wolf typedef struct BlockDriverAIOCBCoroutine {
405168485420SKevin Wolf     BlockDriverAIOCB common;
405268485420SKevin Wolf     BlockRequest req;
405368485420SKevin Wolf     bool is_write;
4054d318aea9SKevin Wolf     bool *done;
405568485420SKevin Wolf     QEMUBH* bh;
405668485420SKevin Wolf } BlockDriverAIOCBCoroutine;
405768485420SKevin Wolf 
405868485420SKevin Wolf static void bdrv_aio_co_cancel_em(BlockDriverAIOCB *blockacb)
405968485420SKevin Wolf {
4060d318aea9SKevin Wolf     BlockDriverAIOCBCoroutine *acb =
4061d318aea9SKevin Wolf         container_of(blockacb, BlockDriverAIOCBCoroutine, common);
4062d318aea9SKevin Wolf     bool done = false;
4063d318aea9SKevin Wolf 
4064d318aea9SKevin Wolf     acb->done = &done;
4065d318aea9SKevin Wolf     while (!done) {
4066d318aea9SKevin Wolf         qemu_aio_wait();
4067d318aea9SKevin Wolf     }
406868485420SKevin Wolf }
406968485420SKevin Wolf 
4070d7331bedSStefan Hajnoczi static const AIOCBInfo bdrv_em_co_aiocb_info = {
407168485420SKevin Wolf     .aiocb_size         = sizeof(BlockDriverAIOCBCoroutine),
407268485420SKevin Wolf     .cancel             = bdrv_aio_co_cancel_em,
407368485420SKevin Wolf };
407468485420SKevin Wolf 
407535246a68SPaolo Bonzini static void bdrv_co_em_bh(void *opaque)
407668485420SKevin Wolf {
407768485420SKevin Wolf     BlockDriverAIOCBCoroutine *acb = opaque;
407868485420SKevin Wolf 
407968485420SKevin Wolf     acb->common.cb(acb->common.opaque, acb->req.error);
4080d318aea9SKevin Wolf 
4081d318aea9SKevin Wolf     if (acb->done) {
4082d318aea9SKevin Wolf         *acb->done = true;
4083d318aea9SKevin Wolf     }
4084d318aea9SKevin Wolf 
408568485420SKevin Wolf     qemu_bh_delete(acb->bh);
408668485420SKevin Wolf     qemu_aio_release(acb);
408768485420SKevin Wolf }
408868485420SKevin Wolf 
4089b2a61371SStefan Hajnoczi /* Invoke bdrv_co_do_readv/bdrv_co_do_writev */
4090b2a61371SStefan Hajnoczi static void coroutine_fn bdrv_co_do_rw(void *opaque)
4091b2a61371SStefan Hajnoczi {
4092b2a61371SStefan Hajnoczi     BlockDriverAIOCBCoroutine *acb = opaque;
4093b2a61371SStefan Hajnoczi     BlockDriverState *bs = acb->common.bs;
4094b2a61371SStefan Hajnoczi 
4095b2a61371SStefan Hajnoczi     if (!acb->is_write) {
4096b2a61371SStefan Hajnoczi         acb->req.error = bdrv_co_do_readv(bs, acb->req.sector,
4097470c0504SStefan Hajnoczi             acb->req.nb_sectors, acb->req.qiov, 0);
4098b2a61371SStefan Hajnoczi     } else {
4099b2a61371SStefan Hajnoczi         acb->req.error = bdrv_co_do_writev(bs, acb->req.sector,
4100f08f2ddaSStefan Hajnoczi             acb->req.nb_sectors, acb->req.qiov, 0);
4101b2a61371SStefan Hajnoczi     }
4102b2a61371SStefan Hajnoczi 
410335246a68SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
4104b2a61371SStefan Hajnoczi     qemu_bh_schedule(acb->bh);
4105b2a61371SStefan Hajnoczi }
4106b2a61371SStefan Hajnoczi 
410768485420SKevin Wolf static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
410868485420SKevin Wolf                                                int64_t sector_num,
410968485420SKevin Wolf                                                QEMUIOVector *qiov,
411068485420SKevin Wolf                                                int nb_sectors,
411168485420SKevin Wolf                                                BlockDriverCompletionFunc *cb,
411268485420SKevin Wolf                                                void *opaque,
41138c5873d6SStefan Hajnoczi                                                bool is_write)
411468485420SKevin Wolf {
411568485420SKevin Wolf     Coroutine *co;
411668485420SKevin Wolf     BlockDriverAIOCBCoroutine *acb;
411768485420SKevin Wolf 
4118d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
411968485420SKevin Wolf     acb->req.sector = sector_num;
412068485420SKevin Wolf     acb->req.nb_sectors = nb_sectors;
412168485420SKevin Wolf     acb->req.qiov = qiov;
412268485420SKevin Wolf     acb->is_write = is_write;
4123d318aea9SKevin Wolf     acb->done = NULL;
412468485420SKevin Wolf 
41258c5873d6SStefan Hajnoczi     co = qemu_coroutine_create(bdrv_co_do_rw);
412668485420SKevin Wolf     qemu_coroutine_enter(co, acb);
412768485420SKevin Wolf 
412868485420SKevin Wolf     return &acb->common;
412968485420SKevin Wolf }
413068485420SKevin Wolf 
413107f07615SPaolo Bonzini static void coroutine_fn bdrv_aio_flush_co_entry(void *opaque)
4132b2e12bc6SChristoph Hellwig {
413307f07615SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb = opaque;
413407f07615SPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
4135b2e12bc6SChristoph Hellwig 
413607f07615SPaolo Bonzini     acb->req.error = bdrv_co_flush(bs);
413707f07615SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
4138b2e12bc6SChristoph Hellwig     qemu_bh_schedule(acb->bh);
4139b2e12bc6SChristoph Hellwig }
4140b2e12bc6SChristoph Hellwig 
414107f07615SPaolo Bonzini BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
4142016f5cf6SAlexander Graf         BlockDriverCompletionFunc *cb, void *opaque)
4143016f5cf6SAlexander Graf {
414407f07615SPaolo Bonzini     trace_bdrv_aio_flush(bs, opaque);
4145016f5cf6SAlexander Graf 
414607f07615SPaolo Bonzini     Coroutine *co;
414707f07615SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb;
4148016f5cf6SAlexander Graf 
4149d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
4150d318aea9SKevin Wolf     acb->done = NULL;
4151d318aea9SKevin Wolf 
415207f07615SPaolo Bonzini     co = qemu_coroutine_create(bdrv_aio_flush_co_entry);
415307f07615SPaolo Bonzini     qemu_coroutine_enter(co, acb);
4154016f5cf6SAlexander Graf 
4155016f5cf6SAlexander Graf     return &acb->common;
4156016f5cf6SAlexander Graf }
4157016f5cf6SAlexander Graf 
41584265d620SPaolo Bonzini static void coroutine_fn bdrv_aio_discard_co_entry(void *opaque)
41594265d620SPaolo Bonzini {
41604265d620SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb = opaque;
41614265d620SPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
41624265d620SPaolo Bonzini 
41634265d620SPaolo Bonzini     acb->req.error = bdrv_co_discard(bs, acb->req.sector, acb->req.nb_sectors);
41644265d620SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
41654265d620SPaolo Bonzini     qemu_bh_schedule(acb->bh);
41664265d620SPaolo Bonzini }
41674265d620SPaolo Bonzini 
41684265d620SPaolo Bonzini BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
41694265d620SPaolo Bonzini         int64_t sector_num, int nb_sectors,
41704265d620SPaolo Bonzini         BlockDriverCompletionFunc *cb, void *opaque)
41714265d620SPaolo Bonzini {
41724265d620SPaolo Bonzini     Coroutine *co;
41734265d620SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb;
41744265d620SPaolo Bonzini 
41754265d620SPaolo Bonzini     trace_bdrv_aio_discard(bs, sector_num, nb_sectors, opaque);
41764265d620SPaolo Bonzini 
4177d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
41784265d620SPaolo Bonzini     acb->req.sector = sector_num;
41794265d620SPaolo Bonzini     acb->req.nb_sectors = nb_sectors;
4180d318aea9SKevin Wolf     acb->done = NULL;
41814265d620SPaolo Bonzini     co = qemu_coroutine_create(bdrv_aio_discard_co_entry);
41824265d620SPaolo Bonzini     qemu_coroutine_enter(co, acb);
41834265d620SPaolo Bonzini 
41844265d620SPaolo Bonzini     return &acb->common;
41854265d620SPaolo Bonzini }
41864265d620SPaolo Bonzini 
4187ea2384d3Sbellard void bdrv_init(void)
4188ea2384d3Sbellard {
41895efa9d5aSAnthony Liguori     module_call_init(MODULE_INIT_BLOCK);
4190ea2384d3Sbellard }
4191ce1a14dcSpbrook 
4192eb852011SMarkus Armbruster void bdrv_init_with_whitelist(void)
4193eb852011SMarkus Armbruster {
4194eb852011SMarkus Armbruster     use_bdrv_whitelist = 1;
4195eb852011SMarkus Armbruster     bdrv_init();
4196eb852011SMarkus Armbruster }
4197eb852011SMarkus Armbruster 
4198d7331bedSStefan Hajnoczi void *qemu_aio_get(const AIOCBInfo *aiocb_info, BlockDriverState *bs,
41996bbff9a0Saliguori                    BlockDriverCompletionFunc *cb, void *opaque)
42006bbff9a0Saliguori {
4201ce1a14dcSpbrook     BlockDriverAIOCB *acb;
4202ce1a14dcSpbrook 
4203d7331bedSStefan Hajnoczi     acb = g_slice_alloc(aiocb_info->aiocb_size);
4204d7331bedSStefan Hajnoczi     acb->aiocb_info = aiocb_info;
4205ce1a14dcSpbrook     acb->bs = bs;
4206ce1a14dcSpbrook     acb->cb = cb;
4207ce1a14dcSpbrook     acb->opaque = opaque;
4208ce1a14dcSpbrook     return acb;
4209ce1a14dcSpbrook }
4210ce1a14dcSpbrook 
4211ce1a14dcSpbrook void qemu_aio_release(void *p)
4212ce1a14dcSpbrook {
4213d37c975fSStefan Hajnoczi     BlockDriverAIOCB *acb = p;
4214d7331bedSStefan Hajnoczi     g_slice_free1(acb->aiocb_info->aiocb_size, acb);
4215ce1a14dcSpbrook }
421619cb3738Sbellard 
421719cb3738Sbellard /**************************************************************/
4218f9f05dc5SKevin Wolf /* Coroutine block device emulation */
4219f9f05dc5SKevin Wolf 
4220f9f05dc5SKevin Wolf typedef struct CoroutineIOCompletion {
4221f9f05dc5SKevin Wolf     Coroutine *coroutine;
4222f9f05dc5SKevin Wolf     int ret;
4223f9f05dc5SKevin Wolf } CoroutineIOCompletion;
4224f9f05dc5SKevin Wolf 
4225f9f05dc5SKevin Wolf static void bdrv_co_io_em_complete(void *opaque, int ret)
4226f9f05dc5SKevin Wolf {
4227f9f05dc5SKevin Wolf     CoroutineIOCompletion *co = opaque;
4228f9f05dc5SKevin Wolf 
4229f9f05dc5SKevin Wolf     co->ret = ret;
4230f9f05dc5SKevin Wolf     qemu_coroutine_enter(co->coroutine, NULL);
4231f9f05dc5SKevin Wolf }
4232f9f05dc5SKevin Wolf 
4233f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_io_em(BlockDriverState *bs, int64_t sector_num,
4234f9f05dc5SKevin Wolf                                       int nb_sectors, QEMUIOVector *iov,
4235f9f05dc5SKevin Wolf                                       bool is_write)
4236f9f05dc5SKevin Wolf {
4237f9f05dc5SKevin Wolf     CoroutineIOCompletion co = {
4238f9f05dc5SKevin Wolf         .coroutine = qemu_coroutine_self(),
4239f9f05dc5SKevin Wolf     };
4240f9f05dc5SKevin Wolf     BlockDriverAIOCB *acb;
4241f9f05dc5SKevin Wolf 
4242f9f05dc5SKevin Wolf     if (is_write) {
4243a652d160SStefan Hajnoczi         acb = bs->drv->bdrv_aio_writev(bs, sector_num, iov, nb_sectors,
4244f9f05dc5SKevin Wolf                                        bdrv_co_io_em_complete, &co);
4245f9f05dc5SKevin Wolf     } else {
4246a652d160SStefan Hajnoczi         acb = bs->drv->bdrv_aio_readv(bs, sector_num, iov, nb_sectors,
4247f9f05dc5SKevin Wolf                                       bdrv_co_io_em_complete, &co);
4248f9f05dc5SKevin Wolf     }
4249f9f05dc5SKevin Wolf 
425059370aaaSStefan Hajnoczi     trace_bdrv_co_io_em(bs, sector_num, nb_sectors, is_write, acb);
4251f9f05dc5SKevin Wolf     if (!acb) {
4252f9f05dc5SKevin Wolf         return -EIO;
4253f9f05dc5SKevin Wolf     }
4254f9f05dc5SKevin Wolf     qemu_coroutine_yield();
4255f9f05dc5SKevin Wolf 
4256f9f05dc5SKevin Wolf     return co.ret;
4257f9f05dc5SKevin Wolf }
4258f9f05dc5SKevin Wolf 
4259f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
4260f9f05dc5SKevin Wolf                                          int64_t sector_num, int nb_sectors,
4261f9f05dc5SKevin Wolf                                          QEMUIOVector *iov)
4262f9f05dc5SKevin Wolf {
4263f9f05dc5SKevin Wolf     return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, false);
4264f9f05dc5SKevin Wolf }
4265f9f05dc5SKevin Wolf 
4266f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
4267f9f05dc5SKevin Wolf                                          int64_t sector_num, int nb_sectors,
4268f9f05dc5SKevin Wolf                                          QEMUIOVector *iov)
4269f9f05dc5SKevin Wolf {
4270f9f05dc5SKevin Wolf     return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, true);
4271f9f05dc5SKevin Wolf }
4272f9f05dc5SKevin Wolf 
427307f07615SPaolo Bonzini static void coroutine_fn bdrv_flush_co_entry(void *opaque)
4274e7a8a783SKevin Wolf {
427507f07615SPaolo Bonzini     RwCo *rwco = opaque;
427607f07615SPaolo Bonzini 
427707f07615SPaolo Bonzini     rwco->ret = bdrv_co_flush(rwco->bs);
427807f07615SPaolo Bonzini }
427907f07615SPaolo Bonzini 
428007f07615SPaolo Bonzini int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
428107f07615SPaolo Bonzini {
4282eb489bb1SKevin Wolf     int ret;
4283eb489bb1SKevin Wolf 
428429cdb251SPaolo Bonzini     if (!bs || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
428507f07615SPaolo Bonzini         return 0;
4286eb489bb1SKevin Wolf     }
4287eb489bb1SKevin Wolf 
4288ca716364SKevin Wolf     /* Write back cached data to the OS even with cache=unsafe */
4289eb489bb1SKevin Wolf     if (bs->drv->bdrv_co_flush_to_os) {
4290eb489bb1SKevin Wolf         ret = bs->drv->bdrv_co_flush_to_os(bs);
4291eb489bb1SKevin Wolf         if (ret < 0) {
4292eb489bb1SKevin Wolf             return ret;
4293eb489bb1SKevin Wolf         }
4294eb489bb1SKevin Wolf     }
4295eb489bb1SKevin Wolf 
4296ca716364SKevin Wolf     /* But don't actually force it to the disk with cache=unsafe */
4297ca716364SKevin Wolf     if (bs->open_flags & BDRV_O_NO_FLUSH) {
4298d4c82329SKevin Wolf         goto flush_parent;
4299ca716364SKevin Wolf     }
4300ca716364SKevin Wolf 
4301eb489bb1SKevin Wolf     if (bs->drv->bdrv_co_flush_to_disk) {
430229cdb251SPaolo Bonzini         ret = bs->drv->bdrv_co_flush_to_disk(bs);
430307f07615SPaolo Bonzini     } else if (bs->drv->bdrv_aio_flush) {
430407f07615SPaolo Bonzini         BlockDriverAIOCB *acb;
4305e7a8a783SKevin Wolf         CoroutineIOCompletion co = {
4306e7a8a783SKevin Wolf             .coroutine = qemu_coroutine_self(),
4307e7a8a783SKevin Wolf         };
4308e7a8a783SKevin Wolf 
430907f07615SPaolo Bonzini         acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co);
431007f07615SPaolo Bonzini         if (acb == NULL) {
431129cdb251SPaolo Bonzini             ret = -EIO;
431207f07615SPaolo Bonzini         } else {
4313e7a8a783SKevin Wolf             qemu_coroutine_yield();
431429cdb251SPaolo Bonzini             ret = co.ret;
4315e7a8a783SKevin Wolf         }
431607f07615SPaolo Bonzini     } else {
431707f07615SPaolo Bonzini         /*
431807f07615SPaolo Bonzini          * Some block drivers always operate in either writethrough or unsafe
431907f07615SPaolo Bonzini          * mode and don't support bdrv_flush therefore. Usually qemu doesn't
432007f07615SPaolo Bonzini          * know how the server works (because the behaviour is hardcoded or
432107f07615SPaolo Bonzini          * depends on server-side configuration), so we can't ensure that
432207f07615SPaolo Bonzini          * everything is safe on disk. Returning an error doesn't work because
432307f07615SPaolo Bonzini          * that would break guests even if the server operates in writethrough
432407f07615SPaolo Bonzini          * mode.
432507f07615SPaolo Bonzini          *
432607f07615SPaolo Bonzini          * Let's hope the user knows what he's doing.
432707f07615SPaolo Bonzini          */
432829cdb251SPaolo Bonzini         ret = 0;
432907f07615SPaolo Bonzini     }
433029cdb251SPaolo Bonzini     if (ret < 0) {
433129cdb251SPaolo Bonzini         return ret;
433229cdb251SPaolo Bonzini     }
433329cdb251SPaolo Bonzini 
433429cdb251SPaolo Bonzini     /* Now flush the underlying protocol.  It will also have BDRV_O_NO_FLUSH
433529cdb251SPaolo Bonzini      * in the case of cache=unsafe, so there are no useless flushes.
433629cdb251SPaolo Bonzini      */
4337d4c82329SKevin Wolf flush_parent:
433829cdb251SPaolo Bonzini     return bdrv_co_flush(bs->file);
433907f07615SPaolo Bonzini }
434007f07615SPaolo Bonzini 
43410f15423cSAnthony Liguori void bdrv_invalidate_cache(BlockDriverState *bs)
43420f15423cSAnthony Liguori {
43430f15423cSAnthony Liguori     if (bs->drv && bs->drv->bdrv_invalidate_cache) {
43440f15423cSAnthony Liguori         bs->drv->bdrv_invalidate_cache(bs);
43450f15423cSAnthony Liguori     }
43460f15423cSAnthony Liguori }
43470f15423cSAnthony Liguori 
43480f15423cSAnthony Liguori void bdrv_invalidate_cache_all(void)
43490f15423cSAnthony Liguori {
43500f15423cSAnthony Liguori     BlockDriverState *bs;
43510f15423cSAnthony Liguori 
43520f15423cSAnthony Liguori     QTAILQ_FOREACH(bs, &bdrv_states, list) {
43530f15423cSAnthony Liguori         bdrv_invalidate_cache(bs);
43540f15423cSAnthony Liguori     }
43550f15423cSAnthony Liguori }
43560f15423cSAnthony Liguori 
435707789269SBenoît Canet void bdrv_clear_incoming_migration_all(void)
435807789269SBenoît Canet {
435907789269SBenoît Canet     BlockDriverState *bs;
436007789269SBenoît Canet 
436107789269SBenoît Canet     QTAILQ_FOREACH(bs, &bdrv_states, list) {
436207789269SBenoît Canet         bs->open_flags = bs->open_flags & ~(BDRV_O_INCOMING);
436307789269SBenoît Canet     }
436407789269SBenoît Canet }
436507789269SBenoît Canet 
436607f07615SPaolo Bonzini int bdrv_flush(BlockDriverState *bs)
436707f07615SPaolo Bonzini {
436807f07615SPaolo Bonzini     Coroutine *co;
436907f07615SPaolo Bonzini     RwCo rwco = {
437007f07615SPaolo Bonzini         .bs = bs,
437107f07615SPaolo Bonzini         .ret = NOT_DONE,
437207f07615SPaolo Bonzini     };
437307f07615SPaolo Bonzini 
437407f07615SPaolo Bonzini     if (qemu_in_coroutine()) {
437507f07615SPaolo Bonzini         /* Fast-path if already in coroutine context */
437607f07615SPaolo Bonzini         bdrv_flush_co_entry(&rwco);
437707f07615SPaolo Bonzini     } else {
437807f07615SPaolo Bonzini         co = qemu_coroutine_create(bdrv_flush_co_entry);
437907f07615SPaolo Bonzini         qemu_coroutine_enter(co, &rwco);
438007f07615SPaolo Bonzini         while (rwco.ret == NOT_DONE) {
438107f07615SPaolo Bonzini             qemu_aio_wait();
438207f07615SPaolo Bonzini         }
438307f07615SPaolo Bonzini     }
438407f07615SPaolo Bonzini 
438507f07615SPaolo Bonzini     return rwco.ret;
438607f07615SPaolo Bonzini }
4387e7a8a783SKevin Wolf 
43884265d620SPaolo Bonzini static void coroutine_fn bdrv_discard_co_entry(void *opaque)
43894265d620SPaolo Bonzini {
43904265d620SPaolo Bonzini     RwCo *rwco = opaque;
43914265d620SPaolo Bonzini 
43924265d620SPaolo Bonzini     rwco->ret = bdrv_co_discard(rwco->bs, rwco->sector_num, rwco->nb_sectors);
43934265d620SPaolo Bonzini }
43944265d620SPaolo Bonzini 
43954265d620SPaolo Bonzini int coroutine_fn bdrv_co_discard(BlockDriverState *bs, int64_t sector_num,
43964265d620SPaolo Bonzini                                  int nb_sectors)
43974265d620SPaolo Bonzini {
43984265d620SPaolo Bonzini     if (!bs->drv) {
43994265d620SPaolo Bonzini         return -ENOMEDIUM;
44004265d620SPaolo Bonzini     } else if (bdrv_check_request(bs, sector_num, nb_sectors)) {
44014265d620SPaolo Bonzini         return -EIO;
44024265d620SPaolo Bonzini     } else if (bs->read_only) {
44034265d620SPaolo Bonzini         return -EROFS;
4404df702c9bSPaolo Bonzini     }
4405df702c9bSPaolo Bonzini 
4406df702c9bSPaolo Bonzini     if (bs->dirty_bitmap) {
44078f0720ecSPaolo Bonzini         bdrv_reset_dirty(bs, sector_num, nb_sectors);
4408df702c9bSPaolo Bonzini     }
4409df702c9bSPaolo Bonzini 
44109e8f1835SPaolo Bonzini     /* Do nothing if disabled.  */
44119e8f1835SPaolo Bonzini     if (!(bs->open_flags & BDRV_O_UNMAP)) {
44129e8f1835SPaolo Bonzini         return 0;
44139e8f1835SPaolo Bonzini     }
44149e8f1835SPaolo Bonzini 
4415df702c9bSPaolo Bonzini     if (bs->drv->bdrv_co_discard) {
44164265d620SPaolo Bonzini         return bs->drv->bdrv_co_discard(bs, sector_num, nb_sectors);
44174265d620SPaolo Bonzini     } else if (bs->drv->bdrv_aio_discard) {
44184265d620SPaolo Bonzini         BlockDriverAIOCB *acb;
44194265d620SPaolo Bonzini         CoroutineIOCompletion co = {
44204265d620SPaolo Bonzini             .coroutine = qemu_coroutine_self(),
44214265d620SPaolo Bonzini         };
44224265d620SPaolo Bonzini 
44234265d620SPaolo Bonzini         acb = bs->drv->bdrv_aio_discard(bs, sector_num, nb_sectors,
44244265d620SPaolo Bonzini                                         bdrv_co_io_em_complete, &co);
44254265d620SPaolo Bonzini         if (acb == NULL) {
44264265d620SPaolo Bonzini             return -EIO;
44274265d620SPaolo Bonzini         } else {
44284265d620SPaolo Bonzini             qemu_coroutine_yield();
44294265d620SPaolo Bonzini             return co.ret;
44304265d620SPaolo Bonzini         }
44314265d620SPaolo Bonzini     } else {
44324265d620SPaolo Bonzini         return 0;
44334265d620SPaolo Bonzini     }
44344265d620SPaolo Bonzini }
44354265d620SPaolo Bonzini 
44364265d620SPaolo Bonzini int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors)
44374265d620SPaolo Bonzini {
44384265d620SPaolo Bonzini     Coroutine *co;
44394265d620SPaolo Bonzini     RwCo rwco = {
44404265d620SPaolo Bonzini         .bs = bs,
44414265d620SPaolo Bonzini         .sector_num = sector_num,
44424265d620SPaolo Bonzini         .nb_sectors = nb_sectors,
44434265d620SPaolo Bonzini         .ret = NOT_DONE,
44444265d620SPaolo Bonzini     };
44454265d620SPaolo Bonzini 
44464265d620SPaolo Bonzini     if (qemu_in_coroutine()) {
44474265d620SPaolo Bonzini         /* Fast-path if already in coroutine context */
44484265d620SPaolo Bonzini         bdrv_discard_co_entry(&rwco);
44494265d620SPaolo Bonzini     } else {
44504265d620SPaolo Bonzini         co = qemu_coroutine_create(bdrv_discard_co_entry);
44514265d620SPaolo Bonzini         qemu_coroutine_enter(co, &rwco);
44524265d620SPaolo Bonzini         while (rwco.ret == NOT_DONE) {
44534265d620SPaolo Bonzini             qemu_aio_wait();
44544265d620SPaolo Bonzini         }
44554265d620SPaolo Bonzini     }
44564265d620SPaolo Bonzini 
44574265d620SPaolo Bonzini     return rwco.ret;
44584265d620SPaolo Bonzini }
44594265d620SPaolo Bonzini 
4460f9f05dc5SKevin Wolf /**************************************************************/
446119cb3738Sbellard /* removable device support */
446219cb3738Sbellard 
446319cb3738Sbellard /**
446419cb3738Sbellard  * Return TRUE if the media is present
446519cb3738Sbellard  */
446619cb3738Sbellard int bdrv_is_inserted(BlockDriverState *bs)
446719cb3738Sbellard {
446819cb3738Sbellard     BlockDriver *drv = bs->drv;
4469a1aff5bfSMarkus Armbruster 
447019cb3738Sbellard     if (!drv)
447119cb3738Sbellard         return 0;
447219cb3738Sbellard     if (!drv->bdrv_is_inserted)
4473a1aff5bfSMarkus Armbruster         return 1;
4474a1aff5bfSMarkus Armbruster     return drv->bdrv_is_inserted(bs);
447519cb3738Sbellard }
447619cb3738Sbellard 
447719cb3738Sbellard /**
44788e49ca46SMarkus Armbruster  * Return whether the media changed since the last call to this
44798e49ca46SMarkus Armbruster  * function, or -ENOTSUP if we don't know.  Most drivers don't know.
448019cb3738Sbellard  */
448119cb3738Sbellard int bdrv_media_changed(BlockDriverState *bs)
448219cb3738Sbellard {
448319cb3738Sbellard     BlockDriver *drv = bs->drv;
448419cb3738Sbellard 
44858e49ca46SMarkus Armbruster     if (drv && drv->bdrv_media_changed) {
44868e49ca46SMarkus Armbruster         return drv->bdrv_media_changed(bs);
44878e49ca46SMarkus Armbruster     }
44888e49ca46SMarkus Armbruster     return -ENOTSUP;
448919cb3738Sbellard }
449019cb3738Sbellard 
449119cb3738Sbellard /**
449219cb3738Sbellard  * If eject_flag is TRUE, eject the media. Otherwise, close the tray
449319cb3738Sbellard  */
4494f36f3949SLuiz Capitulino void bdrv_eject(BlockDriverState *bs, bool eject_flag)
449519cb3738Sbellard {
449619cb3738Sbellard     BlockDriver *drv = bs->drv;
449719cb3738Sbellard 
4498822e1cd1SMarkus Armbruster     if (drv && drv->bdrv_eject) {
4499822e1cd1SMarkus Armbruster         drv->bdrv_eject(bs, eject_flag);
450019cb3738Sbellard     }
45016f382ed2SLuiz Capitulino 
45026f382ed2SLuiz Capitulino     if (bs->device_name[0] != '\0') {
45036f382ed2SLuiz Capitulino         bdrv_emit_qmp_eject_event(bs, eject_flag);
45046f382ed2SLuiz Capitulino     }
450519cb3738Sbellard }
450619cb3738Sbellard 
450719cb3738Sbellard /**
450819cb3738Sbellard  * Lock or unlock the media (if it is locked, the user won't be able
450919cb3738Sbellard  * to eject it manually).
451019cb3738Sbellard  */
4511025e849aSMarkus Armbruster void bdrv_lock_medium(BlockDriverState *bs, bool locked)
451219cb3738Sbellard {
451319cb3738Sbellard     BlockDriver *drv = bs->drv;
451419cb3738Sbellard 
4515025e849aSMarkus Armbruster     trace_bdrv_lock_medium(bs, locked);
4516b8c6d095SStefan Hajnoczi 
4517025e849aSMarkus Armbruster     if (drv && drv->bdrv_lock_medium) {
4518025e849aSMarkus Armbruster         drv->bdrv_lock_medium(bs, locked);
451919cb3738Sbellard     }
452019cb3738Sbellard }
4521985a03b0Sths 
4522985a03b0Sths /* needed for generic scsi interface */
4523985a03b0Sths 
4524985a03b0Sths int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
4525985a03b0Sths {
4526985a03b0Sths     BlockDriver *drv = bs->drv;
4527985a03b0Sths 
4528985a03b0Sths     if (drv && drv->bdrv_ioctl)
4529985a03b0Sths         return drv->bdrv_ioctl(bs, req, buf);
4530985a03b0Sths     return -ENOTSUP;
4531985a03b0Sths }
45327d780669Saliguori 
4533221f715dSaliguori BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
4534221f715dSaliguori         unsigned long int req, void *buf,
45357d780669Saliguori         BlockDriverCompletionFunc *cb, void *opaque)
45367d780669Saliguori {
4537221f715dSaliguori     BlockDriver *drv = bs->drv;
45387d780669Saliguori 
4539221f715dSaliguori     if (drv && drv->bdrv_aio_ioctl)
4540221f715dSaliguori         return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
4541221f715dSaliguori     return NULL;
45427d780669Saliguori }
4543e268ca52Saliguori 
45447b6f9300SMarkus Armbruster void bdrv_set_buffer_alignment(BlockDriverState *bs, int align)
45457b6f9300SMarkus Armbruster {
45467b6f9300SMarkus Armbruster     bs->buffer_alignment = align;
45477b6f9300SMarkus Armbruster }
45487cd1e32aSlirans@il.ibm.com 
4549e268ca52Saliguori void *qemu_blockalign(BlockDriverState *bs, size_t size)
4550e268ca52Saliguori {
4551e268ca52Saliguori     return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
4552e268ca52Saliguori }
45537cd1e32aSlirans@il.ibm.com 
4554c53b1c51SStefan Hajnoczi /*
4555c53b1c51SStefan Hajnoczi  * Check if all memory in this vector is sector aligned.
4556c53b1c51SStefan Hajnoczi  */
4557c53b1c51SStefan Hajnoczi bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov)
4558c53b1c51SStefan Hajnoczi {
4559c53b1c51SStefan Hajnoczi     int i;
4560c53b1c51SStefan Hajnoczi 
4561c53b1c51SStefan Hajnoczi     for (i = 0; i < qiov->niov; i++) {
4562c53b1c51SStefan Hajnoczi         if ((uintptr_t) qiov->iov[i].iov_base % bs->buffer_alignment) {
4563c53b1c51SStefan Hajnoczi             return false;
4564c53b1c51SStefan Hajnoczi         }
4565c53b1c51SStefan Hajnoczi     }
4566c53b1c51SStefan Hajnoczi 
4567c53b1c51SStefan Hajnoczi     return true;
4568c53b1c51SStefan Hajnoczi }
4569c53b1c51SStefan Hajnoczi 
457050717e94SPaolo Bonzini void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity)
45717cd1e32aSlirans@il.ibm.com {
45727cd1e32aSlirans@il.ibm.com     int64_t bitmap_size;
4573a55eb92cSJan Kiszka 
457450717e94SPaolo Bonzini     assert((granularity & (granularity - 1)) == 0);
457550717e94SPaolo Bonzini 
457650717e94SPaolo Bonzini     if (granularity) {
457750717e94SPaolo Bonzini         granularity >>= BDRV_SECTOR_BITS;
457850717e94SPaolo Bonzini         assert(!bs->dirty_bitmap);
45798f0720ecSPaolo Bonzini         bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS);
458050717e94SPaolo Bonzini         bs->dirty_bitmap = hbitmap_alloc(bitmap_size, ffs(granularity) - 1);
45817cd1e32aSlirans@il.ibm.com     } else {
4582c6d22830SJan Kiszka         if (bs->dirty_bitmap) {
45838f0720ecSPaolo Bonzini             hbitmap_free(bs->dirty_bitmap);
4584c6d22830SJan Kiszka             bs->dirty_bitmap = NULL;
45857cd1e32aSlirans@il.ibm.com         }
45867cd1e32aSlirans@il.ibm.com     }
45877cd1e32aSlirans@il.ibm.com }
45887cd1e32aSlirans@il.ibm.com 
45897cd1e32aSlirans@il.ibm.com int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
45907cd1e32aSlirans@il.ibm.com {
45918f0720ecSPaolo Bonzini     if (bs->dirty_bitmap) {
45928f0720ecSPaolo Bonzini         return hbitmap_get(bs->dirty_bitmap, sector);
45937cd1e32aSlirans@il.ibm.com     } else {
45947cd1e32aSlirans@il.ibm.com         return 0;
45957cd1e32aSlirans@il.ibm.com     }
45967cd1e32aSlirans@il.ibm.com }
45977cd1e32aSlirans@il.ibm.com 
45988f0720ecSPaolo Bonzini void bdrv_dirty_iter_init(BlockDriverState *bs, HBitmapIter *hbi)
45991755da16SPaolo Bonzini {
46008f0720ecSPaolo Bonzini     hbitmap_iter_init(hbi, bs->dirty_bitmap, 0);
46011755da16SPaolo Bonzini }
46021755da16SPaolo Bonzini 
46031755da16SPaolo Bonzini void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector,
46041755da16SPaolo Bonzini                     int nr_sectors)
46051755da16SPaolo Bonzini {
46068f0720ecSPaolo Bonzini     hbitmap_set(bs->dirty_bitmap, cur_sector, nr_sectors);
46071755da16SPaolo Bonzini }
46081755da16SPaolo Bonzini 
46097cd1e32aSlirans@il.ibm.com void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
46107cd1e32aSlirans@il.ibm.com                       int nr_sectors)
46117cd1e32aSlirans@il.ibm.com {
46128f0720ecSPaolo Bonzini     hbitmap_reset(bs->dirty_bitmap, cur_sector, nr_sectors);
46137cd1e32aSlirans@il.ibm.com }
4614aaa0eb75SLiran Schour 
4615aaa0eb75SLiran Schour int64_t bdrv_get_dirty_count(BlockDriverState *bs)
4616aaa0eb75SLiran Schour {
46178f0720ecSPaolo Bonzini     if (bs->dirty_bitmap) {
4618acc906c6SPaolo Bonzini         return hbitmap_count(bs->dirty_bitmap);
46198f0720ecSPaolo Bonzini     } else {
46208f0720ecSPaolo Bonzini         return 0;
46218f0720ecSPaolo Bonzini     }
4622aaa0eb75SLiran Schour }
4623f88e1a42SJes Sorensen 
4624db593f25SMarcelo Tosatti void bdrv_set_in_use(BlockDriverState *bs, int in_use)
4625db593f25SMarcelo Tosatti {
4626db593f25SMarcelo Tosatti     assert(bs->in_use != in_use);
4627db593f25SMarcelo Tosatti     bs->in_use = in_use;
4628db593f25SMarcelo Tosatti }
4629db593f25SMarcelo Tosatti 
4630db593f25SMarcelo Tosatti int bdrv_in_use(BlockDriverState *bs)
4631db593f25SMarcelo Tosatti {
4632db593f25SMarcelo Tosatti     return bs->in_use;
4633db593f25SMarcelo Tosatti }
4634db593f25SMarcelo Tosatti 
463528a7282aSLuiz Capitulino void bdrv_iostatus_enable(BlockDriverState *bs)
463628a7282aSLuiz Capitulino {
4637d6bf279eSLuiz Capitulino     bs->iostatus_enabled = true;
463858e21ef5SLuiz Capitulino     bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
463928a7282aSLuiz Capitulino }
464028a7282aSLuiz Capitulino 
464128a7282aSLuiz Capitulino /* The I/O status is only enabled if the drive explicitly
464228a7282aSLuiz Capitulino  * enables it _and_ the VM is configured to stop on errors */
464328a7282aSLuiz Capitulino bool bdrv_iostatus_is_enabled(const BlockDriverState *bs)
464428a7282aSLuiz Capitulino {
4645d6bf279eSLuiz Capitulino     return (bs->iostatus_enabled &&
464692aa5c6dSPaolo Bonzini            (bs->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
464792aa5c6dSPaolo Bonzini             bs->on_write_error == BLOCKDEV_ON_ERROR_STOP   ||
464892aa5c6dSPaolo Bonzini             bs->on_read_error == BLOCKDEV_ON_ERROR_STOP));
464928a7282aSLuiz Capitulino }
465028a7282aSLuiz Capitulino 
465128a7282aSLuiz Capitulino void bdrv_iostatus_disable(BlockDriverState *bs)
465228a7282aSLuiz Capitulino {
4653d6bf279eSLuiz Capitulino     bs->iostatus_enabled = false;
465428a7282aSLuiz Capitulino }
465528a7282aSLuiz Capitulino 
465628a7282aSLuiz Capitulino void bdrv_iostatus_reset(BlockDriverState *bs)
465728a7282aSLuiz Capitulino {
465828a7282aSLuiz Capitulino     if (bdrv_iostatus_is_enabled(bs)) {
465958e21ef5SLuiz Capitulino         bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
46603bd293c3SPaolo Bonzini         if (bs->job) {
46613bd293c3SPaolo Bonzini             block_job_iostatus_reset(bs->job);
46623bd293c3SPaolo Bonzini         }
466328a7282aSLuiz Capitulino     }
466428a7282aSLuiz Capitulino }
466528a7282aSLuiz Capitulino 
466628a7282aSLuiz Capitulino void bdrv_iostatus_set_err(BlockDriverState *bs, int error)
466728a7282aSLuiz Capitulino {
46683e1caa5fSPaolo Bonzini     assert(bdrv_iostatus_is_enabled(bs));
46693e1caa5fSPaolo Bonzini     if (bs->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
467058e21ef5SLuiz Capitulino         bs->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
467158e21ef5SLuiz Capitulino                                          BLOCK_DEVICE_IO_STATUS_FAILED;
467228a7282aSLuiz Capitulino     }
467328a7282aSLuiz Capitulino }
467428a7282aSLuiz Capitulino 
4675a597e79cSChristoph Hellwig void
4676a597e79cSChristoph Hellwig bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, int64_t bytes,
4677a597e79cSChristoph Hellwig         enum BlockAcctType type)
4678a597e79cSChristoph Hellwig {
4679a597e79cSChristoph Hellwig     assert(type < BDRV_MAX_IOTYPE);
4680a597e79cSChristoph Hellwig 
4681a597e79cSChristoph Hellwig     cookie->bytes = bytes;
4682c488c7f6SChristoph Hellwig     cookie->start_time_ns = get_clock();
4683a597e79cSChristoph Hellwig     cookie->type = type;
4684a597e79cSChristoph Hellwig }
4685a597e79cSChristoph Hellwig 
4686a597e79cSChristoph Hellwig void
4687a597e79cSChristoph Hellwig bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie)
4688a597e79cSChristoph Hellwig {
4689a597e79cSChristoph Hellwig     assert(cookie->type < BDRV_MAX_IOTYPE);
4690a597e79cSChristoph Hellwig 
4691a597e79cSChristoph Hellwig     bs->nr_bytes[cookie->type] += cookie->bytes;
4692a597e79cSChristoph Hellwig     bs->nr_ops[cookie->type]++;
4693c488c7f6SChristoph Hellwig     bs->total_time_ns[cookie->type] += get_clock() - cookie->start_time_ns;
4694a597e79cSChristoph Hellwig }
4695a597e79cSChristoph Hellwig 
4696d92ada22SLuiz Capitulino void bdrv_img_create(const char *filename, const char *fmt,
4697f88e1a42SJes Sorensen                      const char *base_filename, const char *base_fmt,
4698f382d43aSMiroslav Rezanina                      char *options, uint64_t img_size, int flags,
4699f382d43aSMiroslav Rezanina                      Error **errp, bool quiet)
4700f88e1a42SJes Sorensen {
4701f88e1a42SJes Sorensen     QEMUOptionParameter *param = NULL, *create_options = NULL;
4702d220894eSKevin Wolf     QEMUOptionParameter *backing_fmt, *backing_file, *size;
4703f88e1a42SJes Sorensen     BlockDriverState *bs = NULL;
4704f88e1a42SJes Sorensen     BlockDriver *drv, *proto_drv;
470596df67d1SStefan Hajnoczi     BlockDriver *backing_drv = NULL;
4706f88e1a42SJes Sorensen     int ret = 0;
4707f88e1a42SJes Sorensen 
4708f88e1a42SJes Sorensen     /* Find driver and parse its options */
4709f88e1a42SJes Sorensen     drv = bdrv_find_format(fmt);
4710f88e1a42SJes Sorensen     if (!drv) {
471171c79813SLuiz Capitulino         error_setg(errp, "Unknown file format '%s'", fmt);
4712d92ada22SLuiz Capitulino         return;
4713f88e1a42SJes Sorensen     }
4714f88e1a42SJes Sorensen 
4715f88e1a42SJes Sorensen     proto_drv = bdrv_find_protocol(filename);
4716f88e1a42SJes Sorensen     if (!proto_drv) {
471771c79813SLuiz Capitulino         error_setg(errp, "Unknown protocol '%s'", filename);
4718d92ada22SLuiz Capitulino         return;
4719f88e1a42SJes Sorensen     }
4720f88e1a42SJes Sorensen 
4721f88e1a42SJes Sorensen     create_options = append_option_parameters(create_options,
4722f88e1a42SJes Sorensen                                               drv->create_options);
4723f88e1a42SJes Sorensen     create_options = append_option_parameters(create_options,
4724f88e1a42SJes Sorensen                                               proto_drv->create_options);
4725f88e1a42SJes Sorensen 
4726f88e1a42SJes Sorensen     /* Create parameter list with default values */
4727f88e1a42SJes Sorensen     param = parse_option_parameters("", create_options, param);
4728f88e1a42SJes Sorensen 
4729f88e1a42SJes Sorensen     set_option_parameter_int(param, BLOCK_OPT_SIZE, img_size);
4730f88e1a42SJes Sorensen 
4731f88e1a42SJes Sorensen     /* Parse -o options */
4732f88e1a42SJes Sorensen     if (options) {
4733f88e1a42SJes Sorensen         param = parse_option_parameters(options, create_options, param);
4734f88e1a42SJes Sorensen         if (param == NULL) {
473571c79813SLuiz Capitulino             error_setg(errp, "Invalid options for file format '%s'.", fmt);
4736f88e1a42SJes Sorensen             goto out;
4737f88e1a42SJes Sorensen         }
4738f88e1a42SJes Sorensen     }
4739f88e1a42SJes Sorensen 
4740f88e1a42SJes Sorensen     if (base_filename) {
4741f88e1a42SJes Sorensen         if (set_option_parameter(param, BLOCK_OPT_BACKING_FILE,
4742f88e1a42SJes Sorensen                                  base_filename)) {
474371c79813SLuiz Capitulino             error_setg(errp, "Backing file not supported for file format '%s'",
474471c79813SLuiz Capitulino                        fmt);
4745f88e1a42SJes Sorensen             goto out;
4746f88e1a42SJes Sorensen         }
4747f88e1a42SJes Sorensen     }
4748f88e1a42SJes Sorensen 
4749f88e1a42SJes Sorensen     if (base_fmt) {
4750f88e1a42SJes Sorensen         if (set_option_parameter(param, BLOCK_OPT_BACKING_FMT, base_fmt)) {
475171c79813SLuiz Capitulino             error_setg(errp, "Backing file format not supported for file "
475271c79813SLuiz Capitulino                              "format '%s'", fmt);
4753f88e1a42SJes Sorensen             goto out;
4754f88e1a42SJes Sorensen         }
4755f88e1a42SJes Sorensen     }
4756f88e1a42SJes Sorensen 
4757792da93aSJes Sorensen     backing_file = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
4758792da93aSJes Sorensen     if (backing_file && backing_file->value.s) {
4759792da93aSJes Sorensen         if (!strcmp(filename, backing_file->value.s)) {
476071c79813SLuiz Capitulino             error_setg(errp, "Error: Trying to create an image with the "
476171c79813SLuiz Capitulino                              "same filename as the backing file");
4762792da93aSJes Sorensen             goto out;
4763792da93aSJes Sorensen         }
4764792da93aSJes Sorensen     }
4765792da93aSJes Sorensen 
4766f88e1a42SJes Sorensen     backing_fmt = get_option_parameter(param, BLOCK_OPT_BACKING_FMT);
4767f88e1a42SJes Sorensen     if (backing_fmt && backing_fmt->value.s) {
476896df67d1SStefan Hajnoczi         backing_drv = bdrv_find_format(backing_fmt->value.s);
476996df67d1SStefan Hajnoczi         if (!backing_drv) {
477071c79813SLuiz Capitulino             error_setg(errp, "Unknown backing file format '%s'",
477171c79813SLuiz Capitulino                        backing_fmt->value.s);
4772f88e1a42SJes Sorensen             goto out;
4773f88e1a42SJes Sorensen         }
4774f88e1a42SJes Sorensen     }
4775f88e1a42SJes Sorensen 
4776f88e1a42SJes Sorensen     // The size for the image must always be specified, with one exception:
4777f88e1a42SJes Sorensen     // If we are using a backing file, we can obtain the size from there
4778d220894eSKevin Wolf     size = get_option_parameter(param, BLOCK_OPT_SIZE);
4779d220894eSKevin Wolf     if (size && size->value.n == -1) {
4780f88e1a42SJes Sorensen         if (backing_file && backing_file->value.s) {
4781f88e1a42SJes Sorensen             uint64_t size;
4782f88e1a42SJes Sorensen             char buf[32];
478363090dacSPaolo Bonzini             int back_flags;
478463090dacSPaolo Bonzini 
478563090dacSPaolo Bonzini             /* backing files always opened read-only */
478663090dacSPaolo Bonzini             back_flags =
478763090dacSPaolo Bonzini                 flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
4788f88e1a42SJes Sorensen 
4789f88e1a42SJes Sorensen             bs = bdrv_new("");
4790f88e1a42SJes Sorensen 
4791de9c0cecSKevin Wolf             ret = bdrv_open(bs, backing_file->value.s, NULL, back_flags,
4792de9c0cecSKevin Wolf                             backing_drv);
4793f88e1a42SJes Sorensen             if (ret < 0) {
479471c79813SLuiz Capitulino                 error_setg_errno(errp, -ret, "Could not open '%s'",
479571c79813SLuiz Capitulino                                  backing_file->value.s);
4796f88e1a42SJes Sorensen                 goto out;
4797f88e1a42SJes Sorensen             }
4798f88e1a42SJes Sorensen             bdrv_get_geometry(bs, &size);
4799f88e1a42SJes Sorensen             size *= 512;
4800f88e1a42SJes Sorensen 
4801f88e1a42SJes Sorensen             snprintf(buf, sizeof(buf), "%" PRId64, size);
4802f88e1a42SJes Sorensen             set_option_parameter(param, BLOCK_OPT_SIZE, buf);
4803f88e1a42SJes Sorensen         } else {
480471c79813SLuiz Capitulino             error_setg(errp, "Image creation needs a size parameter");
4805f88e1a42SJes Sorensen             goto out;
4806f88e1a42SJes Sorensen         }
4807f88e1a42SJes Sorensen     }
4808f88e1a42SJes Sorensen 
4809f382d43aSMiroslav Rezanina     if (!quiet) {
4810f88e1a42SJes Sorensen         printf("Formatting '%s', fmt=%s ", filename, fmt);
4811f88e1a42SJes Sorensen         print_option_parameters(param);
4812f88e1a42SJes Sorensen         puts("");
4813f382d43aSMiroslav Rezanina     }
4814f88e1a42SJes Sorensen     ret = bdrv_create(drv, filename, param);
4815f88e1a42SJes Sorensen     if (ret < 0) {
4816f88e1a42SJes Sorensen         if (ret == -ENOTSUP) {
481771c79813SLuiz Capitulino             error_setg(errp,"Formatting or formatting option not supported for "
481871c79813SLuiz Capitulino                             "file format '%s'", fmt);
4819f88e1a42SJes Sorensen         } else if (ret == -EFBIG) {
482071c79813SLuiz Capitulino             error_setg(errp, "The image size is too large for file format '%s'",
482171c79813SLuiz Capitulino                        fmt);
4822f88e1a42SJes Sorensen         } else {
482371c79813SLuiz Capitulino             error_setg(errp, "%s: error while creating %s: %s", filename, fmt,
482471c79813SLuiz Capitulino                        strerror(-ret));
4825f88e1a42SJes Sorensen         }
4826f88e1a42SJes Sorensen     }
4827f88e1a42SJes Sorensen 
4828f88e1a42SJes Sorensen out:
4829f88e1a42SJes Sorensen     free_option_parameters(create_options);
4830f88e1a42SJes Sorensen     free_option_parameters(param);
4831f88e1a42SJes Sorensen 
4832f88e1a42SJes Sorensen     if (bs) {
4833f88e1a42SJes Sorensen         bdrv_delete(bs);
4834f88e1a42SJes Sorensen     }
4835f88e1a42SJes Sorensen }
483685d126f3SStefan Hajnoczi 
483785d126f3SStefan Hajnoczi AioContext *bdrv_get_aio_context(BlockDriverState *bs)
483885d126f3SStefan Hajnoczi {
483985d126f3SStefan Hajnoczi     /* Currently BlockDriverState always uses the main loop AioContext */
484085d126f3SStefan Hajnoczi     return qemu_get_aio_context();
484185d126f3SStefan Hajnoczi }
4842