Nicolas Pitre | 74b6792 | 2007-10-30 15:41:13 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Simple text-based progress display module for GIT |
| 3 | * |
Nicolas Pitre | 03aa8ff | 2009-09-14 02:41:16 -0400 | [diff] [blame] | 4 | * Copyright (c) 2007 by Nicolas Pitre <nico@fluxnic.net> |
Nicolas Pitre | 74b6792 | 2007-10-30 15:41:13 -0400 | [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 | |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 11 | #include "git-compat-util.h" |
Nguyễn Thái Ngọc Duy | 754dbc4 | 2014-02-21 19:50:18 +0700 | [diff] [blame] | 12 | #include "gettext.h" |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 13 | #include "progress.h" |
Antoine Pelisse | 079b546 | 2013-04-10 21:03:23 +0200 | [diff] [blame] | 14 | #include "strbuf.h" |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 15 | #include "trace.h" |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 16 | |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 17 | #define TP_IDX_MAX 8 |
| 18 | |
| 19 | struct throughput { |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 20 | off_t curr_total; |
Nicolas Pitre | 218558a | 2007-11-04 22:15:41 -0500 | [diff] [blame] | 21 | off_t prev_total; |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 22 | uint64_t prev_ns; |
Nicolas Pitre | 218558a | 2007-11-04 22:15:41 -0500 | [diff] [blame] | 23 | unsigned int avg_bytes; |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 24 | unsigned int avg_misecs; |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 25 | unsigned int last_bytes[TP_IDX_MAX]; |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 26 | unsigned int last_misecs[TP_IDX_MAX]; |
| 27 | unsigned int idx; |
Jeff King | 3131977 | 2015-09-24 17:05:57 -0400 | [diff] [blame] | 28 | struct strbuf display; |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 29 | }; |
| 30 | |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 31 | struct progress { |
| 32 | const char *title; |
| 33 | int last_value; |
| 34 | unsigned total; |
| 35 | unsigned last_percent; |
| 36 | unsigned delay; |
| 37 | unsigned delayed_percent_treshold; |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 38 | struct throughput *throughput; |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 39 | }; |
| 40 | |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 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 | |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 53 | progress_update = 0; |
| 54 | |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 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 | |
Luke Mewburn | 85cb890 | 2015-04-13 23:30:51 +1000 | [diff] [blame] | 75 | static int is_foreground_fd(int fd) |
| 76 | { |
Jeff King | a4fb76c | 2015-05-19 01:24:57 -0400 | [diff] [blame] | 77 | int tpgrp = tcgetpgrp(fd); |
| 78 | return tpgrp < 0 || tpgrp == getpgid(0); |
Luke Mewburn | 85cb890 | 2015-04-13 23:30:51 +1000 | [diff] [blame] | 79 | } |
| 80 | |
Nicolas Pitre | a984a06 | 2007-11-08 15:45:41 -0500 | [diff] [blame] | 81 | static int display(struct progress *progress, unsigned n, const char *done) |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 82 | { |
Nicolas Pitre | a984a06 | 2007-11-08 15:45:41 -0500 | [diff] [blame] | 83 | const char *eol, *tp; |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 84 | |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 85 | if (progress->delay) { |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 86 | if (!progress_update || --progress->delay) |
| 87 | return 0; |
| 88 | if (progress->total) { |
| 89 | unsigned percent = n * 100 / progress->total; |
| 90 | if (percent > progress->delayed_percent_treshold) { |
| 91 | /* inhibit this progress report entirely */ |
| 92 | clear_progress_signal(); |
| 93 | progress->delay = -1; |
| 94 | progress->total = 0; |
| 95 | return 0; |
| 96 | } |
| 97 | } |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 98 | } |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 99 | |
| 100 | progress->last_value = n; |
Jeff King | 3131977 | 2015-09-24 17:05:57 -0400 | [diff] [blame] | 101 | tp = (progress->throughput) ? progress->throughput->display.buf : ""; |
Nicolas Pitre | a984a06 | 2007-11-08 15:45:41 -0500 | [diff] [blame] | 102 | eol = done ? done : " \r"; |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 103 | if (progress->total) { |
| 104 | unsigned percent = n * 100 / progress->total; |
| 105 | if (percent != progress->last_percent || progress_update) { |
| 106 | progress->last_percent = percent; |
Luke Mewburn | 85cb890 | 2015-04-13 23:30:51 +1000 | [diff] [blame] | 107 | if (is_foreground_fd(fileno(stderr)) || done) { |
| 108 | fprintf(stderr, "%s: %3u%% (%u/%u)%s%s", |
| 109 | progress->title, percent, n, |
| 110 | progress->total, tp, eol); |
| 111 | fflush(stderr); |
| 112 | } |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 113 | progress_update = 0; |
| 114 | return 1; |
| 115 | } |
| 116 | } else if (progress_update) { |
Luke Mewburn | 85cb890 | 2015-04-13 23:30:51 +1000 | [diff] [blame] | 117 | if (is_foreground_fd(fileno(stderr)) || done) { |
| 118 | fprintf(stderr, "%s: %u%s%s", |
| 119 | progress->title, n, tp, eol); |
| 120 | fflush(stderr); |
| 121 | } |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 122 | progress_update = 0; |
| 123 | return 1; |
| 124 | } |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 125 | |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 126 | return 0; |
| 127 | } |
| 128 | |
Antoine Pelisse | 079b546 | 2013-04-10 21:03:23 +0200 | [diff] [blame] | 129 | static void throughput_string(struct strbuf *buf, off_t total, |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 130 | unsigned int rate) |
| 131 | { |
Jeff King | 3131977 | 2015-09-24 17:05:57 -0400 | [diff] [blame] | 132 | strbuf_reset(buf); |
Antoine Pelisse | 079b546 | 2013-04-10 21:03:23 +0200 | [diff] [blame] | 133 | strbuf_addstr(buf, ", "); |
| 134 | strbuf_humanise_bytes(buf, total); |
| 135 | strbuf_addstr(buf, " | "); |
| 136 | strbuf_humanise_bytes(buf, rate * 1024); |
| 137 | strbuf_addstr(buf, "/s"); |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 138 | } |
| 139 | |
Nicolas Pitre | 218558a | 2007-11-04 22:15:41 -0500 | [diff] [blame] | 140 | void display_throughput(struct progress *progress, off_t total) |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 141 | { |
| 142 | struct throughput *tp; |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 143 | uint64_t now_ns; |
| 144 | unsigned int misecs, count, rate; |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 145 | |
| 146 | if (!progress) |
| 147 | return; |
| 148 | tp = progress->throughput; |
| 149 | |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 150 | now_ns = getnanotime(); |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 151 | |
| 152 | if (!tp) { |
| 153 | progress->throughput = tp = calloc(1, sizeof(*tp)); |
Nicolas Pitre | 218558a | 2007-11-04 22:15:41 -0500 | [diff] [blame] | 154 | if (tp) { |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 155 | tp->prev_total = tp->curr_total = total; |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 156 | tp->prev_ns = now_ns; |
Jeff King | 3131977 | 2015-09-24 17:05:57 -0400 | [diff] [blame] | 157 | strbuf_init(&tp->display, 0); |
Nicolas Pitre | 218558a | 2007-11-04 22:15:41 -0500 | [diff] [blame] | 158 | } |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 159 | return; |
| 160 | } |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 161 | tp->curr_total = total; |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 162 | |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 163 | /* only update throughput every 0.5 s */ |
| 164 | if (now_ns - tp->prev_ns <= 500000000) |
| 165 | return; |
| 166 | |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 167 | /* |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 168 | * We have x = bytes and y = nanosecs. We want z = KiB/s: |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 169 | * |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 170 | * z = (x / 1024) / (y / 1000000000) |
| 171 | * z = x / y * 1000000000 / 1024 |
| 172 | * z = x / (y * 1024 / 1000000000) |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 173 | * z = x / y' |
| 174 | * |
| 175 | * To simplify things we'll keep track of misecs, or 1024th of a sec |
| 176 | * obtained with: |
| 177 | * |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 178 | * y' = y * 1024 / 1000000000 |
| 179 | * y' = y * (2^10 / 2^42) * (2^42 / 1000000000) |
| 180 | * y' = y / 2^32 * 4398 |
| 181 | * y' = (y * 4398) >> 32 |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 182 | */ |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 183 | misecs = ((now_ns - tp->prev_ns) * 4398) >> 32; |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 184 | |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 185 | count = total - tp->prev_total; |
| 186 | tp->prev_total = total; |
| 187 | tp->prev_ns = now_ns; |
| 188 | tp->avg_bytes += count; |
| 189 | tp->avg_misecs += misecs; |
| 190 | rate = tp->avg_bytes / tp->avg_misecs; |
| 191 | tp->avg_bytes -= tp->last_bytes[tp->idx]; |
| 192 | tp->avg_misecs -= tp->last_misecs[tp->idx]; |
| 193 | tp->last_bytes[tp->idx] = count; |
| 194 | tp->last_misecs[tp->idx] = misecs; |
| 195 | tp->idx = (tp->idx + 1) % TP_IDX_MAX; |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 196 | |
Jeff King | 3131977 | 2015-09-24 17:05:57 -0400 | [diff] [blame] | 197 | throughput_string(&tp->display, total, rate); |
Karsten Blees | 83d26fa | 2014-07-12 02:08:11 +0200 | [diff] [blame] | 198 | if (progress->last_value != -1 && progress_update) |
| 199 | display(progress, progress->last_value, NULL); |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 200 | } |
| 201 | |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 202 | int display_progress(struct progress *progress, unsigned n) |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 203 | { |
Nicolas Pitre | a984a06 | 2007-11-08 15:45:41 -0500 | [diff] [blame] | 204 | return progress ? display(progress, n, NULL) : 0; |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 205 | } |
| 206 | |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 207 | struct progress *start_progress_delay(const char *title, unsigned total, |
| 208 | unsigned percent_treshold, unsigned delay) |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 209 | { |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 210 | struct progress *progress = malloc(sizeof(*progress)); |
| 211 | if (!progress) { |
| 212 | /* unlikely, but here's a good fallback */ |
| 213 | fprintf(stderr, "%s...\n", title); |
Johannes Sixt | 137a0d0 | 2007-11-19 20:48:58 +0100 | [diff] [blame] | 214 | fflush(stderr); |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 215 | return NULL; |
| 216 | } |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 217 | progress->title = title; |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 218 | progress->total = total; |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 219 | progress->last_value = -1; |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 220 | progress->last_percent = -1; |
| 221 | progress->delayed_percent_treshold = percent_treshold; |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 222 | progress->delay = delay; |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 223 | progress->throughput = NULL; |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 224 | set_progress_signal(); |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 225 | return progress; |
Nicolas Pitre | 180a9f2 | 2007-04-20 15:05:27 -0400 | [diff] [blame] | 226 | } |
| 227 | |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 228 | struct progress *start_progress(const char *title, unsigned total) |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 229 | { |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 230 | return start_progress_delay(title, total, 0, 0); |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 231 | } |
| 232 | |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 233 | void stop_progress(struct progress **p_progress) |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 234 | { |
Nguyễn Thái Ngọc Duy | 754dbc4 | 2014-02-21 19:50:18 +0700 | [diff] [blame] | 235 | stop_progress_msg(p_progress, _("done")); |
Nicolas Pitre | a984a06 | 2007-11-08 15:45:41 -0500 | [diff] [blame] | 236 | } |
| 237 | |
| 238 | void stop_progress_msg(struct progress **p_progress, const char *msg) |
| 239 | { |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 240 | struct progress *progress = *p_progress; |
| 241 | if (!progress) |
| 242 | return; |
| 243 | *p_progress = NULL; |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 244 | if (progress->last_value != -1) { |
| 245 | /* Force the last update */ |
Boyd Lynn Gerber | d4c4444 | 2008-06-08 09:26:15 -0600 | [diff] [blame] | 246 | char buf[128], *bufp; |
| 247 | size_t len = strlen(msg) + 5; |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 248 | struct throughput *tp = progress->throughput; |
Boyd Lynn Gerber | d4c4444 | 2008-06-08 09:26:15 -0600 | [diff] [blame] | 249 | |
Jeff King | 3733e69 | 2016-02-22 17:44:28 -0500 | [diff] [blame] | 250 | bufp = (len < sizeof(buf)) ? buf : xmallocz(len); |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 251 | if (tp) { |
| 252 | unsigned int rate = !tp->avg_misecs ? 0 : |
| 253 | tp->avg_bytes / tp->avg_misecs; |
Jeff King | 3131977 | 2015-09-24 17:05:57 -0400 | [diff] [blame] | 254 | throughput_string(&tp->display, tp->curr_total, rate); |
Nicolas Pitre | 53ed7b5 | 2007-11-06 16:30:28 -0500 | [diff] [blame] | 255 | } |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 256 | progress_update = 1; |
Jeff King | f5691aa | 2015-09-24 17:06:46 -0400 | [diff] [blame] | 257 | xsnprintf(bufp, len + 1, ", %s.\n", msg); |
Boyd Lynn Gerber | d4c4444 | 2008-06-08 09:26:15 -0600 | [diff] [blame] | 258 | display(progress, progress->last_value, bufp); |
| 259 | if (buf != bufp) |
| 260 | free(bufp); |
Nicolas Pitre | 42e18fb | 2007-10-16 21:55:45 -0400 | [diff] [blame] | 261 | } |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 262 | clear_progress_signal(); |
Jeff King | 3131977 | 2015-09-24 17:05:57 -0400 | [diff] [blame] | 263 | if (progress->throughput) |
| 264 | strbuf_release(&progress->throughput->display); |
Nicolas Pitre | cf84d51 | 2007-10-30 14:57:34 -0400 | [diff] [blame] | 265 | free(progress->throughput); |
Nicolas Pitre | dc6a075 | 2007-10-30 14:57:32 -0400 | [diff] [blame] | 266 | free(progress); |
Nicolas Pitre | 96a02f8 | 2007-04-18 14:27:45 -0400 | [diff] [blame] | 267 | } |