blob: a66cc07e75be98195f9fabd9670c863bfb1f5259 [file] [log] [blame]
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +03001/*
2 * Helper functionality for distributing a fixed total amount of
3 * an abstract resource among multiple coroutines.
4 *
5 * Copyright (c) 2019 Virtuozzo International GmbH
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25
26#include "qemu/osdep.h"
27#include "qemu/coroutine.h"
28#include "qemu/co-shared-resource.h"
29
30struct SharedResource {
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020031 uint64_t total; /* Set in shres_create() and not changed anymore */
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030032
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020033 /* State fields protected by lock */
34 uint64_t available;
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030035 CoQueue queue;
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020036
37 QemuMutex lock;
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030038};
39
40SharedResource *shres_create(uint64_t total)
41{
42 SharedResource *s = g_new0(SharedResource, 1);
43
44 s->total = s->available = total;
45 qemu_co_queue_init(&s->queue);
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020046 qemu_mutex_init(&s->lock);
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030047
48 return s;
49}
50
51void shres_destroy(SharedResource *s)
52{
53 assert(s->available == s->total);
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020054 qemu_mutex_destroy(&s->lock);
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030055 g_free(s);
56}
57
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020058/* Called with lock held. */
59static bool co_try_get_from_shres_locked(SharedResource *s, uint64_t n)
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030060{
61 if (s->available >= n) {
62 s->available -= n;
63 return true;
64 }
65
66 return false;
67}
68
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020069bool co_try_get_from_shres(SharedResource *s, uint64_t n)
70{
71 QEMU_LOCK_GUARD(&s->lock);
72 return co_try_get_from_shres_locked(s, n);
73}
74
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030075void coroutine_fn co_get_from_shres(SharedResource *s, uint64_t n)
76{
77 assert(n <= s->total);
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020078 QEMU_LOCK_GUARD(&s->lock);
79 while (!co_try_get_from_shres_locked(s, n)) {
80 qemu_co_queue_wait(&s->queue, &s->lock);
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030081 }
82}
83
84void coroutine_fn co_put_to_shres(SharedResource *s, uint64_t n)
85{
Emanuele Giuseppe Esposito55fa54a2021-06-14 10:11:30 +020086 QEMU_LOCK_GUARD(&s->lock);
Vladimir Sementsov-Ogievskiyf16ba002019-10-22 14:18:03 +030087 assert(s->total - s->available >= n);
88 s->available += n;
89 qemu_co_queue_restart_all(&s->queue);
90}