/*
* Simple text-based progress display module for GIT
*
- * Copyright (c) 2007 by Nicolas Pitre <nico@cam.org>
+ * Copyright (c) 2007 by Nicolas Pitre <nico@fluxnic.net>
*
* This code is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
*/
#include "git-compat-util.h"
+#include "gettext.h"
#include "progress.h"
+#include "strbuf.h"
+#include "trace.h"
#define TP_IDX_MAX 8
struct throughput {
+ off_t curr_total;
off_t prev_total;
- struct timeval prev_tv;
+ uint64_t prev_ns;
unsigned int avg_bytes;
- unsigned int last_bytes[TP_IDX_MAX];
unsigned int avg_misecs;
+ unsigned int last_bytes[TP_IDX_MAX];
unsigned int last_misecs[TP_IDX_MAX];
unsigned int idx;
char display[32];
progress_update = 0;
}
-static int display(struct progress *progress, unsigned n, int done)
+static int display(struct progress *progress, unsigned n, const char *done)
{
- char *eol, *tp;
+ const char *eol, *tp;
if (progress->delay) {
if (!progress_update || --progress->delay)
progress->last_value = n;
tp = (progress->throughput) ? progress->throughput->display : "";
- eol = done ? ", done. \n" : " \r";
+ eol = done ? done : " \r";
if (progress->total) {
unsigned percent = n * 100 / progress->total;
if (percent != progress->last_percent || progress_update) {
fprintf(stderr, "%s: %3u%% (%u/%u)%s%s",
progress->title, percent, n,
progress->total, tp, eol);
+ fflush(stderr);
progress_update = 0;
return 1;
}
} else if (progress_update) {
fprintf(stderr, "%s: %u%s%s", progress->title, n, tp, eol);
+ fflush(stderr);
progress_update = 0;
return 1;
}
return 0;
}
+static void throughput_string(struct strbuf *buf, off_t total,
+ unsigned int rate)
+{
+ strbuf_addstr(buf, ", ");
+ strbuf_humanise_bytes(buf, total);
+ strbuf_addstr(buf, " | ");
+ strbuf_humanise_bytes(buf, rate * 1024);
+ strbuf_addstr(buf, "/s");
+}
+
void display_throughput(struct progress *progress, off_t total)
{
struct throughput *tp;
- struct timeval tv;
- unsigned int misecs;
+ uint64_t now_ns;
+ unsigned int misecs, count, rate;
+ struct strbuf buf = STRBUF_INIT;
if (!progress)
return;
tp = progress->throughput;
- gettimeofday(&tv, NULL);
+ now_ns = getnanotime();
if (!tp) {
progress->throughput = tp = calloc(1, sizeof(*tp));
if (tp) {
- tp->prev_total = total;
- tp->prev_tv = tv;
+ tp->prev_total = tp->curr_total = total;
+ tp->prev_ns = now_ns;
}
return;
}
+ tp->curr_total = total;
+
+ /* only update throughput every 0.5 s */
+ if (now_ns - tp->prev_ns <= 500000000)
+ return;
/*
- * We have x = bytes and y = microsecs. We want z = KiB/s:
+ * We have x = bytes and y = nanosecs. We want z = KiB/s:
*
- * z = (x / 1024) / (y / 1000000)
- * z = x / y * 1000000 / 1024
- * z = x / (y * 1024 / 1000000)
+ * z = (x / 1024) / (y / 1000000000)
+ * z = x / y * 1000000000 / 1024
+ * z = x / (y * 1024 / 1000000000)
* z = x / y'
*
* To simplify things we'll keep track of misecs, or 1024th of a sec
* obtained with:
*
- * y' = y * 1024 / 1000000
- * y' = y / (1000000 / 1024)
- * y' = y / 977
+ * y' = y * 1024 / 1000000000
+ * y' = y * (2^10 / 2^42) * (2^42 / 1000000000)
+ * y' = y / 2^32 * 4398
+ * y' = (y * 4398) >> 32
*/
- misecs = (tv.tv_sec - tp->prev_tv.tv_sec) * 1024;
- misecs += (int)(tv.tv_usec - tp->prev_tv.tv_usec) / 977;
-
- if (misecs > 512) {
- int l = sizeof(tp->display);
- unsigned int count = total - tp->prev_total;
- tp->prev_total = total;
- tp->prev_tv = tv;
- tp->avg_bytes += count;
- tp->avg_misecs += misecs;
-
- if (total > 1 << 30) {
- l -= snprintf(tp->display, l, ", %u.%2.2u GiB",
- (int)(total >> 30),
- (int)(total & ((1 << 30) - 1)) / 10737419);
- } else if (total > 1 << 20) {
- l -= snprintf(tp->display, l, ", %u.%2.2u MiB",
- (int)(total >> 20),
- ((int)(total & ((1 << 20) - 1))
- * 100) >> 20);
- } else if (total > 1 << 10) {
- l -= snprintf(tp->display, l, ", %u.%2.2u KiB",
- (int)(total >> 10),
- ((int)(total & ((1 << 10) - 1))
- * 100) >> 10);
- } else {
- l -= snprintf(tp->display, l, ", %u bytes", (int)total);
- }
- snprintf(tp->display + sizeof(tp->display) - l, l,
- " | %u KiB/s", tp->avg_bytes / tp->avg_misecs);
+ misecs = ((now_ns - tp->prev_ns) * 4398) >> 32;
- tp->avg_bytes -= tp->last_bytes[tp->idx];
- tp->avg_misecs -= tp->last_misecs[tp->idx];
- tp->last_bytes[tp->idx] = count;
- tp->last_misecs[tp->idx] = misecs;
- tp->idx = (tp->idx + 1) % TP_IDX_MAX;
+ count = total - tp->prev_total;
+ tp->prev_total = total;
+ tp->prev_ns = now_ns;
+ tp->avg_bytes += count;
+ tp->avg_misecs += misecs;
+ rate = tp->avg_bytes / tp->avg_misecs;
+ tp->avg_bytes -= tp->last_bytes[tp->idx];
+ tp->avg_misecs -= tp->last_misecs[tp->idx];
+ tp->last_bytes[tp->idx] = count;
+ tp->last_misecs[tp->idx] = misecs;
+ tp->idx = (tp->idx + 1) % TP_IDX_MAX;
- if (progress->last_value != -1 && progress_update)
- display(progress, progress->last_value, 0);
- }
+ throughput_string(&buf, total, rate);
+ strncpy(tp->display, buf.buf, sizeof(tp->display));
+ strbuf_release(&buf);
+ if (progress->last_value != -1 && progress_update)
+ display(progress, progress->last_value, NULL);
}
int display_progress(struct progress *progress, unsigned n)
{
- return progress ? display(progress, n, 0) : 0;
+ return progress ? display(progress, n, NULL) : 0;
}
struct progress *start_progress_delay(const char *title, unsigned total,
if (!progress) {
/* unlikely, but here's a good fallback */
fprintf(stderr, "%s...\n", title);
+ fflush(stderr);
return NULL;
}
progress->title = title;
}
void stop_progress(struct progress **p_progress)
+{
+ stop_progress_msg(p_progress, _("done"));
+}
+
+void stop_progress_msg(struct progress **p_progress, const char *msg)
{
struct progress *progress = *p_progress;
if (!progress)
*p_progress = NULL;
if (progress->last_value != -1) {
/* Force the last update */
+ char buf[128], *bufp;
+ size_t len = strlen(msg) + 5;
+ struct throughput *tp = progress->throughput;
+
+ bufp = (len < sizeof(buf)) ? buf : xmalloc(len + 1);
+ if (tp) {
+ struct strbuf strbuf = STRBUF_INIT;
+ unsigned int rate = !tp->avg_misecs ? 0 :
+ tp->avg_bytes / tp->avg_misecs;
+ throughput_string(&strbuf, tp->curr_total, rate);
+ strncpy(tp->display, strbuf.buf, sizeof(tp->display));
+ strbuf_release(&strbuf);
+ }
progress_update = 1;
- display(progress, progress->last_value, 1);
+ sprintf(bufp, ", %s.\n", msg);
+ display(progress, progress->last_value, bufp);
+ if (buf != bufp)
+ free(bufp);
}
clear_progress_signal();
free(progress->throughput);