]> git.proxmox.com Git - mirror_qemu.git/blame - include/sysemu/block-backend.h
block: Switch transfer length bounds to byte-based
[mirror_qemu.git] / include / sysemu / block-backend.h
CommitLineData
26f54e9a
MA
1/*
2 * QEMU Block backends
3 *
60cb2fa7 4 * Copyright (C) 2014-2016 Red Hat, Inc.
26f54e9a
MA
5 *
6 * Authors:
7 * Markus Armbruster <armbru@redhat.com>,
8 *
9 * This work is licensed under the terms of the GNU LGPL, version 2.1
10 * or later. See the COPYING.LIB file in the top-level directory.
11 */
12
13#ifndef BLOCK_BACKEND_H
14#define BLOCK_BACKEND_H
15
daf015ef 16#include "qemu/iov.h"
27ccdd52 17#include "block/throttle-groups.h"
daf015ef 18
4be74634
MA
19/*
20 * TODO Have to include block/block.h for a bunch of block layer
21 * types. Unfortunately, this pulls in the whole BlockDriverState
22 * API, which we don't want used by many BlockBackend users. Some of
23 * the types belong here, and the rest should be split into a common
24 * header and one for the BlockDriverState API.
25 */
26#include "block/block.h"
27
a7f53e26
MA
28/* Callbacks for block device models */
29typedef struct BlockDevOps {
30 /*
31 * Runs when virtual media changed (monitor commands eject, change)
32 * Argument load is true on load and false on eject.
33 * Beware: doesn't run when a host device's physical media
34 * changes. Sure would be useful if it did.
35 * Device models with removable media must implement this callback.
36 */
37 void (*change_media_cb)(void *opaque, bool load);
38 /*
39 * Runs when an eject request is issued from the monitor, the tray
40 * is closed, and the medium is locked.
41 * Device models that do not implement is_medium_locked will not need
42 * this callback. Device models that can lock the medium or tray might
43 * want to implement the callback and unlock the tray when "force" is
44 * true, even if they do not support eject requests.
45 */
46 void (*eject_request_cb)(void *opaque, bool force);
47 /*
48 * Is the virtual tray open?
49 * Device models implement this only when the device has a tray.
50 */
51 bool (*is_tray_open)(void *opaque);
52 /*
53 * Is the virtual medium locked into the device?
54 * Device models implement this only when device has such a lock.
55 */
56 bool (*is_medium_locked)(void *opaque);
57 /*
58 * Runs when the size changed (e.g. monitor command block_resize)
59 */
60 void (*resize_cb)(void *opaque);
61} BlockDevOps;
62
f2cd875d
KW
63/* This struct is embedded in (the private) BlockBackend struct and contains
64 * fields that must be public. This is in particular for QLIST_ENTRY() and
65 * friends so that BlockBackends can be kept in lists outside block-backend.c */
66typedef struct BlockBackendPublic {
27ccdd52
KW
67 /* I/O throttling.
68 * throttle_state tells us if this BlockBackend has I/O limits configured.
69 * io_limits_disabled tells us if they are currently being enforced */
70 CoQueue throttled_reqs[2];
71 unsigned int io_limits_disabled;
72
31dce3cc
KW
73 /* The following fields are protected by the ThrottleGroup lock.
74 * See the ThrottleGroup documentation for details. */
27ccdd52
KW
75 ThrottleState *throttle_state;
76 ThrottleTimers throttle_timers;
77 unsigned pending_reqs[2];
31dce3cc 78 QLIST_ENTRY(BlockBackendPublic) round_robin;
f2cd875d
KW
79} BlockBackendPublic;
80
109525ad 81BlockBackend *blk_new(void);
efaa7c4e
HR
82BlockBackend *blk_new_open(const char *filename, const char *reference,
83 QDict *options, int flags, Error **errp);
f636ae85 84int blk_get_refcnt(BlockBackend *blk);
26f54e9a
MA
85void blk_ref(BlockBackend *blk);
86void blk_unref(BlockBackend *blk);
d8da3cef 87void blk_remove_all_bs(void);
26f54e9a
MA
88const char *blk_name(BlockBackend *blk);
89BlockBackend *blk_by_name(const char *name);
90BlockBackend *blk_next(BlockBackend *blk);
e5e78550
HR
91bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp);
92void monitor_remove_blk(BlockBackend *blk);
26f54e9a 93
f2cd875d
KW
94BlockBackendPublic *blk_get_public(BlockBackend *blk);
95BlockBackend *blk_by_public(BlockBackendPublic *public);
96
7e7d56d9 97BlockDriverState *blk_bs(BlockBackend *blk);
1c95f7e1 98void blk_remove_bs(BlockBackend *blk);
0c3c36d6 99void blk_insert_bs(BlockBackend *blk, BlockDriverState *bs);
dde33812 100bool bdrv_has_blk(BlockDriverState *bs);
7e7d56d9 101
c10c9d96 102void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow);
4be74634 103void blk_iostatus_enable(BlockBackend *blk);
373340b2
HR
104bool blk_iostatus_is_enabled(const BlockBackend *blk);
105BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk);
106void blk_iostatus_disable(BlockBackend *blk);
107void blk_iostatus_reset(BlockBackend *blk);
108void blk_iostatus_set_err(BlockBackend *blk, int error);
4be74634
MA
109int blk_attach_dev(BlockBackend *blk, void *dev);
110void blk_attach_dev_nofail(BlockBackend *blk, void *dev);
111void blk_detach_dev(BlockBackend *blk, void *dev);
112void *blk_get_attached_dev(BlockBackend *blk);
113void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops, void *opaque);
b7d17f9f
EB
114int blk_pread_unthrottled(BlockBackend *blk, int64_t offset, uint8_t *buf,
115 int count);
1e98fefd
KW
116int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset,
117 unsigned int bytes, QEMUIOVector *qiov,
118 BdrvRequestFlags flags);
119int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset,
120 unsigned int bytes, QEMUIOVector *qiov,
121 BdrvRequestFlags flags);
d004bd52
EB
122int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset,
123 int count, BdrvRequestFlags flags);
124BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
125 int count, BdrvRequestFlags flags,
126 BlockCompletionFunc *cb, void *opaque);
4be74634 127int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count);
8341f00d
EB
128int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count,
129 BdrvRequestFlags flags);
4be74634
MA
130int64_t blk_getlength(BlockBackend *blk);
131void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr);
1ef01253 132int64_t blk_nb_sectors(BlockBackend *blk);
60cb2fa7
EB
133BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset,
134 QEMUIOVector *qiov, BdrvRequestFlags flags,
135 BlockCompletionFunc *cb, void *opaque);
60cb2fa7
EB
136BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset,
137 QEMUIOVector *qiov, BdrvRequestFlags flags,
138 BlockCompletionFunc *cb, void *opaque);
4be74634
MA
139BlockAIOCB *blk_aio_flush(BlockBackend *blk,
140 BlockCompletionFunc *cb, void *opaque);
141BlockAIOCB *blk_aio_discard(BlockBackend *blk,
142 int64_t sector_num, int nb_sectors,
143 BlockCompletionFunc *cb, void *opaque);
144void blk_aio_cancel(BlockAIOCB *acb);
145void blk_aio_cancel_async(BlockAIOCB *acb);
4be74634
MA
146int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf);
147BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
148 BlockCompletionFunc *cb, void *opaque);
2bb0dce7
HR
149int blk_co_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
150int blk_co_flush(BlockBackend *blk);
4be74634
MA
151int blk_flush(BlockBackend *blk);
152int blk_flush_all(void);
1393f212 153int blk_commit_all(void);
97b0385a 154void blk_drain(BlockBackend *blk);
4be74634 155void blk_drain_all(void);
373340b2
HR
156void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
157 BlockdevOnError on_write_error);
4be74634
MA
158BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read);
159BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
160 int error);
161void blk_error_action(BlockBackend *blk, BlockErrorAction action,
162 bool is_read, int error);
163int blk_is_read_only(BlockBackend *blk);
164int blk_is_sg(BlockBackend *blk);
165int blk_enable_write_cache(BlockBackend *blk);
166void blk_set_enable_write_cache(BlockBackend *blk, bool wce);
2bb0dce7 167void blk_invalidate_cache(BlockBackend *blk, Error **errp);
e031f750 168bool blk_is_inserted(BlockBackend *blk);
db0284f8 169bool blk_is_available(BlockBackend *blk);
4be74634
MA
170void blk_lock_medium(BlockBackend *blk, bool locked);
171void blk_eject(BlockBackend *blk, bool eject_flag);
172int blk_get_flags(BlockBackend *blk);
5def6b80 173uint32_t blk_get_max_transfer(BlockBackend *blk);
648296e0 174int blk_get_max_iov(BlockBackend *blk);
4be74634 175void blk_set_guest_block_size(BlockBackend *blk, int align);
f1c17521 176void *blk_try_blockalign(BlockBackend *blk, size_t size);
4be74634
MA
177void *blk_blockalign(BlockBackend *blk, size_t size);
178bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp);
179void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason);
180void blk_op_block_all(BlockBackend *blk, Error *reason);
181void blk_op_unblock_all(BlockBackend *blk, Error *reason);
182AioContext *blk_get_aio_context(BlockBackend *blk);
183void blk_set_aio_context(BlockBackend *blk, AioContext *new_context);
2019ba0a
HR
184void blk_add_aio_context_notifier(BlockBackend *blk,
185 void (*attached_aio_context)(AioContext *new_context, void *opaque),
186 void (*detach_aio_context)(void *opaque), void *opaque);
187void blk_remove_aio_context_notifier(BlockBackend *blk,
188 void (*attached_aio_context)(AioContext *,
189 void *),
190 void (*detach_aio_context)(void *),
191 void *opaque);
3301f6c6
HR
192void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify);
193void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify);
4be74634
MA
194void blk_io_plug(BlockBackend *blk);
195void blk_io_unplug(BlockBackend *blk);
196BlockAcctStats *blk_get_stats(BlockBackend *blk);
281d22d8
HR
197BlockBackendRootState *blk_get_root_state(BlockBackend *blk);
198void blk_update_root_state(BlockBackend *blk);
38cb18f5
HR
199void blk_apply_root_state(BlockBackend *blk, BlockDriverState *bs);
200int blk_get_open_flags_from_root_state(BlockBackend *blk);
4be74634
MA
201
202void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
203 BlockCompletionFunc *cb, void *opaque);
d004bd52
EB
204int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
205 int count, BdrvRequestFlags flags);
1ef01253
HR
206int blk_write_compressed(BlockBackend *blk, int64_t sector_num,
207 const uint8_t *buf, int nb_sectors);
208int blk_truncate(BlockBackend *blk, int64_t offset);
209int blk_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
210int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
211 int64_t pos, int size);
212int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size);
f0272c4d
ET
213int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz);
214int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo);
ca78ecfa
PL
215BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
216 BlockCompletionFunc *cb,
217 void *opaque, int ret);
4be74634 218
97148076
KW
219void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg);
220void blk_io_limits_disable(BlockBackend *blk);
221void blk_io_limits_enable(BlockBackend *blk, const char *group);
222void blk_io_limits_update_group(BlockBackend *blk, const char *group);
223
26f54e9a 224#endif