git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
e17490964c4cc36dd49d5005603c985205cdbe79 blob 8907 bytes (raw)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
/*
 * Simple text-based progress display module for GIT
 *
 * 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
 * published by the Free Software Foundation.
 */

#include "cache.h"
#include "gettext.h"
#include "progress.h"
#include "strbuf.h"
#include "trace.h"
#include "utf8.h"
#include "config.h"

static volatile sig_atomic_t progress_update;
static struct progress *global_progress;

static int is_foreground_fd(int fd)
{
	int tpgrp = tcgetpgrp(fd);
	return tpgrp < 0 || tpgrp == getpgid(0);
}

static void display(struct progress *progress, uint64_t n,
		    const char *update_msg, int last_update)
{
	const char *tp;
	int show_update = 0;
	size_t last_count_len = progress->status_len_utf8;

	if (progress->delay && (!progress_update || --progress->delay))
		return;

	progress->last_value = n;
	tp = (progress->throughput) ? progress->throughput->display.buf : "";
	if (progress->total) {
		unsigned percent = n * 100 / progress->total;
		if (percent != progress->last_percent || progress_update) {
			progress->last_percent = percent;

			strbuf_reset(&progress->status);
			strbuf_addf(&progress->status,
				    "%3u%% (%"PRIuMAX"/%"PRIuMAX")%s", percent,
				    (uintmax_t)n, (uintmax_t)progress->total,
				    tp);
			show_update = 1;
		}
	} else if (progress_update) {
		strbuf_reset(&progress->status);
		strbuf_addf(&progress->status, "%"PRIuMAX"%s", (uintmax_t)n, tp);
		show_update = 1;
	}

	if (show_update && update_msg)
		strbuf_addf(&progress->status, ", %s.", update_msg);

	if (show_update) {
		int stderr_is_foreground_fd = is_foreground_fd(fileno(stderr));
		if (stderr_is_foreground_fd || update_msg) {
			const char *eol = last_update ? "\n" : "\r";
			size_t clear_len = progress->status.len < last_count_len ?
					last_count_len - progress->status.len + 1 :
					0;
			/* The "+ 2" accounts for the ": ". */
			size_t progress_line_len = progress->title_len_utf8 +
						progress->status.len + 2;
			int cols = term_columns();
			progress->status_len_utf8 = utf8_strwidth(progress->status.buf);

			if (progress->split) {
				fprintf(stderr, "  %*s%*s",
					(int)progress->status_len_utf8,
					progress->status.buf,
					(int)clear_len, eol);
			} else if (!update_msg && cols < progress_line_len) {
				clear_len = progress->title_len_utf8 + 1 < cols ?
					    cols - progress->title_len_utf8 - 1 : 0;
				fprintf(stderr, "%*s:%*s\n  %*s%s",
					(int)progress->title_len_utf8,
					progress->title.buf,
					(int)clear_len, "",
					(int)progress->status_len_utf8,
					progress->status.buf, eol);
				progress->split = 1;
			} else {
				fprintf(stderr, "%*s: %*s%*s",
					(int)progress->title_len_utf8,
					progress->title.buf,
					(int)progress->status_len_utf8,
					progress->status.buf,
					(int)clear_len, eol);
			}
			if (stderr_is_foreground_fd)
				fflush(stderr);
		}
		progress_update = 0;
	}
}

static void throughput_string(struct strbuf *buf, uint64_t total,
			      unsigned int rate)
{
	strbuf_reset(buf);
	strbuf_addstr(buf, ", ");
	strbuf_humanise_bytes(buf, total);
	strbuf_addstr(buf, " | ");
	strbuf_humanise_rate(buf, rate * 1024);
}

static uint64_t progress_getnanotime(struct progress *progress)
{
	if (progress->test_getnanotime)
		return progress->start_ns + progress->test_getnanotime;
	else
		return getnanotime();
}

void display_throughput(struct progress *progress, uint64_t total)
{
	struct throughput *tp;
	uint64_t now_ns;
	unsigned int misecs, count, rate;

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

	now_ns = progress_getnanotime(progress);

	if (!tp) {
		progress->throughput = CALLOC_ARRAY(tp, 1);
		tp->prev_total = tp->curr_total = total;
		tp->prev_ns = now_ns;
		strbuf_init(&tp->display, 0);
		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 = nanosecs.  We want z = KiB/s:
	 *
	 *	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 / 1000000000
	 *	y' = y * (2^10 / 2^42) * (2^42 / 1000000000)
	 *	y' = y / 2^32 * 4398
	 *	y' = (y * 4398) >> 32
	 */
	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) % PROGRESS_THROUGHPUT_IDX_MAX;

	throughput_string(&tp->display, total, rate);
	if (progress->last_value != -1 && progress_update)
		display(progress, progress->last_value, NULL, 0);
}

void display_progress(struct progress *progress, uint64_t n)
{
	if (progress)
		display(progress, n, NULL, 0);
}

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

void test_progress_force_update(void)
{
	progress_interval(SIGALRM);
}

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

	if (global_progress)
		BUG("should have no global_progress in set_progress_signal()");
	global_progress = progress;

	if (progress->test_mode)
		return;

	progress_update = 0;

	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(struct progress *progress)
{
	struct itimerval v = {{0,},};

	if (!global_progress)
		BUG("should have a global_progress in clear_progress_signal()");
	global_progress = NULL;

	if (progress->test_mode)
		return;

	setitimer(ITIMER_REAL, &v, NULL);
	signal(SIGALRM, SIG_IGN);
	progress_update = 0;
}

static struct progress *start_progress_delay(const char *title, uint64_t total,
					     unsigned delay, int testing)
{
	struct progress *progress = xmalloc(sizeof(*progress));
	strbuf_init(&progress->title, 0);
	strbuf_addstr(&progress->title, title);
	progress->title_len_utf8 = utf8_strwidth(title);
	strbuf_init(&progress->status, 0);
	progress->status_len_utf8 = 0;

	progress->total = total;
	progress->last_value = -1;
	progress->last_percent = -1;
	progress->delay = delay;
	progress->throughput = NULL;
	progress->start_ns = getnanotime();
	progress->split = 0;
	progress->test_mode = testing;
	set_progress_signal(progress);
	trace2_region_enter("progress", title, the_repository);
	return progress;
}

struct progress *start_progress_testing(const char *title, uint64_t total)
{
	return start_progress_delay(title, total, 0, 1);
}

static int get_default_delay(void)
{
	static int delay_in_secs = -1;

	if (delay_in_secs < 0)
		delay_in_secs = git_env_ulong("GIT_PROGRESS_DELAY", 2);

	return delay_in_secs;
}

struct progress *start_delayed_progress(const char *title, uint64_t total)
{
	return start_progress_delay(title, total, get_default_delay(), 0);
}

struct progress *start_progress(const char *title, uint64_t total)
{
	return start_progress_delay(title, total, 0, 0);
}

void stop_progress(struct progress **p_progress)
{
	if (!p_progress)
		BUG("don't provide NULL to stop_progress");

	if (*p_progress) {
		struct progress *progress = *p_progress;
		trace2_data_intmax("progress", the_repository, "total_objects",
				   (*p_progress)->total);

		if ((*p_progress)->throughput)
			trace2_data_intmax("progress", the_repository,
					   "total_bytes",
					   progress->throughput->curr_total);

		trace2_region_leave("progress", progress->title.buf, the_repository);
	}

	stop_progress_msg(p_progress, _("done"));
}

void stop_progress_msg(struct progress **p_progress, const char *msg)
{
	struct progress *progress;

	if (!p_progress)
		BUG("don't provide NULL to stop_progress_msg");

	progress = *p_progress;
	if (!progress)
		return;
	*p_progress = NULL;
	if (progress->last_value != -1) {
		/* Force the last update */
		struct throughput *tp = progress->throughput;

		if (tp) {
			uint64_t now_ns = progress_getnanotime(progress);
			unsigned int misecs, rate;
			misecs = ((now_ns - progress->start_ns) * 4398) >> 32;
			rate = tp->curr_total / (misecs ? misecs : 1);
			throughput_string(&tp->display, tp->curr_total, rate);
		}
		progress_update = 1;
		display(progress, progress->last_value, msg, 1);
	}
	clear_progress_signal(progress);
	strbuf_release(&progress->title);
	strbuf_release(&progress->status);
	if (progress->throughput)
		strbuf_release(&progress->throughput->display);
	free(progress->throughput);
	free(progress);
}
debug log:

solving e17490964c4 ...
found e17490964c4 in https://public-inbox.org/git/patch-16.25-2161d9cbef3-20210623T155626Z-avarab@gmail.com/
found 44479f65921 in https://public-inbox.org/git/patch-15.25-160c5fe04c3-20210623T155626Z-avarab@gmail.com/
found 39d7f6bd86b in https://public-inbox.org/git/patch-14.25-88d864c373a-20210623T155626Z-avarab@gmail.com/
found aff9af9ee8b in https://public-inbox.org/git/patch-13.25-f2e84e3a3f2-20210623T155626Z-avarab@gmail.com/
found e1b50ef7882 in https://public-inbox.org/git/patch-12.25-c4e7179e957-20210623T155626Z-avarab@gmail.com/
found 912edd4c818 in https://public-inbox.org/git/patch-10.25-66e4909580b-20210623T155626Z-avarab@gmail.com/
found 1ab7d19deb8 in git.git.git
preparing index
index prepared:
100644 1ab7d19deb8cc7e33a6b8f2a2948b64997fa0172	progress.c

applying [1/6] https://public-inbox.org/git/patch-10.25-66e4909580b-20210623T155626Z-avarab@gmail.com/
diff --git a/progress.c b/progress.c
index 1ab7d19deb8..912edd4c818 100644


applying [2/6] https://public-inbox.org/git/patch-12.25-c4e7179e957-20210623T155626Z-avarab@gmail.com/
diff --git a/progress.c b/progress.c
index 912edd4c818..e1b50ef7882 100644


applying [3/6] https://public-inbox.org/git/patch-13.25-f2e84e3a3f2-20210623T155626Z-avarab@gmail.com/
diff --git a/progress.c b/progress.c
index e1b50ef7882..aff9af9ee8b 100644


applying [4/6] https://public-inbox.org/git/patch-14.25-88d864c373a-20210623T155626Z-avarab@gmail.com/
diff --git a/progress.c b/progress.c
index aff9af9ee8b..39d7f6bd86b 100644


applying [5/6] https://public-inbox.org/git/patch-15.25-160c5fe04c3-20210623T155626Z-avarab@gmail.com/
diff --git a/progress.c b/progress.c
index 39d7f6bd86b..44479f65921 100644


applying [6/6] https://public-inbox.org/git/patch-16.25-2161d9cbef3-20210623T155626Z-avarab@gmail.com/
diff --git a/progress.c b/progress.c
index 44479f65921..e17490964c4 100644

Checking patch progress.c...
Applied patch progress.c cleanly.
Checking patch progress.c...
Applied patch progress.c cleanly.
Checking patch progress.c...
Applied patch progress.c cleanly.
Checking patch progress.c...
Applied patch progress.c cleanly.
Checking patch progress.c...
Applied patch progress.c cleanly.
Checking patch progress.c...
Applied patch progress.c cleanly.

index at:
100644 e17490964c4cc36dd49d5005603c985205cdbe79	progress.c

Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).