xref: /openbmc/qemu/block.c (revision 8d3b1a2d0b34a95800c482e1414c63f469ac4973)
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 {
721f500a6d3SKevin Wolf         assert(file != NULL);
722f500a6d3SKevin Wolf         bs->file = file;
723b6ad491aSKevin Wolf         ret = drv->bdrv_open(bs, options, open_flags);
72466f82ceeSKevin Wolf     }
72566f82ceeSKevin Wolf 
72657915332SKevin Wolf     if (ret < 0) {
72757915332SKevin Wolf         goto free_and_fail;
72857915332SKevin Wolf     }
72957915332SKevin Wolf 
73051762288SStefan Hajnoczi     ret = refresh_total_sectors(bs, bs->total_sectors);
73151762288SStefan Hajnoczi     if (ret < 0) {
73251762288SStefan Hajnoczi         goto free_and_fail;
73357915332SKevin Wolf     }
73451762288SStefan Hajnoczi 
73557915332SKevin Wolf #ifndef _WIN32
73657915332SKevin Wolf     if (bs->is_temporary) {
737c2ad1b0cSKevin Wolf         assert(filename != NULL);
73857915332SKevin Wolf         unlink(filename);
73957915332SKevin Wolf     }
74057915332SKevin Wolf #endif
74157915332SKevin Wolf     return 0;
74257915332SKevin Wolf 
74357915332SKevin Wolf free_and_fail:
74466f82ceeSKevin Wolf     bs->file = NULL;
7457267c094SAnthony Liguori     g_free(bs->opaque);
74657915332SKevin Wolf     bs->opaque = NULL;
74757915332SKevin Wolf     bs->drv = NULL;
74857915332SKevin Wolf     return ret;
74957915332SKevin Wolf }
75057915332SKevin Wolf 
75157915332SKevin Wolf /*
752b6ce07aaSKevin Wolf  * Opens a file using a protocol (file, host_device, nbd, ...)
753787e4a85SKevin Wolf  *
754787e4a85SKevin Wolf  * options is a QDict of options to pass to the block drivers, or NULL for an
755787e4a85SKevin Wolf  * empty set of options. The reference to the QDict belongs to the block layer
756787e4a85SKevin Wolf  * after the call (even on failure), so if the caller intends to reuse the
757787e4a85SKevin Wolf  * dictionary, it needs to use QINCREF() before calling bdrv_file_open.
758b6ce07aaSKevin Wolf  */
759787e4a85SKevin Wolf int bdrv_file_open(BlockDriverState **pbs, const char *filename,
760787e4a85SKevin Wolf                    QDict *options, int flags)
761b338082bSbellard {
76283f64091Sbellard     BlockDriverState *bs;
7636db95603SChristoph Hellwig     BlockDriver *drv;
764c2ad1b0cSKevin Wolf     const char *drvname;
76583f64091Sbellard     int ret;
7663b0d4f61Sbellard 
767707ff828SKevin Wolf     /* NULL means an empty set of options */
768707ff828SKevin Wolf     if (options == NULL) {
769707ff828SKevin Wolf         options = qdict_new();
7703b0d4f61Sbellard     }
771707ff828SKevin Wolf 
772707ff828SKevin Wolf     bs = bdrv_new("");
773707ff828SKevin Wolf     bs->options = options;
774707ff828SKevin Wolf     options = qdict_clone_shallow(options);
775707ff828SKevin Wolf 
776c2ad1b0cSKevin Wolf     /* Find the right block driver */
777c2ad1b0cSKevin Wolf     drvname = qdict_get_try_str(options, "driver");
778c2ad1b0cSKevin Wolf     if (drvname) {
779c2ad1b0cSKevin Wolf         drv = bdrv_find_whitelisted_format(drvname);
780c2ad1b0cSKevin Wolf         qdict_del(options, "driver");
781c2ad1b0cSKevin Wolf     } else if (filename) {
782c2ad1b0cSKevin Wolf         drv = bdrv_find_protocol(filename);
783c2ad1b0cSKevin Wolf     } else {
784c2ad1b0cSKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR,
785c2ad1b0cSKevin Wolf                       "Must specify either driver or file");
786c2ad1b0cSKevin Wolf         drv = NULL;
787c2ad1b0cSKevin Wolf     }
788c2ad1b0cSKevin Wolf 
789c2ad1b0cSKevin Wolf     if (!drv) {
790c2ad1b0cSKevin Wolf         ret = -ENOENT;
791c2ad1b0cSKevin Wolf         goto fail;
792c2ad1b0cSKevin Wolf     }
793c2ad1b0cSKevin Wolf 
794c2ad1b0cSKevin Wolf     /* Parse the filename and open it */
795c2ad1b0cSKevin Wolf     if (drv->bdrv_parse_filename && filename) {
7966963a30dSKevin Wolf         Error *local_err = NULL;
7976963a30dSKevin Wolf         drv->bdrv_parse_filename(filename, options, &local_err);
7986963a30dSKevin Wolf         if (error_is_set(&local_err)) {
7996963a30dSKevin Wolf             qerror_report_err(local_err);
8006963a30dSKevin Wolf             error_free(local_err);
8016963a30dSKevin Wolf             ret = -EINVAL;
8026963a30dSKevin Wolf             goto fail;
8036963a30dSKevin Wolf         }
804c2ad1b0cSKevin Wolf     } else if (!drv->bdrv_parse_filename && !filename) {
805c2ad1b0cSKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR,
806c2ad1b0cSKevin Wolf                       "The '%s' block driver requires a file name",
807c2ad1b0cSKevin Wolf                       drv->format_name);
808c2ad1b0cSKevin Wolf         ret = -EINVAL;
809c2ad1b0cSKevin Wolf         goto fail;
8106963a30dSKevin Wolf     }
8116963a30dSKevin Wolf 
812707ff828SKevin Wolf     ret = bdrv_open_common(bs, NULL, filename, options, flags, drv);
813707ff828SKevin Wolf     if (ret < 0) {
814707ff828SKevin Wolf         goto fail;
815707ff828SKevin Wolf     }
816707ff828SKevin Wolf 
817707ff828SKevin Wolf     /* Check if any unknown options were used */
818707ff828SKevin Wolf     if (qdict_size(options) != 0) {
819707ff828SKevin Wolf         const QDictEntry *entry = qdict_first(options);
820707ff828SKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR, "Block protocol '%s' doesn't "
821707ff828SKevin Wolf                       "support the option '%s'",
822707ff828SKevin Wolf                       drv->format_name, entry->key);
823707ff828SKevin Wolf         ret = -EINVAL;
824707ff828SKevin Wolf         goto fail;
825707ff828SKevin Wolf     }
826707ff828SKevin Wolf     QDECREF(options);
827707ff828SKevin Wolf 
82871d0770cSaliguori     bs->growable = 1;
82983f64091Sbellard     *pbs = bs;
83083f64091Sbellard     return 0;
831707ff828SKevin Wolf 
832707ff828SKevin Wolf fail:
833707ff828SKevin Wolf     QDECREF(options);
834707ff828SKevin Wolf     if (!bs->drv) {
835707ff828SKevin Wolf         QDECREF(bs->options);
836707ff828SKevin Wolf     }
837707ff828SKevin Wolf     bdrv_delete(bs);
838707ff828SKevin Wolf     return ret;
8393b0d4f61Sbellard }
8403b0d4f61Sbellard 
8419156df12SPaolo Bonzini int bdrv_open_backing_file(BlockDriverState *bs)
8429156df12SPaolo Bonzini {
8439156df12SPaolo Bonzini     char backing_filename[PATH_MAX];
8449156df12SPaolo Bonzini     int back_flags, ret;
8459156df12SPaolo Bonzini     BlockDriver *back_drv = NULL;
8469156df12SPaolo Bonzini 
8479156df12SPaolo Bonzini     if (bs->backing_hd != NULL) {
8489156df12SPaolo Bonzini         return 0;
8499156df12SPaolo Bonzini     }
8509156df12SPaolo Bonzini 
8519156df12SPaolo Bonzini     bs->open_flags &= ~BDRV_O_NO_BACKING;
8529156df12SPaolo Bonzini     if (bs->backing_file[0] == '\0') {
8539156df12SPaolo Bonzini         return 0;
8549156df12SPaolo Bonzini     }
8559156df12SPaolo Bonzini 
8569156df12SPaolo Bonzini     bs->backing_hd = bdrv_new("");
8579156df12SPaolo Bonzini     bdrv_get_full_backing_filename(bs, backing_filename,
8589156df12SPaolo Bonzini                                    sizeof(backing_filename));
8599156df12SPaolo Bonzini 
8609156df12SPaolo Bonzini     if (bs->backing_format[0] != '\0') {
8619156df12SPaolo Bonzini         back_drv = bdrv_find_format(bs->backing_format);
8629156df12SPaolo Bonzini     }
8639156df12SPaolo Bonzini 
8649156df12SPaolo Bonzini     /* backing files always opened read-only */
8659156df12SPaolo Bonzini     back_flags = bs->open_flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT);
8669156df12SPaolo Bonzini 
867de9c0cecSKevin Wolf     ret = bdrv_open(bs->backing_hd, backing_filename, NULL,
868de9c0cecSKevin Wolf                     back_flags, back_drv);
8699156df12SPaolo Bonzini     if (ret < 0) {
8709156df12SPaolo Bonzini         bdrv_delete(bs->backing_hd);
8719156df12SPaolo Bonzini         bs->backing_hd = NULL;
8729156df12SPaolo Bonzini         bs->open_flags |= BDRV_O_NO_BACKING;
8739156df12SPaolo Bonzini         return ret;
8749156df12SPaolo Bonzini     }
8759156df12SPaolo Bonzini     return 0;
8769156df12SPaolo Bonzini }
8779156df12SPaolo Bonzini 
878707ff828SKevin Wolf static void extract_subqdict(QDict *src, QDict **dst, const char *start)
879707ff828SKevin Wolf {
880707ff828SKevin Wolf     const QDictEntry *entry, *next;
881707ff828SKevin Wolf     const char *p;
882707ff828SKevin Wolf 
883707ff828SKevin Wolf     *dst = qdict_new();
884707ff828SKevin Wolf     entry = qdict_first(src);
885707ff828SKevin Wolf 
886707ff828SKevin Wolf     while (entry != NULL) {
887707ff828SKevin Wolf         next = qdict_next(src, entry);
888707ff828SKevin Wolf         if (strstart(entry->key, start, &p)) {
889707ff828SKevin Wolf             qobject_incref(entry->value);
890707ff828SKevin Wolf             qdict_put_obj(*dst, p, entry->value);
891707ff828SKevin Wolf             qdict_del(src, entry->key);
892707ff828SKevin Wolf         }
893707ff828SKevin Wolf         entry = next;
894707ff828SKevin Wolf     }
895707ff828SKevin Wolf }
896707ff828SKevin Wolf 
897b6ce07aaSKevin Wolf /*
898b6ce07aaSKevin Wolf  * Opens a disk image (raw, qcow2, vmdk, ...)
899de9c0cecSKevin Wolf  *
900de9c0cecSKevin Wolf  * options is a QDict of options to pass to the block drivers, or NULL for an
901de9c0cecSKevin Wolf  * empty set of options. The reference to the QDict belongs to the block layer
902de9c0cecSKevin Wolf  * after the call (even on failure), so if the caller intends to reuse the
903de9c0cecSKevin Wolf  * dictionary, it needs to use QINCREF() before calling bdrv_open.
904b6ce07aaSKevin Wolf  */
905de9c0cecSKevin Wolf int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options,
906de9c0cecSKevin Wolf               int flags, BlockDriver *drv)
907ea2384d3Sbellard {
908b6ce07aaSKevin Wolf     int ret;
90989c9bc3dSStefan Weil     /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */
91089c9bc3dSStefan Weil     char tmp_filename[PATH_MAX + 1];
911f500a6d3SKevin Wolf     BlockDriverState *file = NULL;
912707ff828SKevin Wolf     QDict *file_options = NULL;
91333e3963eSbellard 
914de9c0cecSKevin Wolf     /* NULL means an empty set of options */
915de9c0cecSKevin Wolf     if (options == NULL) {
916de9c0cecSKevin Wolf         options = qdict_new();
917de9c0cecSKevin Wolf     }
918de9c0cecSKevin Wolf 
919de9c0cecSKevin Wolf     bs->options = options;
920b6ad491aSKevin Wolf     options = qdict_clone_shallow(options);
921de9c0cecSKevin Wolf 
922de9c0cecSKevin Wolf     /* For snapshot=on, create a temporary qcow2 overlay */
92383f64091Sbellard     if (flags & BDRV_O_SNAPSHOT) {
924ea2384d3Sbellard         BlockDriverState *bs1;
925ea2384d3Sbellard         int64_t total_size;
92691a073a9SKevin Wolf         BlockDriver *bdrv_qcow2;
92708b392e1SKevin Wolf         QEMUOptionParameter *create_options;
928b6ce07aaSKevin Wolf         char backing_filename[PATH_MAX];
92933e3963eSbellard 
930c2ad1b0cSKevin Wolf         if (qdict_size(options) != 0) {
931c2ad1b0cSKevin Wolf             error_report("Can't use snapshot=on with driver-specific options");
932c2ad1b0cSKevin Wolf             ret = -EINVAL;
933c2ad1b0cSKevin Wolf             goto fail;
934c2ad1b0cSKevin Wolf         }
935c2ad1b0cSKevin Wolf         assert(filename != NULL);
936c2ad1b0cSKevin Wolf 
937ea2384d3Sbellard         /* if snapshot, we create a temporary backing file and open it
938ea2384d3Sbellard            instead of opening 'filename' directly */
939ea2384d3Sbellard 
940ea2384d3Sbellard         /* if there is a backing file, use it */
941ea2384d3Sbellard         bs1 = bdrv_new("");
942de9c0cecSKevin Wolf         ret = bdrv_open(bs1, filename, NULL, 0, drv);
94351d7c00cSaliguori         if (ret < 0) {
944ea2384d3Sbellard             bdrv_delete(bs1);
945de9c0cecSKevin Wolf             goto fail;
946ea2384d3Sbellard         }
9473e82990bSJes Sorensen         total_size = bdrv_getlength(bs1) & BDRV_SECTOR_MASK;
9487c96d46eSaliguori 
949ea2384d3Sbellard         bdrv_delete(bs1);
950ea2384d3Sbellard 
951eba25057SJim Meyering         ret = get_tmp_filename(tmp_filename, sizeof(tmp_filename));
952eba25057SJim Meyering         if (ret < 0) {
953de9c0cecSKevin Wolf             goto fail;
954eba25057SJim Meyering         }
9557c96d46eSaliguori 
9567c96d46eSaliguori         /* Real path is meaningless for protocols */
9574d70655bSStefan Hajnoczi         if (path_has_protocol(filename)) {
9587c96d46eSaliguori             snprintf(backing_filename, sizeof(backing_filename),
9597c96d46eSaliguori                      "%s", filename);
960de9c0cecSKevin Wolf         } else if (!realpath(filename, backing_filename)) {
961de9c0cecSKevin Wolf             ret = -errno;
962de9c0cecSKevin Wolf             goto fail;
963de9c0cecSKevin Wolf         }
9647c96d46eSaliguori 
96591a073a9SKevin Wolf         bdrv_qcow2 = bdrv_find_format("qcow2");
96608b392e1SKevin Wolf         create_options = parse_option_parameters("", bdrv_qcow2->create_options,
96708b392e1SKevin Wolf                                                  NULL);
96891a073a9SKevin Wolf 
96908b392e1SKevin Wolf         set_option_parameter_int(create_options, BLOCK_OPT_SIZE, total_size);
97008b392e1SKevin Wolf         set_option_parameter(create_options, BLOCK_OPT_BACKING_FILE,
97108b392e1SKevin Wolf                              backing_filename);
97291a073a9SKevin Wolf         if (drv) {
97308b392e1SKevin Wolf             set_option_parameter(create_options, BLOCK_OPT_BACKING_FMT,
97491a073a9SKevin Wolf                 drv->format_name);
97591a073a9SKevin Wolf         }
97691a073a9SKevin Wolf 
97708b392e1SKevin Wolf         ret = bdrv_create(bdrv_qcow2, tmp_filename, create_options);
97808b392e1SKevin Wolf         free_option_parameters(create_options);
97951d7c00cSaliguori         if (ret < 0) {
980de9c0cecSKevin Wolf             goto fail;
981ea2384d3Sbellard         }
98291a073a9SKevin Wolf 
983ea2384d3Sbellard         filename = tmp_filename;
98491a073a9SKevin Wolf         drv = bdrv_qcow2;
985ea2384d3Sbellard         bs->is_temporary = 1;
986ea2384d3Sbellard     }
987ea2384d3Sbellard 
988f500a6d3SKevin Wolf     /* Open image file without format layer */
989be028adcSJeff Cody     if (flags & BDRV_O_RDWR) {
990be028adcSJeff Cody         flags |= BDRV_O_ALLOW_RDWR;
991be028adcSJeff Cody     }
992be028adcSJeff Cody 
993707ff828SKevin Wolf     extract_subqdict(options, &file_options, "file.");
994707ff828SKevin Wolf 
995707ff828SKevin Wolf     ret = bdrv_file_open(&file, filename, file_options,
996707ff828SKevin Wolf                          bdrv_open_flags(bs, flags));
997f500a6d3SKevin Wolf     if (ret < 0) {
998de9c0cecSKevin Wolf         goto fail;
999f500a6d3SKevin Wolf     }
1000f500a6d3SKevin Wolf 
1001f500a6d3SKevin Wolf     /* Find the right image format driver */
1002f500a6d3SKevin Wolf     if (!drv) {
1003f500a6d3SKevin Wolf         ret = find_image_format(file, filename, &drv);
1004f500a6d3SKevin Wolf     }
1005f500a6d3SKevin Wolf 
1006f500a6d3SKevin Wolf     if (!drv) {
1007f500a6d3SKevin Wolf         goto unlink_and_fail;
1008f500a6d3SKevin Wolf     }
1009f500a6d3SKevin Wolf 
1010b6ce07aaSKevin Wolf     /* Open the image */
1011b6ad491aSKevin Wolf     ret = bdrv_open_common(bs, file, filename, options, flags, drv);
1012b6ce07aaSKevin Wolf     if (ret < 0) {
10136987307cSChristoph Hellwig         goto unlink_and_fail;
10146987307cSChristoph Hellwig     }
10156987307cSChristoph Hellwig 
1016f500a6d3SKevin Wolf     if (bs->file != file) {
1017f500a6d3SKevin Wolf         bdrv_delete(file);
1018f500a6d3SKevin Wolf         file = NULL;
1019f500a6d3SKevin Wolf     }
1020f500a6d3SKevin Wolf 
1021b6ce07aaSKevin Wolf     /* If there is a backing file, use it */
10229156df12SPaolo Bonzini     if ((flags & BDRV_O_NO_BACKING) == 0) {
10239156df12SPaolo Bonzini         ret = bdrv_open_backing_file(bs);
1024b6ce07aaSKevin Wolf         if (ret < 0) {
1025b6ad491aSKevin Wolf             goto close_and_fail;
1026b6ce07aaSKevin Wolf         }
1027b6ce07aaSKevin Wolf     }
1028b6ce07aaSKevin Wolf 
1029b6ad491aSKevin Wolf     /* Check if any unknown options were used */
1030b6ad491aSKevin Wolf     if (qdict_size(options) != 0) {
1031b6ad491aSKevin Wolf         const QDictEntry *entry = qdict_first(options);
1032b6ad491aSKevin Wolf         qerror_report(ERROR_CLASS_GENERIC_ERROR, "Block format '%s' used by "
1033b6ad491aSKevin Wolf             "device '%s' doesn't support the option '%s'",
1034b6ad491aSKevin Wolf             drv->format_name, bs->device_name, entry->key);
1035b6ad491aSKevin Wolf 
1036b6ad491aSKevin Wolf         ret = -EINVAL;
1037b6ad491aSKevin Wolf         goto close_and_fail;
1038b6ad491aSKevin Wolf     }
1039b6ad491aSKevin Wolf     QDECREF(options);
1040b6ad491aSKevin Wolf 
1041b6ce07aaSKevin Wolf     if (!bdrv_key_required(bs)) {
10427d4b4ba5SMarkus Armbruster         bdrv_dev_change_media_cb(bs, true);
1043b6ce07aaSKevin Wolf     }
1044b6ce07aaSKevin Wolf 
104598f90dbaSZhi Yong Wu     /* throttling disk I/O limits */
104698f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
104798f90dbaSZhi Yong Wu         bdrv_io_limits_enable(bs);
104898f90dbaSZhi Yong Wu     }
104998f90dbaSZhi Yong Wu 
1050b6ce07aaSKevin Wolf     return 0;
1051b6ce07aaSKevin Wolf 
1052b6ce07aaSKevin Wolf unlink_and_fail:
1053f500a6d3SKevin Wolf     if (file != NULL) {
1054f500a6d3SKevin Wolf         bdrv_delete(file);
1055f500a6d3SKevin Wolf     }
1056b6ce07aaSKevin Wolf     if (bs->is_temporary) {
1057b6ce07aaSKevin Wolf         unlink(filename);
1058b6ce07aaSKevin Wolf     }
1059de9c0cecSKevin Wolf fail:
1060de9c0cecSKevin Wolf     QDECREF(bs->options);
1061b6ad491aSKevin Wolf     QDECREF(options);
1062de9c0cecSKevin Wolf     bs->options = NULL;
1063b6ad491aSKevin Wolf     return ret;
1064de9c0cecSKevin Wolf 
1065b6ad491aSKevin Wolf close_and_fail:
1066b6ad491aSKevin Wolf     bdrv_close(bs);
1067b6ad491aSKevin Wolf     QDECREF(options);
1068b6ce07aaSKevin Wolf     return ret;
1069b6ce07aaSKevin Wolf }
1070b6ce07aaSKevin Wolf 
1071e971aa12SJeff Cody typedef struct BlockReopenQueueEntry {
1072e971aa12SJeff Cody      bool prepared;
1073e971aa12SJeff Cody      BDRVReopenState state;
1074e971aa12SJeff Cody      QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry;
1075e971aa12SJeff Cody } BlockReopenQueueEntry;
1076e971aa12SJeff Cody 
1077e971aa12SJeff Cody /*
1078e971aa12SJeff Cody  * Adds a BlockDriverState to a simple queue for an atomic, transactional
1079e971aa12SJeff Cody  * reopen of multiple devices.
1080e971aa12SJeff Cody  *
1081e971aa12SJeff Cody  * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT
1082e971aa12SJeff Cody  * already performed, or alternatively may be NULL a new BlockReopenQueue will
1083e971aa12SJeff Cody  * be created and initialized. This newly created BlockReopenQueue should be
1084e971aa12SJeff Cody  * passed back in for subsequent calls that are intended to be of the same
1085e971aa12SJeff Cody  * atomic 'set'.
1086e971aa12SJeff Cody  *
1087e971aa12SJeff Cody  * bs is the BlockDriverState to add to the reopen queue.
1088e971aa12SJeff Cody  *
1089e971aa12SJeff Cody  * flags contains the open flags for the associated bs
1090e971aa12SJeff Cody  *
1091e971aa12SJeff Cody  * returns a pointer to bs_queue, which is either the newly allocated
1092e971aa12SJeff Cody  * bs_queue, or the existing bs_queue being used.
1093e971aa12SJeff Cody  *
1094e971aa12SJeff Cody  */
1095e971aa12SJeff Cody BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
1096e971aa12SJeff Cody                                     BlockDriverState *bs, int flags)
1097e971aa12SJeff Cody {
1098e971aa12SJeff Cody     assert(bs != NULL);
1099e971aa12SJeff Cody 
1100e971aa12SJeff Cody     BlockReopenQueueEntry *bs_entry;
1101e971aa12SJeff Cody     if (bs_queue == NULL) {
1102e971aa12SJeff Cody         bs_queue = g_new0(BlockReopenQueue, 1);
1103e971aa12SJeff Cody         QSIMPLEQ_INIT(bs_queue);
1104e971aa12SJeff Cody     }
1105e971aa12SJeff Cody 
1106e971aa12SJeff Cody     if (bs->file) {
1107e971aa12SJeff Cody         bdrv_reopen_queue(bs_queue, bs->file, flags);
1108e971aa12SJeff Cody     }
1109e971aa12SJeff Cody 
1110e971aa12SJeff Cody     bs_entry = g_new0(BlockReopenQueueEntry, 1);
1111e971aa12SJeff Cody     QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry);
1112e971aa12SJeff Cody 
1113e971aa12SJeff Cody     bs_entry->state.bs = bs;
1114e971aa12SJeff Cody     bs_entry->state.flags = flags;
1115e971aa12SJeff Cody 
1116e971aa12SJeff Cody     return bs_queue;
1117e971aa12SJeff Cody }
1118e971aa12SJeff Cody 
1119e971aa12SJeff Cody /*
1120e971aa12SJeff Cody  * Reopen multiple BlockDriverStates atomically & transactionally.
1121e971aa12SJeff Cody  *
1122e971aa12SJeff Cody  * The queue passed in (bs_queue) must have been built up previous
1123e971aa12SJeff Cody  * via bdrv_reopen_queue().
1124e971aa12SJeff Cody  *
1125e971aa12SJeff Cody  * Reopens all BDS specified in the queue, with the appropriate
1126e971aa12SJeff Cody  * flags.  All devices are prepared for reopen, and failure of any
1127e971aa12SJeff Cody  * device will cause all device changes to be abandonded, and intermediate
1128e971aa12SJeff Cody  * data cleaned up.
1129e971aa12SJeff Cody  *
1130e971aa12SJeff Cody  * If all devices prepare successfully, then the changes are committed
1131e971aa12SJeff Cody  * to all devices.
1132e971aa12SJeff Cody  *
1133e971aa12SJeff Cody  */
1134e971aa12SJeff Cody int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp)
1135e971aa12SJeff Cody {
1136e971aa12SJeff Cody     int ret = -1;
1137e971aa12SJeff Cody     BlockReopenQueueEntry *bs_entry, *next;
1138e971aa12SJeff Cody     Error *local_err = NULL;
1139e971aa12SJeff Cody 
1140e971aa12SJeff Cody     assert(bs_queue != NULL);
1141e971aa12SJeff Cody 
1142e971aa12SJeff Cody     bdrv_drain_all();
1143e971aa12SJeff Cody 
1144e971aa12SJeff Cody     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
1145e971aa12SJeff Cody         if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) {
1146e971aa12SJeff Cody             error_propagate(errp, local_err);
1147e971aa12SJeff Cody             goto cleanup;
1148e971aa12SJeff Cody         }
1149e971aa12SJeff Cody         bs_entry->prepared = true;
1150e971aa12SJeff Cody     }
1151e971aa12SJeff Cody 
1152e971aa12SJeff Cody     /* If we reach this point, we have success and just need to apply the
1153e971aa12SJeff Cody      * changes
1154e971aa12SJeff Cody      */
1155e971aa12SJeff Cody     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
1156e971aa12SJeff Cody         bdrv_reopen_commit(&bs_entry->state);
1157e971aa12SJeff Cody     }
1158e971aa12SJeff Cody 
1159e971aa12SJeff Cody     ret = 0;
1160e971aa12SJeff Cody 
1161e971aa12SJeff Cody cleanup:
1162e971aa12SJeff Cody     QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) {
1163e971aa12SJeff Cody         if (ret && bs_entry->prepared) {
1164e971aa12SJeff Cody             bdrv_reopen_abort(&bs_entry->state);
1165e971aa12SJeff Cody         }
1166e971aa12SJeff Cody         g_free(bs_entry);
1167e971aa12SJeff Cody     }
1168e971aa12SJeff Cody     g_free(bs_queue);
1169e971aa12SJeff Cody     return ret;
1170e971aa12SJeff Cody }
1171e971aa12SJeff Cody 
1172e971aa12SJeff Cody 
1173e971aa12SJeff Cody /* Reopen a single BlockDriverState with the specified flags. */
1174e971aa12SJeff Cody int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp)
1175e971aa12SJeff Cody {
1176e971aa12SJeff Cody     int ret = -1;
1177e971aa12SJeff Cody     Error *local_err = NULL;
1178e971aa12SJeff Cody     BlockReopenQueue *queue = bdrv_reopen_queue(NULL, bs, bdrv_flags);
1179e971aa12SJeff Cody 
1180e971aa12SJeff Cody     ret = bdrv_reopen_multiple(queue, &local_err);
1181e971aa12SJeff Cody     if (local_err != NULL) {
1182e971aa12SJeff Cody         error_propagate(errp, local_err);
1183e971aa12SJeff Cody     }
1184e971aa12SJeff Cody     return ret;
1185e971aa12SJeff Cody }
1186e971aa12SJeff Cody 
1187e971aa12SJeff Cody 
1188e971aa12SJeff Cody /*
1189e971aa12SJeff Cody  * Prepares a BlockDriverState for reopen. All changes are staged in the
1190e971aa12SJeff Cody  * 'opaque' field of the BDRVReopenState, which is used and allocated by
1191e971aa12SJeff Cody  * the block driver layer .bdrv_reopen_prepare()
1192e971aa12SJeff Cody  *
1193e971aa12SJeff Cody  * bs is the BlockDriverState to reopen
1194e971aa12SJeff Cody  * flags are the new open flags
1195e971aa12SJeff Cody  * queue is the reopen queue
1196e971aa12SJeff Cody  *
1197e971aa12SJeff Cody  * Returns 0 on success, non-zero on error.  On error errp will be set
1198e971aa12SJeff Cody  * as well.
1199e971aa12SJeff Cody  *
1200e971aa12SJeff Cody  * On failure, bdrv_reopen_abort() will be called to clean up any data.
1201e971aa12SJeff Cody  * It is the responsibility of the caller to then call the abort() or
1202e971aa12SJeff Cody  * commit() for any other BDS that have been left in a prepare() state
1203e971aa12SJeff Cody  *
1204e971aa12SJeff Cody  */
1205e971aa12SJeff Cody int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue,
1206e971aa12SJeff Cody                         Error **errp)
1207e971aa12SJeff Cody {
1208e971aa12SJeff Cody     int ret = -1;
1209e971aa12SJeff Cody     Error *local_err = NULL;
1210e971aa12SJeff Cody     BlockDriver *drv;
1211e971aa12SJeff Cody 
1212e971aa12SJeff Cody     assert(reopen_state != NULL);
1213e971aa12SJeff Cody     assert(reopen_state->bs->drv != NULL);
1214e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1215e971aa12SJeff Cody 
1216e971aa12SJeff Cody     /* if we are to stay read-only, do not allow permission change
1217e971aa12SJeff Cody      * to r/w */
1218e971aa12SJeff Cody     if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) &&
1219e971aa12SJeff Cody         reopen_state->flags & BDRV_O_RDWR) {
1220e971aa12SJeff Cody         error_set(errp, QERR_DEVICE_IS_READ_ONLY,
1221e971aa12SJeff Cody                   reopen_state->bs->device_name);
1222e971aa12SJeff Cody         goto error;
1223e971aa12SJeff Cody     }
1224e971aa12SJeff Cody 
1225e971aa12SJeff Cody 
1226e971aa12SJeff Cody     ret = bdrv_flush(reopen_state->bs);
1227e971aa12SJeff Cody     if (ret) {
1228e971aa12SJeff Cody         error_set(errp, ERROR_CLASS_GENERIC_ERROR, "Error (%s) flushing drive",
1229e971aa12SJeff Cody                   strerror(-ret));
1230e971aa12SJeff Cody         goto error;
1231e971aa12SJeff Cody     }
1232e971aa12SJeff Cody 
1233e971aa12SJeff Cody     if (drv->bdrv_reopen_prepare) {
1234e971aa12SJeff Cody         ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err);
1235e971aa12SJeff Cody         if (ret) {
1236e971aa12SJeff Cody             if (local_err != NULL) {
1237e971aa12SJeff Cody                 error_propagate(errp, local_err);
1238e971aa12SJeff Cody             } else {
1239e971aa12SJeff Cody                 error_set(errp, QERR_OPEN_FILE_FAILED,
1240e971aa12SJeff Cody                           reopen_state->bs->filename);
1241e971aa12SJeff Cody             }
1242e971aa12SJeff Cody             goto error;
1243e971aa12SJeff Cody         }
1244e971aa12SJeff Cody     } else {
1245e971aa12SJeff Cody         /* It is currently mandatory to have a bdrv_reopen_prepare()
1246e971aa12SJeff Cody          * handler for each supported drv. */
1247e971aa12SJeff Cody         error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1248e971aa12SJeff Cody                   drv->format_name, reopen_state->bs->device_name,
1249e971aa12SJeff Cody                  "reopening of file");
1250e971aa12SJeff Cody         ret = -1;
1251e971aa12SJeff Cody         goto error;
1252e971aa12SJeff Cody     }
1253e971aa12SJeff Cody 
1254e971aa12SJeff Cody     ret = 0;
1255e971aa12SJeff Cody 
1256e971aa12SJeff Cody error:
1257e971aa12SJeff Cody     return ret;
1258e971aa12SJeff Cody }
1259e971aa12SJeff Cody 
1260e971aa12SJeff Cody /*
1261e971aa12SJeff Cody  * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and
1262e971aa12SJeff Cody  * makes them final by swapping the staging BlockDriverState contents into
1263e971aa12SJeff Cody  * the active BlockDriverState contents.
1264e971aa12SJeff Cody  */
1265e971aa12SJeff Cody void bdrv_reopen_commit(BDRVReopenState *reopen_state)
1266e971aa12SJeff Cody {
1267e971aa12SJeff Cody     BlockDriver *drv;
1268e971aa12SJeff Cody 
1269e971aa12SJeff Cody     assert(reopen_state != NULL);
1270e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1271e971aa12SJeff Cody     assert(drv != NULL);
1272e971aa12SJeff Cody 
1273e971aa12SJeff Cody     /* If there are any driver level actions to take */
1274e971aa12SJeff Cody     if (drv->bdrv_reopen_commit) {
1275e971aa12SJeff Cody         drv->bdrv_reopen_commit(reopen_state);
1276e971aa12SJeff Cody     }
1277e971aa12SJeff Cody 
1278e971aa12SJeff Cody     /* set BDS specific flags now */
1279e971aa12SJeff Cody     reopen_state->bs->open_flags         = reopen_state->flags;
1280e971aa12SJeff Cody     reopen_state->bs->enable_write_cache = !!(reopen_state->flags &
1281e971aa12SJeff Cody                                               BDRV_O_CACHE_WB);
1282e971aa12SJeff Cody     reopen_state->bs->read_only = !(reopen_state->flags & BDRV_O_RDWR);
1283e971aa12SJeff Cody }
1284e971aa12SJeff Cody 
1285e971aa12SJeff Cody /*
1286e971aa12SJeff Cody  * Abort the reopen, and delete and free the staged changes in
1287e971aa12SJeff Cody  * reopen_state
1288e971aa12SJeff Cody  */
1289e971aa12SJeff Cody void bdrv_reopen_abort(BDRVReopenState *reopen_state)
1290e971aa12SJeff Cody {
1291e971aa12SJeff Cody     BlockDriver *drv;
1292e971aa12SJeff Cody 
1293e971aa12SJeff Cody     assert(reopen_state != NULL);
1294e971aa12SJeff Cody     drv = reopen_state->bs->drv;
1295e971aa12SJeff Cody     assert(drv != NULL);
1296e971aa12SJeff Cody 
1297e971aa12SJeff Cody     if (drv->bdrv_reopen_abort) {
1298e971aa12SJeff Cody         drv->bdrv_reopen_abort(reopen_state);
1299e971aa12SJeff Cody     }
1300e971aa12SJeff Cody }
1301e971aa12SJeff Cody 
1302e971aa12SJeff Cody 
1303fc01f7e7Sbellard void bdrv_close(BlockDriverState *bs)
1304fc01f7e7Sbellard {
130580ccf93bSLiu Yuan     bdrv_flush(bs);
13063e914655SPaolo Bonzini     if (bs->job) {
13073e914655SPaolo Bonzini         block_job_cancel_sync(bs->job);
13083e914655SPaolo Bonzini     }
13097094f12fSKevin Wolf     bdrv_drain_all();
1310d7d512f6SPaolo Bonzini     notifier_list_notify(&bs->close_notifiers, bs);
13117094f12fSKevin Wolf 
13123cbc002cSPaolo Bonzini     if (bs->drv) {
1313f9092b10SMarkus Armbruster         if (bs == bs_snapshots) {
1314f9092b10SMarkus Armbruster             bs_snapshots = NULL;
1315f9092b10SMarkus Armbruster         }
1316557df6acSStefan Hajnoczi         if (bs->backing_hd) {
1317ea2384d3Sbellard             bdrv_delete(bs->backing_hd);
1318557df6acSStefan Hajnoczi             bs->backing_hd = NULL;
1319557df6acSStefan Hajnoczi         }
1320ea2384d3Sbellard         bs->drv->bdrv_close(bs);
13217267c094SAnthony Liguori         g_free(bs->opaque);
1322ea2384d3Sbellard #ifdef _WIN32
1323ea2384d3Sbellard         if (bs->is_temporary) {
1324ea2384d3Sbellard             unlink(bs->filename);
1325ea2384d3Sbellard         }
132667b915a5Sbellard #endif
1327ea2384d3Sbellard         bs->opaque = NULL;
1328ea2384d3Sbellard         bs->drv = NULL;
132953fec9d3SStefan Hajnoczi         bs->copy_on_read = 0;
1330a275fa42SPaolo Bonzini         bs->backing_file[0] = '\0';
1331a275fa42SPaolo Bonzini         bs->backing_format[0] = '\0';
13326405875cSPaolo Bonzini         bs->total_sectors = 0;
13336405875cSPaolo Bonzini         bs->encrypted = 0;
13346405875cSPaolo Bonzini         bs->valid_key = 0;
13356405875cSPaolo Bonzini         bs->sg = 0;
13366405875cSPaolo Bonzini         bs->growable = 0;
1337de9c0cecSKevin Wolf         QDECREF(bs->options);
1338de9c0cecSKevin Wolf         bs->options = NULL;
1339b338082bSbellard 
134066f82ceeSKevin Wolf         if (bs->file != NULL) {
13410ac9377dSPaolo Bonzini             bdrv_delete(bs->file);
13420ac9377dSPaolo Bonzini             bs->file = NULL;
134366f82ceeSKevin Wolf         }
13449ca11154SPavel Hrdina     }
134566f82ceeSKevin Wolf 
13467d4b4ba5SMarkus Armbruster     bdrv_dev_change_media_cb(bs, false);
134798f90dbaSZhi Yong Wu 
134898f90dbaSZhi Yong Wu     /*throttling disk I/O limits*/
134998f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
135098f90dbaSZhi Yong Wu         bdrv_io_limits_disable(bs);
135198f90dbaSZhi Yong Wu     }
1352b338082bSbellard }
1353b338082bSbellard 
13542bc93fedSMORITA Kazutaka void bdrv_close_all(void)
13552bc93fedSMORITA Kazutaka {
13562bc93fedSMORITA Kazutaka     BlockDriverState *bs;
13572bc93fedSMORITA Kazutaka 
13582bc93fedSMORITA Kazutaka     QTAILQ_FOREACH(bs, &bdrv_states, list) {
13592bc93fedSMORITA Kazutaka         bdrv_close(bs);
13602bc93fedSMORITA Kazutaka     }
13612bc93fedSMORITA Kazutaka }
13622bc93fedSMORITA Kazutaka 
1363922453bcSStefan Hajnoczi /*
1364922453bcSStefan Hajnoczi  * Wait for pending requests to complete across all BlockDriverStates
1365922453bcSStefan Hajnoczi  *
1366922453bcSStefan Hajnoczi  * This function does not flush data to disk, use bdrv_flush_all() for that
1367922453bcSStefan Hajnoczi  * after calling this function.
13684c355d53SZhi Yong Wu  *
13694c355d53SZhi Yong Wu  * Note that completion of an asynchronous I/O operation can trigger any
13704c355d53SZhi Yong Wu  * number of other I/O operations on other devices---for example a coroutine
13714c355d53SZhi Yong Wu  * can be arbitrarily complex and a constant flow of I/O can come until the
13724c355d53SZhi Yong Wu  * coroutine is complete.  Because of this, it is not possible to have a
13734c355d53SZhi Yong Wu  * function to drain a single device's I/O queue.
1374922453bcSStefan Hajnoczi  */
1375922453bcSStefan Hajnoczi void bdrv_drain_all(void)
1376922453bcSStefan Hajnoczi {
1377922453bcSStefan Hajnoczi     BlockDriverState *bs;
13784c355d53SZhi Yong Wu     bool busy;
1379922453bcSStefan Hajnoczi 
13804c355d53SZhi Yong Wu     do {
13814c355d53SZhi Yong Wu         busy = qemu_aio_wait();
13824c355d53SZhi Yong Wu 
13834c355d53SZhi Yong Wu         /* FIXME: We do not have timer support here, so this is effectively
13844c355d53SZhi Yong Wu          * a busy wait.
13854c355d53SZhi Yong Wu          */
13864c355d53SZhi Yong Wu         QTAILQ_FOREACH(bs, &bdrv_states, list) {
13874c355d53SZhi Yong Wu             if (!qemu_co_queue_empty(&bs->throttled_reqs)) {
13884c355d53SZhi Yong Wu                 qemu_co_queue_restart_all(&bs->throttled_reqs);
13894c355d53SZhi Yong Wu                 busy = true;
13904c355d53SZhi Yong Wu             }
13914c355d53SZhi Yong Wu         }
13924c355d53SZhi Yong Wu     } while (busy);
1393922453bcSStefan Hajnoczi 
1394922453bcSStefan Hajnoczi     /* If requests are still pending there is a bug somewhere */
1395922453bcSStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
1396922453bcSStefan Hajnoczi         assert(QLIST_EMPTY(&bs->tracked_requests));
1397922453bcSStefan Hajnoczi         assert(qemu_co_queue_empty(&bs->throttled_reqs));
1398922453bcSStefan Hajnoczi     }
1399922453bcSStefan Hajnoczi }
1400922453bcSStefan Hajnoczi 
1401d22b2f41SRyan Harper /* make a BlockDriverState anonymous by removing from bdrv_state list.
1402d22b2f41SRyan Harper    Also, NULL terminate the device_name to prevent double remove */
1403d22b2f41SRyan Harper void bdrv_make_anon(BlockDriverState *bs)
1404d22b2f41SRyan Harper {
1405d22b2f41SRyan Harper     if (bs->device_name[0] != '\0') {
1406d22b2f41SRyan Harper         QTAILQ_REMOVE(&bdrv_states, bs, list);
1407d22b2f41SRyan Harper     }
1408d22b2f41SRyan Harper     bs->device_name[0] = '\0';
1409d22b2f41SRyan Harper }
1410d22b2f41SRyan Harper 
1411e023b2e2SPaolo Bonzini static void bdrv_rebind(BlockDriverState *bs)
1412e023b2e2SPaolo Bonzini {
1413e023b2e2SPaolo Bonzini     if (bs->drv && bs->drv->bdrv_rebind) {
1414e023b2e2SPaolo Bonzini         bs->drv->bdrv_rebind(bs);
1415e023b2e2SPaolo Bonzini     }
1416e023b2e2SPaolo Bonzini }
1417e023b2e2SPaolo Bonzini 
14184ddc07caSPaolo Bonzini static void bdrv_move_feature_fields(BlockDriverState *bs_dest,
14194ddc07caSPaolo Bonzini                                      BlockDriverState *bs_src)
14204ddc07caSPaolo Bonzini {
14214ddc07caSPaolo Bonzini     /* move some fields that need to stay attached to the device */
14224ddc07caSPaolo Bonzini     bs_dest->open_flags         = bs_src->open_flags;
14234ddc07caSPaolo Bonzini 
14244ddc07caSPaolo Bonzini     /* dev info */
14254ddc07caSPaolo Bonzini     bs_dest->dev_ops            = bs_src->dev_ops;
14264ddc07caSPaolo Bonzini     bs_dest->dev_opaque         = bs_src->dev_opaque;
14274ddc07caSPaolo Bonzini     bs_dest->dev                = bs_src->dev;
14284ddc07caSPaolo Bonzini     bs_dest->buffer_alignment   = bs_src->buffer_alignment;
14294ddc07caSPaolo Bonzini     bs_dest->copy_on_read       = bs_src->copy_on_read;
14304ddc07caSPaolo Bonzini 
14314ddc07caSPaolo Bonzini     bs_dest->enable_write_cache = bs_src->enable_write_cache;
14324ddc07caSPaolo Bonzini 
14334ddc07caSPaolo Bonzini     /* i/o timing parameters */
14344ddc07caSPaolo Bonzini     bs_dest->slice_start        = bs_src->slice_start;
14354ddc07caSPaolo Bonzini     bs_dest->slice_end          = bs_src->slice_end;
14365905fbc9SStefan Hajnoczi     bs_dest->slice_submitted    = bs_src->slice_submitted;
14374ddc07caSPaolo Bonzini     bs_dest->io_limits          = bs_src->io_limits;
14384ddc07caSPaolo Bonzini     bs_dest->throttled_reqs     = bs_src->throttled_reqs;
14394ddc07caSPaolo Bonzini     bs_dest->block_timer        = bs_src->block_timer;
14404ddc07caSPaolo Bonzini     bs_dest->io_limits_enabled  = bs_src->io_limits_enabled;
14414ddc07caSPaolo Bonzini 
14424ddc07caSPaolo Bonzini     /* r/w error */
14434ddc07caSPaolo Bonzini     bs_dest->on_read_error      = bs_src->on_read_error;
14444ddc07caSPaolo Bonzini     bs_dest->on_write_error     = bs_src->on_write_error;
14454ddc07caSPaolo Bonzini 
14464ddc07caSPaolo Bonzini     /* i/o status */
14474ddc07caSPaolo Bonzini     bs_dest->iostatus_enabled   = bs_src->iostatus_enabled;
14484ddc07caSPaolo Bonzini     bs_dest->iostatus           = bs_src->iostatus;
14494ddc07caSPaolo Bonzini 
14504ddc07caSPaolo Bonzini     /* dirty bitmap */
14514ddc07caSPaolo Bonzini     bs_dest->dirty_bitmap       = bs_src->dirty_bitmap;
14524ddc07caSPaolo Bonzini 
14534ddc07caSPaolo Bonzini     /* job */
14544ddc07caSPaolo Bonzini     bs_dest->in_use             = bs_src->in_use;
14554ddc07caSPaolo Bonzini     bs_dest->job                = bs_src->job;
14564ddc07caSPaolo Bonzini 
14574ddc07caSPaolo Bonzini     /* keep the same entry in bdrv_states */
14584ddc07caSPaolo Bonzini     pstrcpy(bs_dest->device_name, sizeof(bs_dest->device_name),
14594ddc07caSPaolo Bonzini             bs_src->device_name);
14604ddc07caSPaolo Bonzini     bs_dest->list = bs_src->list;
14614ddc07caSPaolo Bonzini }
14624ddc07caSPaolo Bonzini 
14634ddc07caSPaolo Bonzini /*
14644ddc07caSPaolo Bonzini  * Swap bs contents for two image chains while they are live,
14654ddc07caSPaolo Bonzini  * while keeping required fields on the BlockDriverState that is
14664ddc07caSPaolo Bonzini  * actually attached to a device.
14674ddc07caSPaolo Bonzini  *
14684ddc07caSPaolo Bonzini  * This will modify the BlockDriverState fields, and swap contents
14694ddc07caSPaolo Bonzini  * between bs_new and bs_old. Both bs_new and bs_old are modified.
14704ddc07caSPaolo Bonzini  *
14714ddc07caSPaolo Bonzini  * bs_new is required to be anonymous.
14724ddc07caSPaolo Bonzini  *
14734ddc07caSPaolo Bonzini  * This function does not create any image files.
14744ddc07caSPaolo Bonzini  */
14754ddc07caSPaolo Bonzini void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old)
14764ddc07caSPaolo Bonzini {
14774ddc07caSPaolo Bonzini     BlockDriverState tmp;
14784ddc07caSPaolo Bonzini 
14794ddc07caSPaolo Bonzini     /* bs_new must be anonymous and shouldn't have anything fancy enabled */
14804ddc07caSPaolo Bonzini     assert(bs_new->device_name[0] == '\0');
14814ddc07caSPaolo Bonzini     assert(bs_new->dirty_bitmap == NULL);
14824ddc07caSPaolo Bonzini     assert(bs_new->job == NULL);
14834ddc07caSPaolo Bonzini     assert(bs_new->dev == NULL);
14844ddc07caSPaolo Bonzini     assert(bs_new->in_use == 0);
14854ddc07caSPaolo Bonzini     assert(bs_new->io_limits_enabled == false);
14864ddc07caSPaolo Bonzini     assert(bs_new->block_timer == NULL);
14874ddc07caSPaolo Bonzini 
14884ddc07caSPaolo Bonzini     tmp = *bs_new;
14894ddc07caSPaolo Bonzini     *bs_new = *bs_old;
14904ddc07caSPaolo Bonzini     *bs_old = tmp;
14914ddc07caSPaolo Bonzini 
14924ddc07caSPaolo Bonzini     /* there are some fields that should not be swapped, move them back */
14934ddc07caSPaolo Bonzini     bdrv_move_feature_fields(&tmp, bs_old);
14944ddc07caSPaolo Bonzini     bdrv_move_feature_fields(bs_old, bs_new);
14954ddc07caSPaolo Bonzini     bdrv_move_feature_fields(bs_new, &tmp);
14964ddc07caSPaolo Bonzini 
14974ddc07caSPaolo Bonzini     /* bs_new shouldn't be in bdrv_states even after the swap!  */
14984ddc07caSPaolo Bonzini     assert(bs_new->device_name[0] == '\0');
14994ddc07caSPaolo Bonzini 
15004ddc07caSPaolo Bonzini     /* Check a few fields that should remain attached to the device */
15014ddc07caSPaolo Bonzini     assert(bs_new->dev == NULL);
15024ddc07caSPaolo Bonzini     assert(bs_new->job == NULL);
15034ddc07caSPaolo Bonzini     assert(bs_new->in_use == 0);
15044ddc07caSPaolo Bonzini     assert(bs_new->io_limits_enabled == false);
15054ddc07caSPaolo Bonzini     assert(bs_new->block_timer == NULL);
15064ddc07caSPaolo Bonzini 
15074ddc07caSPaolo Bonzini     bdrv_rebind(bs_new);
15084ddc07caSPaolo Bonzini     bdrv_rebind(bs_old);
15094ddc07caSPaolo Bonzini }
15104ddc07caSPaolo Bonzini 
15118802d1fdSJeff Cody /*
15128802d1fdSJeff Cody  * Add new bs contents at the top of an image chain while the chain is
15138802d1fdSJeff Cody  * live, while keeping required fields on the top layer.
15148802d1fdSJeff Cody  *
15158802d1fdSJeff Cody  * This will modify the BlockDriverState fields, and swap contents
15168802d1fdSJeff Cody  * between bs_new and bs_top. Both bs_new and bs_top are modified.
15178802d1fdSJeff Cody  *
1518f6801b83SJeff Cody  * bs_new is required to be anonymous.
1519f6801b83SJeff Cody  *
15208802d1fdSJeff Cody  * This function does not create any image files.
15218802d1fdSJeff Cody  */
15228802d1fdSJeff Cody void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top)
15238802d1fdSJeff Cody {
15244ddc07caSPaolo Bonzini     bdrv_swap(bs_new, bs_top);
15258802d1fdSJeff Cody 
15268802d1fdSJeff Cody     /* The contents of 'tmp' will become bs_top, as we are
15278802d1fdSJeff Cody      * swapping bs_new and bs_top contents. */
15284ddc07caSPaolo Bonzini     bs_top->backing_hd = bs_new;
15294ddc07caSPaolo Bonzini     bs_top->open_flags &= ~BDRV_O_NO_BACKING;
15304ddc07caSPaolo Bonzini     pstrcpy(bs_top->backing_file, sizeof(bs_top->backing_file),
15314ddc07caSPaolo Bonzini             bs_new->filename);
15324ddc07caSPaolo Bonzini     pstrcpy(bs_top->backing_format, sizeof(bs_top->backing_format),
15334ddc07caSPaolo Bonzini             bs_new->drv ? bs_new->drv->format_name : "");
15348802d1fdSJeff Cody }
15358802d1fdSJeff Cody 
1536b338082bSbellard void bdrv_delete(BlockDriverState *bs)
1537b338082bSbellard {
1538fa879d62SMarkus Armbruster     assert(!bs->dev);
15393e914655SPaolo Bonzini     assert(!bs->job);
15403e914655SPaolo Bonzini     assert(!bs->in_use);
154118846deeSMarkus Armbruster 
15421b7bdbc1SStefan Hajnoczi     /* remove from list, if necessary */
1543d22b2f41SRyan Harper     bdrv_make_anon(bs);
154434c6f050Saurel32 
1545b338082bSbellard     bdrv_close(bs);
154666f82ceeSKevin Wolf 
1547f9092b10SMarkus Armbruster     assert(bs != bs_snapshots);
15487267c094SAnthony Liguori     g_free(bs);
1549fc01f7e7Sbellard }
1550fc01f7e7Sbellard 
1551fa879d62SMarkus Armbruster int bdrv_attach_dev(BlockDriverState *bs, void *dev)
1552fa879d62SMarkus Armbruster /* TODO change to DeviceState *dev when all users are qdevified */
155318846deeSMarkus Armbruster {
1554fa879d62SMarkus Armbruster     if (bs->dev) {
155518846deeSMarkus Armbruster         return -EBUSY;
155618846deeSMarkus Armbruster     }
1557fa879d62SMarkus Armbruster     bs->dev = dev;
155828a7282aSLuiz Capitulino     bdrv_iostatus_reset(bs);
155918846deeSMarkus Armbruster     return 0;
156018846deeSMarkus Armbruster }
156118846deeSMarkus Armbruster 
1562fa879d62SMarkus Armbruster /* TODO qdevified devices don't use this, remove when devices are qdevified */
1563fa879d62SMarkus Armbruster void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev)
156418846deeSMarkus Armbruster {
1565fa879d62SMarkus Armbruster     if (bdrv_attach_dev(bs, dev) < 0) {
1566fa879d62SMarkus Armbruster         abort();
1567fa879d62SMarkus Armbruster     }
1568fa879d62SMarkus Armbruster }
1569fa879d62SMarkus Armbruster 
1570fa879d62SMarkus Armbruster void bdrv_detach_dev(BlockDriverState *bs, void *dev)
1571fa879d62SMarkus Armbruster /* TODO change to DeviceState *dev when all users are qdevified */
1572fa879d62SMarkus Armbruster {
1573fa879d62SMarkus Armbruster     assert(bs->dev == dev);
1574fa879d62SMarkus Armbruster     bs->dev = NULL;
15750e49de52SMarkus Armbruster     bs->dev_ops = NULL;
15760e49de52SMarkus Armbruster     bs->dev_opaque = NULL;
157729e05f20SMarkus Armbruster     bs->buffer_alignment = 512;
157818846deeSMarkus Armbruster }
157918846deeSMarkus Armbruster 
1580fa879d62SMarkus Armbruster /* TODO change to return DeviceState * when all users are qdevified */
1581fa879d62SMarkus Armbruster void *bdrv_get_attached_dev(BlockDriverState *bs)
158218846deeSMarkus Armbruster {
1583fa879d62SMarkus Armbruster     return bs->dev;
158418846deeSMarkus Armbruster }
158518846deeSMarkus Armbruster 
15860e49de52SMarkus Armbruster void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
15870e49de52SMarkus Armbruster                       void *opaque)
15880e49de52SMarkus Armbruster {
15890e49de52SMarkus Armbruster     bs->dev_ops = ops;
15900e49de52SMarkus Armbruster     bs->dev_opaque = opaque;
15912c6942faSMarkus Armbruster     if (bdrv_dev_has_removable_media(bs) && bs == bs_snapshots) {
15922c6942faSMarkus Armbruster         bs_snapshots = NULL;
15932c6942faSMarkus Armbruster     }
15940e49de52SMarkus Armbruster }
15950e49de52SMarkus Armbruster 
159632c81a4aSPaolo Bonzini void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
159732c81a4aSPaolo Bonzini                                enum MonitorEvent ev,
15981ceee0d5SPaolo Bonzini                                BlockErrorAction action, bool is_read)
1599329c0a48SLuiz Capitulino {
1600329c0a48SLuiz Capitulino     QObject *data;
1601329c0a48SLuiz Capitulino     const char *action_str;
1602329c0a48SLuiz Capitulino 
1603329c0a48SLuiz Capitulino     switch (action) {
1604329c0a48SLuiz Capitulino     case BDRV_ACTION_REPORT:
1605329c0a48SLuiz Capitulino         action_str = "report";
1606329c0a48SLuiz Capitulino         break;
1607329c0a48SLuiz Capitulino     case BDRV_ACTION_IGNORE:
1608329c0a48SLuiz Capitulino         action_str = "ignore";
1609329c0a48SLuiz Capitulino         break;
1610329c0a48SLuiz Capitulino     case BDRV_ACTION_STOP:
1611329c0a48SLuiz Capitulino         action_str = "stop";
1612329c0a48SLuiz Capitulino         break;
1613329c0a48SLuiz Capitulino     default:
1614329c0a48SLuiz Capitulino         abort();
1615329c0a48SLuiz Capitulino     }
1616329c0a48SLuiz Capitulino 
1617329c0a48SLuiz Capitulino     data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
1618329c0a48SLuiz Capitulino                               bdrv->device_name,
1619329c0a48SLuiz Capitulino                               action_str,
1620329c0a48SLuiz Capitulino                               is_read ? "read" : "write");
162132c81a4aSPaolo Bonzini     monitor_protocol_event(ev, data);
1622329c0a48SLuiz Capitulino 
1623329c0a48SLuiz Capitulino     qobject_decref(data);
1624329c0a48SLuiz Capitulino }
1625329c0a48SLuiz Capitulino 
16266f382ed2SLuiz Capitulino static void bdrv_emit_qmp_eject_event(BlockDriverState *bs, bool ejected)
16276f382ed2SLuiz Capitulino {
16286f382ed2SLuiz Capitulino     QObject *data;
16296f382ed2SLuiz Capitulino 
16306f382ed2SLuiz Capitulino     data = qobject_from_jsonf("{ 'device': %s, 'tray-open': %i }",
16316f382ed2SLuiz Capitulino                               bdrv_get_device_name(bs), ejected);
16326f382ed2SLuiz Capitulino     monitor_protocol_event(QEVENT_DEVICE_TRAY_MOVED, data);
16336f382ed2SLuiz Capitulino 
16346f382ed2SLuiz Capitulino     qobject_decref(data);
16356f382ed2SLuiz Capitulino }
16366f382ed2SLuiz Capitulino 
16377d4b4ba5SMarkus Armbruster static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load)
16380e49de52SMarkus Armbruster {
1639145feb17SMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->change_media_cb) {
16406f382ed2SLuiz Capitulino         bool tray_was_closed = !bdrv_dev_is_tray_open(bs);
16417d4b4ba5SMarkus Armbruster         bs->dev_ops->change_media_cb(bs->dev_opaque, load);
16426f382ed2SLuiz Capitulino         if (tray_was_closed) {
16436f382ed2SLuiz Capitulino             /* tray open */
16446f382ed2SLuiz Capitulino             bdrv_emit_qmp_eject_event(bs, true);
16456f382ed2SLuiz Capitulino         }
16466f382ed2SLuiz Capitulino         if (load) {
16476f382ed2SLuiz Capitulino             /* tray close */
16486f382ed2SLuiz Capitulino             bdrv_emit_qmp_eject_event(bs, false);
16496f382ed2SLuiz Capitulino         }
1650145feb17SMarkus Armbruster     }
1651145feb17SMarkus Armbruster }
1652145feb17SMarkus Armbruster 
16532c6942faSMarkus Armbruster bool bdrv_dev_has_removable_media(BlockDriverState *bs)
16542c6942faSMarkus Armbruster {
16552c6942faSMarkus Armbruster     return !bs->dev || (bs->dev_ops && bs->dev_ops->change_media_cb);
16562c6942faSMarkus Armbruster }
16572c6942faSMarkus Armbruster 
1658025ccaa7SPaolo Bonzini void bdrv_dev_eject_request(BlockDriverState *bs, bool force)
1659025ccaa7SPaolo Bonzini {
1660025ccaa7SPaolo Bonzini     if (bs->dev_ops && bs->dev_ops->eject_request_cb) {
1661025ccaa7SPaolo Bonzini         bs->dev_ops->eject_request_cb(bs->dev_opaque, force);
1662025ccaa7SPaolo Bonzini     }
1663025ccaa7SPaolo Bonzini }
1664025ccaa7SPaolo Bonzini 
1665e4def80bSMarkus Armbruster bool bdrv_dev_is_tray_open(BlockDriverState *bs)
1666e4def80bSMarkus Armbruster {
1667e4def80bSMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->is_tray_open) {
1668e4def80bSMarkus Armbruster         return bs->dev_ops->is_tray_open(bs->dev_opaque);
1669e4def80bSMarkus Armbruster     }
1670e4def80bSMarkus Armbruster     return false;
1671e4def80bSMarkus Armbruster }
1672e4def80bSMarkus Armbruster 
1673145feb17SMarkus Armbruster static void bdrv_dev_resize_cb(BlockDriverState *bs)
1674145feb17SMarkus Armbruster {
1675145feb17SMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->resize_cb) {
1676145feb17SMarkus Armbruster         bs->dev_ops->resize_cb(bs->dev_opaque);
16770e49de52SMarkus Armbruster     }
16780e49de52SMarkus Armbruster }
16790e49de52SMarkus Armbruster 
1680f107639aSMarkus Armbruster bool bdrv_dev_is_medium_locked(BlockDriverState *bs)
1681f107639aSMarkus Armbruster {
1682f107639aSMarkus Armbruster     if (bs->dev_ops && bs->dev_ops->is_medium_locked) {
1683f107639aSMarkus Armbruster         return bs->dev_ops->is_medium_locked(bs->dev_opaque);
1684f107639aSMarkus Armbruster     }
1685f107639aSMarkus Armbruster     return false;
1686f107639aSMarkus Armbruster }
1687f107639aSMarkus Armbruster 
1688e97fc193Saliguori /*
1689e97fc193Saliguori  * Run consistency checks on an image
1690e97fc193Saliguori  *
1691e076f338SKevin Wolf  * Returns 0 if the check could be completed (it doesn't mean that the image is
1692a1c7273bSStefan Weil  * free of errors) or -errno when an internal error occurred. The results of the
1693e076f338SKevin Wolf  * check are stored in res.
1694e97fc193Saliguori  */
16954534ff54SKevin Wolf int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix)
1696e97fc193Saliguori {
1697e97fc193Saliguori     if (bs->drv->bdrv_check == NULL) {
1698e97fc193Saliguori         return -ENOTSUP;
1699e97fc193Saliguori     }
1700e97fc193Saliguori 
1701e076f338SKevin Wolf     memset(res, 0, sizeof(*res));
17024534ff54SKevin Wolf     return bs->drv->bdrv_check(bs, res, fix);
1703e97fc193Saliguori }
1704e97fc193Saliguori 
17058a426614SKevin Wolf #define COMMIT_BUF_SECTORS 2048
17068a426614SKevin Wolf 
170733e3963eSbellard /* commit COW file into the raw image */
170833e3963eSbellard int bdrv_commit(BlockDriverState *bs)
170933e3963eSbellard {
171019cb3738Sbellard     BlockDriver *drv = bs->drv;
17118a426614SKevin Wolf     int64_t sector, total_sectors;
17128a426614SKevin Wolf     int n, ro, open_flags;
17130bce597dSJeff Cody     int ret = 0;
17148a426614SKevin Wolf     uint8_t *buf;
1715c2cba3d9SJim Meyering     char filename[PATH_MAX];
171633e3963eSbellard 
171719cb3738Sbellard     if (!drv)
171819cb3738Sbellard         return -ENOMEDIUM;
171933e3963eSbellard 
17204dca4b63SNaphtali Sprei     if (!bs->backing_hd) {
17214dca4b63SNaphtali Sprei         return -ENOTSUP;
17224dca4b63SNaphtali Sprei     }
17234dca4b63SNaphtali Sprei 
17242d3735d3SStefan Hajnoczi     if (bdrv_in_use(bs) || bdrv_in_use(bs->backing_hd)) {
17252d3735d3SStefan Hajnoczi         return -EBUSY;
17262d3735d3SStefan Hajnoczi     }
17272d3735d3SStefan Hajnoczi 
17284dca4b63SNaphtali Sprei     ro = bs->backing_hd->read_only;
1729c2cba3d9SJim Meyering     /* Use pstrcpy (not strncpy): filename must be NUL-terminated. */
1730c2cba3d9SJim Meyering     pstrcpy(filename, sizeof(filename), bs->backing_hd->filename);
17314dca4b63SNaphtali Sprei     open_flags =  bs->backing_hd->open_flags;
17324dca4b63SNaphtali Sprei 
17334dca4b63SNaphtali Sprei     if (ro) {
17340bce597dSJeff Cody         if (bdrv_reopen(bs->backing_hd, open_flags | BDRV_O_RDWR, NULL)) {
17350bce597dSJeff Cody             return -EACCES;
17364dca4b63SNaphtali Sprei         }
1737ea2384d3Sbellard     }
1738ea2384d3Sbellard 
17396ea44308SJan Kiszka     total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
17407267c094SAnthony Liguori     buf = g_malloc(COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE);
17418a426614SKevin Wolf 
17428a426614SKevin Wolf     for (sector = 0; sector < total_sectors; sector += n) {
174305c4af54SStefan Hajnoczi         if (bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n)) {
17448a426614SKevin Wolf 
17458a426614SKevin Wolf             if (bdrv_read(bs, sector, buf, n) != 0) {
17464dca4b63SNaphtali Sprei                 ret = -EIO;
17474dca4b63SNaphtali Sprei                 goto ro_cleanup;
174833e3963eSbellard             }
174933e3963eSbellard 
17508a426614SKevin Wolf             if (bdrv_write(bs->backing_hd, sector, buf, n) != 0) {
17514dca4b63SNaphtali Sprei                 ret = -EIO;
17524dca4b63SNaphtali Sprei                 goto ro_cleanup;
175333e3963eSbellard             }
175433e3963eSbellard         }
175533e3963eSbellard     }
175695389c86Sbellard 
17571d44952fSChristoph Hellwig     if (drv->bdrv_make_empty) {
17581d44952fSChristoph Hellwig         ret = drv->bdrv_make_empty(bs);
17591d44952fSChristoph Hellwig         bdrv_flush(bs);
17601d44952fSChristoph Hellwig     }
176195389c86Sbellard 
17623f5075aeSChristoph Hellwig     /*
17633f5075aeSChristoph Hellwig      * Make sure all data we wrote to the backing device is actually
17643f5075aeSChristoph Hellwig      * stable on disk.
17653f5075aeSChristoph Hellwig      */
17663f5075aeSChristoph Hellwig     if (bs->backing_hd)
17673f5075aeSChristoph Hellwig         bdrv_flush(bs->backing_hd);
17684dca4b63SNaphtali Sprei 
17694dca4b63SNaphtali Sprei ro_cleanup:
17707267c094SAnthony Liguori     g_free(buf);
17714dca4b63SNaphtali Sprei 
17724dca4b63SNaphtali Sprei     if (ro) {
17730bce597dSJeff Cody         /* ignoring error return here */
17740bce597dSJeff Cody         bdrv_reopen(bs->backing_hd, open_flags & ~BDRV_O_RDWR, NULL);
17754dca4b63SNaphtali Sprei     }
17764dca4b63SNaphtali Sprei 
17771d44952fSChristoph Hellwig     return ret;
177833e3963eSbellard }
177933e3963eSbellard 
1780e8877497SStefan Hajnoczi int bdrv_commit_all(void)
17816ab4b5abSMarkus Armbruster {
17826ab4b5abSMarkus Armbruster     BlockDriverState *bs;
17836ab4b5abSMarkus Armbruster 
17846ab4b5abSMarkus Armbruster     QTAILQ_FOREACH(bs, &bdrv_states, list) {
1785272d2d8eSJeff Cody         if (bs->drv && bs->backing_hd) {
1786e8877497SStefan Hajnoczi             int ret = bdrv_commit(bs);
1787e8877497SStefan Hajnoczi             if (ret < 0) {
1788e8877497SStefan Hajnoczi                 return ret;
17896ab4b5abSMarkus Armbruster             }
17906ab4b5abSMarkus Armbruster         }
1791272d2d8eSJeff Cody     }
1792e8877497SStefan Hajnoczi     return 0;
1793e8877497SStefan Hajnoczi }
17946ab4b5abSMarkus Armbruster 
1795dbffbdcfSStefan Hajnoczi struct BdrvTrackedRequest {
1796dbffbdcfSStefan Hajnoczi     BlockDriverState *bs;
1797dbffbdcfSStefan Hajnoczi     int64_t sector_num;
1798dbffbdcfSStefan Hajnoczi     int nb_sectors;
1799dbffbdcfSStefan Hajnoczi     bool is_write;
1800dbffbdcfSStefan Hajnoczi     QLIST_ENTRY(BdrvTrackedRequest) list;
18015f8b6491SStefan Hajnoczi     Coroutine *co; /* owner, used for deadlock detection */
1802f4658285SStefan Hajnoczi     CoQueue wait_queue; /* coroutines blocked on this request */
1803dbffbdcfSStefan Hajnoczi };
1804dbffbdcfSStefan Hajnoczi 
1805dbffbdcfSStefan Hajnoczi /**
1806dbffbdcfSStefan Hajnoczi  * Remove an active request from the tracked requests list
1807dbffbdcfSStefan Hajnoczi  *
1808dbffbdcfSStefan Hajnoczi  * This function should be called when a tracked request is completing.
1809dbffbdcfSStefan Hajnoczi  */
1810dbffbdcfSStefan Hajnoczi static void tracked_request_end(BdrvTrackedRequest *req)
1811dbffbdcfSStefan Hajnoczi {
1812dbffbdcfSStefan Hajnoczi     QLIST_REMOVE(req, list);
1813f4658285SStefan Hajnoczi     qemu_co_queue_restart_all(&req->wait_queue);
1814dbffbdcfSStefan Hajnoczi }
1815dbffbdcfSStefan Hajnoczi 
1816dbffbdcfSStefan Hajnoczi /**
1817dbffbdcfSStefan Hajnoczi  * Add an active request to the tracked requests list
1818dbffbdcfSStefan Hajnoczi  */
1819dbffbdcfSStefan Hajnoczi static void tracked_request_begin(BdrvTrackedRequest *req,
1820dbffbdcfSStefan Hajnoczi                                   BlockDriverState *bs,
1821dbffbdcfSStefan Hajnoczi                                   int64_t sector_num,
1822dbffbdcfSStefan Hajnoczi                                   int nb_sectors, bool is_write)
1823dbffbdcfSStefan Hajnoczi {
1824dbffbdcfSStefan Hajnoczi     *req = (BdrvTrackedRequest){
1825dbffbdcfSStefan Hajnoczi         .bs = bs,
1826dbffbdcfSStefan Hajnoczi         .sector_num = sector_num,
1827dbffbdcfSStefan Hajnoczi         .nb_sectors = nb_sectors,
1828dbffbdcfSStefan Hajnoczi         .is_write = is_write,
18295f8b6491SStefan Hajnoczi         .co = qemu_coroutine_self(),
1830dbffbdcfSStefan Hajnoczi     };
1831dbffbdcfSStefan Hajnoczi 
1832f4658285SStefan Hajnoczi     qemu_co_queue_init(&req->wait_queue);
1833f4658285SStefan Hajnoczi 
1834dbffbdcfSStefan Hajnoczi     QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
1835dbffbdcfSStefan Hajnoczi }
1836dbffbdcfSStefan Hajnoczi 
1837d83947acSStefan Hajnoczi /**
1838d83947acSStefan Hajnoczi  * Round a region to cluster boundaries
1839d83947acSStefan Hajnoczi  */
1840343bded4SPaolo Bonzini void bdrv_round_to_clusters(BlockDriverState *bs,
1841d83947acSStefan Hajnoczi                             int64_t sector_num, int nb_sectors,
1842d83947acSStefan Hajnoczi                             int64_t *cluster_sector_num,
1843d83947acSStefan Hajnoczi                             int *cluster_nb_sectors)
1844d83947acSStefan Hajnoczi {
1845d83947acSStefan Hajnoczi     BlockDriverInfo bdi;
1846d83947acSStefan Hajnoczi 
1847d83947acSStefan Hajnoczi     if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
1848d83947acSStefan Hajnoczi         *cluster_sector_num = sector_num;
1849d83947acSStefan Hajnoczi         *cluster_nb_sectors = nb_sectors;
1850d83947acSStefan Hajnoczi     } else {
1851d83947acSStefan Hajnoczi         int64_t c = bdi.cluster_size / BDRV_SECTOR_SIZE;
1852d83947acSStefan Hajnoczi         *cluster_sector_num = QEMU_ALIGN_DOWN(sector_num, c);
1853d83947acSStefan Hajnoczi         *cluster_nb_sectors = QEMU_ALIGN_UP(sector_num - *cluster_sector_num +
1854d83947acSStefan Hajnoczi                                             nb_sectors, c);
1855d83947acSStefan Hajnoczi     }
1856d83947acSStefan Hajnoczi }
1857d83947acSStefan Hajnoczi 
1858f4658285SStefan Hajnoczi static bool tracked_request_overlaps(BdrvTrackedRequest *req,
1859f4658285SStefan Hajnoczi                                      int64_t sector_num, int nb_sectors) {
1860d83947acSStefan Hajnoczi     /*        aaaa   bbbb */
1861d83947acSStefan Hajnoczi     if (sector_num >= req->sector_num + req->nb_sectors) {
1862d83947acSStefan Hajnoczi         return false;
1863d83947acSStefan Hajnoczi     }
1864d83947acSStefan Hajnoczi     /* bbbb   aaaa        */
1865d83947acSStefan Hajnoczi     if (req->sector_num >= sector_num + nb_sectors) {
1866d83947acSStefan Hajnoczi         return false;
1867d83947acSStefan Hajnoczi     }
1868d83947acSStefan Hajnoczi     return true;
1869f4658285SStefan Hajnoczi }
1870f4658285SStefan Hajnoczi 
1871f4658285SStefan Hajnoczi static void coroutine_fn wait_for_overlapping_requests(BlockDriverState *bs,
1872f4658285SStefan Hajnoczi         int64_t sector_num, int nb_sectors)
1873f4658285SStefan Hajnoczi {
1874f4658285SStefan Hajnoczi     BdrvTrackedRequest *req;
1875d83947acSStefan Hajnoczi     int64_t cluster_sector_num;
1876d83947acSStefan Hajnoczi     int cluster_nb_sectors;
1877f4658285SStefan Hajnoczi     bool retry;
1878f4658285SStefan Hajnoczi 
1879d83947acSStefan Hajnoczi     /* If we touch the same cluster it counts as an overlap.  This guarantees
1880d83947acSStefan Hajnoczi      * that allocating writes will be serialized and not race with each other
1881d83947acSStefan Hajnoczi      * for the same cluster.  For example, in copy-on-read it ensures that the
1882d83947acSStefan Hajnoczi      * CoR read and write operations are atomic and guest writes cannot
1883d83947acSStefan Hajnoczi      * interleave between them.
1884d83947acSStefan Hajnoczi      */
1885343bded4SPaolo Bonzini     bdrv_round_to_clusters(bs, sector_num, nb_sectors,
1886d83947acSStefan Hajnoczi                            &cluster_sector_num, &cluster_nb_sectors);
1887d83947acSStefan Hajnoczi 
1888f4658285SStefan Hajnoczi     do {
1889f4658285SStefan Hajnoczi         retry = false;
1890f4658285SStefan Hajnoczi         QLIST_FOREACH(req, &bs->tracked_requests, list) {
1891d83947acSStefan Hajnoczi             if (tracked_request_overlaps(req, cluster_sector_num,
1892d83947acSStefan Hajnoczi                                          cluster_nb_sectors)) {
18935f8b6491SStefan Hajnoczi                 /* Hitting this means there was a reentrant request, for
18945f8b6491SStefan Hajnoczi                  * example, a block driver issuing nested requests.  This must
18955f8b6491SStefan Hajnoczi                  * never happen since it means deadlock.
18965f8b6491SStefan Hajnoczi                  */
18975f8b6491SStefan Hajnoczi                 assert(qemu_coroutine_self() != req->co);
18985f8b6491SStefan Hajnoczi 
1899f4658285SStefan Hajnoczi                 qemu_co_queue_wait(&req->wait_queue);
1900f4658285SStefan Hajnoczi                 retry = true;
1901f4658285SStefan Hajnoczi                 break;
1902f4658285SStefan Hajnoczi             }
1903f4658285SStefan Hajnoczi         }
1904f4658285SStefan Hajnoczi     } while (retry);
1905f4658285SStefan Hajnoczi }
1906f4658285SStefan Hajnoczi 
1907756e6736SKevin Wolf /*
1908756e6736SKevin Wolf  * Return values:
1909756e6736SKevin Wolf  * 0        - success
1910756e6736SKevin Wolf  * -EINVAL  - backing format specified, but no file
1911756e6736SKevin Wolf  * -ENOSPC  - can't update the backing file because no space is left in the
1912756e6736SKevin Wolf  *            image file header
1913756e6736SKevin Wolf  * -ENOTSUP - format driver doesn't support changing the backing file
1914756e6736SKevin Wolf  */
1915756e6736SKevin Wolf int bdrv_change_backing_file(BlockDriverState *bs,
1916756e6736SKevin Wolf     const char *backing_file, const char *backing_fmt)
1917756e6736SKevin Wolf {
1918756e6736SKevin Wolf     BlockDriver *drv = bs->drv;
1919469ef350SPaolo Bonzini     int ret;
1920756e6736SKevin Wolf 
19215f377794SPaolo Bonzini     /* Backing file format doesn't make sense without a backing file */
19225f377794SPaolo Bonzini     if (backing_fmt && !backing_file) {
19235f377794SPaolo Bonzini         return -EINVAL;
19245f377794SPaolo Bonzini     }
19255f377794SPaolo Bonzini 
1926756e6736SKevin Wolf     if (drv->bdrv_change_backing_file != NULL) {
1927469ef350SPaolo Bonzini         ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
1928756e6736SKevin Wolf     } else {
1929469ef350SPaolo Bonzini         ret = -ENOTSUP;
1930756e6736SKevin Wolf     }
1931469ef350SPaolo Bonzini 
1932469ef350SPaolo Bonzini     if (ret == 0) {
1933469ef350SPaolo Bonzini         pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1934469ef350SPaolo Bonzini         pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1935469ef350SPaolo Bonzini     }
1936469ef350SPaolo Bonzini     return ret;
1937756e6736SKevin Wolf }
1938756e6736SKevin Wolf 
19396ebdcee2SJeff Cody /*
19406ebdcee2SJeff Cody  * Finds the image layer in the chain that has 'bs' as its backing file.
19416ebdcee2SJeff Cody  *
19426ebdcee2SJeff Cody  * active is the current topmost image.
19436ebdcee2SJeff Cody  *
19446ebdcee2SJeff Cody  * Returns NULL if bs is not found in active's image chain,
19456ebdcee2SJeff Cody  * or if active == bs.
19466ebdcee2SJeff Cody  */
19476ebdcee2SJeff Cody BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
19486ebdcee2SJeff Cody                                     BlockDriverState *bs)
19496ebdcee2SJeff Cody {
19506ebdcee2SJeff Cody     BlockDriverState *overlay = NULL;
19516ebdcee2SJeff Cody     BlockDriverState *intermediate;
19526ebdcee2SJeff Cody 
19536ebdcee2SJeff Cody     assert(active != NULL);
19546ebdcee2SJeff Cody     assert(bs != NULL);
19556ebdcee2SJeff Cody 
19566ebdcee2SJeff Cody     /* if bs is the same as active, then by definition it has no overlay
19576ebdcee2SJeff Cody      */
19586ebdcee2SJeff Cody     if (active == bs) {
19596ebdcee2SJeff Cody         return NULL;
19606ebdcee2SJeff Cody     }
19616ebdcee2SJeff Cody 
19626ebdcee2SJeff Cody     intermediate = active;
19636ebdcee2SJeff Cody     while (intermediate->backing_hd) {
19646ebdcee2SJeff Cody         if (intermediate->backing_hd == bs) {
19656ebdcee2SJeff Cody             overlay = intermediate;
19666ebdcee2SJeff Cody             break;
19676ebdcee2SJeff Cody         }
19686ebdcee2SJeff Cody         intermediate = intermediate->backing_hd;
19696ebdcee2SJeff Cody     }
19706ebdcee2SJeff Cody 
19716ebdcee2SJeff Cody     return overlay;
19726ebdcee2SJeff Cody }
19736ebdcee2SJeff Cody 
19746ebdcee2SJeff Cody typedef struct BlkIntermediateStates {
19756ebdcee2SJeff Cody     BlockDriverState *bs;
19766ebdcee2SJeff Cody     QSIMPLEQ_ENTRY(BlkIntermediateStates) entry;
19776ebdcee2SJeff Cody } BlkIntermediateStates;
19786ebdcee2SJeff Cody 
19796ebdcee2SJeff Cody 
19806ebdcee2SJeff Cody /*
19816ebdcee2SJeff Cody  * Drops images above 'base' up to and including 'top', and sets the image
19826ebdcee2SJeff Cody  * above 'top' to have base as its backing file.
19836ebdcee2SJeff Cody  *
19846ebdcee2SJeff Cody  * Requires that the overlay to 'top' is opened r/w, so that the backing file
19856ebdcee2SJeff Cody  * information in 'bs' can be properly updated.
19866ebdcee2SJeff Cody  *
19876ebdcee2SJeff Cody  * E.g., this will convert the following chain:
19886ebdcee2SJeff Cody  * bottom <- base <- intermediate <- top <- active
19896ebdcee2SJeff Cody  *
19906ebdcee2SJeff Cody  * to
19916ebdcee2SJeff Cody  *
19926ebdcee2SJeff Cody  * bottom <- base <- active
19936ebdcee2SJeff Cody  *
19946ebdcee2SJeff Cody  * It is allowed for bottom==base, in which case it converts:
19956ebdcee2SJeff Cody  *
19966ebdcee2SJeff Cody  * base <- intermediate <- top <- active
19976ebdcee2SJeff Cody  *
19986ebdcee2SJeff Cody  * to
19996ebdcee2SJeff Cody  *
20006ebdcee2SJeff Cody  * base <- active
20016ebdcee2SJeff Cody  *
20026ebdcee2SJeff Cody  * Error conditions:
20036ebdcee2SJeff Cody  *  if active == top, that is considered an error
20046ebdcee2SJeff Cody  *
20056ebdcee2SJeff Cody  */
20066ebdcee2SJeff Cody int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
20076ebdcee2SJeff Cody                            BlockDriverState *base)
20086ebdcee2SJeff Cody {
20096ebdcee2SJeff Cody     BlockDriverState *intermediate;
20106ebdcee2SJeff Cody     BlockDriverState *base_bs = NULL;
20116ebdcee2SJeff Cody     BlockDriverState *new_top_bs = NULL;
20126ebdcee2SJeff Cody     BlkIntermediateStates *intermediate_state, *next;
20136ebdcee2SJeff Cody     int ret = -EIO;
20146ebdcee2SJeff Cody 
20156ebdcee2SJeff Cody     QSIMPLEQ_HEAD(states_to_delete, BlkIntermediateStates) states_to_delete;
20166ebdcee2SJeff Cody     QSIMPLEQ_INIT(&states_to_delete);
20176ebdcee2SJeff Cody 
20186ebdcee2SJeff Cody     if (!top->drv || !base->drv) {
20196ebdcee2SJeff Cody         goto exit;
20206ebdcee2SJeff Cody     }
20216ebdcee2SJeff Cody 
20226ebdcee2SJeff Cody     new_top_bs = bdrv_find_overlay(active, top);
20236ebdcee2SJeff Cody 
20246ebdcee2SJeff Cody     if (new_top_bs == NULL) {
20256ebdcee2SJeff Cody         /* we could not find the image above 'top', this is an error */
20266ebdcee2SJeff Cody         goto exit;
20276ebdcee2SJeff Cody     }
20286ebdcee2SJeff Cody 
20296ebdcee2SJeff Cody     /* special case of new_top_bs->backing_hd already pointing to base - nothing
20306ebdcee2SJeff Cody      * to do, no intermediate images */
20316ebdcee2SJeff Cody     if (new_top_bs->backing_hd == base) {
20326ebdcee2SJeff Cody         ret = 0;
20336ebdcee2SJeff Cody         goto exit;
20346ebdcee2SJeff Cody     }
20356ebdcee2SJeff Cody 
20366ebdcee2SJeff Cody     intermediate = top;
20376ebdcee2SJeff Cody 
20386ebdcee2SJeff Cody     /* now we will go down through the list, and add each BDS we find
20396ebdcee2SJeff Cody      * into our deletion queue, until we hit the 'base'
20406ebdcee2SJeff Cody      */
20416ebdcee2SJeff Cody     while (intermediate) {
20426ebdcee2SJeff Cody         intermediate_state = g_malloc0(sizeof(BlkIntermediateStates));
20436ebdcee2SJeff Cody         intermediate_state->bs = intermediate;
20446ebdcee2SJeff Cody         QSIMPLEQ_INSERT_TAIL(&states_to_delete, intermediate_state, entry);
20456ebdcee2SJeff Cody 
20466ebdcee2SJeff Cody         if (intermediate->backing_hd == base) {
20476ebdcee2SJeff Cody             base_bs = intermediate->backing_hd;
20486ebdcee2SJeff Cody             break;
20496ebdcee2SJeff Cody         }
20506ebdcee2SJeff Cody         intermediate = intermediate->backing_hd;
20516ebdcee2SJeff Cody     }
20526ebdcee2SJeff Cody     if (base_bs == NULL) {
20536ebdcee2SJeff Cody         /* something went wrong, we did not end at the base. safely
20546ebdcee2SJeff Cody          * unravel everything, and exit with error */
20556ebdcee2SJeff Cody         goto exit;
20566ebdcee2SJeff Cody     }
20576ebdcee2SJeff Cody 
20586ebdcee2SJeff Cody     /* success - we can delete the intermediate states, and link top->base */
20596ebdcee2SJeff Cody     ret = bdrv_change_backing_file(new_top_bs, base_bs->filename,
20606ebdcee2SJeff Cody                                    base_bs->drv ? base_bs->drv->format_name : "");
20616ebdcee2SJeff Cody     if (ret) {
20626ebdcee2SJeff Cody         goto exit;
20636ebdcee2SJeff Cody     }
20646ebdcee2SJeff Cody     new_top_bs->backing_hd = base_bs;
20656ebdcee2SJeff Cody 
20666ebdcee2SJeff Cody 
20676ebdcee2SJeff Cody     QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) {
20686ebdcee2SJeff Cody         /* so that bdrv_close() does not recursively close the chain */
20696ebdcee2SJeff Cody         intermediate_state->bs->backing_hd = NULL;
20706ebdcee2SJeff Cody         bdrv_delete(intermediate_state->bs);
20716ebdcee2SJeff Cody     }
20726ebdcee2SJeff Cody     ret = 0;
20736ebdcee2SJeff Cody 
20746ebdcee2SJeff Cody exit:
20756ebdcee2SJeff Cody     QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) {
20766ebdcee2SJeff Cody         g_free(intermediate_state);
20776ebdcee2SJeff Cody     }
20786ebdcee2SJeff Cody     return ret;
20796ebdcee2SJeff Cody }
20806ebdcee2SJeff Cody 
20816ebdcee2SJeff Cody 
208271d0770cSaliguori static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
208371d0770cSaliguori                                    size_t size)
208471d0770cSaliguori {
208571d0770cSaliguori     int64_t len;
208671d0770cSaliguori 
208771d0770cSaliguori     if (!bdrv_is_inserted(bs))
208871d0770cSaliguori         return -ENOMEDIUM;
208971d0770cSaliguori 
209071d0770cSaliguori     if (bs->growable)
209171d0770cSaliguori         return 0;
209271d0770cSaliguori 
209371d0770cSaliguori     len = bdrv_getlength(bs);
209471d0770cSaliguori 
2095fbb7b4e0SKevin Wolf     if (offset < 0)
2096fbb7b4e0SKevin Wolf         return -EIO;
2097fbb7b4e0SKevin Wolf 
2098fbb7b4e0SKevin Wolf     if ((offset > len) || (len - offset < size))
209971d0770cSaliguori         return -EIO;
210071d0770cSaliguori 
210171d0770cSaliguori     return 0;
210271d0770cSaliguori }
210371d0770cSaliguori 
210471d0770cSaliguori static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
210571d0770cSaliguori                               int nb_sectors)
210671d0770cSaliguori {
2107eb5a3165SJes Sorensen     return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
2108eb5a3165SJes Sorensen                                    nb_sectors * BDRV_SECTOR_SIZE);
210971d0770cSaliguori }
211071d0770cSaliguori 
21111c9805a3SStefan Hajnoczi typedef struct RwCo {
21121c9805a3SStefan Hajnoczi     BlockDriverState *bs;
21131c9805a3SStefan Hajnoczi     int64_t sector_num;
21141c9805a3SStefan Hajnoczi     int nb_sectors;
21151c9805a3SStefan Hajnoczi     QEMUIOVector *qiov;
21161c9805a3SStefan Hajnoczi     bool is_write;
21171c9805a3SStefan Hajnoczi     int ret;
21181c9805a3SStefan Hajnoczi } RwCo;
21191c9805a3SStefan Hajnoczi 
21201c9805a3SStefan Hajnoczi static void coroutine_fn bdrv_rw_co_entry(void *opaque)
2121fc01f7e7Sbellard {
21221c9805a3SStefan Hajnoczi     RwCo *rwco = opaque;
2123fc01f7e7Sbellard 
21241c9805a3SStefan Hajnoczi     if (!rwco->is_write) {
21251c9805a3SStefan Hajnoczi         rwco->ret = bdrv_co_do_readv(rwco->bs, rwco->sector_num,
2126470c0504SStefan Hajnoczi                                      rwco->nb_sectors, rwco->qiov, 0);
21271c9805a3SStefan Hajnoczi     } else {
21281c9805a3SStefan Hajnoczi         rwco->ret = bdrv_co_do_writev(rwco->bs, rwco->sector_num,
2129f08f2ddaSStefan Hajnoczi                                       rwco->nb_sectors, rwco->qiov, 0);
21301c9805a3SStefan Hajnoczi     }
21311c9805a3SStefan Hajnoczi }
2132e7a8a783SKevin Wolf 
21331c9805a3SStefan Hajnoczi /*
2134*8d3b1a2dSKevin Wolf  * Process a vectored synchronous request using coroutines
21351c9805a3SStefan Hajnoczi  */
2136*8d3b1a2dSKevin Wolf static int bdrv_rwv_co(BlockDriverState *bs, int64_t sector_num,
2137*8d3b1a2dSKevin Wolf                        QEMUIOVector *qiov, bool is_write)
21381c9805a3SStefan Hajnoczi {
21391c9805a3SStefan Hajnoczi     Coroutine *co;
21401c9805a3SStefan Hajnoczi     RwCo rwco = {
21411c9805a3SStefan Hajnoczi         .bs = bs,
21421c9805a3SStefan Hajnoczi         .sector_num = sector_num,
2143*8d3b1a2dSKevin Wolf         .nb_sectors = qiov->size >> BDRV_SECTOR_BITS,
2144*8d3b1a2dSKevin Wolf         .qiov = qiov,
21451c9805a3SStefan Hajnoczi         .is_write = is_write,
21461c9805a3SStefan Hajnoczi         .ret = NOT_DONE,
21471c9805a3SStefan Hajnoczi     };
2148*8d3b1a2dSKevin Wolf     assert((qiov->size & (BDRV_SECTOR_SIZE - 1)) == 0);
21491c9805a3SStefan Hajnoczi 
2150498e386cSZhi Yong Wu     /**
2151498e386cSZhi Yong Wu      * In sync call context, when the vcpu is blocked, this throttling timer
2152498e386cSZhi Yong Wu      * will not fire; so the I/O throttling function has to be disabled here
2153498e386cSZhi Yong Wu      * if it has been enabled.
2154498e386cSZhi Yong Wu      */
2155498e386cSZhi Yong Wu     if (bs->io_limits_enabled) {
2156498e386cSZhi Yong Wu         fprintf(stderr, "Disabling I/O throttling on '%s' due "
2157498e386cSZhi Yong Wu                         "to synchronous I/O.\n", bdrv_get_device_name(bs));
2158498e386cSZhi Yong Wu         bdrv_io_limits_disable(bs);
2159498e386cSZhi Yong Wu     }
2160498e386cSZhi Yong Wu 
21611c9805a3SStefan Hajnoczi     if (qemu_in_coroutine()) {
21621c9805a3SStefan Hajnoczi         /* Fast-path if already in coroutine context */
21631c9805a3SStefan Hajnoczi         bdrv_rw_co_entry(&rwco);
21641c9805a3SStefan Hajnoczi     } else {
21651c9805a3SStefan Hajnoczi         co = qemu_coroutine_create(bdrv_rw_co_entry);
21661c9805a3SStefan Hajnoczi         qemu_coroutine_enter(co, &rwco);
21671c9805a3SStefan Hajnoczi         while (rwco.ret == NOT_DONE) {
21681c9805a3SStefan Hajnoczi             qemu_aio_wait();
21691c9805a3SStefan Hajnoczi         }
21701c9805a3SStefan Hajnoczi     }
21711c9805a3SStefan Hajnoczi     return rwco.ret;
2172e7a8a783SKevin Wolf }
2173e7a8a783SKevin Wolf 
2174*8d3b1a2dSKevin Wolf /*
2175*8d3b1a2dSKevin Wolf  * Process a synchronous request using coroutines
2176*8d3b1a2dSKevin Wolf  */
2177*8d3b1a2dSKevin Wolf static int bdrv_rw_co(BlockDriverState *bs, int64_t sector_num, uint8_t *buf,
2178*8d3b1a2dSKevin Wolf                       int nb_sectors, bool is_write)
2179*8d3b1a2dSKevin Wolf {
2180*8d3b1a2dSKevin Wolf     QEMUIOVector qiov;
2181*8d3b1a2dSKevin Wolf     struct iovec iov = {
2182*8d3b1a2dSKevin Wolf         .iov_base = (void *)buf,
2183*8d3b1a2dSKevin Wolf         .iov_len = nb_sectors * BDRV_SECTOR_SIZE,
2184*8d3b1a2dSKevin Wolf     };
2185*8d3b1a2dSKevin Wolf 
2186*8d3b1a2dSKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
2187*8d3b1a2dSKevin Wolf     return bdrv_rwv_co(bs, sector_num, &qiov, is_write);
2188*8d3b1a2dSKevin Wolf }
2189*8d3b1a2dSKevin Wolf 
21901c9805a3SStefan Hajnoczi /* return < 0 if error. See bdrv_write() for the return codes */
21911c9805a3SStefan Hajnoczi int bdrv_read(BlockDriverState *bs, int64_t sector_num,
21921c9805a3SStefan Hajnoczi               uint8_t *buf, int nb_sectors)
21931c9805a3SStefan Hajnoczi {
21941c9805a3SStefan Hajnoczi     return bdrv_rw_co(bs, sector_num, buf, nb_sectors, false);
219583f64091Sbellard }
2196fc01f7e7Sbellard 
219707d27a44SMarkus Armbruster /* Just like bdrv_read(), but with I/O throttling temporarily disabled */
219807d27a44SMarkus Armbruster int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
219907d27a44SMarkus Armbruster                           uint8_t *buf, int nb_sectors)
220007d27a44SMarkus Armbruster {
220107d27a44SMarkus Armbruster     bool enabled;
220207d27a44SMarkus Armbruster     int ret;
220307d27a44SMarkus Armbruster 
220407d27a44SMarkus Armbruster     enabled = bs->io_limits_enabled;
220507d27a44SMarkus Armbruster     bs->io_limits_enabled = false;
220607d27a44SMarkus Armbruster     ret = bdrv_read(bs, 0, buf, 1);
220707d27a44SMarkus Armbruster     bs->io_limits_enabled = enabled;
220807d27a44SMarkus Armbruster     return ret;
220907d27a44SMarkus Armbruster }
221007d27a44SMarkus Armbruster 
221119cb3738Sbellard /* Return < 0 if error. Important errors are:
221219cb3738Sbellard   -EIO         generic I/O error (may happen for all errors)
221319cb3738Sbellard   -ENOMEDIUM   No media inserted.
221419cb3738Sbellard   -EINVAL      Invalid sector number or nb_sectors
221519cb3738Sbellard   -EACCES      Trying to write a read-only device
221619cb3738Sbellard */
2217fc01f7e7Sbellard int bdrv_write(BlockDriverState *bs, int64_t sector_num,
2218fc01f7e7Sbellard                const uint8_t *buf, int nb_sectors)
2219fc01f7e7Sbellard {
22201c9805a3SStefan Hajnoczi     return bdrv_rw_co(bs, sector_num, (uint8_t *)buf, nb_sectors, true);
222183f64091Sbellard }
222283f64091Sbellard 
2223*8d3b1a2dSKevin Wolf int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov)
2224*8d3b1a2dSKevin Wolf {
2225*8d3b1a2dSKevin Wolf     return bdrv_rwv_co(bs, sector_num, qiov, true);
2226*8d3b1a2dSKevin Wolf }
2227*8d3b1a2dSKevin Wolf 
2228eda578e5Saliguori int bdrv_pread(BlockDriverState *bs, int64_t offset,
2229eda578e5Saliguori                void *buf, int count1)
223083f64091Sbellard {
22316ea44308SJan Kiszka     uint8_t tmp_buf[BDRV_SECTOR_SIZE];
223283f64091Sbellard     int len, nb_sectors, count;
223383f64091Sbellard     int64_t sector_num;
22349a8c4cceSKevin Wolf     int ret;
223583f64091Sbellard 
223683f64091Sbellard     count = count1;
223783f64091Sbellard     /* first read to align to sector start */
22386ea44308SJan Kiszka     len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
223983f64091Sbellard     if (len > count)
224083f64091Sbellard         len = count;
22416ea44308SJan Kiszka     sector_num = offset >> BDRV_SECTOR_BITS;
224283f64091Sbellard     if (len > 0) {
22439a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
22449a8c4cceSKevin Wolf             return ret;
22456ea44308SJan Kiszka         memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
224683f64091Sbellard         count -= len;
224783f64091Sbellard         if (count == 0)
224883f64091Sbellard             return count1;
224983f64091Sbellard         sector_num++;
225083f64091Sbellard         buf += len;
225183f64091Sbellard     }
225283f64091Sbellard 
225383f64091Sbellard     /* read the sectors "in place" */
22546ea44308SJan Kiszka     nb_sectors = count >> BDRV_SECTOR_BITS;
225583f64091Sbellard     if (nb_sectors > 0) {
22569a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
22579a8c4cceSKevin Wolf             return ret;
225883f64091Sbellard         sector_num += nb_sectors;
22596ea44308SJan Kiszka         len = nb_sectors << BDRV_SECTOR_BITS;
226083f64091Sbellard         buf += len;
226183f64091Sbellard         count -= len;
226283f64091Sbellard     }
226383f64091Sbellard 
226483f64091Sbellard     /* add data from the last sector */
226583f64091Sbellard     if (count > 0) {
22669a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
22679a8c4cceSKevin Wolf             return ret;
226883f64091Sbellard         memcpy(buf, tmp_buf, count);
226983f64091Sbellard     }
227083f64091Sbellard     return count1;
227183f64091Sbellard }
227283f64091Sbellard 
2273*8d3b1a2dSKevin Wolf int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov)
227483f64091Sbellard {
22756ea44308SJan Kiszka     uint8_t tmp_buf[BDRV_SECTOR_SIZE];
227683f64091Sbellard     int len, nb_sectors, count;
227783f64091Sbellard     int64_t sector_num;
22789a8c4cceSKevin Wolf     int ret;
227983f64091Sbellard 
2280*8d3b1a2dSKevin Wolf     count = qiov->size;
2281*8d3b1a2dSKevin Wolf 
228283f64091Sbellard     /* first write to align to sector start */
22836ea44308SJan Kiszka     len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
228483f64091Sbellard     if (len > count)
228583f64091Sbellard         len = count;
22866ea44308SJan Kiszka     sector_num = offset >> BDRV_SECTOR_BITS;
228783f64091Sbellard     if (len > 0) {
22889a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
22899a8c4cceSKevin Wolf             return ret;
2290*8d3b1a2dSKevin Wolf         qemu_iovec_to_buf(qiov, 0, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)),
2291*8d3b1a2dSKevin Wolf                           len);
22929a8c4cceSKevin Wolf         if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
22939a8c4cceSKevin Wolf             return ret;
229483f64091Sbellard         count -= len;
229583f64091Sbellard         if (count == 0)
2296*8d3b1a2dSKevin Wolf             return qiov->size;
229783f64091Sbellard         sector_num++;
229883f64091Sbellard     }
229983f64091Sbellard 
230083f64091Sbellard     /* write the sectors "in place" */
23016ea44308SJan Kiszka     nb_sectors = count >> BDRV_SECTOR_BITS;
230283f64091Sbellard     if (nb_sectors > 0) {
2303*8d3b1a2dSKevin Wolf         QEMUIOVector qiov_inplace;
2304*8d3b1a2dSKevin Wolf 
2305*8d3b1a2dSKevin Wolf         qemu_iovec_init(&qiov_inplace, qiov->niov);
2306*8d3b1a2dSKevin Wolf         qemu_iovec_concat(&qiov_inplace, qiov, len,
2307*8d3b1a2dSKevin Wolf                           nb_sectors << BDRV_SECTOR_BITS);
2308*8d3b1a2dSKevin Wolf         ret = bdrv_writev(bs, sector_num, &qiov_inplace);
2309*8d3b1a2dSKevin Wolf         qemu_iovec_destroy(&qiov_inplace);
2310*8d3b1a2dSKevin Wolf         if (ret < 0) {
23119a8c4cceSKevin Wolf             return ret;
2312*8d3b1a2dSKevin Wolf         }
2313*8d3b1a2dSKevin Wolf 
231483f64091Sbellard         sector_num += nb_sectors;
23156ea44308SJan Kiszka         len = nb_sectors << BDRV_SECTOR_BITS;
231683f64091Sbellard         count -= len;
231783f64091Sbellard     }
231883f64091Sbellard 
231983f64091Sbellard     /* add data from the last sector */
232083f64091Sbellard     if (count > 0) {
23219a8c4cceSKevin Wolf         if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
23229a8c4cceSKevin Wolf             return ret;
2323*8d3b1a2dSKevin Wolf         qemu_iovec_to_buf(qiov, qiov->size - count, tmp_buf, count);
23249a8c4cceSKevin Wolf         if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
23259a8c4cceSKevin Wolf             return ret;
232683f64091Sbellard     }
2327*8d3b1a2dSKevin Wolf     return qiov->size;
2328*8d3b1a2dSKevin Wolf }
2329*8d3b1a2dSKevin Wolf 
2330*8d3b1a2dSKevin Wolf int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
2331*8d3b1a2dSKevin Wolf                 const void *buf, int count1)
2332*8d3b1a2dSKevin Wolf {
2333*8d3b1a2dSKevin Wolf     QEMUIOVector qiov;
2334*8d3b1a2dSKevin Wolf     struct iovec iov = {
2335*8d3b1a2dSKevin Wolf         .iov_base   = (void *) buf,
2336*8d3b1a2dSKevin Wolf         .iov_len    = count1,
2337*8d3b1a2dSKevin Wolf     };
2338*8d3b1a2dSKevin Wolf 
2339*8d3b1a2dSKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
2340*8d3b1a2dSKevin Wolf     return bdrv_pwritev(bs, offset, &qiov);
234183f64091Sbellard }
234283f64091Sbellard 
2343f08145feSKevin Wolf /*
2344f08145feSKevin Wolf  * Writes to the file and ensures that no writes are reordered across this
2345f08145feSKevin Wolf  * request (acts as a barrier)
2346f08145feSKevin Wolf  *
2347f08145feSKevin Wolf  * Returns 0 on success, -errno in error cases.
2348f08145feSKevin Wolf  */
2349f08145feSKevin Wolf int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
2350f08145feSKevin Wolf     const void *buf, int count)
2351f08145feSKevin Wolf {
2352f08145feSKevin Wolf     int ret;
2353f08145feSKevin Wolf 
2354f08145feSKevin Wolf     ret = bdrv_pwrite(bs, offset, buf, count);
2355f08145feSKevin Wolf     if (ret < 0) {
2356f08145feSKevin Wolf         return ret;
2357f08145feSKevin Wolf     }
2358f08145feSKevin Wolf 
2359f05fa4adSPaolo Bonzini     /* No flush needed for cache modes that already do it */
2360f05fa4adSPaolo Bonzini     if (bs->enable_write_cache) {
2361f08145feSKevin Wolf         bdrv_flush(bs);
2362f08145feSKevin Wolf     }
2363f08145feSKevin Wolf 
2364f08145feSKevin Wolf     return 0;
2365f08145feSKevin Wolf }
2366f08145feSKevin Wolf 
2367470c0504SStefan Hajnoczi static int coroutine_fn bdrv_co_do_copy_on_readv(BlockDriverState *bs,
2368ab185921SStefan Hajnoczi         int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
2369ab185921SStefan Hajnoczi {
2370ab185921SStefan Hajnoczi     /* Perform I/O through a temporary buffer so that users who scribble over
2371ab185921SStefan Hajnoczi      * their read buffer while the operation is in progress do not end up
2372ab185921SStefan Hajnoczi      * modifying the image file.  This is critical for zero-copy guest I/O
2373ab185921SStefan Hajnoczi      * where anything might happen inside guest memory.
2374ab185921SStefan Hajnoczi      */
2375ab185921SStefan Hajnoczi     void *bounce_buffer;
2376ab185921SStefan Hajnoczi 
237779c053bdSStefan Hajnoczi     BlockDriver *drv = bs->drv;
2378ab185921SStefan Hajnoczi     struct iovec iov;
2379ab185921SStefan Hajnoczi     QEMUIOVector bounce_qiov;
2380ab185921SStefan Hajnoczi     int64_t cluster_sector_num;
2381ab185921SStefan Hajnoczi     int cluster_nb_sectors;
2382ab185921SStefan Hajnoczi     size_t skip_bytes;
2383ab185921SStefan Hajnoczi     int ret;
2384ab185921SStefan Hajnoczi 
2385ab185921SStefan Hajnoczi     /* Cover entire cluster so no additional backing file I/O is required when
2386ab185921SStefan Hajnoczi      * allocating cluster in the image file.
2387ab185921SStefan Hajnoczi      */
2388343bded4SPaolo Bonzini     bdrv_round_to_clusters(bs, sector_num, nb_sectors,
2389ab185921SStefan Hajnoczi                            &cluster_sector_num, &cluster_nb_sectors);
2390ab185921SStefan Hajnoczi 
2391470c0504SStefan Hajnoczi     trace_bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors,
2392ab185921SStefan Hajnoczi                                    cluster_sector_num, cluster_nb_sectors);
2393ab185921SStefan Hajnoczi 
2394ab185921SStefan Hajnoczi     iov.iov_len = cluster_nb_sectors * BDRV_SECTOR_SIZE;
2395ab185921SStefan Hajnoczi     iov.iov_base = bounce_buffer = qemu_blockalign(bs, iov.iov_len);
2396ab185921SStefan Hajnoczi     qemu_iovec_init_external(&bounce_qiov, &iov, 1);
2397ab185921SStefan Hajnoczi 
239879c053bdSStefan Hajnoczi     ret = drv->bdrv_co_readv(bs, cluster_sector_num, cluster_nb_sectors,
2399ab185921SStefan Hajnoczi                              &bounce_qiov);
2400ab185921SStefan Hajnoczi     if (ret < 0) {
2401ab185921SStefan Hajnoczi         goto err;
2402ab185921SStefan Hajnoczi     }
2403ab185921SStefan Hajnoczi 
240479c053bdSStefan Hajnoczi     if (drv->bdrv_co_write_zeroes &&
240579c053bdSStefan Hajnoczi         buffer_is_zero(bounce_buffer, iov.iov_len)) {
2406621f0589SKevin Wolf         ret = bdrv_co_do_write_zeroes(bs, cluster_sector_num,
240779c053bdSStefan Hajnoczi                                       cluster_nb_sectors);
240879c053bdSStefan Hajnoczi     } else {
2409f05fa4adSPaolo Bonzini         /* This does not change the data on the disk, it is not necessary
2410f05fa4adSPaolo Bonzini          * to flush even in cache=writethrough mode.
2411f05fa4adSPaolo Bonzini          */
241279c053bdSStefan Hajnoczi         ret = drv->bdrv_co_writev(bs, cluster_sector_num, cluster_nb_sectors,
2413ab185921SStefan Hajnoczi                                   &bounce_qiov);
241479c053bdSStefan Hajnoczi     }
241579c053bdSStefan Hajnoczi 
2416ab185921SStefan Hajnoczi     if (ret < 0) {
2417ab185921SStefan Hajnoczi         /* It might be okay to ignore write errors for guest requests.  If this
2418ab185921SStefan Hajnoczi          * is a deliberate copy-on-read then we don't want to ignore the error.
2419ab185921SStefan Hajnoczi          * Simply report it in all cases.
2420ab185921SStefan Hajnoczi          */
2421ab185921SStefan Hajnoczi         goto err;
2422ab185921SStefan Hajnoczi     }
2423ab185921SStefan Hajnoczi 
2424ab185921SStefan Hajnoczi     skip_bytes = (sector_num - cluster_sector_num) * BDRV_SECTOR_SIZE;
242503396148SMichael Tokarev     qemu_iovec_from_buf(qiov, 0, bounce_buffer + skip_bytes,
2426ab185921SStefan Hajnoczi                         nb_sectors * BDRV_SECTOR_SIZE);
2427ab185921SStefan Hajnoczi 
2428ab185921SStefan Hajnoczi err:
2429ab185921SStefan Hajnoczi     qemu_vfree(bounce_buffer);
2430ab185921SStefan Hajnoczi     return ret;
2431ab185921SStefan Hajnoczi }
2432ab185921SStefan Hajnoczi 
2433c5fbe571SStefan Hajnoczi /*
2434c5fbe571SStefan Hajnoczi  * Handle a read request in coroutine context
2435c5fbe571SStefan Hajnoczi  */
2436c5fbe571SStefan Hajnoczi static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
2437470c0504SStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
2438470c0504SStefan Hajnoczi     BdrvRequestFlags flags)
2439da1fa91dSKevin Wolf {
2440da1fa91dSKevin Wolf     BlockDriver *drv = bs->drv;
2441dbffbdcfSStefan Hajnoczi     BdrvTrackedRequest req;
2442dbffbdcfSStefan Hajnoczi     int ret;
2443da1fa91dSKevin Wolf 
2444da1fa91dSKevin Wolf     if (!drv) {
2445da1fa91dSKevin Wolf         return -ENOMEDIUM;
2446da1fa91dSKevin Wolf     }
2447da1fa91dSKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors)) {
2448da1fa91dSKevin Wolf         return -EIO;
2449da1fa91dSKevin Wolf     }
2450da1fa91dSKevin Wolf 
245198f90dbaSZhi Yong Wu     /* throttling disk read I/O */
245298f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
245398f90dbaSZhi Yong Wu         bdrv_io_limits_intercept(bs, false, nb_sectors);
245498f90dbaSZhi Yong Wu     }
245598f90dbaSZhi Yong Wu 
2456f4658285SStefan Hajnoczi     if (bs->copy_on_read) {
2457470c0504SStefan Hajnoczi         flags |= BDRV_REQ_COPY_ON_READ;
2458470c0504SStefan Hajnoczi     }
2459470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2460470c0504SStefan Hajnoczi         bs->copy_on_read_in_flight++;
2461470c0504SStefan Hajnoczi     }
2462470c0504SStefan Hajnoczi 
2463470c0504SStefan Hajnoczi     if (bs->copy_on_read_in_flight) {
2464f4658285SStefan Hajnoczi         wait_for_overlapping_requests(bs, sector_num, nb_sectors);
2465f4658285SStefan Hajnoczi     }
2466f4658285SStefan Hajnoczi 
2467dbffbdcfSStefan Hajnoczi     tracked_request_begin(&req, bs, sector_num, nb_sectors, false);
2468ab185921SStefan Hajnoczi 
2469470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2470ab185921SStefan Hajnoczi         int pnum;
2471ab185921SStefan Hajnoczi 
2472ab185921SStefan Hajnoczi         ret = bdrv_co_is_allocated(bs, sector_num, nb_sectors, &pnum);
2473ab185921SStefan Hajnoczi         if (ret < 0) {
2474ab185921SStefan Hajnoczi             goto out;
2475ab185921SStefan Hajnoczi         }
2476ab185921SStefan Hajnoczi 
2477ab185921SStefan Hajnoczi         if (!ret || pnum != nb_sectors) {
2478470c0504SStefan Hajnoczi             ret = bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors, qiov);
2479ab185921SStefan Hajnoczi             goto out;
2480ab185921SStefan Hajnoczi         }
2481ab185921SStefan Hajnoczi     }
2482ab185921SStefan Hajnoczi 
2483dbffbdcfSStefan Hajnoczi     ret = drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
2484ab185921SStefan Hajnoczi 
2485ab185921SStefan Hajnoczi out:
2486dbffbdcfSStefan Hajnoczi     tracked_request_end(&req);
2487470c0504SStefan Hajnoczi 
2488470c0504SStefan Hajnoczi     if (flags & BDRV_REQ_COPY_ON_READ) {
2489470c0504SStefan Hajnoczi         bs->copy_on_read_in_flight--;
2490470c0504SStefan Hajnoczi     }
2491470c0504SStefan Hajnoczi 
2492dbffbdcfSStefan Hajnoczi     return ret;
2493da1fa91dSKevin Wolf }
2494da1fa91dSKevin Wolf 
2495c5fbe571SStefan Hajnoczi int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
2496da1fa91dSKevin Wolf     int nb_sectors, QEMUIOVector *qiov)
2497da1fa91dSKevin Wolf {
2498c5fbe571SStefan Hajnoczi     trace_bdrv_co_readv(bs, sector_num, nb_sectors);
2499da1fa91dSKevin Wolf 
2500470c0504SStefan Hajnoczi     return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov, 0);
2501470c0504SStefan Hajnoczi }
2502470c0504SStefan Hajnoczi 
2503470c0504SStefan Hajnoczi int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
2504470c0504SStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
2505470c0504SStefan Hajnoczi {
2506470c0504SStefan Hajnoczi     trace_bdrv_co_copy_on_readv(bs, sector_num, nb_sectors);
2507470c0504SStefan Hajnoczi 
2508470c0504SStefan Hajnoczi     return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov,
2509470c0504SStefan Hajnoczi                             BDRV_REQ_COPY_ON_READ);
2510c5fbe571SStefan Hajnoczi }
2511c5fbe571SStefan Hajnoczi 
2512f08f2ddaSStefan Hajnoczi static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs,
2513f08f2ddaSStefan Hajnoczi     int64_t sector_num, int nb_sectors)
2514f08f2ddaSStefan Hajnoczi {
2515f08f2ddaSStefan Hajnoczi     BlockDriver *drv = bs->drv;
2516f08f2ddaSStefan Hajnoczi     QEMUIOVector qiov;
2517f08f2ddaSStefan Hajnoczi     struct iovec iov;
2518f08f2ddaSStefan Hajnoczi     int ret;
2519f08f2ddaSStefan Hajnoczi 
2520621f0589SKevin Wolf     /* TODO Emulate only part of misaligned requests instead of letting block
2521621f0589SKevin Wolf      * drivers return -ENOTSUP and emulate everything */
2522621f0589SKevin Wolf 
2523f08f2ddaSStefan Hajnoczi     /* First try the efficient write zeroes operation */
2524f08f2ddaSStefan Hajnoczi     if (drv->bdrv_co_write_zeroes) {
2525621f0589SKevin Wolf         ret = drv->bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
2526621f0589SKevin Wolf         if (ret != -ENOTSUP) {
2527621f0589SKevin Wolf             return ret;
2528621f0589SKevin Wolf         }
2529f08f2ddaSStefan Hajnoczi     }
2530f08f2ddaSStefan Hajnoczi 
2531f08f2ddaSStefan Hajnoczi     /* Fall back to bounce buffer if write zeroes is unsupported */
2532f08f2ddaSStefan Hajnoczi     iov.iov_len  = nb_sectors * BDRV_SECTOR_SIZE;
2533f08f2ddaSStefan Hajnoczi     iov.iov_base = qemu_blockalign(bs, iov.iov_len);
2534f08f2ddaSStefan Hajnoczi     memset(iov.iov_base, 0, iov.iov_len);
2535f08f2ddaSStefan Hajnoczi     qemu_iovec_init_external(&qiov, &iov, 1);
2536f08f2ddaSStefan Hajnoczi 
2537f08f2ddaSStefan Hajnoczi     ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, &qiov);
2538f08f2ddaSStefan Hajnoczi 
2539f08f2ddaSStefan Hajnoczi     qemu_vfree(iov.iov_base);
2540f08f2ddaSStefan Hajnoczi     return ret;
2541f08f2ddaSStefan Hajnoczi }
2542f08f2ddaSStefan Hajnoczi 
2543c5fbe571SStefan Hajnoczi /*
2544c5fbe571SStefan Hajnoczi  * Handle a write request in coroutine context
2545c5fbe571SStefan Hajnoczi  */
2546c5fbe571SStefan Hajnoczi static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
2547f08f2ddaSStefan Hajnoczi     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
2548f08f2ddaSStefan Hajnoczi     BdrvRequestFlags flags)
2549c5fbe571SStefan Hajnoczi {
2550c5fbe571SStefan Hajnoczi     BlockDriver *drv = bs->drv;
2551dbffbdcfSStefan Hajnoczi     BdrvTrackedRequest req;
25526b7cb247SStefan Hajnoczi     int ret;
2553da1fa91dSKevin Wolf 
2554da1fa91dSKevin Wolf     if (!bs->drv) {
2555da1fa91dSKevin Wolf         return -ENOMEDIUM;
2556da1fa91dSKevin Wolf     }
2557da1fa91dSKevin Wolf     if (bs->read_only) {
2558da1fa91dSKevin Wolf         return -EACCES;
2559da1fa91dSKevin Wolf     }
2560da1fa91dSKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors)) {
2561da1fa91dSKevin Wolf         return -EIO;
2562da1fa91dSKevin Wolf     }
2563da1fa91dSKevin Wolf 
256498f90dbaSZhi Yong Wu     /* throttling disk write I/O */
256598f90dbaSZhi Yong Wu     if (bs->io_limits_enabled) {
256698f90dbaSZhi Yong Wu         bdrv_io_limits_intercept(bs, true, nb_sectors);
256798f90dbaSZhi Yong Wu     }
256898f90dbaSZhi Yong Wu 
2569470c0504SStefan Hajnoczi     if (bs->copy_on_read_in_flight) {
2570f4658285SStefan Hajnoczi         wait_for_overlapping_requests(bs, sector_num, nb_sectors);
2571f4658285SStefan Hajnoczi     }
2572f4658285SStefan Hajnoczi 
2573dbffbdcfSStefan Hajnoczi     tracked_request_begin(&req, bs, sector_num, nb_sectors, true);
2574dbffbdcfSStefan Hajnoczi 
2575f08f2ddaSStefan Hajnoczi     if (flags & BDRV_REQ_ZERO_WRITE) {
2576f08f2ddaSStefan Hajnoczi         ret = bdrv_co_do_write_zeroes(bs, sector_num, nb_sectors);
2577f08f2ddaSStefan Hajnoczi     } else {
25786b7cb247SStefan Hajnoczi         ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
2579f08f2ddaSStefan Hajnoczi     }
25806b7cb247SStefan Hajnoczi 
2581f05fa4adSPaolo Bonzini     if (ret == 0 && !bs->enable_write_cache) {
2582f05fa4adSPaolo Bonzini         ret = bdrv_co_flush(bs);
2583f05fa4adSPaolo Bonzini     }
2584f05fa4adSPaolo Bonzini 
2585da1fa91dSKevin Wolf     if (bs->dirty_bitmap) {
25861755da16SPaolo Bonzini         bdrv_set_dirty(bs, sector_num, nb_sectors);
2587da1fa91dSKevin Wolf     }
2588da1fa91dSKevin Wolf 
2589da1fa91dSKevin Wolf     if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
2590da1fa91dSKevin Wolf         bs->wr_highest_sector = sector_num + nb_sectors - 1;
2591da1fa91dSKevin Wolf     }
2592da1fa91dSKevin Wolf 
2593dbffbdcfSStefan Hajnoczi     tracked_request_end(&req);
2594dbffbdcfSStefan Hajnoczi 
25956b7cb247SStefan Hajnoczi     return ret;
2596da1fa91dSKevin Wolf }
2597da1fa91dSKevin Wolf 
2598c5fbe571SStefan Hajnoczi int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
2599c5fbe571SStefan Hajnoczi     int nb_sectors, QEMUIOVector *qiov)
2600c5fbe571SStefan Hajnoczi {
2601c5fbe571SStefan Hajnoczi     trace_bdrv_co_writev(bs, sector_num, nb_sectors);
2602c5fbe571SStefan Hajnoczi 
2603f08f2ddaSStefan Hajnoczi     return bdrv_co_do_writev(bs, sector_num, nb_sectors, qiov, 0);
2604f08f2ddaSStefan Hajnoczi }
2605f08f2ddaSStefan Hajnoczi 
2606f08f2ddaSStefan Hajnoczi int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs,
2607f08f2ddaSStefan Hajnoczi                                       int64_t sector_num, int nb_sectors)
2608f08f2ddaSStefan Hajnoczi {
2609f08f2ddaSStefan Hajnoczi     trace_bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
2610f08f2ddaSStefan Hajnoczi 
2611f08f2ddaSStefan Hajnoczi     return bdrv_co_do_writev(bs, sector_num, nb_sectors, NULL,
2612f08f2ddaSStefan Hajnoczi                              BDRV_REQ_ZERO_WRITE);
2613c5fbe571SStefan Hajnoczi }
2614c5fbe571SStefan Hajnoczi 
261583f64091Sbellard /**
261683f64091Sbellard  * Truncate file to 'offset' bytes (needed only for file protocols)
261783f64091Sbellard  */
261883f64091Sbellard int bdrv_truncate(BlockDriverState *bs, int64_t offset)
261983f64091Sbellard {
262083f64091Sbellard     BlockDriver *drv = bs->drv;
262151762288SStefan Hajnoczi     int ret;
262283f64091Sbellard     if (!drv)
262319cb3738Sbellard         return -ENOMEDIUM;
262483f64091Sbellard     if (!drv->bdrv_truncate)
262583f64091Sbellard         return -ENOTSUP;
262659f2689dSNaphtali Sprei     if (bs->read_only)
262759f2689dSNaphtali Sprei         return -EACCES;
26288591675fSMarcelo Tosatti     if (bdrv_in_use(bs))
26298591675fSMarcelo Tosatti         return -EBUSY;
263051762288SStefan Hajnoczi     ret = drv->bdrv_truncate(bs, offset);
263151762288SStefan Hajnoczi     if (ret == 0) {
263251762288SStefan Hajnoczi         ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
2633145feb17SMarkus Armbruster         bdrv_dev_resize_cb(bs);
263451762288SStefan Hajnoczi     }
263551762288SStefan Hajnoczi     return ret;
263683f64091Sbellard }
263783f64091Sbellard 
263883f64091Sbellard /**
26394a1d5e1fSFam Zheng  * Length of a allocated file in bytes. Sparse files are counted by actual
26404a1d5e1fSFam Zheng  * allocated space. Return < 0 if error or unknown.
26414a1d5e1fSFam Zheng  */
26424a1d5e1fSFam Zheng int64_t bdrv_get_allocated_file_size(BlockDriverState *bs)
26434a1d5e1fSFam Zheng {
26444a1d5e1fSFam Zheng     BlockDriver *drv = bs->drv;
26454a1d5e1fSFam Zheng     if (!drv) {
26464a1d5e1fSFam Zheng         return -ENOMEDIUM;
26474a1d5e1fSFam Zheng     }
26484a1d5e1fSFam Zheng     if (drv->bdrv_get_allocated_file_size) {
26494a1d5e1fSFam Zheng         return drv->bdrv_get_allocated_file_size(bs);
26504a1d5e1fSFam Zheng     }
26514a1d5e1fSFam Zheng     if (bs->file) {
26524a1d5e1fSFam Zheng         return bdrv_get_allocated_file_size(bs->file);
26534a1d5e1fSFam Zheng     }
26544a1d5e1fSFam Zheng     return -ENOTSUP;
26554a1d5e1fSFam Zheng }
26564a1d5e1fSFam Zheng 
26574a1d5e1fSFam Zheng /**
265883f64091Sbellard  * Length of a file in bytes. Return < 0 if error or unknown.
265983f64091Sbellard  */
266083f64091Sbellard int64_t bdrv_getlength(BlockDriverState *bs)
266183f64091Sbellard {
266283f64091Sbellard     BlockDriver *drv = bs->drv;
266383f64091Sbellard     if (!drv)
266419cb3738Sbellard         return -ENOMEDIUM;
266551762288SStefan Hajnoczi 
26662c6942faSMarkus Armbruster     if (bs->growable || bdrv_dev_has_removable_media(bs)) {
266746a4e4e6SStefan Hajnoczi         if (drv->bdrv_getlength) {
266883f64091Sbellard             return drv->bdrv_getlength(bs);
2669fc01f7e7Sbellard         }
267046a4e4e6SStefan Hajnoczi     }
267146a4e4e6SStefan Hajnoczi     return bs->total_sectors * BDRV_SECTOR_SIZE;
267246a4e4e6SStefan Hajnoczi }
2673fc01f7e7Sbellard 
267419cb3738Sbellard /* return 0 as number of sectors if no device present or error */
267596b8f136Sths void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
2676fc01f7e7Sbellard {
267719cb3738Sbellard     int64_t length;
267819cb3738Sbellard     length = bdrv_getlength(bs);
267919cb3738Sbellard     if (length < 0)
268019cb3738Sbellard         length = 0;
268119cb3738Sbellard     else
26826ea44308SJan Kiszka         length = length >> BDRV_SECTOR_BITS;
268319cb3738Sbellard     *nb_sectors_ptr = length;
2684fc01f7e7Sbellard }
2685cf98951bSbellard 
26860563e191SZhi Yong Wu /* throttling disk io limits */
26870563e191SZhi Yong Wu void bdrv_set_io_limits(BlockDriverState *bs,
26880563e191SZhi Yong Wu                         BlockIOLimit *io_limits)
26890563e191SZhi Yong Wu {
26900563e191SZhi Yong Wu     bs->io_limits = *io_limits;
26910563e191SZhi Yong Wu     bs->io_limits_enabled = bdrv_io_limits_enabled(bs);
26920563e191SZhi Yong Wu }
26930563e191SZhi Yong Wu 
2694ff06f5f3SPaolo Bonzini void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
2695ff06f5f3SPaolo Bonzini                        BlockdevOnError on_write_error)
2696abd7f68dSMarkus Armbruster {
2697abd7f68dSMarkus Armbruster     bs->on_read_error = on_read_error;
2698abd7f68dSMarkus Armbruster     bs->on_write_error = on_write_error;
2699abd7f68dSMarkus Armbruster }
2700abd7f68dSMarkus Armbruster 
27011ceee0d5SPaolo Bonzini BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read)
2702abd7f68dSMarkus Armbruster {
2703abd7f68dSMarkus Armbruster     return is_read ? bs->on_read_error : bs->on_write_error;
2704abd7f68dSMarkus Armbruster }
2705abd7f68dSMarkus Armbruster 
27063e1caa5fSPaolo Bonzini BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error)
27073e1caa5fSPaolo Bonzini {
27083e1caa5fSPaolo Bonzini     BlockdevOnError on_err = is_read ? bs->on_read_error : bs->on_write_error;
27093e1caa5fSPaolo Bonzini 
27103e1caa5fSPaolo Bonzini     switch (on_err) {
27113e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_ENOSPC:
27123e1caa5fSPaolo Bonzini         return (error == ENOSPC) ? BDRV_ACTION_STOP : BDRV_ACTION_REPORT;
27133e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_STOP:
27143e1caa5fSPaolo Bonzini         return BDRV_ACTION_STOP;
27153e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_REPORT:
27163e1caa5fSPaolo Bonzini         return BDRV_ACTION_REPORT;
27173e1caa5fSPaolo Bonzini     case BLOCKDEV_ON_ERROR_IGNORE:
27183e1caa5fSPaolo Bonzini         return BDRV_ACTION_IGNORE;
27193e1caa5fSPaolo Bonzini     default:
27203e1caa5fSPaolo Bonzini         abort();
27213e1caa5fSPaolo Bonzini     }
27223e1caa5fSPaolo Bonzini }
27233e1caa5fSPaolo Bonzini 
27243e1caa5fSPaolo Bonzini /* This is done by device models because, while the block layer knows
27253e1caa5fSPaolo Bonzini  * about the error, it does not know whether an operation comes from
27263e1caa5fSPaolo Bonzini  * the device or the block layer (from a job, for example).
27273e1caa5fSPaolo Bonzini  */
27283e1caa5fSPaolo Bonzini void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
27293e1caa5fSPaolo Bonzini                        bool is_read, int error)
27303e1caa5fSPaolo Bonzini {
27313e1caa5fSPaolo Bonzini     assert(error >= 0);
273232c81a4aSPaolo Bonzini     bdrv_emit_qmp_error_event(bs, QEVENT_BLOCK_IO_ERROR, action, is_read);
27333e1caa5fSPaolo Bonzini     if (action == BDRV_ACTION_STOP) {
27343e1caa5fSPaolo Bonzini         vm_stop(RUN_STATE_IO_ERROR);
27353e1caa5fSPaolo Bonzini         bdrv_iostatus_set_err(bs, error);
27363e1caa5fSPaolo Bonzini     }
27373e1caa5fSPaolo Bonzini }
27383e1caa5fSPaolo Bonzini 
2739b338082bSbellard int bdrv_is_read_only(BlockDriverState *bs)
2740b338082bSbellard {
2741b338082bSbellard     return bs->read_only;
2742b338082bSbellard }
2743b338082bSbellard 
2744985a03b0Sths int bdrv_is_sg(BlockDriverState *bs)
2745985a03b0Sths {
2746985a03b0Sths     return bs->sg;
2747985a03b0Sths }
2748985a03b0Sths 
2749e900a7b7SChristoph Hellwig int bdrv_enable_write_cache(BlockDriverState *bs)
2750e900a7b7SChristoph Hellwig {
2751e900a7b7SChristoph Hellwig     return bs->enable_write_cache;
2752e900a7b7SChristoph Hellwig }
2753e900a7b7SChristoph Hellwig 
2754425b0148SPaolo Bonzini void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce)
2755425b0148SPaolo Bonzini {
2756425b0148SPaolo Bonzini     bs->enable_write_cache = wce;
275755b110f2SJeff Cody 
275855b110f2SJeff Cody     /* so a reopen() will preserve wce */
275955b110f2SJeff Cody     if (wce) {
276055b110f2SJeff Cody         bs->open_flags |= BDRV_O_CACHE_WB;
276155b110f2SJeff Cody     } else {
276255b110f2SJeff Cody         bs->open_flags &= ~BDRV_O_CACHE_WB;
276355b110f2SJeff Cody     }
2764425b0148SPaolo Bonzini }
2765425b0148SPaolo Bonzini 
2766ea2384d3Sbellard int bdrv_is_encrypted(BlockDriverState *bs)
2767ea2384d3Sbellard {
2768ea2384d3Sbellard     if (bs->backing_hd && bs->backing_hd->encrypted)
2769ea2384d3Sbellard         return 1;
2770ea2384d3Sbellard     return bs->encrypted;
2771ea2384d3Sbellard }
2772ea2384d3Sbellard 
2773c0f4ce77Saliguori int bdrv_key_required(BlockDriverState *bs)
2774c0f4ce77Saliguori {
2775c0f4ce77Saliguori     BlockDriverState *backing_hd = bs->backing_hd;
2776c0f4ce77Saliguori 
2777c0f4ce77Saliguori     if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
2778c0f4ce77Saliguori         return 1;
2779c0f4ce77Saliguori     return (bs->encrypted && !bs->valid_key);
2780c0f4ce77Saliguori }
2781c0f4ce77Saliguori 
2782ea2384d3Sbellard int bdrv_set_key(BlockDriverState *bs, const char *key)
2783ea2384d3Sbellard {
2784ea2384d3Sbellard     int ret;
2785ea2384d3Sbellard     if (bs->backing_hd && bs->backing_hd->encrypted) {
2786ea2384d3Sbellard         ret = bdrv_set_key(bs->backing_hd, key);
2787ea2384d3Sbellard         if (ret < 0)
2788ea2384d3Sbellard             return ret;
2789ea2384d3Sbellard         if (!bs->encrypted)
2790ea2384d3Sbellard             return 0;
2791ea2384d3Sbellard     }
2792fd04a2aeSShahar Havivi     if (!bs->encrypted) {
2793fd04a2aeSShahar Havivi         return -EINVAL;
2794fd04a2aeSShahar Havivi     } else if (!bs->drv || !bs->drv->bdrv_set_key) {
2795fd04a2aeSShahar Havivi         return -ENOMEDIUM;
2796fd04a2aeSShahar Havivi     }
2797c0f4ce77Saliguori     ret = bs->drv->bdrv_set_key(bs, key);
2798bb5fc20fSaliguori     if (ret < 0) {
2799bb5fc20fSaliguori         bs->valid_key = 0;
2800bb5fc20fSaliguori     } else if (!bs->valid_key) {
2801bb5fc20fSaliguori         bs->valid_key = 1;
2802bb5fc20fSaliguori         /* call the change callback now, we skipped it on open */
28037d4b4ba5SMarkus Armbruster         bdrv_dev_change_media_cb(bs, true);
2804bb5fc20fSaliguori     }
2805c0f4ce77Saliguori     return ret;
2806ea2384d3Sbellard }
2807ea2384d3Sbellard 
2808f8d6bba1SMarkus Armbruster const char *bdrv_get_format_name(BlockDriverState *bs)
2809ea2384d3Sbellard {
2810f8d6bba1SMarkus Armbruster     return bs->drv ? bs->drv->format_name : NULL;
2811ea2384d3Sbellard }
2812ea2384d3Sbellard 
2813ea2384d3Sbellard void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
2814ea2384d3Sbellard                          void *opaque)
2815ea2384d3Sbellard {
2816ea2384d3Sbellard     BlockDriver *drv;
2817ea2384d3Sbellard 
28188a22f02aSStefan Hajnoczi     QLIST_FOREACH(drv, &bdrv_drivers, list) {
2819ea2384d3Sbellard         it(opaque, drv->format_name);
2820ea2384d3Sbellard     }
2821ea2384d3Sbellard }
2822ea2384d3Sbellard 
2823b338082bSbellard BlockDriverState *bdrv_find(const char *name)
2824b338082bSbellard {
2825b338082bSbellard     BlockDriverState *bs;
2826b338082bSbellard 
28271b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
28281b7bdbc1SStefan Hajnoczi         if (!strcmp(name, bs->device_name)) {
2829b338082bSbellard             return bs;
2830b338082bSbellard         }
28311b7bdbc1SStefan Hajnoczi     }
2832b338082bSbellard     return NULL;
2833b338082bSbellard }
2834b338082bSbellard 
28352f399b0aSMarkus Armbruster BlockDriverState *bdrv_next(BlockDriverState *bs)
28362f399b0aSMarkus Armbruster {
28372f399b0aSMarkus Armbruster     if (!bs) {
28382f399b0aSMarkus Armbruster         return QTAILQ_FIRST(&bdrv_states);
28392f399b0aSMarkus Armbruster     }
28402f399b0aSMarkus Armbruster     return QTAILQ_NEXT(bs, list);
28412f399b0aSMarkus Armbruster }
28422f399b0aSMarkus Armbruster 
284351de9760Saliguori void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
284481d0912dSbellard {
284581d0912dSbellard     BlockDriverState *bs;
284681d0912dSbellard 
28471b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
284851de9760Saliguori         it(opaque, bs);
284981d0912dSbellard     }
285081d0912dSbellard }
285181d0912dSbellard 
2852ea2384d3Sbellard const char *bdrv_get_device_name(BlockDriverState *bs)
2853ea2384d3Sbellard {
2854ea2384d3Sbellard     return bs->device_name;
2855ea2384d3Sbellard }
2856ea2384d3Sbellard 
2857c8433287SMarkus Armbruster int bdrv_get_flags(BlockDriverState *bs)
2858c8433287SMarkus Armbruster {
2859c8433287SMarkus Armbruster     return bs->open_flags;
2860c8433287SMarkus Armbruster }
2861c8433287SMarkus Armbruster 
2862c6ca28d6Saliguori void bdrv_flush_all(void)
2863c6ca28d6Saliguori {
2864c6ca28d6Saliguori     BlockDriverState *bs;
2865c6ca28d6Saliguori 
28661b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
2867c6ca28d6Saliguori         bdrv_flush(bs);
2868c6ca28d6Saliguori     }
28691b7bdbc1SStefan Hajnoczi }
2870c6ca28d6Saliguori 
2871f2feebbdSKevin Wolf int bdrv_has_zero_init(BlockDriverState *bs)
2872f2feebbdSKevin Wolf {
2873f2feebbdSKevin Wolf     assert(bs->drv);
2874f2feebbdSKevin Wolf 
2875336c1c12SKevin Wolf     if (bs->drv->bdrv_has_zero_init) {
2876336c1c12SKevin Wolf         return bs->drv->bdrv_has_zero_init(bs);
2877f2feebbdSKevin Wolf     }
2878f2feebbdSKevin Wolf 
2879f2feebbdSKevin Wolf     return 1;
2880f2feebbdSKevin Wolf }
2881f2feebbdSKevin Wolf 
2882376ae3f1SStefan Hajnoczi typedef struct BdrvCoIsAllocatedData {
2883376ae3f1SStefan Hajnoczi     BlockDriverState *bs;
2884b35b2bbaSMiroslav Rezanina     BlockDriverState *base;
2885376ae3f1SStefan Hajnoczi     int64_t sector_num;
2886376ae3f1SStefan Hajnoczi     int nb_sectors;
2887376ae3f1SStefan Hajnoczi     int *pnum;
2888376ae3f1SStefan Hajnoczi     int ret;
2889376ae3f1SStefan Hajnoczi     bool done;
2890376ae3f1SStefan Hajnoczi } BdrvCoIsAllocatedData;
2891376ae3f1SStefan Hajnoczi 
2892f58c7b35Sths /*
2893f58c7b35Sths  * Returns true iff the specified sector is present in the disk image. Drivers
2894f58c7b35Sths  * not implementing the functionality are assumed to not support backing files,
2895f58c7b35Sths  * hence all their sectors are reported as allocated.
2896f58c7b35Sths  *
2897bd9533e3SStefan Hajnoczi  * If 'sector_num' is beyond the end of the disk image the return value is 0
2898bd9533e3SStefan Hajnoczi  * and 'pnum' is set to 0.
2899bd9533e3SStefan Hajnoczi  *
2900f58c7b35Sths  * 'pnum' is set to the number of sectors (including and immediately following
2901f58c7b35Sths  * the specified sector) that are known to be in the same
2902f58c7b35Sths  * allocated/unallocated state.
2903f58c7b35Sths  *
2904bd9533e3SStefan Hajnoczi  * 'nb_sectors' is the max value 'pnum' should be set to.  If nb_sectors goes
2905bd9533e3SStefan Hajnoczi  * beyond the end of the disk image it will be clamped.
2906f58c7b35Sths  */
2907060f51c9SStefan Hajnoczi int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
2908060f51c9SStefan Hajnoczi                                       int nb_sectors, int *pnum)
2909f58c7b35Sths {
2910f58c7b35Sths     int64_t n;
2911bd9533e3SStefan Hajnoczi 
29126aebab14SStefan Hajnoczi     if (sector_num >= bs->total_sectors) {
29136aebab14SStefan Hajnoczi         *pnum = 0;
29146aebab14SStefan Hajnoczi         return 0;
29156aebab14SStefan Hajnoczi     }
2916bd9533e3SStefan Hajnoczi 
29176aebab14SStefan Hajnoczi     n = bs->total_sectors - sector_num;
2918bd9533e3SStefan Hajnoczi     if (n < nb_sectors) {
2919bd9533e3SStefan Hajnoczi         nb_sectors = n;
2920bd9533e3SStefan Hajnoczi     }
2921bd9533e3SStefan Hajnoczi 
2922bd9533e3SStefan Hajnoczi     if (!bs->drv->bdrv_co_is_allocated) {
2923bd9533e3SStefan Hajnoczi         *pnum = nb_sectors;
29246aebab14SStefan Hajnoczi         return 1;
29256aebab14SStefan Hajnoczi     }
29266aebab14SStefan Hajnoczi 
2927060f51c9SStefan Hajnoczi     return bs->drv->bdrv_co_is_allocated(bs, sector_num, nb_sectors, pnum);
2928060f51c9SStefan Hajnoczi }
2929060f51c9SStefan Hajnoczi 
2930060f51c9SStefan Hajnoczi /* Coroutine wrapper for bdrv_is_allocated() */
2931060f51c9SStefan Hajnoczi static void coroutine_fn bdrv_is_allocated_co_entry(void *opaque)
2932060f51c9SStefan Hajnoczi {
2933060f51c9SStefan Hajnoczi     BdrvCoIsAllocatedData *data = opaque;
2934060f51c9SStefan Hajnoczi     BlockDriverState *bs = data->bs;
2935060f51c9SStefan Hajnoczi 
2936060f51c9SStefan Hajnoczi     data->ret = bdrv_co_is_allocated(bs, data->sector_num, data->nb_sectors,
2937060f51c9SStefan Hajnoczi                                      data->pnum);
2938060f51c9SStefan Hajnoczi     data->done = true;
2939060f51c9SStefan Hajnoczi }
2940060f51c9SStefan Hajnoczi 
2941060f51c9SStefan Hajnoczi /*
2942060f51c9SStefan Hajnoczi  * Synchronous wrapper around bdrv_co_is_allocated().
2943060f51c9SStefan Hajnoczi  *
2944060f51c9SStefan Hajnoczi  * See bdrv_co_is_allocated() for details.
2945060f51c9SStefan Hajnoczi  */
2946060f51c9SStefan Hajnoczi int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
2947060f51c9SStefan Hajnoczi                       int *pnum)
2948060f51c9SStefan Hajnoczi {
2949376ae3f1SStefan Hajnoczi     Coroutine *co;
2950376ae3f1SStefan Hajnoczi     BdrvCoIsAllocatedData data = {
2951376ae3f1SStefan Hajnoczi         .bs = bs,
2952376ae3f1SStefan Hajnoczi         .sector_num = sector_num,
2953376ae3f1SStefan Hajnoczi         .nb_sectors = nb_sectors,
2954376ae3f1SStefan Hajnoczi         .pnum = pnum,
2955376ae3f1SStefan Hajnoczi         .done = false,
2956376ae3f1SStefan Hajnoczi     };
2957376ae3f1SStefan Hajnoczi 
2958376ae3f1SStefan Hajnoczi     co = qemu_coroutine_create(bdrv_is_allocated_co_entry);
2959376ae3f1SStefan Hajnoczi     qemu_coroutine_enter(co, &data);
2960376ae3f1SStefan Hajnoczi     while (!data.done) {
2961376ae3f1SStefan Hajnoczi         qemu_aio_wait();
2962376ae3f1SStefan Hajnoczi     }
2963376ae3f1SStefan Hajnoczi     return data.ret;
2964376ae3f1SStefan Hajnoczi }
2965f58c7b35Sths 
2966188a7bbfSPaolo Bonzini /*
2967188a7bbfSPaolo Bonzini  * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
2968188a7bbfSPaolo Bonzini  *
2969188a7bbfSPaolo Bonzini  * Return true if the given sector is allocated in any image between
2970188a7bbfSPaolo Bonzini  * BASE and TOP (inclusive).  BASE can be NULL to check if the given
2971188a7bbfSPaolo Bonzini  * sector is allocated in any image of the chain.  Return false otherwise.
2972188a7bbfSPaolo Bonzini  *
2973188a7bbfSPaolo Bonzini  * 'pnum' is set to the number of sectors (including and immediately following
2974188a7bbfSPaolo Bonzini  *  the specified sector) that are known to be in the same
2975188a7bbfSPaolo Bonzini  *  allocated/unallocated state.
2976188a7bbfSPaolo Bonzini  *
2977188a7bbfSPaolo Bonzini  */
2978188a7bbfSPaolo Bonzini int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
2979188a7bbfSPaolo Bonzini                                             BlockDriverState *base,
2980188a7bbfSPaolo Bonzini                                             int64_t sector_num,
2981188a7bbfSPaolo Bonzini                                             int nb_sectors, int *pnum)
2982188a7bbfSPaolo Bonzini {
2983188a7bbfSPaolo Bonzini     BlockDriverState *intermediate;
2984188a7bbfSPaolo Bonzini     int ret, n = nb_sectors;
2985188a7bbfSPaolo Bonzini 
2986188a7bbfSPaolo Bonzini     intermediate = top;
2987188a7bbfSPaolo Bonzini     while (intermediate && intermediate != base) {
2988188a7bbfSPaolo Bonzini         int pnum_inter;
2989188a7bbfSPaolo Bonzini         ret = bdrv_co_is_allocated(intermediate, sector_num, nb_sectors,
2990188a7bbfSPaolo Bonzini                                    &pnum_inter);
2991188a7bbfSPaolo Bonzini         if (ret < 0) {
2992188a7bbfSPaolo Bonzini             return ret;
2993188a7bbfSPaolo Bonzini         } else if (ret) {
2994188a7bbfSPaolo Bonzini             *pnum = pnum_inter;
2995188a7bbfSPaolo Bonzini             return 1;
2996188a7bbfSPaolo Bonzini         }
2997188a7bbfSPaolo Bonzini 
2998188a7bbfSPaolo Bonzini         /*
2999188a7bbfSPaolo Bonzini          * [sector_num, nb_sectors] is unallocated on top but intermediate
3000188a7bbfSPaolo Bonzini          * might have
3001188a7bbfSPaolo Bonzini          *
3002188a7bbfSPaolo Bonzini          * [sector_num+x, nr_sectors] allocated.
3003188a7bbfSPaolo Bonzini          */
300463ba17d3SVishvananda Ishaya         if (n > pnum_inter &&
300563ba17d3SVishvananda Ishaya             (intermediate == top ||
300663ba17d3SVishvananda Ishaya              sector_num + pnum_inter < intermediate->total_sectors)) {
3007188a7bbfSPaolo Bonzini             n = pnum_inter;
3008188a7bbfSPaolo Bonzini         }
3009188a7bbfSPaolo Bonzini 
3010188a7bbfSPaolo Bonzini         intermediate = intermediate->backing_hd;
3011188a7bbfSPaolo Bonzini     }
3012188a7bbfSPaolo Bonzini 
3013188a7bbfSPaolo Bonzini     *pnum = n;
3014188a7bbfSPaolo Bonzini     return 0;
3015188a7bbfSPaolo Bonzini }
3016188a7bbfSPaolo Bonzini 
3017b35b2bbaSMiroslav Rezanina /* Coroutine wrapper for bdrv_is_allocated_above() */
3018b35b2bbaSMiroslav Rezanina static void coroutine_fn bdrv_is_allocated_above_co_entry(void *opaque)
3019b35b2bbaSMiroslav Rezanina {
3020b35b2bbaSMiroslav Rezanina     BdrvCoIsAllocatedData *data = opaque;
3021b35b2bbaSMiroslav Rezanina     BlockDriverState *top = data->bs;
3022b35b2bbaSMiroslav Rezanina     BlockDriverState *base = data->base;
3023b35b2bbaSMiroslav Rezanina 
3024b35b2bbaSMiroslav Rezanina     data->ret = bdrv_co_is_allocated_above(top, base, data->sector_num,
3025b35b2bbaSMiroslav Rezanina                                            data->nb_sectors, data->pnum);
3026b35b2bbaSMiroslav Rezanina     data->done = true;
3027b35b2bbaSMiroslav Rezanina }
3028b35b2bbaSMiroslav Rezanina 
3029b35b2bbaSMiroslav Rezanina /*
3030b35b2bbaSMiroslav Rezanina  * Synchronous wrapper around bdrv_co_is_allocated_above().
3031b35b2bbaSMiroslav Rezanina  *
3032b35b2bbaSMiroslav Rezanina  * See bdrv_co_is_allocated_above() for details.
3033b35b2bbaSMiroslav Rezanina  */
3034b35b2bbaSMiroslav Rezanina int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
3035b35b2bbaSMiroslav Rezanina                             int64_t sector_num, int nb_sectors, int *pnum)
3036b35b2bbaSMiroslav Rezanina {
3037b35b2bbaSMiroslav Rezanina     Coroutine *co;
3038b35b2bbaSMiroslav Rezanina     BdrvCoIsAllocatedData data = {
3039b35b2bbaSMiroslav Rezanina         .bs = top,
3040b35b2bbaSMiroslav Rezanina         .base = base,
3041b35b2bbaSMiroslav Rezanina         .sector_num = sector_num,
3042b35b2bbaSMiroslav Rezanina         .nb_sectors = nb_sectors,
3043b35b2bbaSMiroslav Rezanina         .pnum = pnum,
3044b35b2bbaSMiroslav Rezanina         .done = false,
3045b35b2bbaSMiroslav Rezanina     };
3046b35b2bbaSMiroslav Rezanina 
3047b35b2bbaSMiroslav Rezanina     co = qemu_coroutine_create(bdrv_is_allocated_above_co_entry);
3048b35b2bbaSMiroslav Rezanina     qemu_coroutine_enter(co, &data);
3049b35b2bbaSMiroslav Rezanina     while (!data.done) {
3050b35b2bbaSMiroslav Rezanina         qemu_aio_wait();
3051b35b2bbaSMiroslav Rezanina     }
3052b35b2bbaSMiroslav Rezanina     return data.ret;
3053b35b2bbaSMiroslav Rezanina }
3054b35b2bbaSMiroslav Rezanina 
3055ac84adacSPaolo Bonzini BlockInfo *bdrv_query_info(BlockDriverState *bs)
3056ac84adacSPaolo Bonzini {
3057ac84adacSPaolo Bonzini     BlockInfo *info = g_malloc0(sizeof(*info));
3058ac84adacSPaolo Bonzini     info->device = g_strdup(bs->device_name);
3059ac84adacSPaolo Bonzini     info->type = g_strdup("unknown");
3060ac84adacSPaolo Bonzini     info->locked = bdrv_dev_is_medium_locked(bs);
3061ac84adacSPaolo Bonzini     info->removable = bdrv_dev_has_removable_media(bs);
3062ac84adacSPaolo Bonzini 
3063ac84adacSPaolo Bonzini     if (bdrv_dev_has_removable_media(bs)) {
3064ac84adacSPaolo Bonzini         info->has_tray_open = true;
3065ac84adacSPaolo Bonzini         info->tray_open = bdrv_dev_is_tray_open(bs);
3066ac84adacSPaolo Bonzini     }
3067ac84adacSPaolo Bonzini 
3068ac84adacSPaolo Bonzini     if (bdrv_iostatus_is_enabled(bs)) {
3069ac84adacSPaolo Bonzini         info->has_io_status = true;
3070ac84adacSPaolo Bonzini         info->io_status = bs->iostatus;
3071ac84adacSPaolo Bonzini     }
3072ac84adacSPaolo Bonzini 
3073b9a9b3a4SPaolo Bonzini     if (bs->dirty_bitmap) {
3074b9a9b3a4SPaolo Bonzini         info->has_dirty = true;
3075b9a9b3a4SPaolo Bonzini         info->dirty = g_malloc0(sizeof(*info->dirty));
3076acc906c6SPaolo Bonzini         info->dirty->count = bdrv_get_dirty_count(bs) * BDRV_SECTOR_SIZE;
307750717e94SPaolo Bonzini         info->dirty->granularity =
307850717e94SPaolo Bonzini             ((int64_t) BDRV_SECTOR_SIZE << hbitmap_granularity(bs->dirty_bitmap));
3079b9a9b3a4SPaolo Bonzini     }
3080b9a9b3a4SPaolo Bonzini 
3081ac84adacSPaolo Bonzini     if (bs->drv) {
3082ac84adacSPaolo Bonzini         info->has_inserted = true;
3083ac84adacSPaolo Bonzini         info->inserted = g_malloc0(sizeof(*info->inserted));
3084ac84adacSPaolo Bonzini         info->inserted->file = g_strdup(bs->filename);
3085ac84adacSPaolo Bonzini         info->inserted->ro = bs->read_only;
3086ac84adacSPaolo Bonzini         info->inserted->drv = g_strdup(bs->drv->format_name);
3087ac84adacSPaolo Bonzini         info->inserted->encrypted = bs->encrypted;
3088ac84adacSPaolo Bonzini         info->inserted->encryption_key_missing = bdrv_key_required(bs);
3089ac84adacSPaolo Bonzini 
3090ac84adacSPaolo Bonzini         if (bs->backing_file[0]) {
3091ac84adacSPaolo Bonzini             info->inserted->has_backing_file = true;
3092ac84adacSPaolo Bonzini             info->inserted->backing_file = g_strdup(bs->backing_file);
3093ac84adacSPaolo Bonzini         }
3094ac84adacSPaolo Bonzini 
3095ac84adacSPaolo Bonzini         info->inserted->backing_file_depth = bdrv_get_backing_file_depth(bs);
3096ac84adacSPaolo Bonzini 
3097ac84adacSPaolo Bonzini         if (bs->io_limits_enabled) {
3098ac84adacSPaolo Bonzini             info->inserted->bps =
3099ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
3100ac84adacSPaolo Bonzini             info->inserted->bps_rd =
3101ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_READ];
3102ac84adacSPaolo Bonzini             info->inserted->bps_wr =
3103ac84adacSPaolo Bonzini                            bs->io_limits.bps[BLOCK_IO_LIMIT_WRITE];
3104ac84adacSPaolo Bonzini             info->inserted->iops =
3105ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
3106ac84adacSPaolo Bonzini             info->inserted->iops_rd =
3107ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_READ];
3108ac84adacSPaolo Bonzini             info->inserted->iops_wr =
3109ac84adacSPaolo Bonzini                            bs->io_limits.iops[BLOCK_IO_LIMIT_WRITE];
3110ac84adacSPaolo Bonzini         }
3111ac84adacSPaolo Bonzini     }
3112ac84adacSPaolo Bonzini     return info;
3113ac84adacSPaolo Bonzini }
3114ac84adacSPaolo Bonzini 
3115b2023818SLuiz Capitulino BlockInfoList *qmp_query_block(Error **errp)
3116b338082bSbellard {
3117ac84adacSPaolo Bonzini     BlockInfoList *head = NULL, **p_next = &head;
3118d15e5465SLuiz Capitulino     BlockDriverState *bs;
3119d15e5465SLuiz Capitulino 
31201b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
3121b2023818SLuiz Capitulino         BlockInfoList *info = g_malloc0(sizeof(*info));
3122ac84adacSPaolo Bonzini         info->value = bdrv_query_info(bs);
3123d15e5465SLuiz Capitulino 
3124ac84adacSPaolo Bonzini         *p_next = info;
3125ac84adacSPaolo Bonzini         p_next = &info->next;
3126d15e5465SLuiz Capitulino     }
3127d15e5465SLuiz Capitulino 
3128b2023818SLuiz Capitulino     return head;
3129b338082bSbellard }
3130a36e69ddSths 
31319887b616SPaolo Bonzini BlockStats *bdrv_query_stats(const BlockDriverState *bs)
3132a36e69ddSths {
3133f11f57e4SLuiz Capitulino     BlockStats *s;
3134218a536aSLuiz Capitulino 
3135f11f57e4SLuiz Capitulino     s = g_malloc0(sizeof(*s));
3136218a536aSLuiz Capitulino 
3137f11f57e4SLuiz Capitulino     if (bs->device_name[0]) {
3138f11f57e4SLuiz Capitulino         s->has_device = true;
3139f11f57e4SLuiz Capitulino         s->device = g_strdup(bs->device_name);
3140218a536aSLuiz Capitulino     }
3141218a536aSLuiz Capitulino 
3142f11f57e4SLuiz Capitulino     s->stats = g_malloc0(sizeof(*s->stats));
3143f11f57e4SLuiz Capitulino     s->stats->rd_bytes = bs->nr_bytes[BDRV_ACCT_READ];
3144f11f57e4SLuiz Capitulino     s->stats->wr_bytes = bs->nr_bytes[BDRV_ACCT_WRITE];
3145f11f57e4SLuiz Capitulino     s->stats->rd_operations = bs->nr_ops[BDRV_ACCT_READ];
3146f11f57e4SLuiz Capitulino     s->stats->wr_operations = bs->nr_ops[BDRV_ACCT_WRITE];
3147f11f57e4SLuiz Capitulino     s->stats->wr_highest_offset = bs->wr_highest_sector * BDRV_SECTOR_SIZE;
3148f11f57e4SLuiz Capitulino     s->stats->flush_operations = bs->nr_ops[BDRV_ACCT_FLUSH];
3149f11f57e4SLuiz Capitulino     s->stats->wr_total_time_ns = bs->total_time_ns[BDRV_ACCT_WRITE];
3150f11f57e4SLuiz Capitulino     s->stats->rd_total_time_ns = bs->total_time_ns[BDRV_ACCT_READ];
3151f11f57e4SLuiz Capitulino     s->stats->flush_total_time_ns = bs->total_time_ns[BDRV_ACCT_FLUSH];
3152294cc35fSKevin Wolf 
3153294cc35fSKevin Wolf     if (bs->file) {
3154f11f57e4SLuiz Capitulino         s->has_parent = true;
31559887b616SPaolo Bonzini         s->parent = bdrv_query_stats(bs->file);
3156294cc35fSKevin Wolf     }
3157294cc35fSKevin Wolf 
3158f11f57e4SLuiz Capitulino     return s;
3159294cc35fSKevin Wolf }
3160294cc35fSKevin Wolf 
3161f11f57e4SLuiz Capitulino BlockStatsList *qmp_query_blockstats(Error **errp)
3162218a536aSLuiz Capitulino {
31639887b616SPaolo Bonzini     BlockStatsList *head = NULL, **p_next = &head;
3164a36e69ddSths     BlockDriverState *bs;
3165a36e69ddSths 
31661b7bdbc1SStefan Hajnoczi     QTAILQ_FOREACH(bs, &bdrv_states, list) {
3167f11f57e4SLuiz Capitulino         BlockStatsList *info = g_malloc0(sizeof(*info));
31689887b616SPaolo Bonzini         info->value = bdrv_query_stats(bs);
3169f11f57e4SLuiz Capitulino 
31709887b616SPaolo Bonzini         *p_next = info;
31719887b616SPaolo Bonzini         p_next = &info->next;
3172a36e69ddSths     }
3173218a536aSLuiz Capitulino 
3174f11f57e4SLuiz Capitulino     return head;
3175a36e69ddSths }
3176ea2384d3Sbellard 
3177045df330Saliguori const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
3178045df330Saliguori {
3179045df330Saliguori     if (bs->backing_hd && bs->backing_hd->encrypted)
3180045df330Saliguori         return bs->backing_file;
3181045df330Saliguori     else if (bs->encrypted)
3182045df330Saliguori         return bs->filename;
3183045df330Saliguori     else
3184045df330Saliguori         return NULL;
3185045df330Saliguori }
3186045df330Saliguori 
318783f64091Sbellard void bdrv_get_backing_filename(BlockDriverState *bs,
318883f64091Sbellard                                char *filename, int filename_size)
318983f64091Sbellard {
319083f64091Sbellard     pstrcpy(filename, filename_size, bs->backing_file);
319183f64091Sbellard }
319283f64091Sbellard 
3193faea38e7Sbellard int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
3194faea38e7Sbellard                           const uint8_t *buf, int nb_sectors)
3195faea38e7Sbellard {
3196faea38e7Sbellard     BlockDriver *drv = bs->drv;
3197faea38e7Sbellard     if (!drv)
319819cb3738Sbellard         return -ENOMEDIUM;
3199faea38e7Sbellard     if (!drv->bdrv_write_compressed)
3200faea38e7Sbellard         return -ENOTSUP;
3201fbb7b4e0SKevin Wolf     if (bdrv_check_request(bs, sector_num, nb_sectors))
3202fbb7b4e0SKevin Wolf         return -EIO;
32037cd1e32aSlirans@il.ibm.com 
32041755da16SPaolo Bonzini     assert(!bs->dirty_bitmap);
32057cd1e32aSlirans@il.ibm.com 
3206faea38e7Sbellard     return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
3207faea38e7Sbellard }
3208faea38e7Sbellard 
3209faea38e7Sbellard int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
3210faea38e7Sbellard {
3211faea38e7Sbellard     BlockDriver *drv = bs->drv;
3212faea38e7Sbellard     if (!drv)
321319cb3738Sbellard         return -ENOMEDIUM;
3214faea38e7Sbellard     if (!drv->bdrv_get_info)
3215faea38e7Sbellard         return -ENOTSUP;
3216faea38e7Sbellard     memset(bdi, 0, sizeof(*bdi));
3217faea38e7Sbellard     return drv->bdrv_get_info(bs, bdi);
3218faea38e7Sbellard }
3219faea38e7Sbellard 
322045566e9cSChristoph Hellwig int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
322145566e9cSChristoph Hellwig                       int64_t pos, int size)
3222178e08a5Saliguori {
3223cf8074b3SKevin Wolf     QEMUIOVector qiov;
3224cf8074b3SKevin Wolf     struct iovec iov = {
3225cf8074b3SKevin Wolf         .iov_base   = (void *) buf,
3226cf8074b3SKevin Wolf         .iov_len    = size,
3227cf8074b3SKevin Wolf     };
3228cf8074b3SKevin Wolf 
3229cf8074b3SKevin Wolf     qemu_iovec_init_external(&qiov, &iov, 1);
3230cf8074b3SKevin Wolf     return bdrv_writev_vmstate(bs, &qiov, pos);
3231cf8074b3SKevin Wolf }
3232cf8074b3SKevin Wolf 
3233cf8074b3SKevin Wolf int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
3234cf8074b3SKevin Wolf {
3235178e08a5Saliguori     BlockDriver *drv = bs->drv;
3236cf8074b3SKevin Wolf 
3237cf8074b3SKevin Wolf     if (!drv) {
3238178e08a5Saliguori         return -ENOMEDIUM;
3239cf8074b3SKevin Wolf     } else if (drv->bdrv_save_vmstate) {
3240cf8074b3SKevin Wolf         return drv->bdrv_save_vmstate(bs, qiov, pos);
3241cf8074b3SKevin Wolf     } else if (bs->file) {
3242cf8074b3SKevin Wolf         return bdrv_writev_vmstate(bs->file, qiov, pos);
3243cf8074b3SKevin Wolf     }
3244cf8074b3SKevin Wolf 
32457cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3246178e08a5Saliguori }
3247178e08a5Saliguori 
324845566e9cSChristoph Hellwig int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
324945566e9cSChristoph Hellwig                       int64_t pos, int size)
3250178e08a5Saliguori {
3251178e08a5Saliguori     BlockDriver *drv = bs->drv;
3252178e08a5Saliguori     if (!drv)
3253178e08a5Saliguori         return -ENOMEDIUM;
32547cdb1f6dSMORITA Kazutaka     if (drv->bdrv_load_vmstate)
325545566e9cSChristoph Hellwig         return drv->bdrv_load_vmstate(bs, buf, pos, size);
32567cdb1f6dSMORITA Kazutaka     if (bs->file)
32577cdb1f6dSMORITA Kazutaka         return bdrv_load_vmstate(bs->file, buf, pos, size);
32587cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3259178e08a5Saliguori }
3260178e08a5Saliguori 
32618b9b0cc2SKevin Wolf void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
32628b9b0cc2SKevin Wolf {
32638b9b0cc2SKevin Wolf     BlockDriver *drv = bs->drv;
32648b9b0cc2SKevin Wolf 
32658b9b0cc2SKevin Wolf     if (!drv || !drv->bdrv_debug_event) {
32668b9b0cc2SKevin Wolf         return;
32678b9b0cc2SKevin Wolf     }
32688b9b0cc2SKevin Wolf 
32690ed8b6f6SBlue Swirl     drv->bdrv_debug_event(bs, event);
327041c695c7SKevin Wolf }
32718b9b0cc2SKevin Wolf 
327241c695c7SKevin Wolf int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
327341c695c7SKevin Wolf                           const char *tag)
327441c695c7SKevin Wolf {
327541c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) {
327641c695c7SKevin Wolf         bs = bs->file;
327741c695c7SKevin Wolf     }
327841c695c7SKevin Wolf 
327941c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) {
328041c695c7SKevin Wolf         return bs->drv->bdrv_debug_breakpoint(bs, event, tag);
328141c695c7SKevin Wolf     }
328241c695c7SKevin Wolf 
328341c695c7SKevin Wolf     return -ENOTSUP;
328441c695c7SKevin Wolf }
328541c695c7SKevin Wolf 
328641c695c7SKevin Wolf int bdrv_debug_resume(BlockDriverState *bs, const char *tag)
328741c695c7SKevin Wolf {
328841c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_resume) {
328941c695c7SKevin Wolf         bs = bs->file;
329041c695c7SKevin Wolf     }
329141c695c7SKevin Wolf 
329241c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_resume) {
329341c695c7SKevin Wolf         return bs->drv->bdrv_debug_resume(bs, tag);
329441c695c7SKevin Wolf     }
329541c695c7SKevin Wolf 
329641c695c7SKevin Wolf     return -ENOTSUP;
329741c695c7SKevin Wolf }
329841c695c7SKevin Wolf 
329941c695c7SKevin Wolf bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag)
330041c695c7SKevin Wolf {
330141c695c7SKevin Wolf     while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) {
330241c695c7SKevin Wolf         bs = bs->file;
330341c695c7SKevin Wolf     }
330441c695c7SKevin Wolf 
330541c695c7SKevin Wolf     if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) {
330641c695c7SKevin Wolf         return bs->drv->bdrv_debug_is_suspended(bs, tag);
330741c695c7SKevin Wolf     }
330841c695c7SKevin Wolf 
330941c695c7SKevin Wolf     return false;
33108b9b0cc2SKevin Wolf }
33118b9b0cc2SKevin Wolf 
3312faea38e7Sbellard /**************************************************************/
3313faea38e7Sbellard /* handling of snapshots */
3314faea38e7Sbellard 
3315feeee5acSMiguel Di Ciurcio Filho int bdrv_can_snapshot(BlockDriverState *bs)
3316feeee5acSMiguel Di Ciurcio Filho {
3317feeee5acSMiguel Di Ciurcio Filho     BlockDriver *drv = bs->drv;
331807b70bfbSMarkus Armbruster     if (!drv || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
3319feeee5acSMiguel Di Ciurcio Filho         return 0;
3320feeee5acSMiguel Di Ciurcio Filho     }
3321feeee5acSMiguel Di Ciurcio Filho 
3322feeee5acSMiguel Di Ciurcio Filho     if (!drv->bdrv_snapshot_create) {
3323feeee5acSMiguel Di Ciurcio Filho         if (bs->file != NULL) {
3324feeee5acSMiguel Di Ciurcio Filho             return bdrv_can_snapshot(bs->file);
3325feeee5acSMiguel Di Ciurcio Filho         }
3326feeee5acSMiguel Di Ciurcio Filho         return 0;
3327feeee5acSMiguel Di Ciurcio Filho     }
3328feeee5acSMiguel Di Ciurcio Filho 
3329feeee5acSMiguel Di Ciurcio Filho     return 1;
3330feeee5acSMiguel Di Ciurcio Filho }
3331feeee5acSMiguel Di Ciurcio Filho 
3332199630b6SBlue Swirl int bdrv_is_snapshot(BlockDriverState *bs)
3333199630b6SBlue Swirl {
3334199630b6SBlue Swirl     return !!(bs->open_flags & BDRV_O_SNAPSHOT);
3335199630b6SBlue Swirl }
3336199630b6SBlue Swirl 
3337f9092b10SMarkus Armbruster BlockDriverState *bdrv_snapshots(void)
3338f9092b10SMarkus Armbruster {
3339f9092b10SMarkus Armbruster     BlockDriverState *bs;
3340f9092b10SMarkus Armbruster 
33413ac906f7SMarkus Armbruster     if (bs_snapshots) {
3342f9092b10SMarkus Armbruster         return bs_snapshots;
33433ac906f7SMarkus Armbruster     }
3344f9092b10SMarkus Armbruster 
3345f9092b10SMarkus Armbruster     bs = NULL;
3346f9092b10SMarkus Armbruster     while ((bs = bdrv_next(bs))) {
3347f9092b10SMarkus Armbruster         if (bdrv_can_snapshot(bs)) {
33483ac906f7SMarkus Armbruster             bs_snapshots = bs;
33493ac906f7SMarkus Armbruster             return bs;
3350f9092b10SMarkus Armbruster         }
3351f9092b10SMarkus Armbruster     }
3352f9092b10SMarkus Armbruster     return NULL;
3353f9092b10SMarkus Armbruster }
3354f9092b10SMarkus Armbruster 
3355faea38e7Sbellard int bdrv_snapshot_create(BlockDriverState *bs,
3356faea38e7Sbellard                          QEMUSnapshotInfo *sn_info)
3357faea38e7Sbellard {
3358faea38e7Sbellard     BlockDriver *drv = bs->drv;
3359faea38e7Sbellard     if (!drv)
336019cb3738Sbellard         return -ENOMEDIUM;
33617cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_create)
3362faea38e7Sbellard         return drv->bdrv_snapshot_create(bs, sn_info);
33637cdb1f6dSMORITA Kazutaka     if (bs->file)
33647cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_create(bs->file, sn_info);
33657cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3366faea38e7Sbellard }
3367faea38e7Sbellard 
3368faea38e7Sbellard int bdrv_snapshot_goto(BlockDriverState *bs,
3369faea38e7Sbellard                        const char *snapshot_id)
3370faea38e7Sbellard {
3371faea38e7Sbellard     BlockDriver *drv = bs->drv;
33727cdb1f6dSMORITA Kazutaka     int ret, open_ret;
33737cdb1f6dSMORITA Kazutaka 
3374faea38e7Sbellard     if (!drv)
337519cb3738Sbellard         return -ENOMEDIUM;
33767cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_goto)
3377faea38e7Sbellard         return drv->bdrv_snapshot_goto(bs, snapshot_id);
33787cdb1f6dSMORITA Kazutaka 
33797cdb1f6dSMORITA Kazutaka     if (bs->file) {
33807cdb1f6dSMORITA Kazutaka         drv->bdrv_close(bs);
33817cdb1f6dSMORITA Kazutaka         ret = bdrv_snapshot_goto(bs->file, snapshot_id);
33821a86938fSKevin Wolf         open_ret = drv->bdrv_open(bs, NULL, bs->open_flags);
33837cdb1f6dSMORITA Kazutaka         if (open_ret < 0) {
33847cdb1f6dSMORITA Kazutaka             bdrv_delete(bs->file);
33857cdb1f6dSMORITA Kazutaka             bs->drv = NULL;
33867cdb1f6dSMORITA Kazutaka             return open_ret;
33877cdb1f6dSMORITA Kazutaka         }
33887cdb1f6dSMORITA Kazutaka         return ret;
33897cdb1f6dSMORITA Kazutaka     }
33907cdb1f6dSMORITA Kazutaka 
33917cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3392faea38e7Sbellard }
3393faea38e7Sbellard 
3394faea38e7Sbellard int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
3395faea38e7Sbellard {
3396faea38e7Sbellard     BlockDriver *drv = bs->drv;
3397faea38e7Sbellard     if (!drv)
339819cb3738Sbellard         return -ENOMEDIUM;
33997cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_delete)
3400faea38e7Sbellard         return drv->bdrv_snapshot_delete(bs, snapshot_id);
34017cdb1f6dSMORITA Kazutaka     if (bs->file)
34027cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_delete(bs->file, snapshot_id);
34037cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3404faea38e7Sbellard }
3405faea38e7Sbellard 
3406faea38e7Sbellard int bdrv_snapshot_list(BlockDriverState *bs,
3407faea38e7Sbellard                        QEMUSnapshotInfo **psn_info)
3408faea38e7Sbellard {
3409faea38e7Sbellard     BlockDriver *drv = bs->drv;
3410faea38e7Sbellard     if (!drv)
341119cb3738Sbellard         return -ENOMEDIUM;
34127cdb1f6dSMORITA Kazutaka     if (drv->bdrv_snapshot_list)
3413faea38e7Sbellard         return drv->bdrv_snapshot_list(bs, psn_info);
34147cdb1f6dSMORITA Kazutaka     if (bs->file)
34157cdb1f6dSMORITA Kazutaka         return bdrv_snapshot_list(bs->file, psn_info);
34167cdb1f6dSMORITA Kazutaka     return -ENOTSUP;
3417faea38e7Sbellard }
3418faea38e7Sbellard 
341951ef6727Sedison int bdrv_snapshot_load_tmp(BlockDriverState *bs,
342051ef6727Sedison         const char *snapshot_name)
342151ef6727Sedison {
342251ef6727Sedison     BlockDriver *drv = bs->drv;
342351ef6727Sedison     if (!drv) {
342451ef6727Sedison         return -ENOMEDIUM;
342551ef6727Sedison     }
342651ef6727Sedison     if (!bs->read_only) {
342751ef6727Sedison         return -EINVAL;
342851ef6727Sedison     }
342951ef6727Sedison     if (drv->bdrv_snapshot_load_tmp) {
343051ef6727Sedison         return drv->bdrv_snapshot_load_tmp(bs, snapshot_name);
343151ef6727Sedison     }
343251ef6727Sedison     return -ENOTSUP;
343351ef6727Sedison }
343451ef6727Sedison 
3435b1b1d783SJeff Cody /* backing_file can either be relative, or absolute, or a protocol.  If it is
3436b1b1d783SJeff Cody  * relative, it must be relative to the chain.  So, passing in bs->filename
3437b1b1d783SJeff Cody  * from a BDS as backing_file should not be done, as that may be relative to
3438b1b1d783SJeff Cody  * the CWD rather than the chain. */
3439e8a6bb9cSMarcelo Tosatti BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
3440e8a6bb9cSMarcelo Tosatti         const char *backing_file)
3441e8a6bb9cSMarcelo Tosatti {
3442b1b1d783SJeff Cody     char *filename_full = NULL;
3443b1b1d783SJeff Cody     char *backing_file_full = NULL;
3444b1b1d783SJeff Cody     char *filename_tmp = NULL;
3445b1b1d783SJeff Cody     int is_protocol = 0;
3446b1b1d783SJeff Cody     BlockDriverState *curr_bs = NULL;
3447b1b1d783SJeff Cody     BlockDriverState *retval = NULL;
3448b1b1d783SJeff Cody 
3449b1b1d783SJeff Cody     if (!bs || !bs->drv || !backing_file) {
3450e8a6bb9cSMarcelo Tosatti         return NULL;
3451e8a6bb9cSMarcelo Tosatti     }
3452e8a6bb9cSMarcelo Tosatti 
3453b1b1d783SJeff Cody     filename_full     = g_malloc(PATH_MAX);
3454b1b1d783SJeff Cody     backing_file_full = g_malloc(PATH_MAX);
3455b1b1d783SJeff Cody     filename_tmp      = g_malloc(PATH_MAX);
3456b1b1d783SJeff Cody 
3457b1b1d783SJeff Cody     is_protocol = path_has_protocol(backing_file);
3458b1b1d783SJeff Cody 
3459b1b1d783SJeff Cody     for (curr_bs = bs; curr_bs->backing_hd; curr_bs = curr_bs->backing_hd) {
3460b1b1d783SJeff Cody 
3461b1b1d783SJeff Cody         /* If either of the filename paths is actually a protocol, then
3462b1b1d783SJeff Cody          * compare unmodified paths; otherwise make paths relative */
3463b1b1d783SJeff Cody         if (is_protocol || path_has_protocol(curr_bs->backing_file)) {
3464b1b1d783SJeff Cody             if (strcmp(backing_file, curr_bs->backing_file) == 0) {
3465b1b1d783SJeff Cody                 retval = curr_bs->backing_hd;
3466b1b1d783SJeff Cody                 break;
3467b1b1d783SJeff Cody             }
3468e8a6bb9cSMarcelo Tosatti         } else {
3469b1b1d783SJeff Cody             /* If not an absolute filename path, make it relative to the current
3470b1b1d783SJeff Cody              * image's filename path */
3471b1b1d783SJeff Cody             path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3472b1b1d783SJeff Cody                          backing_file);
3473b1b1d783SJeff Cody 
3474b1b1d783SJeff Cody             /* We are going to compare absolute pathnames */
3475b1b1d783SJeff Cody             if (!realpath(filename_tmp, filename_full)) {
3476b1b1d783SJeff Cody                 continue;
3477b1b1d783SJeff Cody             }
3478b1b1d783SJeff Cody 
3479b1b1d783SJeff Cody             /* We need to make sure the backing filename we are comparing against
3480b1b1d783SJeff Cody              * is relative to the current image filename (or absolute) */
3481b1b1d783SJeff Cody             path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3482b1b1d783SJeff Cody                          curr_bs->backing_file);
3483b1b1d783SJeff Cody 
3484b1b1d783SJeff Cody             if (!realpath(filename_tmp, backing_file_full)) {
3485b1b1d783SJeff Cody                 continue;
3486b1b1d783SJeff Cody             }
3487b1b1d783SJeff Cody 
3488b1b1d783SJeff Cody             if (strcmp(backing_file_full, filename_full) == 0) {
3489b1b1d783SJeff Cody                 retval = curr_bs->backing_hd;
3490b1b1d783SJeff Cody                 break;
3491b1b1d783SJeff Cody             }
3492e8a6bb9cSMarcelo Tosatti         }
3493e8a6bb9cSMarcelo Tosatti     }
3494e8a6bb9cSMarcelo Tosatti 
3495b1b1d783SJeff Cody     g_free(filename_full);
3496b1b1d783SJeff Cody     g_free(backing_file_full);
3497b1b1d783SJeff Cody     g_free(filename_tmp);
3498b1b1d783SJeff Cody     return retval;
3499e8a6bb9cSMarcelo Tosatti }
3500e8a6bb9cSMarcelo Tosatti 
3501f198fd1cSBenoît Canet int bdrv_get_backing_file_depth(BlockDriverState *bs)
3502f198fd1cSBenoît Canet {
3503f198fd1cSBenoît Canet     if (!bs->drv) {
3504f198fd1cSBenoît Canet         return 0;
3505f198fd1cSBenoît Canet     }
3506f198fd1cSBenoît Canet 
3507f198fd1cSBenoît Canet     if (!bs->backing_hd) {
3508f198fd1cSBenoît Canet         return 0;
3509f198fd1cSBenoît Canet     }
3510f198fd1cSBenoît Canet 
3511f198fd1cSBenoît Canet     return 1 + bdrv_get_backing_file_depth(bs->backing_hd);
3512f198fd1cSBenoît Canet }
3513f198fd1cSBenoît Canet 
351479fac568SJeff Cody BlockDriverState *bdrv_find_base(BlockDriverState *bs)
351579fac568SJeff Cody {
351679fac568SJeff Cody     BlockDriverState *curr_bs = NULL;
351779fac568SJeff Cody 
351879fac568SJeff Cody     if (!bs) {
351979fac568SJeff Cody         return NULL;
352079fac568SJeff Cody     }
352179fac568SJeff Cody 
352279fac568SJeff Cody     curr_bs = bs;
352379fac568SJeff Cody 
352479fac568SJeff Cody     while (curr_bs->backing_hd) {
352579fac568SJeff Cody         curr_bs = curr_bs->backing_hd;
352679fac568SJeff Cody     }
352779fac568SJeff Cody     return curr_bs;
352879fac568SJeff Cody }
352979fac568SJeff Cody 
3530faea38e7Sbellard #define NB_SUFFIXES 4
3531faea38e7Sbellard 
3532faea38e7Sbellard char *get_human_readable_size(char *buf, int buf_size, int64_t size)
3533faea38e7Sbellard {
3534faea38e7Sbellard     static const char suffixes[NB_SUFFIXES] = "KMGT";
3535faea38e7Sbellard     int64_t base;
3536faea38e7Sbellard     int i;
3537faea38e7Sbellard 
3538faea38e7Sbellard     if (size <= 999) {
3539faea38e7Sbellard         snprintf(buf, buf_size, "%" PRId64, size);
3540faea38e7Sbellard     } else {
3541faea38e7Sbellard         base = 1024;
3542faea38e7Sbellard         for(i = 0; i < NB_SUFFIXES; i++) {
3543faea38e7Sbellard             if (size < (10 * base)) {
3544faea38e7Sbellard                 snprintf(buf, buf_size, "%0.1f%c",
3545faea38e7Sbellard                          (double)size / base,
3546faea38e7Sbellard                          suffixes[i]);
3547faea38e7Sbellard                 break;
3548faea38e7Sbellard             } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
3549faea38e7Sbellard                 snprintf(buf, buf_size, "%" PRId64 "%c",
3550faea38e7Sbellard                          ((size + (base >> 1)) / base),
3551faea38e7Sbellard                          suffixes[i]);
3552faea38e7Sbellard                 break;
3553faea38e7Sbellard             }
3554faea38e7Sbellard             base = base * 1024;
3555faea38e7Sbellard         }
3556faea38e7Sbellard     }
3557faea38e7Sbellard     return buf;
3558faea38e7Sbellard }
3559faea38e7Sbellard 
3560faea38e7Sbellard char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
3561faea38e7Sbellard {
3562faea38e7Sbellard     char buf1[128], date_buf[128], clock_buf[128];
3563faea38e7Sbellard     struct tm tm;
3564faea38e7Sbellard     time_t ti;
3565faea38e7Sbellard     int64_t secs;
3566faea38e7Sbellard 
3567faea38e7Sbellard     if (!sn) {
3568faea38e7Sbellard         snprintf(buf, buf_size,
3569faea38e7Sbellard                  "%-10s%-20s%7s%20s%15s",
3570faea38e7Sbellard                  "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
3571faea38e7Sbellard     } else {
3572faea38e7Sbellard         ti = sn->date_sec;
3573faea38e7Sbellard         localtime_r(&ti, &tm);
3574faea38e7Sbellard         strftime(date_buf, sizeof(date_buf),
3575faea38e7Sbellard                  "%Y-%m-%d %H:%M:%S", &tm);
3576faea38e7Sbellard         secs = sn->vm_clock_nsec / 1000000000;
3577faea38e7Sbellard         snprintf(clock_buf, sizeof(clock_buf),
3578faea38e7Sbellard                  "%02d:%02d:%02d.%03d",
3579faea38e7Sbellard                  (int)(secs / 3600),
3580faea38e7Sbellard                  (int)((secs / 60) % 60),
3581faea38e7Sbellard                  (int)(secs % 60),
3582faea38e7Sbellard                  (int)((sn->vm_clock_nsec / 1000000) % 1000));
3583faea38e7Sbellard         snprintf(buf, buf_size,
3584faea38e7Sbellard                  "%-10s%-20s%7s%20s%15s",
3585faea38e7Sbellard                  sn->id_str, sn->name,
3586faea38e7Sbellard                  get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
3587faea38e7Sbellard                  date_buf,
3588faea38e7Sbellard                  clock_buf);
3589faea38e7Sbellard     }
3590faea38e7Sbellard     return buf;
3591faea38e7Sbellard }
3592faea38e7Sbellard 
3593ea2384d3Sbellard /**************************************************************/
359483f64091Sbellard /* async I/Os */
3595ea2384d3Sbellard 
35963b69e4b9Saliguori BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
3597f141eafeSaliguori                                  QEMUIOVector *qiov, int nb_sectors,
359883f64091Sbellard                                  BlockDriverCompletionFunc *cb, void *opaque)
3599ea2384d3Sbellard {
3600bbf0a440SStefan Hajnoczi     trace_bdrv_aio_readv(bs, sector_num, nb_sectors, opaque);
3601bbf0a440SStefan Hajnoczi 
3602b2a61371SStefan Hajnoczi     return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
36038c5873d6SStefan Hajnoczi                                  cb, opaque, false);
360483f64091Sbellard }
360583f64091Sbellard 
3606f141eafeSaliguori BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
3607f141eafeSaliguori                                   QEMUIOVector *qiov, int nb_sectors,
360883f64091Sbellard                                   BlockDriverCompletionFunc *cb, void *opaque)
36097674e7bfSbellard {
3610bbf0a440SStefan Hajnoczi     trace_bdrv_aio_writev(bs, sector_num, nb_sectors, opaque);
3611bbf0a440SStefan Hajnoczi 
36121a6e115bSStefan Hajnoczi     return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
36138c5873d6SStefan Hajnoczi                                  cb, opaque, true);
361483f64091Sbellard }
361583f64091Sbellard 
361640b4f539SKevin Wolf 
361740b4f539SKevin Wolf typedef struct MultiwriteCB {
361840b4f539SKevin Wolf     int error;
361940b4f539SKevin Wolf     int num_requests;
362040b4f539SKevin Wolf     int num_callbacks;
362140b4f539SKevin Wolf     struct {
362240b4f539SKevin Wolf         BlockDriverCompletionFunc *cb;
362340b4f539SKevin Wolf         void *opaque;
362440b4f539SKevin Wolf         QEMUIOVector *free_qiov;
362540b4f539SKevin Wolf     } callbacks[];
362640b4f539SKevin Wolf } MultiwriteCB;
362740b4f539SKevin Wolf 
362840b4f539SKevin Wolf static void multiwrite_user_cb(MultiwriteCB *mcb)
362940b4f539SKevin Wolf {
363040b4f539SKevin Wolf     int i;
363140b4f539SKevin Wolf 
363240b4f539SKevin Wolf     for (i = 0; i < mcb->num_callbacks; i++) {
363340b4f539SKevin Wolf         mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
36341e1ea48dSStefan Hajnoczi         if (mcb->callbacks[i].free_qiov) {
36351e1ea48dSStefan Hajnoczi             qemu_iovec_destroy(mcb->callbacks[i].free_qiov);
36361e1ea48dSStefan Hajnoczi         }
36377267c094SAnthony Liguori         g_free(mcb->callbacks[i].free_qiov);
363840b4f539SKevin Wolf     }
363940b4f539SKevin Wolf }
364040b4f539SKevin Wolf 
364140b4f539SKevin Wolf static void multiwrite_cb(void *opaque, int ret)
364240b4f539SKevin Wolf {
364340b4f539SKevin Wolf     MultiwriteCB *mcb = opaque;
364440b4f539SKevin Wolf 
36456d519a5fSStefan Hajnoczi     trace_multiwrite_cb(mcb, ret);
36466d519a5fSStefan Hajnoczi 
3647cb6d3ca0SKevin Wolf     if (ret < 0 && !mcb->error) {
364840b4f539SKevin Wolf         mcb->error = ret;
364940b4f539SKevin Wolf     }
365040b4f539SKevin Wolf 
365140b4f539SKevin Wolf     mcb->num_requests--;
365240b4f539SKevin Wolf     if (mcb->num_requests == 0) {
365340b4f539SKevin Wolf         multiwrite_user_cb(mcb);
36547267c094SAnthony Liguori         g_free(mcb);
365540b4f539SKevin Wolf     }
365640b4f539SKevin Wolf }
365740b4f539SKevin Wolf 
365840b4f539SKevin Wolf static int multiwrite_req_compare(const void *a, const void *b)
365940b4f539SKevin Wolf {
366077be4366SChristoph Hellwig     const BlockRequest *req1 = a, *req2 = b;
366177be4366SChristoph Hellwig 
366277be4366SChristoph Hellwig     /*
366377be4366SChristoph Hellwig      * Note that we can't simply subtract req2->sector from req1->sector
366477be4366SChristoph Hellwig      * here as that could overflow the return value.
366577be4366SChristoph Hellwig      */
366677be4366SChristoph Hellwig     if (req1->sector > req2->sector) {
366777be4366SChristoph Hellwig         return 1;
366877be4366SChristoph Hellwig     } else if (req1->sector < req2->sector) {
366977be4366SChristoph Hellwig         return -1;
367077be4366SChristoph Hellwig     } else {
367177be4366SChristoph Hellwig         return 0;
367277be4366SChristoph Hellwig     }
367340b4f539SKevin Wolf }
367440b4f539SKevin Wolf 
367540b4f539SKevin Wolf /*
367640b4f539SKevin Wolf  * Takes a bunch of requests and tries to merge them. Returns the number of
367740b4f539SKevin Wolf  * requests that remain after merging.
367840b4f539SKevin Wolf  */
367940b4f539SKevin Wolf static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
368040b4f539SKevin Wolf     int num_reqs, MultiwriteCB *mcb)
368140b4f539SKevin Wolf {
368240b4f539SKevin Wolf     int i, outidx;
368340b4f539SKevin Wolf 
368440b4f539SKevin Wolf     // Sort requests by start sector
368540b4f539SKevin Wolf     qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);
368640b4f539SKevin Wolf 
368740b4f539SKevin Wolf     // Check if adjacent requests touch the same clusters. If so, combine them,
368840b4f539SKevin Wolf     // filling up gaps with zero sectors.
368940b4f539SKevin Wolf     outidx = 0;
369040b4f539SKevin Wolf     for (i = 1; i < num_reqs; i++) {
369140b4f539SKevin Wolf         int merge = 0;
369240b4f539SKevin Wolf         int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;
369340b4f539SKevin Wolf 
3694b6a127a1SPaolo Bonzini         // Handle exactly sequential writes and overlapping writes.
369540b4f539SKevin Wolf         if (reqs[i].sector <= oldreq_last) {
369640b4f539SKevin Wolf             merge = 1;
369740b4f539SKevin Wolf         }
369840b4f539SKevin Wolf 
3699e2a305fbSChristoph Hellwig         if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
3700e2a305fbSChristoph Hellwig             merge = 0;
3701e2a305fbSChristoph Hellwig         }
3702e2a305fbSChristoph Hellwig 
370340b4f539SKevin Wolf         if (merge) {
370440b4f539SKevin Wolf             size_t size;
37057267c094SAnthony Liguori             QEMUIOVector *qiov = g_malloc0(sizeof(*qiov));
370640b4f539SKevin Wolf             qemu_iovec_init(qiov,
370740b4f539SKevin Wolf                 reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);
370840b4f539SKevin Wolf 
370940b4f539SKevin Wolf             // Add the first request to the merged one. If the requests are
371040b4f539SKevin Wolf             // overlapping, drop the last sectors of the first request.
371140b4f539SKevin Wolf             size = (reqs[i].sector - reqs[outidx].sector) << 9;
37121b093c48SMichael Tokarev             qemu_iovec_concat(qiov, reqs[outidx].qiov, 0, size);
371340b4f539SKevin Wolf 
3714b6a127a1SPaolo Bonzini             // We should need to add any zeros between the two requests
3715b6a127a1SPaolo Bonzini             assert (reqs[i].sector <= oldreq_last);
371640b4f539SKevin Wolf 
371740b4f539SKevin Wolf             // Add the second request
37181b093c48SMichael Tokarev             qemu_iovec_concat(qiov, reqs[i].qiov, 0, reqs[i].qiov->size);
371940b4f539SKevin Wolf 
3720cbf1dff2SKevin Wolf             reqs[outidx].nb_sectors = qiov->size >> 9;
372140b4f539SKevin Wolf             reqs[outidx].qiov = qiov;
372240b4f539SKevin Wolf 
372340b4f539SKevin Wolf             mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
372440b4f539SKevin Wolf         } else {
372540b4f539SKevin Wolf             outidx++;
372640b4f539SKevin Wolf             reqs[outidx].sector     = reqs[i].sector;
372740b4f539SKevin Wolf             reqs[outidx].nb_sectors = reqs[i].nb_sectors;
372840b4f539SKevin Wolf             reqs[outidx].qiov       = reqs[i].qiov;
372940b4f539SKevin Wolf         }
373040b4f539SKevin Wolf     }
373140b4f539SKevin Wolf 
373240b4f539SKevin Wolf     return outidx + 1;
373340b4f539SKevin Wolf }
373440b4f539SKevin Wolf 
373540b4f539SKevin Wolf /*
373640b4f539SKevin Wolf  * Submit multiple AIO write requests at once.
373740b4f539SKevin Wolf  *
373840b4f539SKevin Wolf  * On success, the function returns 0 and all requests in the reqs array have
373940b4f539SKevin Wolf  * been submitted. In error case this function returns -1, and any of the
374040b4f539SKevin Wolf  * requests may or may not be submitted yet. In particular, this means that the
374140b4f539SKevin Wolf  * callback will be called for some of the requests, for others it won't. The
374240b4f539SKevin Wolf  * caller must check the error field of the BlockRequest to wait for the right
374340b4f539SKevin Wolf  * callbacks (if error != 0, no callback will be called).
374440b4f539SKevin Wolf  *
374540b4f539SKevin Wolf  * The implementation may modify the contents of the reqs array, e.g. to merge
374640b4f539SKevin Wolf  * requests. However, the fields opaque and error are left unmodified as they
374740b4f539SKevin Wolf  * are used to signal failure for a single request to the caller.
374840b4f539SKevin Wolf  */
374940b4f539SKevin Wolf int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
375040b4f539SKevin Wolf {
375140b4f539SKevin Wolf     MultiwriteCB *mcb;
375240b4f539SKevin Wolf     int i;
375340b4f539SKevin Wolf 
3754301db7c2SRyan Harper     /* don't submit writes if we don't have a medium */
3755301db7c2SRyan Harper     if (bs->drv == NULL) {
3756301db7c2SRyan Harper         for (i = 0; i < num_reqs; i++) {
3757301db7c2SRyan Harper             reqs[i].error = -ENOMEDIUM;
3758301db7c2SRyan Harper         }
3759301db7c2SRyan Harper         return -1;
3760301db7c2SRyan Harper     }
3761301db7c2SRyan Harper 
376240b4f539SKevin Wolf     if (num_reqs == 0) {
376340b4f539SKevin Wolf         return 0;
376440b4f539SKevin Wolf     }
376540b4f539SKevin Wolf 
376640b4f539SKevin Wolf     // Create MultiwriteCB structure
37677267c094SAnthony Liguori     mcb = g_malloc0(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
376840b4f539SKevin Wolf     mcb->num_requests = 0;
376940b4f539SKevin Wolf     mcb->num_callbacks = num_reqs;
377040b4f539SKevin Wolf 
377140b4f539SKevin Wolf     for (i = 0; i < num_reqs; i++) {
377240b4f539SKevin Wolf         mcb->callbacks[i].cb = reqs[i].cb;
377340b4f539SKevin Wolf         mcb->callbacks[i].opaque = reqs[i].opaque;
377440b4f539SKevin Wolf     }
377540b4f539SKevin Wolf 
377640b4f539SKevin Wolf     // Check for mergable requests
377740b4f539SKevin Wolf     num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);
377840b4f539SKevin Wolf 
37796d519a5fSStefan Hajnoczi     trace_bdrv_aio_multiwrite(mcb, mcb->num_callbacks, num_reqs);
37806d519a5fSStefan Hajnoczi 
3781df9309fbSPaolo Bonzini     /* Run the aio requests. */
3782df9309fbSPaolo Bonzini     mcb->num_requests = num_reqs;
378340b4f539SKevin Wolf     for (i = 0; i < num_reqs; i++) {
3784ad54ae80SPaolo Bonzini         bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
378540b4f539SKevin Wolf             reqs[i].nb_sectors, multiwrite_cb, mcb);
378640b4f539SKevin Wolf     }
378740b4f539SKevin Wolf 
378840b4f539SKevin Wolf     return 0;
378940b4f539SKevin Wolf }
379040b4f539SKevin Wolf 
379183f64091Sbellard void bdrv_aio_cancel(BlockDriverAIOCB *acb)
379283f64091Sbellard {
3793d7331bedSStefan Hajnoczi     acb->aiocb_info->cancel(acb);
379483f64091Sbellard }
379583f64091Sbellard 
379698f90dbaSZhi Yong Wu /* block I/O throttling */
379798f90dbaSZhi Yong Wu static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
379898f90dbaSZhi Yong Wu                  bool is_write, double elapsed_time, uint64_t *wait)
379998f90dbaSZhi Yong Wu {
380098f90dbaSZhi Yong Wu     uint64_t bps_limit = 0;
3801ae29d6c6SStefan Hajnoczi     uint64_t extension;
380298f90dbaSZhi Yong Wu     double   bytes_limit, bytes_base, bytes_res;
380398f90dbaSZhi Yong Wu     double   slice_time, wait_time;
380498f90dbaSZhi Yong Wu 
380598f90dbaSZhi Yong Wu     if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
380698f90dbaSZhi Yong Wu         bps_limit = bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
380798f90dbaSZhi Yong Wu     } else if (bs->io_limits.bps[is_write]) {
380898f90dbaSZhi Yong Wu         bps_limit = bs->io_limits.bps[is_write];
380998f90dbaSZhi Yong Wu     } else {
381098f90dbaSZhi Yong Wu         if (wait) {
381198f90dbaSZhi Yong Wu             *wait = 0;
381298f90dbaSZhi Yong Wu         }
381398f90dbaSZhi Yong Wu 
381498f90dbaSZhi Yong Wu         return false;
381598f90dbaSZhi Yong Wu     }
381698f90dbaSZhi Yong Wu 
381798f90dbaSZhi Yong Wu     slice_time = bs->slice_end - bs->slice_start;
381898f90dbaSZhi Yong Wu     slice_time /= (NANOSECONDS_PER_SECOND);
381998f90dbaSZhi Yong Wu     bytes_limit = bps_limit * slice_time;
38205905fbc9SStefan Hajnoczi     bytes_base  = bs->slice_submitted.bytes[is_write];
382198f90dbaSZhi Yong Wu     if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
38225905fbc9SStefan Hajnoczi         bytes_base += bs->slice_submitted.bytes[!is_write];
382398f90dbaSZhi Yong Wu     }
382498f90dbaSZhi Yong Wu 
382598f90dbaSZhi Yong Wu     /* bytes_base: the bytes of data which have been read/written; and
382698f90dbaSZhi Yong Wu      *             it is obtained from the history statistic info.
382798f90dbaSZhi Yong Wu      * bytes_res: the remaining bytes of data which need to be read/written.
382898f90dbaSZhi Yong Wu      * (bytes_base + bytes_res) / bps_limit: used to calcuate
382998f90dbaSZhi Yong Wu      *             the total time for completing reading/writting all data.
383098f90dbaSZhi Yong Wu      */
383198f90dbaSZhi Yong Wu     bytes_res   = (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
383298f90dbaSZhi Yong Wu 
383398f90dbaSZhi Yong Wu     if (bytes_base + bytes_res <= bytes_limit) {
383498f90dbaSZhi Yong Wu         if (wait) {
383598f90dbaSZhi Yong Wu             *wait = 0;
383698f90dbaSZhi Yong Wu         }
383798f90dbaSZhi Yong Wu 
383898f90dbaSZhi Yong Wu         return false;
383998f90dbaSZhi Yong Wu     }
384098f90dbaSZhi Yong Wu 
384198f90dbaSZhi Yong Wu     /* Calc approx time to dispatch */
384298f90dbaSZhi Yong Wu     wait_time = (bytes_base + bytes_res) / bps_limit - elapsed_time;
384398f90dbaSZhi Yong Wu 
384498f90dbaSZhi Yong Wu     /* When the I/O rate at runtime exceeds the limits,
384598f90dbaSZhi Yong Wu      * bs->slice_end need to be extended in order that the current statistic
384698f90dbaSZhi Yong Wu      * info can be kept until the timer fire, so it is increased and tuned
384798f90dbaSZhi Yong Wu      * based on the result of experiment.
384898f90dbaSZhi Yong Wu      */
3849ae29d6c6SStefan Hajnoczi     extension = wait_time * NANOSECONDS_PER_SECOND;
3850ae29d6c6SStefan Hajnoczi     extension = DIV_ROUND_UP(extension, BLOCK_IO_SLICE_TIME) *
3851ae29d6c6SStefan Hajnoczi                 BLOCK_IO_SLICE_TIME;
3852ae29d6c6SStefan Hajnoczi     bs->slice_end += extension;
385398f90dbaSZhi Yong Wu     if (wait) {
38540775437fSStefan Hajnoczi         *wait = wait_time * NANOSECONDS_PER_SECOND;
385598f90dbaSZhi Yong Wu     }
385698f90dbaSZhi Yong Wu 
385798f90dbaSZhi Yong Wu     return true;
385898f90dbaSZhi Yong Wu }
385998f90dbaSZhi Yong Wu 
386098f90dbaSZhi Yong Wu static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
386198f90dbaSZhi Yong Wu                              double elapsed_time, uint64_t *wait)
386298f90dbaSZhi Yong Wu {
386398f90dbaSZhi Yong Wu     uint64_t iops_limit = 0;
386498f90dbaSZhi Yong Wu     double   ios_limit, ios_base;
386598f90dbaSZhi Yong Wu     double   slice_time, wait_time;
386698f90dbaSZhi Yong Wu 
386798f90dbaSZhi Yong Wu     if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
386898f90dbaSZhi Yong Wu         iops_limit = bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
386998f90dbaSZhi Yong Wu     } else if (bs->io_limits.iops[is_write]) {
387098f90dbaSZhi Yong Wu         iops_limit = bs->io_limits.iops[is_write];
387198f90dbaSZhi Yong Wu     } else {
387298f90dbaSZhi Yong Wu         if (wait) {
387398f90dbaSZhi Yong Wu             *wait = 0;
387498f90dbaSZhi Yong Wu         }
387598f90dbaSZhi Yong Wu 
387698f90dbaSZhi Yong Wu         return false;
387798f90dbaSZhi Yong Wu     }
387898f90dbaSZhi Yong Wu 
387998f90dbaSZhi Yong Wu     slice_time = bs->slice_end - bs->slice_start;
388098f90dbaSZhi Yong Wu     slice_time /= (NANOSECONDS_PER_SECOND);
388198f90dbaSZhi Yong Wu     ios_limit  = iops_limit * slice_time;
38825905fbc9SStefan Hajnoczi     ios_base   = bs->slice_submitted.ios[is_write];
388398f90dbaSZhi Yong Wu     if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
38845905fbc9SStefan Hajnoczi         ios_base += bs->slice_submitted.ios[!is_write];
388598f90dbaSZhi Yong Wu     }
388698f90dbaSZhi Yong Wu 
388798f90dbaSZhi Yong Wu     if (ios_base + 1 <= ios_limit) {
388898f90dbaSZhi Yong Wu         if (wait) {
388998f90dbaSZhi Yong Wu             *wait = 0;
389098f90dbaSZhi Yong Wu         }
389198f90dbaSZhi Yong Wu 
389298f90dbaSZhi Yong Wu         return false;
389398f90dbaSZhi Yong Wu     }
389498f90dbaSZhi Yong Wu 
38950775437fSStefan Hajnoczi     /* Calc approx time to dispatch, in seconds */
389698f90dbaSZhi Yong Wu     wait_time = (ios_base + 1) / iops_limit;
389798f90dbaSZhi Yong Wu     if (wait_time > elapsed_time) {
389898f90dbaSZhi Yong Wu         wait_time = wait_time - elapsed_time;
389998f90dbaSZhi Yong Wu     } else {
390098f90dbaSZhi Yong Wu         wait_time = 0;
390198f90dbaSZhi Yong Wu     }
390298f90dbaSZhi Yong Wu 
3903ae29d6c6SStefan Hajnoczi     /* Exceeded current slice, extend it by another slice time */
3904ae29d6c6SStefan Hajnoczi     bs->slice_end += BLOCK_IO_SLICE_TIME;
390598f90dbaSZhi Yong Wu     if (wait) {
39060775437fSStefan Hajnoczi         *wait = wait_time * NANOSECONDS_PER_SECOND;
390798f90dbaSZhi Yong Wu     }
390898f90dbaSZhi Yong Wu 
390998f90dbaSZhi Yong Wu     return true;
391098f90dbaSZhi Yong Wu }
391198f90dbaSZhi Yong Wu 
391298f90dbaSZhi Yong Wu static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
391398f90dbaSZhi Yong Wu                            bool is_write, int64_t *wait)
391498f90dbaSZhi Yong Wu {
391598f90dbaSZhi Yong Wu     int64_t  now, max_wait;
391698f90dbaSZhi Yong Wu     uint64_t bps_wait = 0, iops_wait = 0;
391798f90dbaSZhi Yong Wu     double   elapsed_time;
391898f90dbaSZhi Yong Wu     int      bps_ret, iops_ret;
391998f90dbaSZhi Yong Wu 
392098f90dbaSZhi Yong Wu     now = qemu_get_clock_ns(vm_clock);
3921e660fb8bSStefan Hajnoczi     if (now > bs->slice_end) {
392298f90dbaSZhi Yong Wu         bs->slice_start = now;
3923ae29d6c6SStefan Hajnoczi         bs->slice_end   = now + BLOCK_IO_SLICE_TIME;
39245905fbc9SStefan Hajnoczi         memset(&bs->slice_submitted, 0, sizeof(bs->slice_submitted));
392598f90dbaSZhi Yong Wu     }
392698f90dbaSZhi Yong Wu 
392798f90dbaSZhi Yong Wu     elapsed_time  = now - bs->slice_start;
392898f90dbaSZhi Yong Wu     elapsed_time  /= (NANOSECONDS_PER_SECOND);
392998f90dbaSZhi Yong Wu 
393098f90dbaSZhi Yong Wu     bps_ret  = bdrv_exceed_bps_limits(bs, nb_sectors,
393198f90dbaSZhi Yong Wu                                       is_write, elapsed_time, &bps_wait);
393298f90dbaSZhi Yong Wu     iops_ret = bdrv_exceed_iops_limits(bs, is_write,
393398f90dbaSZhi Yong Wu                                       elapsed_time, &iops_wait);
393498f90dbaSZhi Yong Wu     if (bps_ret || iops_ret) {
393598f90dbaSZhi Yong Wu         max_wait = bps_wait > iops_wait ? bps_wait : iops_wait;
393698f90dbaSZhi Yong Wu         if (wait) {
393798f90dbaSZhi Yong Wu             *wait = max_wait;
393898f90dbaSZhi Yong Wu         }
393998f90dbaSZhi Yong Wu 
394098f90dbaSZhi Yong Wu         now = qemu_get_clock_ns(vm_clock);
394198f90dbaSZhi Yong Wu         if (bs->slice_end < now + max_wait) {
394298f90dbaSZhi Yong Wu             bs->slice_end = now + max_wait;
394398f90dbaSZhi Yong Wu         }
394498f90dbaSZhi Yong Wu 
394598f90dbaSZhi Yong Wu         return true;
394698f90dbaSZhi Yong Wu     }
394798f90dbaSZhi Yong Wu 
394898f90dbaSZhi Yong Wu     if (wait) {
394998f90dbaSZhi Yong Wu         *wait = 0;
395098f90dbaSZhi Yong Wu     }
395198f90dbaSZhi Yong Wu 
39525905fbc9SStefan Hajnoczi     bs->slice_submitted.bytes[is_write] += (int64_t)nb_sectors *
39535905fbc9SStefan Hajnoczi                                            BDRV_SECTOR_SIZE;
39545905fbc9SStefan Hajnoczi     bs->slice_submitted.ios[is_write]++;
39555905fbc9SStefan Hajnoczi 
395698f90dbaSZhi Yong Wu     return false;
395798f90dbaSZhi Yong Wu }
395883f64091Sbellard 
395983f64091Sbellard /**************************************************************/
396083f64091Sbellard /* async block device emulation */
396183f64091Sbellard 
3962c16b5a2cSChristoph Hellwig typedef struct BlockDriverAIOCBSync {
3963c16b5a2cSChristoph Hellwig     BlockDriverAIOCB common;
3964c16b5a2cSChristoph Hellwig     QEMUBH *bh;
3965c16b5a2cSChristoph Hellwig     int ret;
3966c16b5a2cSChristoph Hellwig     /* vector translation state */
3967c16b5a2cSChristoph Hellwig     QEMUIOVector *qiov;
3968c16b5a2cSChristoph Hellwig     uint8_t *bounce;
3969c16b5a2cSChristoph Hellwig     int is_write;
3970c16b5a2cSChristoph Hellwig } BlockDriverAIOCBSync;
3971c16b5a2cSChristoph Hellwig 
3972c16b5a2cSChristoph Hellwig static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
3973c16b5a2cSChristoph Hellwig {
3974b666d239SKevin Wolf     BlockDriverAIOCBSync *acb =
3975b666d239SKevin Wolf         container_of(blockacb, BlockDriverAIOCBSync, common);
39766a7ad299SDor Laor     qemu_bh_delete(acb->bh);
397736afc451SAvi Kivity     acb->bh = NULL;
3978c16b5a2cSChristoph Hellwig     qemu_aio_release(acb);
3979c16b5a2cSChristoph Hellwig }
3980c16b5a2cSChristoph Hellwig 
3981d7331bedSStefan Hajnoczi static const AIOCBInfo bdrv_em_aiocb_info = {
3982c16b5a2cSChristoph Hellwig     .aiocb_size         = sizeof(BlockDriverAIOCBSync),
3983c16b5a2cSChristoph Hellwig     .cancel             = bdrv_aio_cancel_em,
3984c16b5a2cSChristoph Hellwig };
3985c16b5a2cSChristoph Hellwig 
398683f64091Sbellard static void bdrv_aio_bh_cb(void *opaque)
3987beac80cdSbellard {
3988ce1a14dcSpbrook     BlockDriverAIOCBSync *acb = opaque;
3989f141eafeSaliguori 
3990f141eafeSaliguori     if (!acb->is_write)
399103396148SMichael Tokarev         qemu_iovec_from_buf(acb->qiov, 0, acb->bounce, acb->qiov->size);
3992ceb42de8Saliguori     qemu_vfree(acb->bounce);
3993ce1a14dcSpbrook     acb->common.cb(acb->common.opaque, acb->ret);
39946a7ad299SDor Laor     qemu_bh_delete(acb->bh);
399536afc451SAvi Kivity     acb->bh = NULL;
3996ce1a14dcSpbrook     qemu_aio_release(acb);
3997beac80cdSbellard }
3998beac80cdSbellard 
3999f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
4000f141eafeSaliguori                                             int64_t sector_num,
4001f141eafeSaliguori                                             QEMUIOVector *qiov,
4002f141eafeSaliguori                                             int nb_sectors,
4003f141eafeSaliguori                                             BlockDriverCompletionFunc *cb,
4004f141eafeSaliguori                                             void *opaque,
4005f141eafeSaliguori                                             int is_write)
4006f141eafeSaliguori 
4007ea2384d3Sbellard {
4008ce1a14dcSpbrook     BlockDriverAIOCBSync *acb;
400983f64091Sbellard 
4010d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_aiocb_info, bs, cb, opaque);
4011f141eafeSaliguori     acb->is_write = is_write;
4012f141eafeSaliguori     acb->qiov = qiov;
4013e268ca52Saliguori     acb->bounce = qemu_blockalign(bs, qiov->size);
4014ce1a14dcSpbrook     acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
4015f141eafeSaliguori 
4016f141eafeSaliguori     if (is_write) {
4017d5e6b161SMichael Tokarev         qemu_iovec_to_buf(acb->qiov, 0, acb->bounce, qiov->size);
40181ed20acfSStefan Hajnoczi         acb->ret = bs->drv->bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
4019f141eafeSaliguori     } else {
40201ed20acfSStefan Hajnoczi         acb->ret = bs->drv->bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
4021f141eafeSaliguori     }
4022f141eafeSaliguori 
4023ce1a14dcSpbrook     qemu_bh_schedule(acb->bh);
4024f141eafeSaliguori 
4025ce1a14dcSpbrook     return &acb->common;
40267a6cba61Spbrook }
40277a6cba61Spbrook 
4028f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
4029f141eafeSaliguori         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
4030ce1a14dcSpbrook         BlockDriverCompletionFunc *cb, void *opaque)
403183f64091Sbellard {
4032f141eafeSaliguori     return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
403383f64091Sbellard }
403483f64091Sbellard 
4035f141eafeSaliguori static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
4036f141eafeSaliguori         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
4037f141eafeSaliguori         BlockDriverCompletionFunc *cb, void *opaque)
4038f141eafeSaliguori {
4039f141eafeSaliguori     return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
4040f141eafeSaliguori }
4041f141eafeSaliguori 
404268485420SKevin Wolf 
404368485420SKevin Wolf typedef struct BlockDriverAIOCBCoroutine {
404468485420SKevin Wolf     BlockDriverAIOCB common;
404568485420SKevin Wolf     BlockRequest req;
404668485420SKevin Wolf     bool is_write;
4047d318aea9SKevin Wolf     bool *done;
404868485420SKevin Wolf     QEMUBH* bh;
404968485420SKevin Wolf } BlockDriverAIOCBCoroutine;
405068485420SKevin Wolf 
405168485420SKevin Wolf static void bdrv_aio_co_cancel_em(BlockDriverAIOCB *blockacb)
405268485420SKevin Wolf {
4053d318aea9SKevin Wolf     BlockDriverAIOCBCoroutine *acb =
4054d318aea9SKevin Wolf         container_of(blockacb, BlockDriverAIOCBCoroutine, common);
4055d318aea9SKevin Wolf     bool done = false;
4056d318aea9SKevin Wolf 
4057d318aea9SKevin Wolf     acb->done = &done;
4058d318aea9SKevin Wolf     while (!done) {
4059d318aea9SKevin Wolf         qemu_aio_wait();
4060d318aea9SKevin Wolf     }
406168485420SKevin Wolf }
406268485420SKevin Wolf 
4063d7331bedSStefan Hajnoczi static const AIOCBInfo bdrv_em_co_aiocb_info = {
406468485420SKevin Wolf     .aiocb_size         = sizeof(BlockDriverAIOCBCoroutine),
406568485420SKevin Wolf     .cancel             = bdrv_aio_co_cancel_em,
406668485420SKevin Wolf };
406768485420SKevin Wolf 
406835246a68SPaolo Bonzini static void bdrv_co_em_bh(void *opaque)
406968485420SKevin Wolf {
407068485420SKevin Wolf     BlockDriverAIOCBCoroutine *acb = opaque;
407168485420SKevin Wolf 
407268485420SKevin Wolf     acb->common.cb(acb->common.opaque, acb->req.error);
4073d318aea9SKevin Wolf 
4074d318aea9SKevin Wolf     if (acb->done) {
4075d318aea9SKevin Wolf         *acb->done = true;
4076d318aea9SKevin Wolf     }
4077d318aea9SKevin Wolf 
407868485420SKevin Wolf     qemu_bh_delete(acb->bh);
407968485420SKevin Wolf     qemu_aio_release(acb);
408068485420SKevin Wolf }
408168485420SKevin Wolf 
4082b2a61371SStefan Hajnoczi /* Invoke bdrv_co_do_readv/bdrv_co_do_writev */
4083b2a61371SStefan Hajnoczi static void coroutine_fn bdrv_co_do_rw(void *opaque)
4084b2a61371SStefan Hajnoczi {
4085b2a61371SStefan Hajnoczi     BlockDriverAIOCBCoroutine *acb = opaque;
4086b2a61371SStefan Hajnoczi     BlockDriverState *bs = acb->common.bs;
4087b2a61371SStefan Hajnoczi 
4088b2a61371SStefan Hajnoczi     if (!acb->is_write) {
4089b2a61371SStefan Hajnoczi         acb->req.error = bdrv_co_do_readv(bs, acb->req.sector,
4090470c0504SStefan Hajnoczi             acb->req.nb_sectors, acb->req.qiov, 0);
4091b2a61371SStefan Hajnoczi     } else {
4092b2a61371SStefan Hajnoczi         acb->req.error = bdrv_co_do_writev(bs, acb->req.sector,
4093f08f2ddaSStefan Hajnoczi             acb->req.nb_sectors, acb->req.qiov, 0);
4094b2a61371SStefan Hajnoczi     }
4095b2a61371SStefan Hajnoczi 
409635246a68SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
4097b2a61371SStefan Hajnoczi     qemu_bh_schedule(acb->bh);
4098b2a61371SStefan Hajnoczi }
4099b2a61371SStefan Hajnoczi 
410068485420SKevin Wolf static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
410168485420SKevin Wolf                                                int64_t sector_num,
410268485420SKevin Wolf                                                QEMUIOVector *qiov,
410368485420SKevin Wolf                                                int nb_sectors,
410468485420SKevin Wolf                                                BlockDriverCompletionFunc *cb,
410568485420SKevin Wolf                                                void *opaque,
41068c5873d6SStefan Hajnoczi                                                bool is_write)
410768485420SKevin Wolf {
410868485420SKevin Wolf     Coroutine *co;
410968485420SKevin Wolf     BlockDriverAIOCBCoroutine *acb;
411068485420SKevin Wolf 
4111d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
411268485420SKevin Wolf     acb->req.sector = sector_num;
411368485420SKevin Wolf     acb->req.nb_sectors = nb_sectors;
411468485420SKevin Wolf     acb->req.qiov = qiov;
411568485420SKevin Wolf     acb->is_write = is_write;
4116d318aea9SKevin Wolf     acb->done = NULL;
411768485420SKevin Wolf 
41188c5873d6SStefan Hajnoczi     co = qemu_coroutine_create(bdrv_co_do_rw);
411968485420SKevin Wolf     qemu_coroutine_enter(co, acb);
412068485420SKevin Wolf 
412168485420SKevin Wolf     return &acb->common;
412268485420SKevin Wolf }
412368485420SKevin Wolf 
412407f07615SPaolo Bonzini static void coroutine_fn bdrv_aio_flush_co_entry(void *opaque)
4125b2e12bc6SChristoph Hellwig {
412607f07615SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb = opaque;
412707f07615SPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
4128b2e12bc6SChristoph Hellwig 
412907f07615SPaolo Bonzini     acb->req.error = bdrv_co_flush(bs);
413007f07615SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
4131b2e12bc6SChristoph Hellwig     qemu_bh_schedule(acb->bh);
4132b2e12bc6SChristoph Hellwig }
4133b2e12bc6SChristoph Hellwig 
413407f07615SPaolo Bonzini BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
4135016f5cf6SAlexander Graf         BlockDriverCompletionFunc *cb, void *opaque)
4136016f5cf6SAlexander Graf {
413707f07615SPaolo Bonzini     trace_bdrv_aio_flush(bs, opaque);
4138016f5cf6SAlexander Graf 
413907f07615SPaolo Bonzini     Coroutine *co;
414007f07615SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb;
4141016f5cf6SAlexander Graf 
4142d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
4143d318aea9SKevin Wolf     acb->done = NULL;
4144d318aea9SKevin Wolf 
414507f07615SPaolo Bonzini     co = qemu_coroutine_create(bdrv_aio_flush_co_entry);
414607f07615SPaolo Bonzini     qemu_coroutine_enter(co, acb);
4147016f5cf6SAlexander Graf 
4148016f5cf6SAlexander Graf     return &acb->common;
4149016f5cf6SAlexander Graf }
4150016f5cf6SAlexander Graf 
41514265d620SPaolo Bonzini static void coroutine_fn bdrv_aio_discard_co_entry(void *opaque)
41524265d620SPaolo Bonzini {
41534265d620SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb = opaque;
41544265d620SPaolo Bonzini     BlockDriverState *bs = acb->common.bs;
41554265d620SPaolo Bonzini 
41564265d620SPaolo Bonzini     acb->req.error = bdrv_co_discard(bs, acb->req.sector, acb->req.nb_sectors);
41574265d620SPaolo Bonzini     acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
41584265d620SPaolo Bonzini     qemu_bh_schedule(acb->bh);
41594265d620SPaolo Bonzini }
41604265d620SPaolo Bonzini 
41614265d620SPaolo Bonzini BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
41624265d620SPaolo Bonzini         int64_t sector_num, int nb_sectors,
41634265d620SPaolo Bonzini         BlockDriverCompletionFunc *cb, void *opaque)
41644265d620SPaolo Bonzini {
41654265d620SPaolo Bonzini     Coroutine *co;
41664265d620SPaolo Bonzini     BlockDriverAIOCBCoroutine *acb;
41674265d620SPaolo Bonzini 
41684265d620SPaolo Bonzini     trace_bdrv_aio_discard(bs, sector_num, nb_sectors, opaque);
41694265d620SPaolo Bonzini 
4170d7331bedSStefan Hajnoczi     acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
41714265d620SPaolo Bonzini     acb->req.sector = sector_num;
41724265d620SPaolo Bonzini     acb->req.nb_sectors = nb_sectors;
4173d318aea9SKevin Wolf     acb->done = NULL;
41744265d620SPaolo Bonzini     co = qemu_coroutine_create(bdrv_aio_discard_co_entry);
41754265d620SPaolo Bonzini     qemu_coroutine_enter(co, acb);
41764265d620SPaolo Bonzini 
41774265d620SPaolo Bonzini     return &acb->common;
41784265d620SPaolo Bonzini }
41794265d620SPaolo Bonzini 
4180ea2384d3Sbellard void bdrv_init(void)
4181ea2384d3Sbellard {
41825efa9d5aSAnthony Liguori     module_call_init(MODULE_INIT_BLOCK);
4183ea2384d3Sbellard }
4184ce1a14dcSpbrook 
4185eb852011SMarkus Armbruster void bdrv_init_with_whitelist(void)
4186eb852011SMarkus Armbruster {
4187eb852011SMarkus Armbruster     use_bdrv_whitelist = 1;
4188eb852011SMarkus Armbruster     bdrv_init();
4189eb852011SMarkus Armbruster }
4190eb852011SMarkus Armbruster 
4191d7331bedSStefan Hajnoczi void *qemu_aio_get(const AIOCBInfo *aiocb_info, BlockDriverState *bs,
41926bbff9a0Saliguori                    BlockDriverCompletionFunc *cb, void *opaque)
41936bbff9a0Saliguori {
4194ce1a14dcSpbrook     BlockDriverAIOCB *acb;
4195ce1a14dcSpbrook 
4196d7331bedSStefan Hajnoczi     acb = g_slice_alloc(aiocb_info->aiocb_size);
4197d7331bedSStefan Hajnoczi     acb->aiocb_info = aiocb_info;
4198ce1a14dcSpbrook     acb->bs = bs;
4199ce1a14dcSpbrook     acb->cb = cb;
4200ce1a14dcSpbrook     acb->opaque = opaque;
4201ce1a14dcSpbrook     return acb;
4202ce1a14dcSpbrook }
4203ce1a14dcSpbrook 
4204ce1a14dcSpbrook void qemu_aio_release(void *p)
4205ce1a14dcSpbrook {
4206d37c975fSStefan Hajnoczi     BlockDriverAIOCB *acb = p;
4207d7331bedSStefan Hajnoczi     g_slice_free1(acb->aiocb_info->aiocb_size, acb);
4208ce1a14dcSpbrook }
420919cb3738Sbellard 
421019cb3738Sbellard /**************************************************************/
4211f9f05dc5SKevin Wolf /* Coroutine block device emulation */
4212f9f05dc5SKevin Wolf 
4213f9f05dc5SKevin Wolf typedef struct CoroutineIOCompletion {
4214f9f05dc5SKevin Wolf     Coroutine *coroutine;
4215f9f05dc5SKevin Wolf     int ret;
4216f9f05dc5SKevin Wolf } CoroutineIOCompletion;
4217f9f05dc5SKevin Wolf 
4218f9f05dc5SKevin Wolf static void bdrv_co_io_em_complete(void *opaque, int ret)
4219f9f05dc5SKevin Wolf {
4220f9f05dc5SKevin Wolf     CoroutineIOCompletion *co = opaque;
4221f9f05dc5SKevin Wolf 
4222f9f05dc5SKevin Wolf     co->ret = ret;
4223f9f05dc5SKevin Wolf     qemu_coroutine_enter(co->coroutine, NULL);
4224f9f05dc5SKevin Wolf }
4225f9f05dc5SKevin Wolf 
4226f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_io_em(BlockDriverState *bs, int64_t sector_num,
4227f9f05dc5SKevin Wolf                                       int nb_sectors, QEMUIOVector *iov,
4228f9f05dc5SKevin Wolf                                       bool is_write)
4229f9f05dc5SKevin Wolf {
4230f9f05dc5SKevin Wolf     CoroutineIOCompletion co = {
4231f9f05dc5SKevin Wolf         .coroutine = qemu_coroutine_self(),
4232f9f05dc5SKevin Wolf     };
4233f9f05dc5SKevin Wolf     BlockDriverAIOCB *acb;
4234f9f05dc5SKevin Wolf 
4235f9f05dc5SKevin Wolf     if (is_write) {
4236a652d160SStefan Hajnoczi         acb = bs->drv->bdrv_aio_writev(bs, sector_num, iov, nb_sectors,
4237f9f05dc5SKevin Wolf                                        bdrv_co_io_em_complete, &co);
4238f9f05dc5SKevin Wolf     } else {
4239a652d160SStefan Hajnoczi         acb = bs->drv->bdrv_aio_readv(bs, sector_num, iov, nb_sectors,
4240f9f05dc5SKevin Wolf                                       bdrv_co_io_em_complete, &co);
4241f9f05dc5SKevin Wolf     }
4242f9f05dc5SKevin Wolf 
424359370aaaSStefan Hajnoczi     trace_bdrv_co_io_em(bs, sector_num, nb_sectors, is_write, acb);
4244f9f05dc5SKevin Wolf     if (!acb) {
4245f9f05dc5SKevin Wolf         return -EIO;
4246f9f05dc5SKevin Wolf     }
4247f9f05dc5SKevin Wolf     qemu_coroutine_yield();
4248f9f05dc5SKevin Wolf 
4249f9f05dc5SKevin Wolf     return co.ret;
4250f9f05dc5SKevin Wolf }
4251f9f05dc5SKevin Wolf 
4252f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
4253f9f05dc5SKevin Wolf                                          int64_t sector_num, int nb_sectors,
4254f9f05dc5SKevin Wolf                                          QEMUIOVector *iov)
4255f9f05dc5SKevin Wolf {
4256f9f05dc5SKevin Wolf     return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, false);
4257f9f05dc5SKevin Wolf }
4258f9f05dc5SKevin Wolf 
4259f9f05dc5SKevin Wolf static int coroutine_fn bdrv_co_writev_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, true);
4264f9f05dc5SKevin Wolf }
4265f9f05dc5SKevin Wolf 
426607f07615SPaolo Bonzini static void coroutine_fn bdrv_flush_co_entry(void *opaque)
4267e7a8a783SKevin Wolf {
426807f07615SPaolo Bonzini     RwCo *rwco = opaque;
426907f07615SPaolo Bonzini 
427007f07615SPaolo Bonzini     rwco->ret = bdrv_co_flush(rwco->bs);
427107f07615SPaolo Bonzini }
427207f07615SPaolo Bonzini 
427307f07615SPaolo Bonzini int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
427407f07615SPaolo Bonzini {
4275eb489bb1SKevin Wolf     int ret;
4276eb489bb1SKevin Wolf 
427729cdb251SPaolo Bonzini     if (!bs || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
427807f07615SPaolo Bonzini         return 0;
4279eb489bb1SKevin Wolf     }
4280eb489bb1SKevin Wolf 
4281ca716364SKevin Wolf     /* Write back cached data to the OS even with cache=unsafe */
4282eb489bb1SKevin Wolf     if (bs->drv->bdrv_co_flush_to_os) {
4283eb489bb1SKevin Wolf         ret = bs->drv->bdrv_co_flush_to_os(bs);
4284eb489bb1SKevin Wolf         if (ret < 0) {
4285eb489bb1SKevin Wolf             return ret;
4286eb489bb1SKevin Wolf         }
4287eb489bb1SKevin Wolf     }
4288eb489bb1SKevin Wolf 
4289ca716364SKevin Wolf     /* But don't actually force it to the disk with cache=unsafe */
4290ca716364SKevin Wolf     if (bs->open_flags & BDRV_O_NO_FLUSH) {
4291d4c82329SKevin Wolf         goto flush_parent;
4292ca716364SKevin Wolf     }
4293ca716364SKevin Wolf 
4294eb489bb1SKevin Wolf     if (bs->drv->bdrv_co_flush_to_disk) {
429529cdb251SPaolo Bonzini         ret = bs->drv->bdrv_co_flush_to_disk(bs);
429607f07615SPaolo Bonzini     } else if (bs->drv->bdrv_aio_flush) {
429707f07615SPaolo Bonzini         BlockDriverAIOCB *acb;
4298e7a8a783SKevin Wolf         CoroutineIOCompletion co = {
4299e7a8a783SKevin Wolf             .coroutine = qemu_coroutine_self(),
4300e7a8a783SKevin Wolf         };
4301e7a8a783SKevin Wolf 
430207f07615SPaolo Bonzini         acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co);
430307f07615SPaolo Bonzini         if (acb == NULL) {
430429cdb251SPaolo Bonzini             ret = -EIO;
430507f07615SPaolo Bonzini         } else {
4306e7a8a783SKevin Wolf             qemu_coroutine_yield();
430729cdb251SPaolo Bonzini             ret = co.ret;
4308e7a8a783SKevin Wolf         }
430907f07615SPaolo Bonzini     } else {
431007f07615SPaolo Bonzini         /*
431107f07615SPaolo Bonzini          * Some block drivers always operate in either writethrough or unsafe
431207f07615SPaolo Bonzini          * mode and don't support bdrv_flush therefore. Usually qemu doesn't
431307f07615SPaolo Bonzini          * know how the server works (because the behaviour is hardcoded or
431407f07615SPaolo Bonzini          * depends on server-side configuration), so we can't ensure that
431507f07615SPaolo Bonzini          * everything is safe on disk. Returning an error doesn't work because
431607f07615SPaolo Bonzini          * that would break guests even if the server operates in writethrough
431707f07615SPaolo Bonzini          * mode.
431807f07615SPaolo Bonzini          *
431907f07615SPaolo Bonzini          * Let's hope the user knows what he's doing.
432007f07615SPaolo Bonzini          */
432129cdb251SPaolo Bonzini         ret = 0;
432207f07615SPaolo Bonzini     }
432329cdb251SPaolo Bonzini     if (ret < 0) {
432429cdb251SPaolo Bonzini         return ret;
432529cdb251SPaolo Bonzini     }
432629cdb251SPaolo Bonzini 
432729cdb251SPaolo Bonzini     /* Now flush the underlying protocol.  It will also have BDRV_O_NO_FLUSH
432829cdb251SPaolo Bonzini      * in the case of cache=unsafe, so there are no useless flushes.
432929cdb251SPaolo Bonzini      */
4330d4c82329SKevin Wolf flush_parent:
433129cdb251SPaolo Bonzini     return bdrv_co_flush(bs->file);
433207f07615SPaolo Bonzini }
433307f07615SPaolo Bonzini 
43340f15423cSAnthony Liguori void bdrv_invalidate_cache(BlockDriverState *bs)
43350f15423cSAnthony Liguori {
43360f15423cSAnthony Liguori     if (bs->drv && bs->drv->bdrv_invalidate_cache) {
43370f15423cSAnthony Liguori         bs->drv->bdrv_invalidate_cache(bs);
43380f15423cSAnthony Liguori     }
43390f15423cSAnthony Liguori }
43400f15423cSAnthony Liguori 
43410f15423cSAnthony Liguori void bdrv_invalidate_cache_all(void)
43420f15423cSAnthony Liguori {
43430f15423cSAnthony Liguori     BlockDriverState *bs;
43440f15423cSAnthony Liguori 
43450f15423cSAnthony Liguori     QTAILQ_FOREACH(bs, &bdrv_states, list) {
43460f15423cSAnthony Liguori         bdrv_invalidate_cache(bs);
43470f15423cSAnthony Liguori     }
43480f15423cSAnthony Liguori }
43490f15423cSAnthony Liguori 
435007789269SBenoît Canet void bdrv_clear_incoming_migration_all(void)
435107789269SBenoît Canet {
435207789269SBenoît Canet     BlockDriverState *bs;
435307789269SBenoît Canet 
435407789269SBenoît Canet     QTAILQ_FOREACH(bs, &bdrv_states, list) {
435507789269SBenoît Canet         bs->open_flags = bs->open_flags & ~(BDRV_O_INCOMING);
435607789269SBenoît Canet     }
435707789269SBenoît Canet }
435807789269SBenoît Canet 
435907f07615SPaolo Bonzini int bdrv_flush(BlockDriverState *bs)
436007f07615SPaolo Bonzini {
436107f07615SPaolo Bonzini     Coroutine *co;
436207f07615SPaolo Bonzini     RwCo rwco = {
436307f07615SPaolo Bonzini         .bs = bs,
436407f07615SPaolo Bonzini         .ret = NOT_DONE,
436507f07615SPaolo Bonzini     };
436607f07615SPaolo Bonzini 
436707f07615SPaolo Bonzini     if (qemu_in_coroutine()) {
436807f07615SPaolo Bonzini         /* Fast-path if already in coroutine context */
436907f07615SPaolo Bonzini         bdrv_flush_co_entry(&rwco);
437007f07615SPaolo Bonzini     } else {
437107f07615SPaolo Bonzini         co = qemu_coroutine_create(bdrv_flush_co_entry);
437207f07615SPaolo Bonzini         qemu_coroutine_enter(co, &rwco);
437307f07615SPaolo Bonzini         while (rwco.ret == NOT_DONE) {
437407f07615SPaolo Bonzini             qemu_aio_wait();
437507f07615SPaolo Bonzini         }
437607f07615SPaolo Bonzini     }
437707f07615SPaolo Bonzini 
437807f07615SPaolo Bonzini     return rwco.ret;
437907f07615SPaolo Bonzini }
4380e7a8a783SKevin Wolf 
43814265d620SPaolo Bonzini static void coroutine_fn bdrv_discard_co_entry(void *opaque)
43824265d620SPaolo Bonzini {
43834265d620SPaolo Bonzini     RwCo *rwco = opaque;
43844265d620SPaolo Bonzini 
43854265d620SPaolo Bonzini     rwco->ret = bdrv_co_discard(rwco->bs, rwco->sector_num, rwco->nb_sectors);
43864265d620SPaolo Bonzini }
43874265d620SPaolo Bonzini 
43884265d620SPaolo Bonzini int coroutine_fn bdrv_co_discard(BlockDriverState *bs, int64_t sector_num,
43894265d620SPaolo Bonzini                                  int nb_sectors)
43904265d620SPaolo Bonzini {
43914265d620SPaolo Bonzini     if (!bs->drv) {
43924265d620SPaolo Bonzini         return -ENOMEDIUM;
43934265d620SPaolo Bonzini     } else if (bdrv_check_request(bs, sector_num, nb_sectors)) {
43944265d620SPaolo Bonzini         return -EIO;
43954265d620SPaolo Bonzini     } else if (bs->read_only) {
43964265d620SPaolo Bonzini         return -EROFS;
4397df702c9bSPaolo Bonzini     }
4398df702c9bSPaolo Bonzini 
4399df702c9bSPaolo Bonzini     if (bs->dirty_bitmap) {
44008f0720ecSPaolo Bonzini         bdrv_reset_dirty(bs, sector_num, nb_sectors);
4401df702c9bSPaolo Bonzini     }
4402df702c9bSPaolo Bonzini 
44039e8f1835SPaolo Bonzini     /* Do nothing if disabled.  */
44049e8f1835SPaolo Bonzini     if (!(bs->open_flags & BDRV_O_UNMAP)) {
44059e8f1835SPaolo Bonzini         return 0;
44069e8f1835SPaolo Bonzini     }
44079e8f1835SPaolo Bonzini 
4408df702c9bSPaolo Bonzini     if (bs->drv->bdrv_co_discard) {
44094265d620SPaolo Bonzini         return bs->drv->bdrv_co_discard(bs, sector_num, nb_sectors);
44104265d620SPaolo Bonzini     } else if (bs->drv->bdrv_aio_discard) {
44114265d620SPaolo Bonzini         BlockDriverAIOCB *acb;
44124265d620SPaolo Bonzini         CoroutineIOCompletion co = {
44134265d620SPaolo Bonzini             .coroutine = qemu_coroutine_self(),
44144265d620SPaolo Bonzini         };
44154265d620SPaolo Bonzini 
44164265d620SPaolo Bonzini         acb = bs->drv->bdrv_aio_discard(bs, sector_num, nb_sectors,
44174265d620SPaolo Bonzini                                         bdrv_co_io_em_complete, &co);
44184265d620SPaolo Bonzini         if (acb == NULL) {
44194265d620SPaolo Bonzini             return -EIO;
44204265d620SPaolo Bonzini         } else {
44214265d620SPaolo Bonzini             qemu_coroutine_yield();
44224265d620SPaolo Bonzini             return co.ret;
44234265d620SPaolo Bonzini         }
44244265d620SPaolo Bonzini     } else {
44254265d620SPaolo Bonzini         return 0;
44264265d620SPaolo Bonzini     }
44274265d620SPaolo Bonzini }
44284265d620SPaolo Bonzini 
44294265d620SPaolo Bonzini int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors)
44304265d620SPaolo Bonzini {
44314265d620SPaolo Bonzini     Coroutine *co;
44324265d620SPaolo Bonzini     RwCo rwco = {
44334265d620SPaolo Bonzini         .bs = bs,
44344265d620SPaolo Bonzini         .sector_num = sector_num,
44354265d620SPaolo Bonzini         .nb_sectors = nb_sectors,
44364265d620SPaolo Bonzini         .ret = NOT_DONE,
44374265d620SPaolo Bonzini     };
44384265d620SPaolo Bonzini 
44394265d620SPaolo Bonzini     if (qemu_in_coroutine()) {
44404265d620SPaolo Bonzini         /* Fast-path if already in coroutine context */
44414265d620SPaolo Bonzini         bdrv_discard_co_entry(&rwco);
44424265d620SPaolo Bonzini     } else {
44434265d620SPaolo Bonzini         co = qemu_coroutine_create(bdrv_discard_co_entry);
44444265d620SPaolo Bonzini         qemu_coroutine_enter(co, &rwco);
44454265d620SPaolo Bonzini         while (rwco.ret == NOT_DONE) {
44464265d620SPaolo Bonzini             qemu_aio_wait();
44474265d620SPaolo Bonzini         }
44484265d620SPaolo Bonzini     }
44494265d620SPaolo Bonzini 
44504265d620SPaolo Bonzini     return rwco.ret;
44514265d620SPaolo Bonzini }
44524265d620SPaolo Bonzini 
4453f9f05dc5SKevin Wolf /**************************************************************/
445419cb3738Sbellard /* removable device support */
445519cb3738Sbellard 
445619cb3738Sbellard /**
445719cb3738Sbellard  * Return TRUE if the media is present
445819cb3738Sbellard  */
445919cb3738Sbellard int bdrv_is_inserted(BlockDriverState *bs)
446019cb3738Sbellard {
446119cb3738Sbellard     BlockDriver *drv = bs->drv;
4462a1aff5bfSMarkus Armbruster 
446319cb3738Sbellard     if (!drv)
446419cb3738Sbellard         return 0;
446519cb3738Sbellard     if (!drv->bdrv_is_inserted)
4466a1aff5bfSMarkus Armbruster         return 1;
4467a1aff5bfSMarkus Armbruster     return drv->bdrv_is_inserted(bs);
446819cb3738Sbellard }
446919cb3738Sbellard 
447019cb3738Sbellard /**
44718e49ca46SMarkus Armbruster  * Return whether the media changed since the last call to this
44728e49ca46SMarkus Armbruster  * function, or -ENOTSUP if we don't know.  Most drivers don't know.
447319cb3738Sbellard  */
447419cb3738Sbellard int bdrv_media_changed(BlockDriverState *bs)
447519cb3738Sbellard {
447619cb3738Sbellard     BlockDriver *drv = bs->drv;
447719cb3738Sbellard 
44788e49ca46SMarkus Armbruster     if (drv && drv->bdrv_media_changed) {
44798e49ca46SMarkus Armbruster         return drv->bdrv_media_changed(bs);
44808e49ca46SMarkus Armbruster     }
44818e49ca46SMarkus Armbruster     return -ENOTSUP;
448219cb3738Sbellard }
448319cb3738Sbellard 
448419cb3738Sbellard /**
448519cb3738Sbellard  * If eject_flag is TRUE, eject the media. Otherwise, close the tray
448619cb3738Sbellard  */
4487f36f3949SLuiz Capitulino void bdrv_eject(BlockDriverState *bs, bool eject_flag)
448819cb3738Sbellard {
448919cb3738Sbellard     BlockDriver *drv = bs->drv;
449019cb3738Sbellard 
4491822e1cd1SMarkus Armbruster     if (drv && drv->bdrv_eject) {
4492822e1cd1SMarkus Armbruster         drv->bdrv_eject(bs, eject_flag);
449319cb3738Sbellard     }
44946f382ed2SLuiz Capitulino 
44956f382ed2SLuiz Capitulino     if (bs->device_name[0] != '\0') {
44966f382ed2SLuiz Capitulino         bdrv_emit_qmp_eject_event(bs, eject_flag);
44976f382ed2SLuiz Capitulino     }
449819cb3738Sbellard }
449919cb3738Sbellard 
450019cb3738Sbellard /**
450119cb3738Sbellard  * Lock or unlock the media (if it is locked, the user won't be able
450219cb3738Sbellard  * to eject it manually).
450319cb3738Sbellard  */
4504025e849aSMarkus Armbruster void bdrv_lock_medium(BlockDriverState *bs, bool locked)
450519cb3738Sbellard {
450619cb3738Sbellard     BlockDriver *drv = bs->drv;
450719cb3738Sbellard 
4508025e849aSMarkus Armbruster     trace_bdrv_lock_medium(bs, locked);
4509b8c6d095SStefan Hajnoczi 
4510025e849aSMarkus Armbruster     if (drv && drv->bdrv_lock_medium) {
4511025e849aSMarkus Armbruster         drv->bdrv_lock_medium(bs, locked);
451219cb3738Sbellard     }
451319cb3738Sbellard }
4514985a03b0Sths 
4515985a03b0Sths /* needed for generic scsi interface */
4516985a03b0Sths 
4517985a03b0Sths int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
4518985a03b0Sths {
4519985a03b0Sths     BlockDriver *drv = bs->drv;
4520985a03b0Sths 
4521985a03b0Sths     if (drv && drv->bdrv_ioctl)
4522985a03b0Sths         return drv->bdrv_ioctl(bs, req, buf);
4523985a03b0Sths     return -ENOTSUP;
4524985a03b0Sths }
45257d780669Saliguori 
4526221f715dSaliguori BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
4527221f715dSaliguori         unsigned long int req, void *buf,
45287d780669Saliguori         BlockDriverCompletionFunc *cb, void *opaque)
45297d780669Saliguori {
4530221f715dSaliguori     BlockDriver *drv = bs->drv;
45317d780669Saliguori 
4532221f715dSaliguori     if (drv && drv->bdrv_aio_ioctl)
4533221f715dSaliguori         return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
4534221f715dSaliguori     return NULL;
45357d780669Saliguori }
4536e268ca52Saliguori 
45377b6f9300SMarkus Armbruster void bdrv_set_buffer_alignment(BlockDriverState *bs, int align)
45387b6f9300SMarkus Armbruster {
45397b6f9300SMarkus Armbruster     bs->buffer_alignment = align;
45407b6f9300SMarkus Armbruster }
45417cd1e32aSlirans@il.ibm.com 
4542e268ca52Saliguori void *qemu_blockalign(BlockDriverState *bs, size_t size)
4543e268ca52Saliguori {
4544e268ca52Saliguori     return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
4545e268ca52Saliguori }
45467cd1e32aSlirans@il.ibm.com 
4547c53b1c51SStefan Hajnoczi /*
4548c53b1c51SStefan Hajnoczi  * Check if all memory in this vector is sector aligned.
4549c53b1c51SStefan Hajnoczi  */
4550c53b1c51SStefan Hajnoczi bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov)
4551c53b1c51SStefan Hajnoczi {
4552c53b1c51SStefan Hajnoczi     int i;
4553c53b1c51SStefan Hajnoczi 
4554c53b1c51SStefan Hajnoczi     for (i = 0; i < qiov->niov; i++) {
4555c53b1c51SStefan Hajnoczi         if ((uintptr_t) qiov->iov[i].iov_base % bs->buffer_alignment) {
4556c53b1c51SStefan Hajnoczi             return false;
4557c53b1c51SStefan Hajnoczi         }
4558c53b1c51SStefan Hajnoczi     }
4559c53b1c51SStefan Hajnoczi 
4560c53b1c51SStefan Hajnoczi     return true;
4561c53b1c51SStefan Hajnoczi }
4562c53b1c51SStefan Hajnoczi 
456350717e94SPaolo Bonzini void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity)
45647cd1e32aSlirans@il.ibm.com {
45657cd1e32aSlirans@il.ibm.com     int64_t bitmap_size;
4566a55eb92cSJan Kiszka 
456750717e94SPaolo Bonzini     assert((granularity & (granularity - 1)) == 0);
456850717e94SPaolo Bonzini 
456950717e94SPaolo Bonzini     if (granularity) {
457050717e94SPaolo Bonzini         granularity >>= BDRV_SECTOR_BITS;
457150717e94SPaolo Bonzini         assert(!bs->dirty_bitmap);
45728f0720ecSPaolo Bonzini         bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS);
457350717e94SPaolo Bonzini         bs->dirty_bitmap = hbitmap_alloc(bitmap_size, ffs(granularity) - 1);
45747cd1e32aSlirans@il.ibm.com     } else {
4575c6d22830SJan Kiszka         if (bs->dirty_bitmap) {
45768f0720ecSPaolo Bonzini             hbitmap_free(bs->dirty_bitmap);
4577c6d22830SJan Kiszka             bs->dirty_bitmap = NULL;
45787cd1e32aSlirans@il.ibm.com         }
45797cd1e32aSlirans@il.ibm.com     }
45807cd1e32aSlirans@il.ibm.com }
45817cd1e32aSlirans@il.ibm.com 
45827cd1e32aSlirans@il.ibm.com int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
45837cd1e32aSlirans@il.ibm.com {
45848f0720ecSPaolo Bonzini     if (bs->dirty_bitmap) {
45858f0720ecSPaolo Bonzini         return hbitmap_get(bs->dirty_bitmap, sector);
45867cd1e32aSlirans@il.ibm.com     } else {
45877cd1e32aSlirans@il.ibm.com         return 0;
45887cd1e32aSlirans@il.ibm.com     }
45897cd1e32aSlirans@il.ibm.com }
45907cd1e32aSlirans@il.ibm.com 
45918f0720ecSPaolo Bonzini void bdrv_dirty_iter_init(BlockDriverState *bs, HBitmapIter *hbi)
45921755da16SPaolo Bonzini {
45938f0720ecSPaolo Bonzini     hbitmap_iter_init(hbi, bs->dirty_bitmap, 0);
45941755da16SPaolo Bonzini }
45951755da16SPaolo Bonzini 
45961755da16SPaolo Bonzini void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector,
45971755da16SPaolo Bonzini                     int nr_sectors)
45981755da16SPaolo Bonzini {
45998f0720ecSPaolo Bonzini     hbitmap_set(bs->dirty_bitmap, cur_sector, nr_sectors);
46001755da16SPaolo Bonzini }
46011755da16SPaolo Bonzini 
46027cd1e32aSlirans@il.ibm.com void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
46037cd1e32aSlirans@il.ibm.com                       int nr_sectors)
46047cd1e32aSlirans@il.ibm.com {
46058f0720ecSPaolo Bonzini     hbitmap_reset(bs->dirty_bitmap, cur_sector, nr_sectors);
46067cd1e32aSlirans@il.ibm.com }
4607aaa0eb75SLiran Schour 
4608aaa0eb75SLiran Schour int64_t bdrv_get_dirty_count(BlockDriverState *bs)
4609aaa0eb75SLiran Schour {
46108f0720ecSPaolo Bonzini     if (bs->dirty_bitmap) {
4611acc906c6SPaolo Bonzini         return hbitmap_count(bs->dirty_bitmap);
46128f0720ecSPaolo Bonzini     } else {
46138f0720ecSPaolo Bonzini         return 0;
46148f0720ecSPaolo Bonzini     }
4615aaa0eb75SLiran Schour }
4616f88e1a42SJes Sorensen 
4617db593f25SMarcelo Tosatti void bdrv_set_in_use(BlockDriverState *bs, int in_use)
4618db593f25SMarcelo Tosatti {
4619db593f25SMarcelo Tosatti     assert(bs->in_use != in_use);
4620db593f25SMarcelo Tosatti     bs->in_use = in_use;
4621db593f25SMarcelo Tosatti }
4622db593f25SMarcelo Tosatti 
4623db593f25SMarcelo Tosatti int bdrv_in_use(BlockDriverState *bs)
4624db593f25SMarcelo Tosatti {
4625db593f25SMarcelo Tosatti     return bs->in_use;
4626db593f25SMarcelo Tosatti }
4627db593f25SMarcelo Tosatti 
462828a7282aSLuiz Capitulino void bdrv_iostatus_enable(BlockDriverState *bs)
462928a7282aSLuiz Capitulino {
4630d6bf279eSLuiz Capitulino     bs->iostatus_enabled = true;
463158e21ef5SLuiz Capitulino     bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
463228a7282aSLuiz Capitulino }
463328a7282aSLuiz Capitulino 
463428a7282aSLuiz Capitulino /* The I/O status is only enabled if the drive explicitly
463528a7282aSLuiz Capitulino  * enables it _and_ the VM is configured to stop on errors */
463628a7282aSLuiz Capitulino bool bdrv_iostatus_is_enabled(const BlockDriverState *bs)
463728a7282aSLuiz Capitulino {
4638d6bf279eSLuiz Capitulino     return (bs->iostatus_enabled &&
463992aa5c6dSPaolo Bonzini            (bs->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
464092aa5c6dSPaolo Bonzini             bs->on_write_error == BLOCKDEV_ON_ERROR_STOP   ||
464192aa5c6dSPaolo Bonzini             bs->on_read_error == BLOCKDEV_ON_ERROR_STOP));
464228a7282aSLuiz Capitulino }
464328a7282aSLuiz Capitulino 
464428a7282aSLuiz Capitulino void bdrv_iostatus_disable(BlockDriverState *bs)
464528a7282aSLuiz Capitulino {
4646d6bf279eSLuiz Capitulino     bs->iostatus_enabled = false;
464728a7282aSLuiz Capitulino }
464828a7282aSLuiz Capitulino 
464928a7282aSLuiz Capitulino void bdrv_iostatus_reset(BlockDriverState *bs)
465028a7282aSLuiz Capitulino {
465128a7282aSLuiz Capitulino     if (bdrv_iostatus_is_enabled(bs)) {
465258e21ef5SLuiz Capitulino         bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
46533bd293c3SPaolo Bonzini         if (bs->job) {
46543bd293c3SPaolo Bonzini             block_job_iostatus_reset(bs->job);
46553bd293c3SPaolo Bonzini         }
465628a7282aSLuiz Capitulino     }
465728a7282aSLuiz Capitulino }
465828a7282aSLuiz Capitulino 
465928a7282aSLuiz Capitulino void bdrv_iostatus_set_err(BlockDriverState *bs, int error)
466028a7282aSLuiz Capitulino {
46613e1caa5fSPaolo Bonzini     assert(bdrv_iostatus_is_enabled(bs));
46623e1caa5fSPaolo Bonzini     if (bs->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
466358e21ef5SLuiz Capitulino         bs->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
466458e21ef5SLuiz Capitulino                                          BLOCK_DEVICE_IO_STATUS_FAILED;
466528a7282aSLuiz Capitulino     }
466628a7282aSLuiz Capitulino }
466728a7282aSLuiz Capitulino 
4668a597e79cSChristoph Hellwig void
4669a597e79cSChristoph Hellwig bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, int64_t bytes,
4670a597e79cSChristoph Hellwig         enum BlockAcctType type)
4671a597e79cSChristoph Hellwig {
4672a597e79cSChristoph Hellwig     assert(type < BDRV_MAX_IOTYPE);
4673a597e79cSChristoph Hellwig 
4674a597e79cSChristoph Hellwig     cookie->bytes = bytes;
4675c488c7f6SChristoph Hellwig     cookie->start_time_ns = get_clock();
4676a597e79cSChristoph Hellwig     cookie->type = type;
4677a597e79cSChristoph Hellwig }
4678a597e79cSChristoph Hellwig 
4679a597e79cSChristoph Hellwig void
4680a597e79cSChristoph Hellwig bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie)
4681a597e79cSChristoph Hellwig {
4682a597e79cSChristoph Hellwig     assert(cookie->type < BDRV_MAX_IOTYPE);
4683a597e79cSChristoph Hellwig 
4684a597e79cSChristoph Hellwig     bs->nr_bytes[cookie->type] += cookie->bytes;
4685a597e79cSChristoph Hellwig     bs->nr_ops[cookie->type]++;
4686c488c7f6SChristoph Hellwig     bs->total_time_ns[cookie->type] += get_clock() - cookie->start_time_ns;
4687a597e79cSChristoph Hellwig }
4688a597e79cSChristoph Hellwig 
4689d92ada22SLuiz Capitulino void bdrv_img_create(const char *filename, const char *fmt,
4690f88e1a42SJes Sorensen                      const char *base_filename, const char *base_fmt,
4691f382d43aSMiroslav Rezanina                      char *options, uint64_t img_size, int flags,
4692f382d43aSMiroslav Rezanina                      Error **errp, bool quiet)
4693f88e1a42SJes Sorensen {
4694f88e1a42SJes Sorensen     QEMUOptionParameter *param = NULL, *create_options = NULL;
4695d220894eSKevin Wolf     QEMUOptionParameter *backing_fmt, *backing_file, *size;
4696f88e1a42SJes Sorensen     BlockDriverState *bs = NULL;
4697f88e1a42SJes Sorensen     BlockDriver *drv, *proto_drv;
469896df67d1SStefan Hajnoczi     BlockDriver *backing_drv = NULL;
4699f88e1a42SJes Sorensen     int ret = 0;
4700f88e1a42SJes Sorensen 
4701f88e1a42SJes Sorensen     /* Find driver and parse its options */
4702f88e1a42SJes Sorensen     drv = bdrv_find_format(fmt);
4703f88e1a42SJes Sorensen     if (!drv) {
470471c79813SLuiz Capitulino         error_setg(errp, "Unknown file format '%s'", fmt);
4705d92ada22SLuiz Capitulino         return;
4706f88e1a42SJes Sorensen     }
4707f88e1a42SJes Sorensen 
4708f88e1a42SJes Sorensen     proto_drv = bdrv_find_protocol(filename);
4709f88e1a42SJes Sorensen     if (!proto_drv) {
471071c79813SLuiz Capitulino         error_setg(errp, "Unknown protocol '%s'", filename);
4711d92ada22SLuiz Capitulino         return;
4712f88e1a42SJes Sorensen     }
4713f88e1a42SJes Sorensen 
4714f88e1a42SJes Sorensen     create_options = append_option_parameters(create_options,
4715f88e1a42SJes Sorensen                                               drv->create_options);
4716f88e1a42SJes Sorensen     create_options = append_option_parameters(create_options,
4717f88e1a42SJes Sorensen                                               proto_drv->create_options);
4718f88e1a42SJes Sorensen 
4719f88e1a42SJes Sorensen     /* Create parameter list with default values */
4720f88e1a42SJes Sorensen     param = parse_option_parameters("", create_options, param);
4721f88e1a42SJes Sorensen 
4722f88e1a42SJes Sorensen     set_option_parameter_int(param, BLOCK_OPT_SIZE, img_size);
4723f88e1a42SJes Sorensen 
4724f88e1a42SJes Sorensen     /* Parse -o options */
4725f88e1a42SJes Sorensen     if (options) {
4726f88e1a42SJes Sorensen         param = parse_option_parameters(options, create_options, param);
4727f88e1a42SJes Sorensen         if (param == NULL) {
472871c79813SLuiz Capitulino             error_setg(errp, "Invalid options for file format '%s'.", fmt);
4729f88e1a42SJes Sorensen             goto out;
4730f88e1a42SJes Sorensen         }
4731f88e1a42SJes Sorensen     }
4732f88e1a42SJes Sorensen 
4733f88e1a42SJes Sorensen     if (base_filename) {
4734f88e1a42SJes Sorensen         if (set_option_parameter(param, BLOCK_OPT_BACKING_FILE,
4735f88e1a42SJes Sorensen                                  base_filename)) {
473671c79813SLuiz Capitulino             error_setg(errp, "Backing file not supported for file format '%s'",
473771c79813SLuiz Capitulino                        fmt);
4738f88e1a42SJes Sorensen             goto out;
4739f88e1a42SJes Sorensen         }
4740f88e1a42SJes Sorensen     }
4741f88e1a42SJes Sorensen 
4742f88e1a42SJes Sorensen     if (base_fmt) {
4743f88e1a42SJes Sorensen         if (set_option_parameter(param, BLOCK_OPT_BACKING_FMT, base_fmt)) {
474471c79813SLuiz Capitulino             error_setg(errp, "Backing file format not supported for file "
474571c79813SLuiz Capitulino                              "format '%s'", fmt);
4746f88e1a42SJes Sorensen             goto out;
4747f88e1a42SJes Sorensen         }
4748f88e1a42SJes Sorensen     }
4749f88e1a42SJes Sorensen 
4750792da93aSJes Sorensen     backing_file = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
4751792da93aSJes Sorensen     if (backing_file && backing_file->value.s) {
4752792da93aSJes Sorensen         if (!strcmp(filename, backing_file->value.s)) {
475371c79813SLuiz Capitulino             error_setg(errp, "Error: Trying to create an image with the "
475471c79813SLuiz Capitulino                              "same filename as the backing file");
4755792da93aSJes Sorensen             goto out;
4756792da93aSJes Sorensen         }
4757792da93aSJes Sorensen     }
4758792da93aSJes Sorensen 
4759f88e1a42SJes Sorensen     backing_fmt = get_option_parameter(param, BLOCK_OPT_BACKING_FMT);
4760f88e1a42SJes Sorensen     if (backing_fmt && backing_fmt->value.s) {
476196df67d1SStefan Hajnoczi         backing_drv = bdrv_find_format(backing_fmt->value.s);
476296df67d1SStefan Hajnoczi         if (!backing_drv) {
476371c79813SLuiz Capitulino             error_setg(errp, "Unknown backing file format '%s'",
476471c79813SLuiz Capitulino                        backing_fmt->value.s);
4765f88e1a42SJes Sorensen             goto out;
4766f88e1a42SJes Sorensen         }
4767f88e1a42SJes Sorensen     }
4768f88e1a42SJes Sorensen 
4769f88e1a42SJes Sorensen     // The size for the image must always be specified, with one exception:
4770f88e1a42SJes Sorensen     // If we are using a backing file, we can obtain the size from there
4771d220894eSKevin Wolf     size = get_option_parameter(param, BLOCK_OPT_SIZE);
4772d220894eSKevin Wolf     if (size && size->value.n == -1) {
4773f88e1a42SJes Sorensen         if (backing_file && backing_file->value.s) {
4774f88e1a42SJes Sorensen             uint64_t size;
4775f88e1a42SJes Sorensen             char buf[32];
477663090dacSPaolo Bonzini             int back_flags;
477763090dacSPaolo Bonzini 
477863090dacSPaolo Bonzini             /* backing files always opened read-only */
477963090dacSPaolo Bonzini             back_flags =
478063090dacSPaolo Bonzini                 flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
4781f88e1a42SJes Sorensen 
4782f88e1a42SJes Sorensen             bs = bdrv_new("");
4783f88e1a42SJes Sorensen 
4784de9c0cecSKevin Wolf             ret = bdrv_open(bs, backing_file->value.s, NULL, back_flags,
4785de9c0cecSKevin Wolf                             backing_drv);
4786f88e1a42SJes Sorensen             if (ret < 0) {
478771c79813SLuiz Capitulino                 error_setg_errno(errp, -ret, "Could not open '%s'",
478871c79813SLuiz Capitulino                                  backing_file->value.s);
4789f88e1a42SJes Sorensen                 goto out;
4790f88e1a42SJes Sorensen             }
4791f88e1a42SJes Sorensen             bdrv_get_geometry(bs, &size);
4792f88e1a42SJes Sorensen             size *= 512;
4793f88e1a42SJes Sorensen 
4794f88e1a42SJes Sorensen             snprintf(buf, sizeof(buf), "%" PRId64, size);
4795f88e1a42SJes Sorensen             set_option_parameter(param, BLOCK_OPT_SIZE, buf);
4796f88e1a42SJes Sorensen         } else {
479771c79813SLuiz Capitulino             error_setg(errp, "Image creation needs a size parameter");
4798f88e1a42SJes Sorensen             goto out;
4799f88e1a42SJes Sorensen         }
4800f88e1a42SJes Sorensen     }
4801f88e1a42SJes Sorensen 
4802f382d43aSMiroslav Rezanina     if (!quiet) {
4803f88e1a42SJes Sorensen         printf("Formatting '%s', fmt=%s ", filename, fmt);
4804f88e1a42SJes Sorensen         print_option_parameters(param);
4805f88e1a42SJes Sorensen         puts("");
4806f382d43aSMiroslav Rezanina     }
4807f88e1a42SJes Sorensen     ret = bdrv_create(drv, filename, param);
4808f88e1a42SJes Sorensen     if (ret < 0) {
4809f88e1a42SJes Sorensen         if (ret == -ENOTSUP) {
481071c79813SLuiz Capitulino             error_setg(errp,"Formatting or formatting option not supported for "
481171c79813SLuiz Capitulino                             "file format '%s'", fmt);
4812f88e1a42SJes Sorensen         } else if (ret == -EFBIG) {
481371c79813SLuiz Capitulino             error_setg(errp, "The image size is too large for file format '%s'",
481471c79813SLuiz Capitulino                        fmt);
4815f88e1a42SJes Sorensen         } else {
481671c79813SLuiz Capitulino             error_setg(errp, "%s: error while creating %s: %s", filename, fmt,
481771c79813SLuiz Capitulino                        strerror(-ret));
4818f88e1a42SJes Sorensen         }
4819f88e1a42SJes Sorensen     }
4820f88e1a42SJes Sorensen 
4821f88e1a42SJes Sorensen out:
4822f88e1a42SJes Sorensen     free_option_parameters(create_options);
4823f88e1a42SJes Sorensen     free_option_parameters(param);
4824f88e1a42SJes Sorensen 
4825f88e1a42SJes Sorensen     if (bs) {
4826f88e1a42SJes Sorensen         bdrv_delete(bs);
4827f88e1a42SJes Sorensen     }
4828f88e1a42SJes Sorensen }
482985d126f3SStefan Hajnoczi 
483085d126f3SStefan Hajnoczi AioContext *bdrv_get_aio_context(BlockDriverState *bs)
483185d126f3SStefan Hajnoczi {
483285d126f3SStefan Hajnoczi     /* Currently BlockDriverState always uses the main loop AioContext */
483385d126f3SStefan Hajnoczi     return qemu_get_aio_context();
483485d126f3SStefan Hajnoczi }
4835