LXR qemu/include/qemu/progress

   1/*
   2 * Helper functionality for some process progress tracking.
   3 *
   4 * Copyright (c) 2011 IBM Corp.
   5 * Copyright (c) 2012, 2018 Red Hat, Inc.
   6 * Copyright (c) 2020 Virtuozzo International GmbH
   7 *
   8 * Permission is hereby granted, free of charge, to any person obtaining a copy
   9 * of this software and associated documentation files (the "Software"), to deal
  10 * in the Software without restriction, including without limitation the rights
  11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12 * copies of the Software, and to permit persons to whom the Software is
  13 * furnished to do so, subject to the following conditions:
  14 *
  15 * The above copyright notice and this permission notice shall be included in
  16 * all copies or substantial portions of the Software.
  17 *
  18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24 * THE SOFTWARE.
  25 */
  26
  27#ifndef QEMU_PROGRESS_METER_H
  28#define QEMU_PROGRESS_METER_H
  29
  30typedef struct ProgressMeter {
  31    /**
  32     * Current progress. The unit is arbitrary as long as the ratio between
  33     * current and total represents the estimated percentage
  34     * of work already done.
  35     */
  36    uint64_t current;
  37
  38    /** Estimated current value at the completion of the process */
  39    uint64_t total;
  40} ProgressMeter;
  41
  42static inline void progress_work_done(ProgressMeter *pm, uint64_t done)
  43{
  44    pm->current += done;
  45}
  46
  47static inline void progress_set_remaining(ProgressMeter *pm, uint64_t remaining)
  48{
  49    pm->total = pm->current + remaining;
  50}
  51
  52static inline void progress_increase_remaining(ProgressMeter *pm,
  53                                               uint64_t delta)
  54{
  55    pm->total += delta;
  56}
  57
  58#endif /* QEMU_PROGRESS_METER_H */
  59