From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([140.186.70.92]:50233) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QN2NX-0002Mf-AU for qemu-devel@nongnu.org; Thu, 19 May 2011 08:31:00 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QN2NW-0003tn-GR for qemu-devel@nongnu.org; Thu, 19 May 2011 08:30:59 -0400 Received: from mx1.redhat.com ([209.132.183.28]:1027) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QN2NW-0003ti-7j for qemu-devel@nongnu.org; Thu, 19 May 2011 08:30:58 -0400 From: Kevin Wolf Date: Thu, 19 May 2011 14:33:20 +0200 Message-Id: <1305808412-16994-7-git-send-email-kwolf@redhat.com> In-Reply-To: <1305808412-16994-1-git-send-email-kwolf@redhat.com> References: <1305808412-16994-1-git-send-email-kwolf@redhat.com> Subject: [Qemu-devel] [PATCH 06/18] Add documentation for qemu_progress_{init, print}() List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: anthony@codemonkey.ws Cc: kwolf@redhat.com, qemu-devel@nongnu.org From: Jes Sorensen Signed-off-by: Jes Sorensen Signed-off-by: Kevin Wolf --- qemu-common.h | 2 +- qemu-progress.c | 24 +++++++++++++++++++++--- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/qemu-common.h b/qemu-common.h index bba8dfe..b851b20 100644 --- a/qemu-common.h +++ b/qemu-common.h @@ -341,7 +341,7 @@ void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count, void qemu_progress_init(int enabled, float min_skip); void qemu_progress_end(void); -void qemu_progress_print(float percent, int max); +void qemu_progress_print(float delta, int max); #define QEMU_FILE_TYPE_BIOS 0 #define QEMU_FILE_TYPE_KEYMAP 1 diff --git a/qemu-progress.c b/qemu-progress.c index a4894c0..8ebe8ef 100644 --- a/qemu-progress.c +++ b/qemu-progress.c @@ -96,6 +96,13 @@ static void progress_dummy_init(void) state.end = progress_dummy_end; } +/* + * Initialize progress reporting. + * If @enabled is false, actual reporting is suppressed. The user can + * still trigger a report by sending a SIGUSR1. + * Reports are also suppressed unless we've had at least @min_skip + * percent progress since the last report. + */ void qemu_progress_init(int enabled, float min_skip) { state.min_skip = min_skip; @@ -111,14 +118,25 @@ void qemu_progress_end(void) state.end(); } -void qemu_progress_print(float percent, int max) +/* + * Report progress. + * @delta is how much progress we made. + * If @max is zero, @delta is an absolut value of the total job done. + * Else, @delta is a progress delta since the last call, as a fraction + * of @max. I.e. the delta is @delta * @max / 100. This allows + * relative accounting of functions which may be a different fraction of + * the full job, depending on the context they are called in. I.e. + * a function might be considered 40% of the full job if used from + * bdrv_img_create() but only 20% if called from img_convert(). + */ +void qemu_progress_print(float delta, int max) { float current; if (max == 0) { - current = percent; + current = delta; } else { - current = state.current + percent / 100 * max; + current = state.current + delta / 100 * max; } if (current > 100) { current = 100; -- 1.7.2.3