xref: /qemu/block/progress_meter.c (revision df4bbc9d)
1a7b4f8fcSEmanuele Giuseppe Esposito /*
2a7b4f8fcSEmanuele Giuseppe Esposito  * Helper functionality for some process progress tracking.
3a7b4f8fcSEmanuele Giuseppe Esposito  *
4a7b4f8fcSEmanuele Giuseppe Esposito  * Copyright (c) 2011 IBM Corp.
5a7b4f8fcSEmanuele Giuseppe Esposito  * Copyright (c) 2012, 2018 Red Hat, Inc.
6a7b4f8fcSEmanuele Giuseppe Esposito  * Copyright (c) 2020 Virtuozzo International GmbH
7a7b4f8fcSEmanuele Giuseppe Esposito  *
8a7b4f8fcSEmanuele Giuseppe Esposito  * Permission is hereby granted, free of charge, to any person obtaining a copy
9a7b4f8fcSEmanuele Giuseppe Esposito  * of this software and associated documentation files (the "Software"), to deal
10a7b4f8fcSEmanuele Giuseppe Esposito  * in the Software without restriction, including without limitation the rights
11a7b4f8fcSEmanuele Giuseppe Esposito  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12a7b4f8fcSEmanuele Giuseppe Esposito  * copies of the Software, and to permit persons to whom the Software is
13a7b4f8fcSEmanuele Giuseppe Esposito  * furnished to do so, subject to the following conditions:
14a7b4f8fcSEmanuele Giuseppe Esposito  *
15a7b4f8fcSEmanuele Giuseppe Esposito  * The above copyright notice and this permission notice shall be included in
16a7b4f8fcSEmanuele Giuseppe Esposito  * all copies or substantial portions of the Software.
17a7b4f8fcSEmanuele Giuseppe Esposito  *
18a7b4f8fcSEmanuele Giuseppe Esposito  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19a7b4f8fcSEmanuele Giuseppe Esposito  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20a7b4f8fcSEmanuele Giuseppe Esposito  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21a7b4f8fcSEmanuele Giuseppe Esposito  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22a7b4f8fcSEmanuele Giuseppe Esposito  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23a7b4f8fcSEmanuele Giuseppe Esposito  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24a7b4f8fcSEmanuele Giuseppe Esposito  * THE SOFTWARE.
25a7b4f8fcSEmanuele Giuseppe Esposito  */
26df4bbc9dSMarkus Armbruster 
27a7b4f8fcSEmanuele Giuseppe Esposito #include "qemu/osdep.h"
28df4bbc9dSMarkus Armbruster #include "qemu/coroutine.h"
29a7b4f8fcSEmanuele Giuseppe Esposito #include "qemu/progress_meter.h"
30a7b4f8fcSEmanuele Giuseppe Esposito 
progress_init(ProgressMeter * pm)31a7b4f8fcSEmanuele Giuseppe Esposito void progress_init(ProgressMeter *pm)
32a7b4f8fcSEmanuele Giuseppe Esposito {
33a7b4f8fcSEmanuele Giuseppe Esposito     qemu_mutex_init(&pm->lock);
34a7b4f8fcSEmanuele Giuseppe Esposito }
35a7b4f8fcSEmanuele Giuseppe Esposito 
progress_destroy(ProgressMeter * pm)36a7b4f8fcSEmanuele Giuseppe Esposito void progress_destroy(ProgressMeter *pm)
37a7b4f8fcSEmanuele Giuseppe Esposito {
38a7b4f8fcSEmanuele Giuseppe Esposito     qemu_mutex_destroy(&pm->lock);
39a7b4f8fcSEmanuele Giuseppe Esposito }
40a7b4f8fcSEmanuele Giuseppe Esposito 
progress_get_snapshot(ProgressMeter * pm,uint64_t * current,uint64_t * total)41a7b4f8fcSEmanuele Giuseppe Esposito void progress_get_snapshot(ProgressMeter *pm, uint64_t *current,
42a7b4f8fcSEmanuele Giuseppe Esposito                            uint64_t *total)
43a7b4f8fcSEmanuele Giuseppe Esposito {
44a7b4f8fcSEmanuele Giuseppe Esposito     QEMU_LOCK_GUARD(&pm->lock);
45a7b4f8fcSEmanuele Giuseppe Esposito 
46a7b4f8fcSEmanuele Giuseppe Esposito     *current = pm->current;
47a7b4f8fcSEmanuele Giuseppe Esposito     *total = pm->total;
48a7b4f8fcSEmanuele Giuseppe Esposito }
49a7b4f8fcSEmanuele Giuseppe Esposito 
progress_work_done(ProgressMeter * pm,uint64_t done)50a7b4f8fcSEmanuele Giuseppe Esposito void progress_work_done(ProgressMeter *pm, uint64_t done)
51a7b4f8fcSEmanuele Giuseppe Esposito {
52a7b4f8fcSEmanuele Giuseppe Esposito     QEMU_LOCK_GUARD(&pm->lock);
53a7b4f8fcSEmanuele Giuseppe Esposito     pm->current += done;
54a7b4f8fcSEmanuele Giuseppe Esposito }
55a7b4f8fcSEmanuele Giuseppe Esposito 
progress_set_remaining(ProgressMeter * pm,uint64_t remaining)56a7b4f8fcSEmanuele Giuseppe Esposito void progress_set_remaining(ProgressMeter *pm, uint64_t remaining)
57a7b4f8fcSEmanuele Giuseppe Esposito {
58a7b4f8fcSEmanuele Giuseppe Esposito     QEMU_LOCK_GUARD(&pm->lock);
59a7b4f8fcSEmanuele Giuseppe Esposito     pm->total = pm->current + remaining;
60a7b4f8fcSEmanuele Giuseppe Esposito }
61a7b4f8fcSEmanuele Giuseppe Esposito 
progress_increase_remaining(ProgressMeter * pm,uint64_t delta)62a7b4f8fcSEmanuele Giuseppe Esposito void progress_increase_remaining(ProgressMeter *pm, uint64_t delta)
63a7b4f8fcSEmanuele Giuseppe Esposito {
64a7b4f8fcSEmanuele Giuseppe Esposito     QEMU_LOCK_GUARD(&pm->lock);
65a7b4f8fcSEmanuele Giuseppe Esposito     pm->total += delta;
66a7b4f8fcSEmanuele Giuseppe Esposito }
67