🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.24.2 / . / progress.c
blob: 0063559aab6e233abd0a69aef6cead9d01e39948 [file] [log] [blame]
Nicolas Pitre74b67922007-10-30 19:41:13[diff] [blame]1/*
2 * Simple text-based progress display module for GIT
3 *
Nicolas Pitre03aa8ff2009-09-14 06:41:16[diff] [blame]4 * Copyright (c) 2007 by Nicolas Pitre <nico@fluxnic.net>
Nicolas Pitre74b67922007-10-30 19:41:13[diff] [blame]5 *
6 * This code is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 */
10
SZEDER Gábor545dc342019-04-12 19:45:15[diff] [blame]11#include "cache.h"
Nguyễn Thái Ngọc Duy754dbc42014-02-21 12:50:18[diff] [blame]12#include "gettext.h"
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]13#include "progress.h"
Antoine Pelisse079b5462013-04-10 19:03:23[diff] [blame]14#include "strbuf.h"
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]15#include "trace.h"
SZEDER Gábor545dc342019-04-12 19:45:15[diff] [blame]16#include "utf8.h"
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]17
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]18#define TP_IDX_MAX 8
19
20struct throughput {
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]21 off_t curr_total;
Nicolas Pitre218558a2007-11-05 03:15:41[diff] [blame]22 off_t prev_total;
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]23 uint64_t prev_ns;
Nicolas Pitre218558a2007-11-05 03:15:41[diff] [blame]24 unsigned int avg_bytes;
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]25 unsigned int avg_misecs;
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]26 unsigned int last_bytes[TP_IDX_MAX];
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]27 unsigned int last_misecs[TP_IDX_MAX];
28 unsigned int idx;
Jeff King31319772015-09-24 21:05:57[diff] [blame]29 struct strbuf display;
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]30};
31
Nicolas Pitredc6a0752007-10-30 18:57:32[diff] [blame]32struct progress {
33 const char *title;
Elijah Newrend6861d02017-11-13 20:15:58[diff] [blame]34 uint64_t last_value;
35 uint64_t total;
Nicolas Pitredc6a0752007-10-30 18:57:32[diff] [blame]36 unsigned last_percent;
37 unsigned delay;
Jeff Hostetler9d81ecb2019-03-21 19:36:11[diff] [blame]38 unsigned sparse;
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]39 struct throughput *throughput;
René Scharfe0fae1e02017-07-08 16:43:42[diff] [blame]40 uint64_t start_ns;
SZEDER Gábord53ba842019-04-05 00:45:37[diff] [blame]41 struct strbuf counters_sb;
SZEDER Gábor545dc342019-04-12 19:45:15[diff] [blame]42 int title_len;
43 int split;
Nicolas Pitredc6a0752007-10-30 18:57:32[diff] [blame]44};
45
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]46static volatile sig_atomic_t progress_update;
47
SZEDER Gábor2bb74b52019-09-16 20:54:12[diff] [blame]48/*
49 * These are only intended for testing the progress output, i.e. exclusively
50 * for 'test-tool progress'.
51 */
52int progress_testing;
53uint64_t progress_test_ns = 0;
54void progress_test_force_update(void); /* To silence -Wmissing-prototypes */
55void progress_test_force_update(void)
56{
57 progress_update = 1;
58}
59
60
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]61static void progress_interval(int signum)
62{
63 progress_update = 1;
64}
65
66static void set_progress_signal(void)
67{
68 struct sigaction sa;
69 struct itimerval v;
70
SZEDER Gábor2bb74b52019-09-16 20:54:12[diff] [blame]71 if (progress_testing)
72 return;
73
Nicolas Pitre180a9f22007-04-20 19:05:27[diff] [blame]74 progress_update = 0;
75
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]76 memset(&sa, 0, sizeof(sa));
77 sa.sa_handler = progress_interval;
78 sigemptyset(&sa.sa_mask);
79 sa.sa_flags = SA_RESTART;
80 sigaction(SIGALRM, &sa, NULL);
81
82 v.it_interval.tv_sec = 1;
83 v.it_interval.tv_usec = 0;
84 v.it_value = v.it_interval;
85 setitimer(ITIMER_REAL, &v, NULL);
86}
87
88static void clear_progress_signal(void)
89{
90 struct itimerval v = {{0,},};
SZEDER Gábor2bb74b52019-09-16 20:54:12[diff] [blame]91
92 if (progress_testing)
93 return;
94
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]95 setitimer(ITIMER_REAL, &v, NULL);
96 signal(SIGALRM, SIG_IGN);
97 progress_update = 0;
98}
99
Luke Mewburn85cb8902015-04-13 13:30:51[diff] [blame]100static int is_foreground_fd(int fd)
101{
Jeff Kinga4fb76c2015-05-19 05:24:57[diff] [blame]102 int tpgrp = tcgetpgrp(fd);
103 return tpgrp < 0 || tpgrp == getpgid(0);
Luke Mewburn85cb8902015-04-13 13:30:51[diff] [blame]104}
105
SZEDER Gábor9219d122019-04-05 00:45:36[diff] [blame]106static void display(struct progress *progress, uint64_t n, const char *done)
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]107{
SZEDER Gábord53ba842019-04-05 00:45:37[diff] [blame]108 const char *tp;
109 struct strbuf *counters_sb = &progress->counters_sb;
110 int show_update = 0;
SZEDER Gáborbbf47562019-09-16 20:54:11[diff] [blame]111 int last_count_len = counters_sb->len;
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]112
Lars Schneider9c5951c2017-12-04 22:07:00[diff] [blame]113 if (progress->delay && (!progress_update || --progress->delay))
SZEDER Gábor9219d122019-04-05 00:45:36[diff] [blame]114 return;
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]115
116 progress->last_value = n;
Jeff King31319772015-09-24 21:05:57[diff] [blame]117 tp = (progress->throughput) ? progress->throughput->display.buf : "";
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]118 if (progress->total) {
119 unsigned percent = n * 100 / progress->total;
120 if (percent != progress->last_percent || progress_update) {
121 progress->last_percent = percent;
SZEDER Gábord53ba842019-04-05 00:45:37[diff] [blame]122
123 strbuf_reset(counters_sb);
124 strbuf_addf(counters_sb,
125 "%3u%% (%"PRIuMAX"/%"PRIuMAX")%s", percent,
126 (uintmax_t)n, (uintmax_t)progress->total,
127 tp);
128 show_update = 1;
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]129 }
130 } else if (progress_update) {
SZEDER Gábord53ba842019-04-05 00:45:37[diff] [blame]131 strbuf_reset(counters_sb);
132 strbuf_addf(counters_sb, "%"PRIuMAX"%s", (uintmax_t)n, tp);
133 show_update = 1;
134 }
135
136 if (show_update) {
Luke Mewburn85cb8902015-04-13 13:30:51[diff] [blame]137 if (is_foreground_fd(fileno(stderr)) || done) {
SZEDER Gábor9f1fd842019-04-12 19:45:14[diff] [blame]138 const char *eol = done ? done : "\r";
SZEDER Gáborbbf47562019-09-16 20:54:11[diff] [blame]139 size_t clear_len = counters_sb->len < last_count_len ?
140 last_count_len - counters_sb->len + 1 :
141 0;
142 /* The "+ 2" accounts for the ": ". */
143 size_t progress_line_len = progress->title_len +
144 counters_sb->len + 2;
145 int cols = term_columns();
SZEDER Gábor545dc342019-04-12 19:45:15[diff] [blame]146
147 if (progress->split) {
SZEDER Gáborbbf47562019-09-16 20:54:11[diff] [blame]148 fprintf(stderr, " %s%*s", counters_sb->buf,
149 (int) clear_len, eol);
150 } else if (!done && cols < progress_line_len) {
151 clear_len = progress->title_len + 1 < cols ?
152 cols - progress->title_len - 1 : 0;
153 fprintf(stderr, "%s:%*s\n %s%s",
154 progress->title, (int) clear_len, "",
155 counters_sb->buf, eol);
SZEDER Gábor545dc342019-04-12 19:45:15[diff] [blame]156 progress->split = 1;
157 } else {
SZEDER Gáborbbf47562019-09-16 20:54:11[diff] [blame]158 fprintf(stderr, "%s: %s%*s", progress->title,
159 counters_sb->buf, (int) clear_len, eol);
SZEDER Gábor545dc342019-04-12 19:45:15[diff] [blame]160 }
Luke Mewburn85cb8902015-04-13 13:30:51[diff] [blame]161 fflush(stderr);
162 }
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]163 progress_update = 0;
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]164 }
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]165}
166
Elijah Newrend6861d02017-11-13 20:15:58[diff] [blame]167static void throughput_string(struct strbuf *buf, uint64_t total,
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]168 unsigned int rate)
169{
Jeff King31319772015-09-24 21:05:57[diff] [blame]170 strbuf_reset(buf);
Antoine Pelisse079b5462013-04-10 19:03:23[diff] [blame]171 strbuf_addstr(buf, ", ");
172 strbuf_humanise_bytes(buf, total);
173 strbuf_addstr(buf, " | ");
Dimitriy Ryazantcev8f354a12019-07-02 18:22:48[diff] [blame]174 strbuf_humanise_rate(buf, rate * 1024);
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]175}
176
SZEDER Gábor2bb74b52019-09-16 20:54:12[diff] [blame]177static uint64_t progress_getnanotime(struct progress *progress)
178{
179 if (progress_testing)
180 return progress->start_ns + progress_test_ns;
181 else
182 return getnanotime();
183}
184
Elijah Newrend6861d02017-11-13 20:15:58[diff] [blame]185void display_throughput(struct progress *progress, uint64_t total)
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]186{
187 struct throughput *tp;
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]188 uint64_t now_ns;
189 unsigned int misecs, count, rate;
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]190
191 if (!progress)
192 return;
193 tp = progress->throughput;
194
SZEDER Gábor2bb74b52019-09-16 20:54:12[diff] [blame]195 now_ns = progress_getnanotime(progress);
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]196
197 if (!tp) {
Jeff King999b9512019-04-11 13:49:57[diff] [blame]198 progress->throughput = tp = xcalloc(1, sizeof(*tp));
199 tp->prev_total = tp->curr_total = total;
200 tp->prev_ns = now_ns;
201 strbuf_init(&tp->display, 0);
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]202 return;
203 }
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]204 tp->curr_total = total;
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]205
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]206 /* only update throughput every 0.5 s */
207 if (now_ns - tp->prev_ns <= 500000000)
208 return;
209
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]210 /*
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]211 * We have x = bytes and y = nanosecs. We want z = KiB/s:
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]212 *
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]213 * z = (x / 1024) / (y / 1000000000)
214 * z = x / y * 1000000000 / 1024
215 * z = x / (y * 1024 / 1000000000)
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]216 * z = x / y'
217 *
218 * To simplify things we'll keep track of misecs, or 1024th of a sec
219 * obtained with:
220 *
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]221 * y' = y * 1024 / 1000000000
222 * y' = y * (2^10 / 2^42) * (2^42 / 1000000000)
223 * y' = y / 2^32 * 4398
224 * y' = (y * 4398) >> 32
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]225 */
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]226 misecs = ((now_ns - tp->prev_ns) * 4398) >> 32;
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]227
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]228 count = total - tp->prev_total;
229 tp->prev_total = total;
230 tp->prev_ns = now_ns;
231 tp->avg_bytes += count;
232 tp->avg_misecs += misecs;
233 rate = tp->avg_bytes / tp->avg_misecs;
234 tp->avg_bytes -= tp->last_bytes[tp->idx];
235 tp->avg_misecs -= tp->last_misecs[tp->idx];
236 tp->last_bytes[tp->idx] = count;
237 tp->last_misecs[tp->idx] = misecs;
238 tp->idx = (tp->idx + 1) % TP_IDX_MAX;
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]239
Jeff King31319772015-09-24 21:05:57[diff] [blame]240 throughput_string(&tp->display, total, rate);
Karsten Blees83d26fa2014-07-12 00:08:11[diff] [blame]241 if (progress->last_value != -1 && progress_update)
242 display(progress, progress->last_value, NULL);
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]243}
244
SZEDER Gábor9219d122019-04-05 00:45:36[diff] [blame]245void display_progress(struct progress *progress, uint64_t n)
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]246{
SZEDER Gábor9219d122019-04-05 00:45:36[diff] [blame]247 if (progress)
248 display(progress, n, NULL);
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]249}
250
Elijah Newrend6861d02017-11-13 20:15:58[diff] [blame]251static struct progress *start_progress_delay(const char *title, uint64_t total,
Jeff Hostetler9d81ecb2019-03-21 19:36:11[diff] [blame]252 unsigned delay, unsigned sparse)
Nicolas Pitre180a9f22007-04-20 19:05:27[diff] [blame]253{
Jeff King999b9512019-04-11 13:49:57[diff] [blame]254 struct progress *progress = xmalloc(sizeof(*progress));
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]255 progress->title = title;
Nicolas Pitre180a9f22007-04-20 19:05:27[diff] [blame]256 progress->total = total;
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]257 progress->last_value = -1;
Nicolas Pitre180a9f22007-04-20 19:05:27[diff] [blame]258 progress->last_percent = -1;
Nicolas Pitre180a9f22007-04-20 19:05:27[diff] [blame]259 progress->delay = delay;
Jeff Hostetler9d81ecb2019-03-21 19:36:11[diff] [blame]260 progress->sparse = sparse;
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]261 progress->throughput = NULL;
René Scharfe0fae1e02017-07-08 16:43:42[diff] [blame]262 progress->start_ns = getnanotime();
SZEDER Gábord53ba842019-04-05 00:45:37[diff] [blame]263 strbuf_init(&progress->counters_sb, 0);
SZEDER Gábor545dc342019-04-12 19:45:15[diff] [blame]264 progress->title_len = utf8_strwidth(title);
265 progress->split = 0;
Nicolas Pitre180a9f22007-04-20 19:05:27[diff] [blame]266 set_progress_signal();
Nicolas Pitredc6a0752007-10-30 18:57:32[diff] [blame]267 return progress;
Nicolas Pitre180a9f22007-04-20 19:05:27[diff] [blame]268}
269
Elijah Newrend6861d02017-11-13 20:15:58[diff] [blame]270struct progress *start_delayed_progress(const char *title, uint64_t total)
Junio C Hamano8aade102017-08-19 17:39:41[diff] [blame]271{
Jeff Hostetler9d81ecb2019-03-21 19:36:11[diff] [blame]272 return start_progress_delay(title, total, 2, 0);
Junio C Hamano8aade102017-08-19 17:39:41[diff] [blame]273}
274
Elijah Newrend6861d02017-11-13 20:15:58[diff] [blame]275struct progress *start_progress(const char *title, uint64_t total)
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]276{
Jeff Hostetler9d81ecb2019-03-21 19:36:11[diff] [blame]277 return start_progress_delay(title, total, 0, 0);
278}
279
280/*
281 * Here "sparse" means that the caller might use some sampling criteria to
282 * decide when to call display_progress() rather than calling it for every
283 * integer value in[0 .. total). In particular, the caller might not call
284 * display_progress() for the last value in the range.
285 *
286 * When "sparse" is set, stop_progress() will automatically force the done
287 * message to show 100%.
288 */
289struct progress *start_sparse_progress(const char *title, uint64_t total)
290{
291 return start_progress_delay(title, total, 0, 1);
292}
293
294struct progress *start_delayed_sparse_progress(const char *title,
295 uint64_t total)
296{
297 return start_progress_delay(title, total, 2, 1);
298}
299
300static void finish_if_sparse(struct progress *progress)
301{
302 if (progress &&
303 progress->sparse &&
304 progress->last_value != progress->total)
305 display_progress(progress, progress->total);
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]306}
307
Nicolas Pitredc6a0752007-10-30 18:57:32[diff] [blame]308void stop_progress(struct progress **p_progress)
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]309{
Jeff Hostetler9d81ecb2019-03-21 19:36:11[diff] [blame]310 finish_if_sparse(*p_progress);
311
Nguyễn Thái Ngọc Duy754dbc42014-02-21 12:50:18[diff] [blame]312 stop_progress_msg(p_progress, _("done"));
Nicolas Pitrea984a062007-11-08 20:45:41[diff] [blame]313}
314
315void stop_progress_msg(struct progress **p_progress, const char *msg)
316{
Nicolas Pitredc6a0752007-10-30 18:57:32[diff] [blame]317 struct progress *progress = *p_progress;
318 if (!progress)
319 return;
320 *p_progress = NULL;
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]321 if (progress->last_value != -1) {
322 /* Force the last update */
Maxim Moseychukfbd09432017-02-16 17:07:13[diff] [blame]323 char *buf;
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]324 struct throughput *tp = progress->throughput;
Boyd Lynn Gerberd4c44442008-06-08 15:26:15[diff] [blame]325
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]326 if (tp) {
SZEDER Gábor2bb74b52019-09-16 20:54:12[diff] [blame]327 uint64_t now_ns = progress_getnanotime(progress);
René Scharfe0fae1e02017-07-08 16:43:42[diff] [blame]328 unsigned int misecs, rate;
329 misecs = ((now_ns - progress->start_ns) * 4398) >> 32;
330 rate = tp->curr_total / (misecs ? misecs : 1);
Jeff King31319772015-09-24 21:05:57[diff] [blame]331 throughput_string(&tp->display, tp->curr_total, rate);
Nicolas Pitre53ed7b52007-11-06 21:30:28[diff] [blame]332 }
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]333 progress_update = 1;
Maxim Moseychukfbd09432017-02-16 17:07:13[diff] [blame]334 buf = xstrfmt(", %s.\n", msg);
335 display(progress, progress->last_value, buf);
336 free(buf);
Nicolas Pitre42e18fb2007-10-17 01:55:45[diff] [blame]337 }
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]338 clear_progress_signal();
SZEDER Gábord53ba842019-04-05 00:45:37[diff] [blame]339 strbuf_release(&progress->counters_sb);
Jeff King31319772015-09-24 21:05:57[diff] [blame]340 if (progress->throughput)
341 strbuf_release(&progress->throughput->display);
Nicolas Pitrecf84d512007-10-30 18:57:34[diff] [blame]342 free(progress->throughput);
Nicolas Pitredc6a0752007-10-30 18:57:32[diff] [blame]343 free(progress);
Nicolas Pitre96a02f82007-04-18 18:27:45[diff] [blame]344}