]>
Commit | Line | Data |
---|---|---|
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 | ||
96a02f8f | 11 | #include "git-compat-util.h" |
754dbc43 | 12 | #include "gettext.h" |
96a02f8f | 13 | #include "progress.h" |
079b546a | 14 | #include "strbuf.h" |
83d26fa7 | 15 | #include "trace.h" |
96a02f8f | 16 | |
cf84d51c NP |
17 | #define TP_IDX_MAX 8 |
18 | ||
19 | struct throughput { | |
53ed7b5a | 20 | off_t curr_total; |
218558af | 21 | off_t prev_total; |
83d26fa7 | 22 | uint64_t prev_ns; |
218558af | 23 | unsigned int avg_bytes; |
cf84d51c | 24 | unsigned int avg_misecs; |
53ed7b5a | 25 | unsigned int last_bytes[TP_IDX_MAX]; |
cf84d51c NP |
26 | unsigned int last_misecs[TP_IDX_MAX]; |
27 | unsigned int idx; | |
3131977d | 28 | struct strbuf display; |
cf84d51c NP |
29 | }; |
30 | ||
dc6a0757 NP |
31 | struct progress { |
32 | const char *title; | |
d6861d02 EN |
33 | uint64_t last_value; |
34 | uint64_t total; | |
dc6a0757 NP |
35 | unsigned last_percent; |
36 | unsigned delay; | |
cf84d51c | 37 | struct throughput *throughput; |
0fae1e07 | 38 | uint64_t start_ns; |
dc6a0757 NP |
39 | }; |
40 | ||
96a02f8f NP |
41 | static volatile sig_atomic_t progress_update; |
42 | ||
43 | static void progress_interval(int signum) | |
44 | { | |
45 | progress_update = 1; | |
46 | } | |
47 | ||
48 | static void set_progress_signal(void) | |
49 | { | |
50 | struct sigaction sa; | |
51 | struct itimerval v; | |
52 | ||
180a9f22 NP |
53 | progress_update = 0; |
54 | ||
96a02f8f NP |
55 | memset(&sa, 0, sizeof(sa)); |
56 | sa.sa_handler = progress_interval; | |
57 | sigemptyset(&sa.sa_mask); | |
58 | sa.sa_flags = SA_RESTART; | |
59 | sigaction(SIGALRM, &sa, NULL); | |
60 | ||
61 | v.it_interval.tv_sec = 1; | |
62 | v.it_interval.tv_usec = 0; | |
63 | v.it_value = v.it_interval; | |
64 | setitimer(ITIMER_REAL, &v, NULL); | |
65 | } | |
66 | ||
67 | static void clear_progress_signal(void) | |
68 | { | |
69 | struct itimerval v = {{0,},}; | |
70 | setitimer(ITIMER_REAL, &v, NULL); | |
71 | signal(SIGALRM, SIG_IGN); | |
72 | progress_update = 0; | |
73 | } | |
74 | ||
85cb8906 LM |
75 | static int is_foreground_fd(int fd) |
76 | { | |
a4fb76ce JK |
77 | int tpgrp = tcgetpgrp(fd); |
78 | return tpgrp < 0 || tpgrp == getpgid(0); | |
85cb8906 LM |
79 | } |
80 | ||
9219d127 | 81 | static void display(struct progress *progress, uint64_t n, const char *done) |
96a02f8f | 82 | { |
a984a06a | 83 | const char *eol, *tp; |
42e18fbf | 84 | |
9c5951ca | 85 | if (progress->delay && (!progress_update || --progress->delay)) |
9219d127 | 86 | return; |
42e18fbf NP |
87 | |
88 | progress->last_value = n; | |
3131977d | 89 | tp = (progress->throughput) ? progress->throughput->display.buf : ""; |
a984a06a | 90 | eol = done ? done : " \r"; |
96a02f8f NP |
91 | if (progress->total) { |
92 | unsigned percent = n * 100 / progress->total; | |
93 | if (percent != progress->last_percent || progress_update) { | |
94 | progress->last_percent = percent; | |
85cb8906 | 95 | if (is_foreground_fd(fileno(stderr)) || done) { |
d6861d02 EN |
96 | fprintf(stderr, "%s: %3u%% (%"PRIuMAX"/%"PRIuMAX")%s%s", |
97 | progress->title, percent, | |
98 | (uintmax_t)n, (uintmax_t)progress->total, | |
99 | tp, eol); | |
85cb8906 LM |
100 | fflush(stderr); |
101 | } | |
96a02f8f | 102 | progress_update = 0; |
96a02f8f NP |
103 | } |
104 | } else if (progress_update) { | |
85cb8906 | 105 | if (is_foreground_fd(fileno(stderr)) || done) { |
d6861d02 EN |
106 | fprintf(stderr, "%s: %"PRIuMAX"%s%s", |
107 | progress->title, (uintmax_t)n, tp, eol); | |
85cb8906 LM |
108 | fflush(stderr); |
109 | } | |
96a02f8f | 110 | progress_update = 0; |
96a02f8f | 111 | } |
96a02f8f NP |
112 | } |
113 | ||
d6861d02 | 114 | static void throughput_string(struct strbuf *buf, uint64_t total, |
53ed7b5a NP |
115 | unsigned int rate) |
116 | { | |
3131977d | 117 | strbuf_reset(buf); |
079b546a AP |
118 | strbuf_addstr(buf, ", "); |
119 | strbuf_humanise_bytes(buf, total); | |
120 | strbuf_addstr(buf, " | "); | |
121 | strbuf_humanise_bytes(buf, rate * 1024); | |
122 | strbuf_addstr(buf, "/s"); | |
53ed7b5a NP |
123 | } |
124 | ||
d6861d02 | 125 | void display_throughput(struct progress *progress, uint64_t total) |
cf84d51c NP |
126 | { |
127 | struct throughput *tp; | |
83d26fa7 KB |
128 | uint64_t now_ns; |
129 | unsigned int misecs, count, rate; | |
cf84d51c NP |
130 | |
131 | if (!progress) | |
132 | return; | |
133 | tp = progress->throughput; | |
134 | ||
83d26fa7 | 135 | now_ns = getnanotime(); |
cf84d51c NP |
136 | |
137 | if (!tp) { | |
138 | progress->throughput = tp = calloc(1, sizeof(*tp)); | |
218558af | 139 | if (tp) { |
53ed7b5a | 140 | tp->prev_total = tp->curr_total = total; |
83d26fa7 | 141 | tp->prev_ns = now_ns; |
3131977d | 142 | strbuf_init(&tp->display, 0); |
218558af | 143 | } |
cf84d51c NP |
144 | return; |
145 | } | |
53ed7b5a | 146 | tp->curr_total = total; |
cf84d51c | 147 | |
83d26fa7 KB |
148 | /* only update throughput every 0.5 s */ |
149 | if (now_ns - tp->prev_ns <= 500000000) | |
150 | return; | |
151 | ||
cf84d51c | 152 | /* |
83d26fa7 | 153 | * We have x = bytes and y = nanosecs. We want z = KiB/s: |
cf84d51c | 154 | * |
83d26fa7 KB |
155 | * z = (x / 1024) / (y / 1000000000) |
156 | * z = x / y * 1000000000 / 1024 | |
157 | * z = x / (y * 1024 / 1000000000) | |
cf84d51c NP |
158 | * z = x / y' |
159 | * | |
160 | * To simplify things we'll keep track of misecs, or 1024th of a sec | |
161 | * obtained with: | |
162 | * | |
83d26fa7 KB |
163 | * y' = y * 1024 / 1000000000 |
164 | * y' = y * (2^10 / 2^42) * (2^42 / 1000000000) | |
165 | * y' = y / 2^32 * 4398 | |
166 | * y' = (y * 4398) >> 32 | |
cf84d51c | 167 | */ |
83d26fa7 KB |
168 | misecs = ((now_ns - tp->prev_ns) * 4398) >> 32; |
169 | ||
170 | count = total - tp->prev_total; | |
171 | tp->prev_total = total; | |
172 | tp->prev_ns = now_ns; | |
173 | tp->avg_bytes += count; | |
174 | tp->avg_misecs += misecs; | |
175 | rate = tp->avg_bytes / tp->avg_misecs; | |
176 | tp->avg_bytes -= tp->last_bytes[tp->idx]; | |
177 | tp->avg_misecs -= tp->last_misecs[tp->idx]; | |
178 | tp->last_bytes[tp->idx] = count; | |
179 | tp->last_misecs[tp->idx] = misecs; | |
180 | tp->idx = (tp->idx + 1) % TP_IDX_MAX; | |
181 | ||
3131977d | 182 | throughput_string(&tp->display, total, rate); |
83d26fa7 KB |
183 | if (progress->last_value != -1 && progress_update) |
184 | display(progress, progress->last_value, NULL); | |
cf84d51c NP |
185 | } |
186 | ||
9219d127 | 187 | void display_progress(struct progress *progress, uint64_t n) |
96a02f8f | 188 | { |
9219d127 SG |
189 | if (progress) |
190 | display(progress, n, NULL); | |
96a02f8f NP |
191 | } |
192 | ||
d6861d02 | 193 | static struct progress *start_progress_delay(const char *title, uint64_t total, |
9c5951ca | 194 | unsigned delay) |
180a9f22 | 195 | { |
dc6a0757 NP |
196 | struct progress *progress = malloc(sizeof(*progress)); |
197 | if (!progress) { | |
198 | /* unlikely, but here's a good fallback */ | |
199 | fprintf(stderr, "%s...\n", title); | |
137a0d0e | 200 | fflush(stderr); |
dc6a0757 NP |
201 | return NULL; |
202 | } | |
42e18fbf | 203 | progress->title = title; |
180a9f22 | 204 | progress->total = total; |
42e18fbf | 205 | progress->last_value = -1; |
180a9f22 | 206 | progress->last_percent = -1; |
180a9f22 | 207 | progress->delay = delay; |
cf84d51c | 208 | progress->throughput = NULL; |
0fae1e07 | 209 | progress->start_ns = getnanotime(); |
180a9f22 | 210 | set_progress_signal(); |
dc6a0757 | 211 | return progress; |
180a9f22 NP |
212 | } |
213 | ||
d6861d02 | 214 | struct progress *start_delayed_progress(const char *title, uint64_t total) |
8aade107 | 215 | { |
9c5951ca | 216 | return start_progress_delay(title, total, 2); |
8aade107 JH |
217 | } |
218 | ||
d6861d02 | 219 | struct progress *start_progress(const char *title, uint64_t total) |
42e18fbf | 220 | { |
9c5951ca | 221 | return start_progress_delay(title, total, 0); |
42e18fbf NP |
222 | } |
223 | ||
dc6a0757 | 224 | void stop_progress(struct progress **p_progress) |
a984a06a | 225 | { |
754dbc43 | 226 | stop_progress_msg(p_progress, _("done")); |
a984a06a NP |
227 | } |
228 | ||
229 | void stop_progress_msg(struct progress **p_progress, const char *msg) | |
96a02f8f | 230 | { |
dc6a0757 NP |
231 | struct progress *progress = *p_progress; |
232 | if (!progress) | |
233 | return; | |
234 | *p_progress = NULL; | |
42e18fbf NP |
235 | if (progress->last_value != -1) { |
236 | /* Force the last update */ | |
fbd09439 | 237 | char *buf; |
53ed7b5a | 238 | struct throughput *tp = progress->throughput; |
d4c44443 | 239 | |
53ed7b5a | 240 | if (tp) { |
0fae1e07 RS |
241 | uint64_t now_ns = getnanotime(); |
242 | unsigned int misecs, rate; | |
243 | misecs = ((now_ns - progress->start_ns) * 4398) >> 32; | |
244 | rate = tp->curr_total / (misecs ? misecs : 1); | |
3131977d | 245 | throughput_string(&tp->display, tp->curr_total, rate); |
53ed7b5a | 246 | } |
42e18fbf | 247 | progress_update = 1; |
fbd09439 MM |
248 | buf = xstrfmt(", %s.\n", msg); |
249 | display(progress, progress->last_value, buf); | |
250 | free(buf); | |
42e18fbf | 251 | } |
96a02f8f | 252 | clear_progress_signal(); |
3131977d JK |
253 | if (progress->throughput) |
254 | strbuf_release(&progress->throughput->display); | |
cf84d51c | 255 | free(progress->throughput); |
dc6a0757 | 256 | free(progress); |
96a02f8f | 257 | } |