promisor-remote: skip move_to_tail when no-op
[git/git.git] / progress.c
CommitLineData
74b6792f
NP
1/*
2 * Simple text-based progress display module for GIT
3 *
03aa8ff3 4 * Copyright (c) 2007 by Nicolas Pitre <nico@fluxnic.net>
74b6792f
NP
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
545dc345 11#include "cache.h"
754dbc43 12#include "gettext.h"
96a02f8f 13#include "progress.h"
079b546a 14#include "strbuf.h"
83d26fa7 15#include "trace.h"
545dc345 16#include "utf8.h"
96a02f8f 17
cf84d51c
NP
18#define TP_IDX_MAX 8
19
20struct throughput {
53ed7b5a 21 off_t curr_total;
218558af 22 off_t prev_total;
83d26fa7 23 uint64_t prev_ns;
218558af 24 unsigned int avg_bytes;
cf84d51c 25 unsigned int avg_misecs;
53ed7b5a 26 unsigned int last_bytes[TP_IDX_MAX];
cf84d51c
NP
27 unsigned int last_misecs[TP_IDX_MAX];
28 unsigned int idx;
3131977d 29 struct strbuf display;
cf84d51c
NP
30};
31
dc6a0757
NP
32struct progress {
33 const char *title;
d6861d02
EN
34 uint64_t last_value;
35 uint64_t total;
dc6a0757
NP
36 unsigned last_percent;
37 unsigned delay;
9d81ecb5 38 unsigned sparse;
cf84d51c 39 struct throughput *throughput;
0fae1e07 40 uint64_t start_ns;
d53ba841 41 struct strbuf counters_sb;
545dc345
SG
42 int title_len;
43 int split;
dc6a0757
NP
44};
45
96a02f8f
NP
46static volatile sig_atomic_t progress_update;
47
48static void progress_interval(int signum)
49{
50 progress_update = 1;
51}
52
53static void set_progress_signal(void)
54{
55 struct sigaction sa;
56 struct itimerval v;
57
180a9f22
NP
58 progress_update = 0;
59
96a02f8f
NP
60 memset(&sa, 0, sizeof(sa));
61 sa.sa_handler = progress_interval;
62 sigemptyset(&sa.sa_mask);
63 sa.sa_flags = SA_RESTART;
64 sigaction(SIGALRM, &sa, NULL);
65
66 v.it_interval.tv_sec = 1;
67 v.it_interval.tv_usec = 0;
68 v.it_value = v.it_interval;
69 setitimer(ITIMER_REAL, &v, NULL);
70}
71
72static void clear_progress_signal(void)
73{
74 struct itimerval v = {{0,},};
75 setitimer(ITIMER_REAL, &v, NULL);
76 signal(SIGALRM, SIG_IGN);
77 progress_update = 0;
78}
79
85cb8906
LM
80static int is_foreground_fd(int fd)
81{
a4fb76ce
JK
82 int tpgrp = tcgetpgrp(fd);
83 return tpgrp < 0 || tpgrp == getpgid(0);
85cb8906
LM
84}
85
9219d127 86static void display(struct progress *progress, uint64_t n, const char *done)
96a02f8f 87{
d53ba841
SG
88 const char *tp;
89 struct strbuf *counters_sb = &progress->counters_sb;
90 int show_update = 0;
9f1fd84e 91 int last_count_len = counters_sb->len;
42e18fbf 92
9c5951ca 93 if (progress->delay && (!progress_update || --progress->delay))
9219d127 94 return;
42e18fbf
NP
95
96 progress->last_value = n;
3131977d 97 tp = (progress->throughput) ? progress->throughput->display.buf : "";
96a02f8f
NP
98 if (progress->total) {
99 unsigned percent = n * 100 / progress->total;
100 if (percent != progress->last_percent || progress_update) {
101 progress->last_percent = percent;
d53ba841
SG
102
103 strbuf_reset(counters_sb);
104 strbuf_addf(counters_sb,
105 "%3u%% (%"PRIuMAX"/%"PRIuMAX")%s", percent,
106 (uintmax_t)n, (uintmax_t)progress->total,
107 tp);
108 show_update = 1;
96a02f8f
NP
109 }
110 } else if (progress_update) {
d53ba841
SG
111 strbuf_reset(counters_sb);
112 strbuf_addf(counters_sb, "%"PRIuMAX"%s", (uintmax_t)n, tp);
113 show_update = 1;
114 }
115
116 if (show_update) {
85cb8906 117 if (is_foreground_fd(fileno(stderr)) || done) {
9f1fd84e
SG
118 const char *eol = done ? done : "\r";
119 size_t clear_len = counters_sb->len < last_count_len ?
120 last_count_len - counters_sb->len + 1 :
121 0;
545dc345
SG
122 size_t progress_line_len = progress->title_len +
123 counters_sb->len + 2;
124 int cols = term_columns();
125
126 if (progress->split) {
127 fprintf(stderr, " %s%*s", counters_sb->buf,
128 (int) clear_len, eol);
129 } else if (!done && cols < progress_line_len) {
130 clear_len = progress->title_len + 1 < cols ?
1aed1a5f 131 cols - progress->title_len - 1 : 0;
545dc345
SG
132 fprintf(stderr, "%s:%*s\n %s%s",
133 progress->title, (int) clear_len, "",
134 counters_sb->buf, eol);
135 progress->split = 1;
136 } else {
137 fprintf(stderr, "%s: %s%*s", progress->title,
138 counters_sb->buf, (int) clear_len, eol);
139 }
85cb8906
LM
140 fflush(stderr);
141 }
96a02f8f 142 progress_update = 0;
96a02f8f 143 }
96a02f8f
NP
144}
145
d6861d02 146static void throughput_string(struct strbuf *buf, uint64_t total,
53ed7b5a
NP
147 unsigned int rate)
148{
3131977d 149 strbuf_reset(buf);
079b546a
AP
150 strbuf_addstr(buf, ", ");
151 strbuf_humanise_bytes(buf, total);
152 strbuf_addstr(buf, " | ");
153 strbuf_humanise_bytes(buf, rate * 1024);
154 strbuf_addstr(buf, "/s");
53ed7b5a
NP
155}
156
d6861d02 157void display_throughput(struct progress *progress, uint64_t total)
cf84d51c
NP
158{
159 struct throughput *tp;
83d26fa7
KB
160 uint64_t now_ns;
161 unsigned int misecs, count, rate;
cf84d51c
NP
162
163 if (!progress)
164 return;
165 tp = progress->throughput;
166
83d26fa7 167 now_ns = getnanotime();
cf84d51c
NP
168
169 if (!tp) {
999b951b
JK
170 progress->throughput = tp = xcalloc(1, sizeof(*tp));
171 tp->prev_total = tp->curr_total = total;
172 tp->prev_ns = now_ns;
173 strbuf_init(&tp->display, 0);
cf84d51c
NP
174 return;
175 }
53ed7b5a 176 tp->curr_total = total;
cf84d51c 177
83d26fa7
KB
178 /* only update throughput every 0.5 s */
179 if (now_ns - tp->prev_ns <= 500000000)
180 return;
181
cf84d51c 182 /*
83d26fa7 183 * We have x = bytes and y = nanosecs. We want z = KiB/s:
cf84d51c 184 *
83d26fa7
KB
185 * z = (x / 1024) / (y / 1000000000)
186 * z = x / y * 1000000000 / 1024
187 * z = x / (y * 1024 / 1000000000)
cf84d51c
NP
188 * z = x / y'
189 *
190 * To simplify things we'll keep track of misecs, or 1024th of a sec
191 * obtained with:
192 *
83d26fa7
KB
193 * y' = y * 1024 / 1000000000
194 * y' = y * (2^10 / 2^42) * (2^42 / 1000000000)
195 * y' = y / 2^32 * 4398
196 * y' = (y * 4398) >> 32
cf84d51c 197 */
83d26fa7
KB
198 misecs = ((now_ns - tp->prev_ns) * 4398) >> 32;
199
200 count = total - tp->prev_total;
201 tp->prev_total = total;
202 tp->prev_ns = now_ns;
203 tp->avg_bytes += count;
204 tp->avg_misecs += misecs;
205 rate = tp->avg_bytes / tp->avg_misecs;
206 tp->avg_bytes -= tp->last_bytes[tp->idx];
207 tp->avg_misecs -= tp->last_misecs[tp->idx];
208 tp->last_bytes[tp->idx] = count;
209 tp->last_misecs[tp->idx] = misecs;
210 tp->idx = (tp->idx + 1) % TP_IDX_MAX;
211
3131977d 212 throughput_string(&tp->display, total, rate);
83d26fa7
KB
213 if (progress->last_value != -1 && progress_update)
214 display(progress, progress->last_value, NULL);
cf84d51c
NP
215}
216
9219d127 217void display_progress(struct progress *progress, uint64_t n)
96a02f8f 218{
9219d127
SG
219 if (progress)
220 display(progress, n, NULL);
96a02f8f
NP
221}
222
d6861d02 223static struct progress *start_progress_delay(const char *title, uint64_t total,
9d81ecb5 224 unsigned delay, unsigned sparse)
180a9f22 225{
999b951b 226 struct progress *progress = xmalloc(sizeof(*progress));
42e18fbf 227 progress->title = title;
180a9f22 228 progress->total = total;
42e18fbf 229 progress->last_value = -1;
180a9f22 230 progress->last_percent = -1;
180a9f22 231 progress->delay = delay;
9d81ecb5 232 progress->sparse = sparse;
cf84d51c 233 progress->throughput = NULL;
0fae1e07 234 progress->start_ns = getnanotime();
d53ba841 235 strbuf_init(&progress->counters_sb, 0);
545dc345
SG
236 progress->title_len = utf8_strwidth(title);
237 progress->split = 0;
180a9f22 238 set_progress_signal();
dc6a0757 239 return progress;
180a9f22
NP
240}
241
d6861d02 242struct progress *start_delayed_progress(const char *title, uint64_t total)
8aade107 243{
9d81ecb5 244 return start_progress_delay(title, total, 2, 0);
8aade107
JH
245}
246
d6861d02 247struct progress *start_progress(const char *title, uint64_t total)
42e18fbf 248{
9d81ecb5
JH
249 return start_progress_delay(title, total, 0, 0);
250}
251
252/*
253 * Here "sparse" means that the caller might use some sampling criteria to
254 * decide when to call display_progress() rather than calling it for every
255 * integer value in[0 .. total). In particular, the caller might not call
256 * display_progress() for the last value in the range.
257 *
258 * When "sparse" is set, stop_progress() will automatically force the done
259 * message to show 100%.
260 */
261struct progress *start_sparse_progress(const char *title, uint64_t total)
262{
263 return start_progress_delay(title, total, 0, 1);
264}
265
266struct progress *start_delayed_sparse_progress(const char *title,
267 uint64_t total)
268{
269 return start_progress_delay(title, total, 2, 1);
270}
271
272static void finish_if_sparse(struct progress *progress)
273{
274 if (progress &&
275 progress->sparse &&
276 progress->last_value != progress->total)
277 display_progress(progress, progress->total);
42e18fbf
NP
278}
279
dc6a0757 280void stop_progress(struct progress **p_progress)
a984a06a 281{
9d81ecb5
JH
282 finish_if_sparse(*p_progress);
283
754dbc43 284 stop_progress_msg(p_progress, _("done"));
a984a06a
NP
285}
286
287void stop_progress_msg(struct progress **p_progress, const char *msg)
96a02f8f 288{
dc6a0757
NP
289 struct progress *progress = *p_progress;
290 if (!progress)
291 return;
292 *p_progress = NULL;
42e18fbf
NP
293 if (progress->last_value != -1) {
294 /* Force the last update */
fbd09439 295 char *buf;
53ed7b5a 296 struct throughput *tp = progress->throughput;
d4c44443 297
53ed7b5a 298 if (tp) {
0fae1e07
RS
299 uint64_t now_ns = getnanotime();
300 unsigned int misecs, rate;
301 misecs = ((now_ns - progress->start_ns) * 4398) >> 32;
302 rate = tp->curr_total / (misecs ? misecs : 1);
3131977d 303 throughput_string(&tp->display, tp->curr_total, rate);
53ed7b5a 304 }
42e18fbf 305 progress_update = 1;
fbd09439
MM
306 buf = xstrfmt(", %s.\n", msg);
307 display(progress, progress->last_value, buf);
308 free(buf);
42e18fbf 309 }
96a02f8f 310 clear_progress_signal();
d53ba841 311 strbuf_release(&progress->counters_sb);
3131977d
JK
312 if (progress->throughput)
313 strbuf_release(&progress->throughput->display);
cf84d51c 314 free(progress->throughput);
dc6a0757 315 free(progress);
96a02f8f 316}