blob: 3aaef18d4ed4212ef7ee5c67fa14df78706ab263 [file] [log] [blame]
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +03001/*
2 * QEMU block throttling filter driver infrastructure
3 *
4 * Copyright (c) 2017 Manos Pitsidianakis
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 or
9 * (at your option) version 3 of the License.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
18 */
19
20#include "qemu/osdep.h"
Markus Armbrustere2c1c342022-12-21 14:35:49 +010021#include "block/block-io.h"
22#include "block/block_int.h"
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030023#include "block/throttle-groups.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020024#include "qemu/module.h"
Markus Armbruster922a01a2018-02-01 12:18:46 +010025#include "qemu/option.h"
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030026#include "qemu/throttle-options.h"
27#include "qapi/error.h"
28
29static QemuOptsList throttle_opts = {
30 .name = "throttle",
31 .head = QTAILQ_HEAD_INITIALIZER(throttle_opts.head),
32 .desc = {
33 {
34 .name = QEMU_OPT_THROTTLE_GROUP_NAME,
35 .type = QEMU_OPT_STRING,
36 .help = "Name of the throttle group",
37 },
38 { /* end of list */ }
39 },
40};
41
Alberto Garciabc33c042018-06-08 18:15:36 +030042/*
43 * If this function succeeds then the throttle group name is stored in
44 * @group and must be freed by the caller.
45 * If there's an error then @group remains unmodified.
46 */
47static int throttle_parse_options(QDict *options, char **group, Error **errp)
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030048{
49 int ret;
50 const char *group_name;
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030051 QemuOpts *opts = qemu_opts_create(&throttle_opts, NULL, 0, &error_abort);
52
Markus Armbrusteraf175e82020-07-07 18:06:03 +020053 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030054 ret = -EINVAL;
55 goto fin;
56 }
57
58 group_name = qemu_opt_get(opts, QEMU_OPT_THROTTLE_GROUP_NAME);
59 if (!group_name) {
60 error_setg(errp, "Please specify a throttle group");
61 ret = -EINVAL;
62 goto fin;
63 } else if (!throttle_group_exists(group_name)) {
64 error_setg(errp, "Throttle group '%s' does not exist", group_name);
65 ret = -EINVAL;
66 goto fin;
67 }
68
Alberto Garciabc33c042018-06-08 18:15:36 +030069 *group = g_strdup(group_name);
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030070 ret = 0;
71fin:
72 qemu_opts_del(opts);
73 return ret;
74}
75
76static int throttle_open(BlockDriverState *bs, QDict *options,
77 int flags, Error **errp)
78{
79 ThrottleGroupMember *tgm = bs->opaque;
Alberto Garciabc33c042018-06-08 18:15:36 +030080 char *group;
81 int ret;
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030082
Vladimir Sementsov-Ogievskiy83930782022-07-26 23:11:21 +030083 ret = bdrv_open_file_child(NULL, options, "file", bs, errp);
84 if (ret < 0) {
85 return ret;
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030086 }
Max Reitz228345b2018-04-21 15:29:26 +020087 bs->supported_write_flags = bs->file->bs->supported_write_flags |
88 BDRV_REQ_WRITE_UNCHANGED;
89 bs->supported_zero_flags = bs->file->bs->supported_zero_flags |
90 BDRV_REQ_WRITE_UNCHANGED;
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +030091
Alberto Garciabc33c042018-06-08 18:15:36 +030092 ret = throttle_parse_options(options, &group, errp);
93 if (ret == 0) {
94 /* Register membership to group with name group_name */
95 throttle_group_register_tgm(tgm, group, bdrv_get_aio_context(bs));
96 g_free(group);
97 }
98
99 return ret;
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300100}
101
102static void throttle_close(BlockDriverState *bs)
103{
104 ThrottleGroupMember *tgm = bs->opaque;
105 throttle_group_unregister_tgm(tgm);
106}
107
108
Kevin Wolf8ab81402023-02-03 16:22:02 +0100109static int64_t coroutine_fn GRAPH_RDLOCK
110throttle_co_getlength(BlockDriverState *bs)
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300111{
Emanuele Giuseppe Espositoc86422c2023-01-13 21:42:04 +0100112 return bdrv_co_getlength(bs->file->bs);
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300113}
114
Kevin Wolfb9b10c32023-02-03 16:21:50 +0100115static int coroutine_fn GRAPH_RDLOCK
116throttle_co_preadv(BlockDriverState *bs, int64_t offset, int64_t bytes,
117 QEMUIOVector *qiov, BdrvRequestFlags flags)
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300118{
119
120 ThrottleGroupMember *tgm = bs->opaque;
121 throttle_group_co_io_limits_intercept(tgm, bytes, false);
122
123 return bdrv_co_preadv(bs->file, offset, bytes, qiov, flags);
124}
125
Kevin Wolfb9b10c32023-02-03 16:21:50 +0100126static int coroutine_fn GRAPH_RDLOCK
127throttle_co_pwritev(BlockDriverState *bs, int64_t offset, int64_t bytes,
128 QEMUIOVector *qiov, BdrvRequestFlags flags)
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300129{
130 ThrottleGroupMember *tgm = bs->opaque;
131 throttle_group_co_io_limits_intercept(tgm, bytes, true);
132
133 return bdrv_co_pwritev(bs->file, offset, bytes, qiov, flags);
134}
135
Kevin Wolfabaf8b72023-02-03 16:21:48 +0100136static int coroutine_fn GRAPH_RDLOCK
137throttle_co_pwrite_zeroes(BlockDriverState *bs, int64_t offset, int64_t bytes,
138 BdrvRequestFlags flags)
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300139{
140 ThrottleGroupMember *tgm = bs->opaque;
141 throttle_group_co_io_limits_intercept(tgm, bytes, true);
142
143 return bdrv_co_pwrite_zeroes(bs->file, offset, bytes, flags);
144}
145
Emanuele Giuseppe Esposito9a5a1c62023-02-03 16:21:47 +0100146static int coroutine_fn GRAPH_RDLOCK
147throttle_co_pdiscard(BlockDriverState *bs, int64_t offset, int64_t bytes)
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300148{
149 ThrottleGroupMember *tgm = bs->opaque;
150 throttle_group_co_io_limits_intercept(tgm, bytes, true);
151
Fam Zheng0b9fd3f2018-07-10 14:31:17 +0800152 return bdrv_co_pdiscard(bs->file, offset, bytes);
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300153}
154
Kevin Wolfb9b10c32023-02-03 16:21:50 +0100155static int coroutine_fn GRAPH_RDLOCK
156throttle_co_pwritev_compressed(BlockDriverState *bs, int64_t offset,
157 int64_t bytes, QEMUIOVector *qiov)
Max Reitze7e754a2019-06-12 22:52:27 +0200158{
159 return throttle_co_pwritev(bs, offset, bytes, qiov,
160 BDRV_REQ_WRITE_COMPRESSED);
161}
162
Emanuele Giuseppe Esposito88095342023-02-03 16:21:46 +0100163static int coroutine_fn GRAPH_RDLOCK throttle_co_flush(BlockDriverState *bs)
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300164{
165 return bdrv_co_flush(bs->file->bs);
166}
167
168static void throttle_detach_aio_context(BlockDriverState *bs)
169{
170 ThrottleGroupMember *tgm = bs->opaque;
171 throttle_group_detach_aio_context(tgm);
172}
173
174static void throttle_attach_aio_context(BlockDriverState *bs,
175 AioContext *new_context)
176{
177 ThrottleGroupMember *tgm = bs->opaque;
178 throttle_group_attach_aio_context(tgm, new_context);
179}
180
181static int throttle_reopen_prepare(BDRVReopenState *reopen_state,
182 BlockReopenQueue *queue, Error **errp)
183{
Alberto Garciabc33c042018-06-08 18:15:36 +0300184 int ret;
185 char *group = NULL;
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300186
187 assert(reopen_state != NULL);
188 assert(reopen_state->bs != NULL);
189
Alberto Garciabc33c042018-06-08 18:15:36 +0300190 ret = throttle_parse_options(reopen_state->options, &group, errp);
191 reopen_state->opaque = group;
192 return ret;
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300193}
194
195static void throttle_reopen_commit(BDRVReopenState *reopen_state)
196{
Alberto Garciabc33c042018-06-08 18:15:36 +0300197 BlockDriverState *bs = reopen_state->bs;
198 ThrottleGroupMember *tgm = bs->opaque;
199 char *group = reopen_state->opaque;
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300200
Alberto Garciabc33c042018-06-08 18:15:36 +0300201 assert(group);
202
203 if (strcmp(group, throttle_group_get_name(tgm))) {
204 throttle_group_unregister_tgm(tgm);
205 throttle_group_register_tgm(tgm, group, bdrv_get_aio_context(bs));
206 }
207 g_free(reopen_state->opaque);
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300208 reopen_state->opaque = NULL;
209}
210
211static void throttle_reopen_abort(BDRVReopenState *reopen_state)
212{
Alberto Garciabc33c042018-06-08 18:15:36 +0300213 g_free(reopen_state->opaque);
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300214 reopen_state->opaque = NULL;
215}
216
Kevin Wolf5e8ac212022-11-18 18:40:58 +0100217static void throttle_drain_begin(BlockDriverState *bs)
Manos Pitsidianakisb867eaa2017-09-23 14:14:11 +0300218{
219 ThrottleGroupMember *tgm = bs->opaque;
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100220 if (qatomic_fetch_inc(&tgm->io_limits_disabled) == 0) {
Manos Pitsidianakisb867eaa2017-09-23 14:14:11 +0300221 throttle_group_restart_tgm(tgm);
222 }
223}
224
Kevin Wolf5e8ac212022-11-18 18:40:58 +0100225static void throttle_drain_end(BlockDriverState *bs)
Manos Pitsidianakisb867eaa2017-09-23 14:14:11 +0300226{
227 ThrottleGroupMember *tgm = bs->opaque;
228 assert(tgm->io_limits_disabled);
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100229 qatomic_dec(&tgm->io_limits_disabled);
Manos Pitsidianakisb867eaa2017-09-23 14:14:11 +0300230}
231
Max Reitz26542672019-02-01 20:29:25 +0100232static const char *const throttle_strong_runtime_opts[] = {
233 QEMU_OPT_THROTTLE_GROUP_NAME,
234
235 NULL
236};
237
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300238static BlockDriver bdrv_throttle = {
239 .format_name = "throttle",
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300240 .instance_size = sizeof(ThrottleGroupMember),
241
Fabiano Rosasa7328ba2018-03-12 19:07:51 -0300242 .bdrv_open = throttle_open,
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300243 .bdrv_close = throttle_close,
244 .bdrv_co_flush = throttle_co_flush,
245
Max Reitz69dca432020-05-13 13:05:39 +0200246 .bdrv_child_perm = bdrv_default_perms,
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300247
Emanuele Giuseppe Espositoc86422c2023-01-13 21:42:04 +0100248 .bdrv_co_getlength = throttle_co_getlength,
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300249
250 .bdrv_co_preadv = throttle_co_preadv,
251 .bdrv_co_pwritev = throttle_co_pwritev,
252
253 .bdrv_co_pwrite_zeroes = throttle_co_pwrite_zeroes,
254 .bdrv_co_pdiscard = throttle_co_pdiscard,
Max Reitze7e754a2019-06-12 22:52:27 +0200255 .bdrv_co_pwritev_compressed = throttle_co_pwritev_compressed,
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300256
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300257 .bdrv_attach_aio_context = throttle_attach_aio_context,
258 .bdrv_detach_aio_context = throttle_detach_aio_context,
259
260 .bdrv_reopen_prepare = throttle_reopen_prepare,
261 .bdrv_reopen_commit = throttle_reopen_commit,
262 .bdrv_reopen_abort = throttle_reopen_abort,
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300263
Kevin Wolf5e8ac212022-11-18 18:40:58 +0100264 .bdrv_drain_begin = throttle_drain_begin,
265 .bdrv_drain_end = throttle_drain_end,
Manos Pitsidianakisb867eaa2017-09-23 14:14:11 +0300266
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300267 .is_filter = true,
Max Reitz26542672019-02-01 20:29:25 +0100268 .strong_runtime_opts = throttle_strong_runtime_opts,
Manos Pitsidianakisd8e7d872017-08-25 16:20:27 +0300269};
270
271static void bdrv_throttle_init(void)
272{
273 bdrv_register(&bdrv_throttle);
274}
275
276block_init(bdrv_throttle_init);