]>
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 | static void progress_interval(int signum) | |
49 | { | |
50 | progress_update = 1; | |
51 | } | |
52 | ||
53 | static void set_progress_signal(void) | |
54 | { | |
55 | struct sigaction sa; | |
56 | struct itimerval v; | |
57 | ||
58 | progress_update = 0; | |
59 | ||
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 | ||
72 | static 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 | ||
80 | static int is_foreground_fd(int fd) | |
81 | { | |
82 | int tpgrp = tcgetpgrp(fd); | |
83 | return tpgrp < 0 || tpgrp == getpgid(0); | |
84 | } | |
85 | ||
86 | static void display(struct progress *progress, uint64_t n, const char *done) | |
87 | { | |
88 | const char *tp; | |
89 | struct strbuf *counters_sb = &progress->counters_sb; | |
90 | int show_update = 0; | |
91 | int last_count_len = counters_sb->len; | |
92 | ||
93 | if (progress->delay && (!progress_update || --progress->delay)) | |
94 | return; | |
95 | ||
96 | progress->last_value = n; | |
97 | tp = (progress->throughput) ? progress->throughput->display.buf : ""; | |
98 | if (progress->total) { | |
99 | unsigned percent = n * 100 / progress->total; | |
100 | if (percent != progress->last_percent || progress_update) { | |
101 | progress->last_percent = percent; | |
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; | |
109 | } | |
110 | } else if (progress_update) { | |
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) { | |
117 | if (is_foreground_fd(fileno(stderr)) || done) { | |
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; | |
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 ? | |
131 | cols - progress->title_len - 1 : 0; | |
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 | } | |
140 | fflush(stderr); | |
141 | } | |
142 | progress_update = 0; | |
143 | } | |
144 | } | |
145 | ||
146 | static void throughput_string(struct strbuf *buf, uint64_t total, | |
147 | unsigned int rate) | |
148 | { | |
149 | strbuf_reset(buf); | |
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"); | |
155 | } | |
156 | ||
157 | void display_throughput(struct progress *progress, uint64_t total) | |
158 | { | |
159 | struct throughput *tp; | |
160 | uint64_t now_ns; | |
161 | unsigned int misecs, count, rate; | |
162 | ||
163 | if (!progress) | |
164 | return; | |
165 | tp = progress->throughput; | |
166 | ||
167 | now_ns = getnanotime(); | |
168 | ||
169 | if (!tp) { | |
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); | |
174 | return; | |
175 | } | |
176 | tp->curr_total = total; | |
177 | ||
178 | /* only update throughput every 0.5 s */ | |
179 | if (now_ns - tp->prev_ns <= 500000000) | |
180 | return; | |
181 | ||
182 | /* | |
183 | * We have x = bytes and y = nanosecs. We want z = KiB/s: | |
184 | * | |
185 | * z = (x / 1024) / (y / 1000000000) | |
186 | * z = x / y * 1000000000 / 1024 | |
187 | * z = x / (y * 1024 / 1000000000) | |
188 | * z = x / y' | |
189 | * | |
190 | * To simplify things we'll keep track of misecs, or 1024th of a sec | |
191 | * obtained with: | |
192 | * | |
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 | |
197 | */ | |
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 | ||
212 | throughput_string(&tp->display, total, rate); | |
213 | if (progress->last_value != -1 && progress_update) | |
214 | display(progress, progress->last_value, NULL); | |
215 | } | |
216 | ||
217 | void display_progress(struct progress *progress, uint64_t n) | |
218 | { | |
219 | if (progress) | |
220 | display(progress, n, NULL); | |
221 | } | |
222 | ||
223 | static struct progress *start_progress_delay(const char *title, uint64_t total, | |
224 | unsigned delay, unsigned sparse) | |
225 | { | |
226 | struct progress *progress = xmalloc(sizeof(*progress)); | |
227 | progress->title = title; | |
228 | progress->total = total; | |
229 | progress->last_value = -1; | |
230 | progress->last_percent = -1; | |
231 | progress->delay = delay; | |
232 | progress->sparse = sparse; | |
233 | progress->throughput = NULL; | |
234 | progress->start_ns = getnanotime(); | |
235 | strbuf_init(&progress->counters_sb, 0); | |
236 | progress->title_len = utf8_strwidth(title); | |
237 | progress->split = 0; | |
238 | set_progress_signal(); | |
239 | return progress; | |
240 | } | |
241 | ||
242 | struct progress *start_delayed_progress(const char *title, uint64_t total) | |
243 | { | |
244 | return start_progress_delay(title, total, 2, 0); | |
245 | } | |
246 | ||
247 | struct progress *start_progress(const char *title, uint64_t total) | |
248 | { | |
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 | */ | |
261 | struct progress *start_sparse_progress(const char *title, uint64_t total) | |
262 | { | |
263 | return start_progress_delay(title, total, 0, 1); | |
264 | } | |
265 | ||
266 | struct progress *start_delayed_sparse_progress(const char *title, | |
267 | uint64_t total) | |
268 | { | |
269 | return start_progress_delay(title, total, 2, 1); | |
270 | } | |
271 | ||
272 | static 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); | |
278 | } | |
279 | ||
280 | void stop_progress(struct progress **p_progress) | |
281 | { | |
282 | finish_if_sparse(*p_progress); | |
283 | ||
284 | stop_progress_msg(p_progress, _("done")); | |
285 | } | |
286 | ||
287 | void stop_progress_msg(struct progress **p_progress, const char *msg) | |
288 | { | |
289 | struct progress *progress = *p_progress; | |
290 | if (!progress) | |
291 | return; | |
292 | *p_progress = NULL; | |
293 | if (progress->last_value != -1) { | |
294 | /* Force the last update */ | |
295 | char *buf; | |
296 | struct throughput *tp = progress->throughput; | |
297 | ||
298 | if (tp) { | |
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); | |
303 | throughput_string(&tp->display, tp->curr_total, rate); | |
304 | } | |
305 | progress_update = 1; | |
306 | buf = xstrfmt(", %s.\n", msg); | |
307 | display(progress, progress->last_value, buf); | |
308 | free(buf); | |
309 | } | |
310 | clear_progress_signal(); | |
311 | strbuf_release(&progress->counters_sb); | |
312 | if (progress->throughput) | |
313 | strbuf_release(&progress->throughput->display); | |
314 | free(progress->throughput); | |
315 | free(progress); | |
316 | } |