]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * Simple text-based progress display module for GIT | |
3 | * | |
4 | * Copyright (c) 2007 by Nicolas Pitre <nico@fluxnic.net> | |
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 | ||
11 | #include "cache.h" | |
12 | #include "gettext.h" | |
13 | #include "progress.h" | |
14 | #include "strbuf.h" | |
15 | #include "trace.h" | |
16 | #include "utf8.h" | |
17 | ||
18 | #define TP_IDX_MAX 8 | |
19 | ||
20 | struct throughput { | |
21 | off_t curr_total; | |
22 | off_t prev_total; | |
23 | uint64_t prev_ns; | |
24 | unsigned int avg_bytes; | |
25 | unsigned int avg_misecs; | |
26 | unsigned int last_bytes[TP_IDX_MAX]; | |
27 | unsigned int last_misecs[TP_IDX_MAX]; | |
28 | unsigned int idx; | |
29 | struct strbuf display; | |
30 | }; | |
31 | ||
32 | struct progress { | |
33 | const char *title; | |
34 | uint64_t last_value; | |
35 | uint64_t total; | |
36 | unsigned last_percent; | |
37 | unsigned delay; | |
38 | unsigned sparse; | |
39 | struct throughput *throughput; | |
40 | uint64_t start_ns; | |
41 | struct strbuf counters_sb; | |
42 | int title_len; | |
43 | int split; | |
44 | }; | |
45 | ||
46 | static volatile sig_atomic_t progress_update; | |
47 | ||
48 | /* | |
49 | * These are only intended for testing the progress output, i.e. exclusively | |
50 | * for 'test-tool progress'. | |
51 | */ | |
52 | int progress_testing; | |
53 | uint64_t progress_test_ns = 0; | |
54 | void progress_test_force_update(void); /* To silence -Wmissing-prototypes */ | |
55 | void progress_test_force_update(void) | |
56 | { | |
57 | progress_update = 1; | |
58 | } | |
59 | ||
60 | ||
61 | static void progress_interval(int signum) | |
62 | { | |
63 | progress_update = 1; | |
64 | } | |
65 | ||
66 | static void set_progress_signal(void) | |
67 | { | |
68 | struct sigaction sa; | |
69 | struct itimerval v; | |
70 | ||
71 | if (progress_testing) | |
72 | return; | |
73 | ||
74 | progress_update = 0; | |
75 | ||
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 | ||
88 | static void clear_progress_signal(void) | |
89 | { | |
90 | struct itimerval v = {{0,},}; | |
91 | ||
92 | if (progress_testing) | |
93 | return; | |
94 | ||
95 | setitimer(ITIMER_REAL, &v, NULL); | |
96 | signal(SIGALRM, SIG_IGN); | |
97 | progress_update = 0; | |
98 | } | |
99 | ||
100 | static int is_foreground_fd(int fd) | |
101 | { | |
102 | int tpgrp = tcgetpgrp(fd); | |
103 | return tpgrp < 0 || tpgrp == getpgid(0); | |
104 | } | |
105 | ||
106 | static void display(struct progress *progress, uint64_t n, const char *done) | |
107 | { | |
108 | const char *tp; | |
109 | struct strbuf *counters_sb = &progress->counters_sb; | |
110 | int show_update = 0; | |
111 | int last_count_len = counters_sb->len; | |
112 | ||
113 | if (progress->delay && (!progress_update || --progress->delay)) | |
114 | return; | |
115 | ||
116 | progress->last_value = n; | |
117 | tp = (progress->throughput) ? progress->throughput->display.buf : ""; | |
118 | if (progress->total) { | |
119 | unsigned percent = n * 100 / progress->total; | |
120 | if (percent != progress->last_percent || progress_update) { | |
121 | progress->last_percent = percent; | |
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; | |
129 | } | |
130 | } else if (progress_update) { | |
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) { | |
137 | if (is_foreground_fd(fileno(stderr)) || done) { | |
138 | const char *eol = done ? done : "\r"; | |
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(); | |
146 | ||
147 | if (progress->split) { | |
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); | |
156 | progress->split = 1; | |
157 | } else { | |
158 | fprintf(stderr, "%s: %s%*s", progress->title, | |
159 | counters_sb->buf, (int) clear_len, eol); | |
160 | } | |
161 | fflush(stderr); | |
162 | } | |
163 | progress_update = 0; | |
164 | } | |
165 | } | |
166 | ||
167 | static void throughput_string(struct strbuf *buf, uint64_t total, | |
168 | unsigned int rate) | |
169 | { | |
170 | strbuf_reset(buf); | |
171 | strbuf_addstr(buf, ", "); | |
172 | strbuf_humanise_bytes(buf, total); | |
173 | strbuf_addstr(buf, " | "); | |
174 | strbuf_humanise_rate(buf, rate * 1024); | |
175 | } | |
176 | ||
177 | static 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 | ||
185 | void display_throughput(struct progress *progress, uint64_t total) | |
186 | { | |
187 | struct throughput *tp; | |
188 | uint64_t now_ns; | |
189 | unsigned int misecs, count, rate; | |
190 | ||
191 | if (!progress) | |
192 | return; | |
193 | tp = progress->throughput; | |
194 | ||
195 | now_ns = progress_getnanotime(progress); | |
196 | ||
197 | if (!tp) { | |
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); | |
202 | return; | |
203 | } | |
204 | tp->curr_total = total; | |
205 | ||
206 | /* only update throughput every 0.5 s */ | |
207 | if (now_ns - tp->prev_ns <= 500000000) | |
208 | return; | |
209 | ||
210 | /* | |
211 | * We have x = bytes and y = nanosecs. We want z = KiB/s: | |
212 | * | |
213 | * z = (x / 1024) / (y / 1000000000) | |
214 | * z = x / y * 1000000000 / 1024 | |
215 | * z = x / (y * 1024 / 1000000000) | |
216 | * z = x / y' | |
217 | * | |
218 | * To simplify things we'll keep track of misecs, or 1024th of a sec | |
219 | * obtained with: | |
220 | * | |
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 | |
225 | */ | |
226 | misecs = ((now_ns - tp->prev_ns) * 4398) >> 32; | |
227 | ||
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; | |
239 | ||
240 | throughput_string(&tp->display, total, rate); | |
241 | if (progress->last_value != -1 && progress_update) | |
242 | display(progress, progress->last_value, NULL); | |
243 | } | |
244 | ||
245 | void display_progress(struct progress *progress, uint64_t n) | |
246 | { | |
247 | if (progress) | |
248 | display(progress, n, NULL); | |
249 | } | |
250 | ||
251 | static struct progress *start_progress_delay(const char *title, uint64_t total, | |
252 | unsigned delay, unsigned sparse) | |
253 | { | |
254 | struct progress *progress = xmalloc(sizeof(*progress)); | |
255 | progress->title = title; | |
256 | progress->total = total; | |
257 | progress->last_value = -1; | |
258 | progress->last_percent = -1; | |
259 | progress->delay = delay; | |
260 | progress->sparse = sparse; | |
261 | progress->throughput = NULL; | |
262 | progress->start_ns = getnanotime(); | |
263 | strbuf_init(&progress->counters_sb, 0); | |
264 | progress->title_len = utf8_strwidth(title); | |
265 | progress->split = 0; | |
266 | set_progress_signal(); | |
267 | return progress; | |
268 | } | |
269 | ||
270 | struct progress *start_delayed_progress(const char *title, uint64_t total) | |
271 | { | |
272 | return start_progress_delay(title, total, 2, 0); | |
273 | } | |
274 | ||
275 | struct progress *start_progress(const char *title, uint64_t total) | |
276 | { | |
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 | */ | |
289 | struct progress *start_sparse_progress(const char *title, uint64_t total) | |
290 | { | |
291 | return start_progress_delay(title, total, 0, 1); | |
292 | } | |
293 | ||
294 | struct progress *start_delayed_sparse_progress(const char *title, | |
295 | uint64_t total) | |
296 | { | |
297 | return start_progress_delay(title, total, 2, 1); | |
298 | } | |
299 | ||
300 | static 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); | |
306 | } | |
307 | ||
308 | void stop_progress(struct progress **p_progress) | |
309 | { | |
310 | finish_if_sparse(*p_progress); | |
311 | ||
312 | stop_progress_msg(p_progress, _("done")); | |
313 | } | |
314 | ||
315 | void stop_progress_msg(struct progress **p_progress, const char *msg) | |
316 | { | |
317 | struct progress *progress = *p_progress; | |
318 | if (!progress) | |
319 | return; | |
320 | *p_progress = NULL; | |
321 | if (progress->last_value != -1) { | |
322 | /* Force the last update */ | |
323 | char *buf; | |
324 | struct throughput *tp = progress->throughput; | |
325 | ||
326 | if (tp) { | |
327 | uint64_t now_ns = progress_getnanotime(progress); | |
328 | unsigned int misecs, rate; | |
329 | misecs = ((now_ns - progress->start_ns) * 4398) >> 32; | |
330 | rate = tp->curr_total / (misecs ? misecs : 1); | |
331 | throughput_string(&tp->display, tp->curr_total, rate); | |
332 | } | |
333 | progress_update = 1; | |
334 | buf = xstrfmt(", %s.\n", msg); | |
335 | display(progress, progress->last_value, buf); | |
336 | free(buf); | |
337 | } | |
338 | clear_progress_signal(); | |
339 | strbuf_release(&progress->counters_sb); | |
340 | if (progress->throughput) | |
341 | strbuf_release(&progress->throughput->display); | |
342 | free(progress->throughput); | |
343 | free(progress); | |
344 | } |