progress.c

   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 #define GIT_TEST_PROGRESS_ONLY
  12 #include "git-compat-util.h"
  13 #include "pager.h"
  14 #include "progress.h"
  15 #include "repository.h"
  16 #include "strbuf.h"
  17 #include "trace.h"
  18 #include "trace2.h"
  19 #include "utf8.h"
  20 #include "config.h"
  21
  22 #define TP_IDX_MAX      8
  23
  24 struct throughput {
  25         off_t curr_total;
  26         off_t prev_total;
  27         uint64_t prev_ns;
  28         unsigned int avg_bytes;
  29         unsigned int avg_misecs;
  30         unsigned int last_bytes[TP_IDX_MAX];
  31         unsigned int last_misecs[TP_IDX_MAX];
  32         unsigned int idx;
  33         struct strbuf display;
  34 };
  35
  36 struct progress {
  37         const char *title;
  38         uint64_t last_value;
  39         uint64_t total;
  40         unsigned last_percent;
  41         unsigned delay;
  42         unsigned sparse;
  43         struct throughput *throughput;
  44         uint64_t start_ns;
  45         struct strbuf counters_sb;
  46         int title_len;
  47         int split;
  48 };
  49
  50 static volatile sig_atomic_t progress_update;
  51
  52 /*
  53  * These are only intended for testing the progress output, i.e. exclusively
  54  * for 'test-tool progress'.
  55  */
  56 int progress_testing;
  57 uint64_t progress_test_ns = 0;
  58 void progress_test_force_update(void)
  59 {
  60         progress_update = 1;
  61 }
  62
  63
  64 static void progress_interval(int signum UNUSED)
  65 {
  66         progress_update = 1;
  67 }
  68
  69 static void set_progress_signal(void)
  70 {
  71         struct sigaction sa;
  72         struct itimerval v;
  73
  74         if (progress_testing)
  75                 return;
  76
  77         progress_update = 0;
  78
  79         memset(&sa, 0, sizeof(sa));
  80         sa.sa_handler = progress_interval;
  81         sigemptyset(&sa.sa_mask);
  82         sa.sa_flags = SA_RESTART;
  83         sigaction(SIGALRM, &sa, NULL);
  84
  85         v.it_interval.tv_sec = 1;
  86         v.it_interval.tv_usec = 0;
  87         v.it_value = v.it_interval;
  88         setitimer(ITIMER_REAL, &v, NULL);
  89 }
  90
  91 static void clear_progress_signal(void)
  92 {
  93         struct itimerval v = {{0,},};
  94
  95         if (progress_testing)
  96                 return;
  97
  98         setitimer(ITIMER_REAL, &v, NULL);
  99         signal(SIGALRM, SIG_IGN);
 100         progress_update = 0;
 101 }
 102
 103 static int is_foreground_fd(int fd)
 104 {
 105         int tpgrp = tcgetpgrp(fd);
 106         return tpgrp < 0 || tpgrp == getpgid(0);
 107 }
 108
 109 static void display(struct progress *progress, uint64_t n, const char *done)
 110 {
 111         const char *tp;
 112         struct strbuf *counters_sb = &progress->counters_sb;
 113         int show_update = 0;
 114         int last_count_len = counters_sb->len;
 115
 116         if (progress->delay && (!progress_update || --progress->delay))
 117                 return;
 118
 119         progress->last_value = n;
 120         tp = (progress->throughput) ? progress->throughput->display.buf : "";
 121         if (progress->total) {
 122                 unsigned percent = n * 100 / progress->total;
 123                 if (percent != progress->last_percent || progress_update) {
 124                         progress->last_percent = percent;
 125
 126                         strbuf_reset(counters_sb);
 127                         strbuf_addf(counters_sb,
 128                                     "%3u%% (%"PRIuMAX"/%"PRIuMAX")%s", percent,
 129                                     (uintmax_t)n, (uintmax_t)progress->total,
 130                                     tp);
 131                         show_update = 1;
 132                 }
 133         } else if (progress_update) {
 134                 strbuf_reset(counters_sb);
 135                 strbuf_addf(counters_sb, "%"PRIuMAX"%s", (uintmax_t)n, tp);
 136                 show_update = 1;
 137         }
 138
 139         if (show_update) {
 140                 if (is_foreground_fd(fileno(stderr)) || done) {
 141                         const char *eol = done ? done : "\r";
 142                         size_t clear_len = counters_sb->len < last_count_len ?
 143                                         last_count_len - counters_sb->len + 1 :
 144                                         0;
 145                         /* The "+ 2" accounts for the ": ". */
 146                         size_t progress_line_len = progress->title_len +
 147                                                 counters_sb->len + 2;
 148                         int cols = term_columns();
 149
 150                         if (progress->split) {
 151                                 fprintf(stderr, "  %s%*s", counters_sb->buf,
 152                                         (int) clear_len, eol);
 153                         } else if (!done && cols < progress_line_len) {
 154                                 clear_len = progress->title_len + 1 < cols ?
 155                                             cols - progress->title_len - 1 : 0;
 156                                 fprintf(stderr, "%s:%*s\n  %s%s",
 157                                         progress->title, (int) clear_len, "",
 158                                         counters_sb->buf, eol);
 159                                 progress->split = 1;
 160                         } else {
 161                                 fprintf(stderr, "%s: %s%*s", progress->title,
 162                                         counters_sb->buf, (int) clear_len, eol);
 163                         }
 164                         fflush(stderr);
 165                 }
 166                 progress_update = 0;
 167         }
 168 }
 169
 170 static void throughput_string(struct strbuf *buf, uint64_t total,
 171                               unsigned int rate)
 172 {
 173         strbuf_reset(buf);
 174         strbuf_addstr(buf, ", ");
 175         strbuf_humanise_bytes(buf, total);
 176         strbuf_addstr(buf, " | ");
 177         strbuf_humanise_rate(buf, rate * 1024);
 178 }
 179
 180 static uint64_t progress_getnanotime(struct progress *progress)
 181 {
 182         if (progress_testing)
 183                 return progress->start_ns + progress_test_ns;
 184         else
 185                 return getnanotime();
 186 }
 187
 188 void display_throughput(struct progress *progress, uint64_t total)
 189 {
 190         struct throughput *tp;
 191         uint64_t now_ns;
 192         unsigned int misecs, count, rate;
 193
 194         if (!progress)
 195                 return;
 196         tp = progress->throughput;
 197
 198         now_ns = progress_getnanotime(progress);
 199
 200         if (!tp) {
 201                 progress->throughput = CALLOC_ARRAY(tp, 1);
 202                 tp->prev_total = tp->curr_total = total;
 203                 tp->prev_ns = now_ns;
 204                 strbuf_init(&tp->display, 0);
 205                 return;
 206         }
 207         tp->curr_total = total;
 208
 209         /* only update throughput every 0.5 s */
 210         if (now_ns - tp->prev_ns <= 500000000)
 211                 return;
 212
 213         /*
 214          * We have x = bytes and y = nanosecs.  We want z = KiB/s:
 215          *
 216          *      z = (x / 1024) / (y / 1000000000)
 217          *      z = x / y * 1000000000 / 1024
 218          *      z = x / (y * 1024 / 1000000000)
 219          *      z = x / y'
 220          *
 221          * To simplify things we'll keep track of misecs, or 1024th of a sec
 222          * obtained with:
 223          *
 224          *      y' = y * 1024 / 1000000000
 225          *      y' = y * (2^10 / 2^42) * (2^42 / 1000000000)
 226          *      y' = y / 2^32 * 4398
 227          *      y' = (y * 4398) >> 32
 228          */
 229         misecs = ((now_ns - tp->prev_ns) * 4398) >> 32;
 230
 231         count = total - tp->prev_total;
 232         tp->prev_total = total;
 233         tp->prev_ns = now_ns;
 234         tp->avg_bytes += count;
 235         tp->avg_misecs += misecs;
 236         rate = tp->avg_bytes / tp->avg_misecs;
 237         tp->avg_bytes -= tp->last_bytes[tp->idx];
 238         tp->avg_misecs -= tp->last_misecs[tp->idx];
 239         tp->last_bytes[tp->idx] = count;
 240         tp->last_misecs[tp->idx] = misecs;
 241         tp->idx = (tp->idx + 1) % TP_IDX_MAX;
 242
 243         throughput_string(&tp->display, total, rate);
 244         if (progress->last_value != -1 && progress_update)
 245                 display(progress, progress->last_value, NULL);
 246 }
 247
 248 void display_progress(struct progress *progress, uint64_t n)
 249 {
 250         if (progress)
 251                 display(progress, n, NULL);
 252 }
 253
 254 static struct progress *start_progress_delay(const char *title, uint64_t total,
 255                                              unsigned delay, unsigned sparse)
 256 {
 257         struct progress *progress = xmalloc(sizeof(*progress));
 258         progress->title = title;
 259         progress->total = total;
 260         progress->last_value = -1;
 261         progress->last_percent = -1;
 262         progress->delay = delay;
 263         progress->sparse = sparse;
 264         progress->throughput = NULL;
 265         progress->start_ns = getnanotime();
 266         strbuf_init(&progress->counters_sb, 0);
 267         progress->title_len = utf8_strwidth(title);
 268         progress->split = 0;
 269         set_progress_signal();
 270         trace2_region_enter("progress", title, the_repository);
 271         return progress;
 272 }
 273
 274 static int get_default_delay(void)
 275 {
 276         static int delay_in_secs = -1;
 277
 278         if (delay_in_secs < 0)
 279                 delay_in_secs = git_env_ulong("GIT_PROGRESS_DELAY", 2);
 280
 281         return delay_in_secs;
 282 }
 283
 284 struct progress *start_delayed_progress(const char *title, uint64_t total)
 285 {
 286         return start_progress_delay(title, total, get_default_delay(), 0);
 287 }
 288
 289 struct progress *start_progress(const char *title, uint64_t total)
 290 {
 291         return start_progress_delay(title, total, 0, 0);
 292 }
 293
 294 /*
 295  * Here "sparse" means that the caller might use some sampling criteria to
 296  * decide when to call display_progress() rather than calling it for every
 297  * integer value in[0 .. total).  In particular, the caller might not call
 298  * display_progress() for the last value in the range.
 299  *
 300  * When "sparse" is set, stop_progress() will automatically force the done
 301  * message to show 100%.
 302  */
 303 struct progress *start_sparse_progress(const char *title, uint64_t total)
 304 {
 305         return start_progress_delay(title, total, 0, 1);
 306 }
 307
 308 struct progress *start_delayed_sparse_progress(const char *title,
 309                                                uint64_t total)
 310 {
 311         return start_progress_delay(title, total, get_default_delay(), 1);
 312 }
 313
 314 static void finish_if_sparse(struct progress *progress)
 315 {
 316         if (progress->sparse &&
 317             progress->last_value != progress->total)
 318                 display_progress(progress, progress->total);
 319 }
 320
 321 static void force_last_update(struct progress *progress, const char *msg)
 322 {
 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
 339 static void log_trace2(struct progress *progress)
 340 {
 341         trace2_data_intmax("progress", the_repository, "total_objects",
 342                            progress->total);
 343
 344         if (progress->throughput)
 345                 trace2_data_intmax("progress", the_repository, "total_bytes",
 346                                    progress->throughput->curr_total);
 347
 348         trace2_region_leave("progress", progress->title, the_repository);
 349 }
 350
 351 void stop_progress_msg(struct progress **p_progress, const char *msg)
 352 {
 353         struct progress *progress;
 354
 355         if (!p_progress)
 356                 BUG("don't provide NULL to stop_progress_msg");
 357
 358         progress = *p_progress;
 359         if (!progress)
 360                 return;
 361         *p_progress = NULL;
 362
 363         finish_if_sparse(progress);
 364         if (progress->last_value != -1)
 365                 force_last_update(progress, msg);
 366         log_trace2(progress);
 367
 368         clear_progress_signal();
 369         strbuf_release(&progress->counters_sb);
 370         if (progress->throughput)
 371                 strbuf_release(&progress->throughput->display);
 372         free(progress->throughput);
 373         free(progress);
 374 }