qemu-progress.c

   1 /*
   2  * QEMU progress printing utility functions
   3  *
   4  * Copyright (C) 2011 Jes Sorensen <Jes.Sorensen@redhat.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "qemu-common.h"
  26 #include "osdep.h"
  27 #include "sysemu.h"
  28 #include <stdio.h>
  29 #include <signal.h>
  30
  31 struct progress_state {
  32     float current;
  33     float last_print;
  34     float min_skip;
  35     void (*print)(void);
  36     void (*end)(void);
  37 };
  38
  39 static struct progress_state state;
  40
  41 /*
  42  * Simple progress print function.
  43  * @percent relative percent of current operation
  44  * @max percent of total operation
  45  */
  46 static void progress_simple_print(void)
  47 {
  48     printf("    (%3.2f/100%%)\r", state.current);
  49     fflush(stdout);
  50 }
  51
  52 static void progress_simple_end(void)
  53 {
  54     printf("\n");
  55 }
  56
  57 static void progress_simple_init(void)
  58 {
  59     state.print = progress_simple_print;
  60     state.end = progress_simple_end;
  61 }
  62
  63 #ifdef CONFIG_POSIX
  64 static void sigusr_print(int signal)
  65 {
  66     printf("    (%3.2f/100%%)\n", state.current);
  67 }
  68 #endif
  69
  70 static void progress_dummy_print(void)
  71 {
  72 }
  73
  74 static void progress_dummy_end(void)
  75 {
  76 }
  77
  78 static void progress_dummy_init(void)
  79 {
  80 #ifdef CONFIG_POSIX
  81     struct sigaction action;
  82
  83     memset(&action, 0, sizeof(action));
  84     sigfillset(&action.sa_mask);
  85     action.sa_handler = sigusr_print;
  86     action.sa_flags = 0;
  87     sigaction(SIGUSR1, &action, NULL);
  88 #endif
  89
  90     state.print = progress_dummy_print;
  91     state.end = progress_dummy_end;
  92 }
  93
  94 void qemu_progress_init(int enabled, float min_skip)
  95 {
  96     state.min_skip = min_skip;
  97     if (enabled) {
  98         progress_simple_init();
  99     } else {
 100         progress_dummy_init();
 101     }
 102 }
 103
 104 void qemu_progress_end(void)
 105 {
 106     state.end();
 107 }
 108
 109 void qemu_progress_print(float percent, int max)
 110 {
 111     float current;
 112
 113     if (max == 0) {
 114         current = percent;
 115     } else {
 116         current = state.current + percent / 100 * max;
 117     }
 118     if (current > 100) {
 119         current = 100;
 120     }
 121     state.current = current;
 122
 123     if (current > (state.last_print + state.min_skip) ||
 124         (current == 100) || (current == 0)) {
 125         state.last_print = state.current;
 126         state.print();
 127     }
 128 }