progress.c 6.12 KB
Newer Older
1 2 3
/*
 * Simple text-based progress display module for GIT
 *
4
 * Copyright (c) 2007 by Nicolas Pitre <nico@fluxnic.net>
5 6 7 8 9 10
 *
 * 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
 * published by the Free Software Foundation.
 */

11
#include "git-compat-util.h"
12
#include "gettext.h"
13
#include "progress.h"
14
#include "strbuf.h"
15
#include "trace.h"
16

17 18 19
#define TP_IDX_MAX      8

struct throughput {
20
	off_t curr_total;
21
	off_t prev_total;
22
	uint64_t prev_ns;
23
	unsigned int avg_bytes;
24
	unsigned int avg_misecs;
25
	unsigned int last_bytes[TP_IDX_MAX];
26 27
	unsigned int last_misecs[TP_IDX_MAX];
	unsigned int idx;
28
	struct strbuf display;
29 30
};

31 32
struct progress {
	const char *title;
33 34
	uint64_t last_value;
	uint64_t total;
35 36
	unsigned last_percent;
	unsigned delay;
37
	struct throughput *throughput;
38
	uint64_t start_ns;
39 40
};

41 42 43 44 45 46 47 48 49 50 51 52
static volatile sig_atomic_t progress_update;

static void progress_interval(int signum)
{
	progress_update = 1;
}

static void set_progress_signal(void)
{
	struct sigaction sa;
	struct itimerval v;

53 54
	progress_update = 0;

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
	memset(&sa, 0, sizeof(sa));
	sa.sa_handler = progress_interval;
	sigemptyset(&sa.sa_mask);
	sa.sa_flags = SA_RESTART;
	sigaction(SIGALRM, &sa, NULL);

	v.it_interval.tv_sec = 1;
	v.it_interval.tv_usec = 0;
	v.it_value = v.it_interval;
	setitimer(ITIMER_REAL, &v, NULL);
}

static void clear_progress_signal(void)
{
	struct itimerval v = {{0,},};
	setitimer(ITIMER_REAL, &v, NULL);
	signal(SIGALRM, SIG_IGN);
	progress_update = 0;
}

75 76
static int is_foreground_fd(int fd)
{
77 78
	int tpgrp = tcgetpgrp(fd);
	return tpgrp < 0 || tpgrp == getpgid(0);
79 80
}

81
static int display(struct progress *progress, uint64_t n, const char *done)
82
{
83
	const char *eol, *tp;
84

85 86
	if (progress->delay && (!progress_update || --progress->delay))
		return 0;
87 88

	progress->last_value = n;
89
	tp = (progress->throughput) ? progress->throughput->display.buf : "";
90
	eol = done ? done : "   \r";
91 92 93 94
	if (progress->total) {
		unsigned percent = n * 100 / progress->total;
		if (percent != progress->last_percent || progress_update) {
			progress->last_percent = percent;
95
			if (is_foreground_fd(fileno(stderr)) || done) {
96 97 98 99
				fprintf(stderr, "%s: %3u%% (%"PRIuMAX"/%"PRIuMAX")%s%s",
					progress->title, percent,
					(uintmax_t)n, (uintmax_t)progress->total,
					tp, eol);
100 101
				fflush(stderr);
			}
102 103 104 105
			progress_update = 0;
			return 1;
		}
	} else if (progress_update) {
106
		if (is_foreground_fd(fileno(stderr)) || done) {
107 108
			fprintf(stderr, "%s: %"PRIuMAX"%s%s",
				progress->title, (uintmax_t)n, tp, eol);
109 110
			fflush(stderr);
		}
111 112 113
		progress_update = 0;
		return 1;
	}
114

115 116 117
	return 0;
}

118
static void throughput_string(struct strbuf *buf, uint64_t total,
119 120
			      unsigned int rate)
{
121
	strbuf_reset(buf);
122 123 124 125 126
	strbuf_addstr(buf, ", ");
	strbuf_humanise_bytes(buf, total);
	strbuf_addstr(buf, " | ");
	strbuf_humanise_bytes(buf, rate * 1024);
	strbuf_addstr(buf, "/s");
127 128
}

129
void display_throughput(struct progress *progress, uint64_t total)
130 131
{
	struct throughput *tp;
132 133
	uint64_t now_ns;
	unsigned int misecs, count, rate;
134 135 136 137 138

	if (!progress)
		return;
	tp = progress->throughput;

139
	now_ns = getnanotime();
140 141 142

	if (!tp) {
		progress->throughput = tp = calloc(1, sizeof(*tp));
143
		if (tp) {
144
			tp->prev_total = tp->curr_total = total;
145
			tp->prev_ns = now_ns;
146
			strbuf_init(&tp->display, 0);
147
		}
148 149
		return;
	}
150
	tp->curr_total = total;
151

152 153 154 155
	/* only update throughput every 0.5 s */
	if (now_ns - tp->prev_ns <= 500000000)
		return;

156
	/*
157
	 * We have x = bytes and y = nanosecs.  We want z = KiB/s:
158
	 *
159 160 161
	 *	z = (x / 1024) / (y / 1000000000)
	 *	z = x / y * 1000000000 / 1024
	 *	z = x / (y * 1024 / 1000000000)
162 163 164 165 166
	 *	z = x / y'
	 *
	 * To simplify things we'll keep track of misecs, or 1024th of a sec
	 * obtained with:
	 *
167 168 169 170
	 *	y' = y * 1024 / 1000000000
	 *	y' = y * (2^10 / 2^42) * (2^42 / 1000000000)
	 *	y' = y / 2^32 * 4398
	 *	y' = (y * 4398) >> 32
171
	 */
172 173 174 175 176 177 178 179 180 181 182 183 184 185
	misecs = ((now_ns - tp->prev_ns) * 4398) >> 32;

	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;

186
	throughput_string(&tp->display, total, rate);
187 188
	if (progress->last_value != -1 && progress_update)
		display(progress, progress->last_value, NULL);
189 190
}

191
int display_progress(struct progress *progress, uint64_t n)
192
{
193
	return progress ? display(progress, n, NULL) : 0;
194 195
}

196
static struct progress *start_progress_delay(const char *title, uint64_t total,
197
					     unsigned delay)
198
{
199 200 201 202
	struct progress *progress = malloc(sizeof(*progress));
	if (!progress) {
		/* unlikely, but here's a good fallback */
		fprintf(stderr, "%s...\n", title);
203
		fflush(stderr);
204 205
		return NULL;
	}
206
	progress->title = title;
207
	progress->total = total;
208
	progress->last_value = -1;
209 210
	progress->last_percent = -1;
	progress->delay = delay;
211
	progress->throughput = NULL;
212
	progress->start_ns = getnanotime();
213
	set_progress_signal();
214
	return progress;
215 216
}

217
struct progress *start_delayed_progress(const char *title, uint64_t total)
218
{
219
	return start_progress_delay(title, total, 2);
220 221
}

222
struct progress *start_progress(const char *title, uint64_t total)
223
{
224
	return start_progress_delay(title, total, 0);
225 226
}

227
void stop_progress(struct progress **p_progress)
228
{
229
	stop_progress_msg(p_progress, _("done"));
230 231 232
}

void stop_progress_msg(struct progress **p_progress, const char *msg)
233
{
234 235 236 237
	struct progress *progress = *p_progress;
	if (!progress)
		return;
	*p_progress = NULL;
238 239
	if (progress->last_value != -1) {
		/* Force the last update */
240
		char *buf;
241
		struct throughput *tp = progress->throughput;
242

243
		if (tp) {
244 245 246 247
			uint64_t now_ns = getnanotime();
			unsigned int misecs, rate;
			misecs = ((now_ns - progress->start_ns) * 4398) >> 32;
			rate = tp->curr_total / (misecs ? misecs : 1);
248
			throughput_string(&tp->display, tp->curr_total, rate);
249
		}
250
		progress_update = 1;
251 252 253
		buf = xstrfmt(", %s.\n", msg);
		display(progress, progress->last_value, buf);
		free(buf);
254
	}
255
	clear_progress_signal();
256 257
	if (progress->throughput)
		strbuf_release(&progress->throughput->display);
258
	free(progress->throughput);
259
	free(progress);
260
}