Revert "compat: add strtok_r()"
[git/mingw.git] / progress.c
blob3971f49f4ddaa774806bd1717379a1edd22ba17c
1 /*
2 * Simple text-based progress display module for GIT
4 * Copyright (c) 2007 by Nicolas Pitre <nico@fluxnic.net>
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 */
11 #include "git-compat-util.h"
12 #include "progress.h"
14 #define TP_IDX_MAX 8
16 struct throughput {
17 off_t curr_total;
18 off_t prev_total;
19 struct timeval prev_tv;
20 unsigned int avg_bytes;
21 unsigned int avg_misecs;
22 unsigned int last_bytes[TP_IDX_MAX];
23 unsigned int last_misecs[TP_IDX_MAX];
24 unsigned int idx;
25 char display[32];
28 struct progress {
29 const char *title;
30 int last_value;
31 unsigned total;
32 unsigned last_percent;
33 unsigned delay;
34 unsigned delayed_percent_treshold;
35 struct throughput *throughput;
38 static volatile sig_atomic_t progress_update;
40 static void progress_interval(int signum)
42 progress_update = 1;
45 static void set_progress_signal(void)
47 struct sigaction sa;
48 struct itimerval v;
50 progress_update = 0;
52 memset(&sa, 0, sizeof(sa));
53 sa.sa_handler = progress_interval;
54 sigemptyset(&sa.sa_mask);
55 sa.sa_flags = SA_RESTART;
56 sigaction(SIGALRM, &sa, NULL);
58 v.it_interval.tv_sec = 1;
59 v.it_interval.tv_usec = 0;
60 v.it_value = v.it_interval;
61 setitimer(ITIMER_REAL, &v, NULL);
64 static void clear_progress_signal(void)
66 struct itimerval v = {{0,},};
67 setitimer(ITIMER_REAL, &v, NULL);
68 signal(SIGALRM, SIG_IGN);
69 progress_update = 0;
72 static int display(struct progress *progress, unsigned n, const char *done)
74 const char *eol, *tp;
76 if (progress->delay) {
77 if (!progress_update || --progress->delay)
78 return 0;
79 if (progress->total) {
80 unsigned percent = n * 100 / progress->total;
81 if (percent > progress->delayed_percent_treshold) {
82 /* inhibit this progress report entirely */
83 clear_progress_signal();
84 progress->delay = -1;
85 progress->total = 0;
86 return 0;
91 progress->last_value = n;
92 tp = (progress->throughput) ? progress->throughput->display : "";
93 eol = done ? done : " \r";
94 if (progress->total) {
95 unsigned percent = n * 100 / progress->total;
96 if (percent != progress->last_percent || progress_update) {
97 progress->last_percent = percent;
98 fprintf(stderr, "%s: %3u%% (%u/%u)%s%s",
99 progress->title, percent, n,
100 progress->total, tp, eol);
101 fflush(stderr);
102 progress_update = 0;
103 return 1;
105 } else if (progress_update) {
106 fprintf(stderr, "%s: %u%s%s", progress->title, n, tp, eol);
107 fflush(stderr);
108 progress_update = 0;
109 return 1;
112 return 0;
115 static void throughput_string(struct throughput *tp, off_t total,
116 unsigned int rate)
118 int l = sizeof(tp->display);
119 if (total > 1 << 30) {
120 l -= snprintf(tp->display, l, ", %u.%2.2u GiB",
121 (int)(total >> 30),
122 (int)(total & ((1 << 30) - 1)) / 10737419);
123 } else if (total > 1 << 20) {
124 int x = total + 5243; /* for rounding */
125 l -= snprintf(tp->display, l, ", %u.%2.2u MiB",
126 x >> 20, ((x & ((1 << 20) - 1)) * 100) >> 20);
127 } else if (total > 1 << 10) {
128 int x = total + 5; /* for rounding */
129 l -= snprintf(tp->display, l, ", %u.%2.2u KiB",
130 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
131 } else {
132 l -= snprintf(tp->display, l, ", %u bytes", (int)total);
135 if (rate > 1 << 10) {
136 int x = rate + 5; /* for rounding */
137 snprintf(tp->display + sizeof(tp->display) - l, l,
138 " | %u.%2.2u MiB/s",
139 x >> 10, ((x & ((1 << 10) - 1)) * 100) >> 10);
140 } else if (rate)
141 snprintf(tp->display + sizeof(tp->display) - l, l,
142 " | %u KiB/s", rate);
145 void display_throughput(struct progress *progress, off_t total)
147 struct throughput *tp;
148 struct timeval tv;
149 unsigned int misecs;
151 if (!progress)
152 return;
153 tp = progress->throughput;
155 gettimeofday(&tv, NULL);
157 if (!tp) {
158 progress->throughput = tp = calloc(1, sizeof(*tp));
159 if (tp) {
160 tp->prev_total = tp->curr_total = total;
161 tp->prev_tv = tv;
163 return;
165 tp->curr_total = total;
168 * We have x = bytes and y = microsecs. We want z = KiB/s:
170 * z = (x / 1024) / (y / 1000000)
171 * z = x / y * 1000000 / 1024
172 * z = x / (y * 1024 / 1000000)
173 * z = x / y'
175 * To simplify things we'll keep track of misecs, or 1024th of a sec
176 * obtained with:
178 * y' = y * 1024 / 1000000
179 * y' = y / (1000000 / 1024)
180 * y' = y / 977
182 misecs = (tv.tv_sec - tp->prev_tv.tv_sec) * 1024;
183 misecs += (int)(tv.tv_usec - tp->prev_tv.tv_usec) / 977;
185 if (misecs > 512) {
186 unsigned int count, rate;
188 count = total - tp->prev_total;
189 tp->prev_total = total;
190 tp->prev_tv = tv;
191 tp->avg_bytes += count;
192 tp->avg_misecs += misecs;
193 rate = tp->avg_bytes / tp->avg_misecs;
194 tp->avg_bytes -= tp->last_bytes[tp->idx];
195 tp->avg_misecs -= tp->last_misecs[tp->idx];
196 tp->last_bytes[tp->idx] = count;
197 tp->last_misecs[tp->idx] = misecs;
198 tp->idx = (tp->idx + 1) % TP_IDX_MAX;
200 throughput_string(tp, total, rate);
201 if (progress->last_value != -1 && progress_update)
202 display(progress, progress->last_value, NULL);
206 int display_progress(struct progress *progress, unsigned n)
208 return progress ? display(progress, n, NULL) : 0;
211 struct progress *start_progress_delay(const char *title, unsigned total,
212 unsigned percent_treshold, unsigned delay)
214 struct progress *progress = malloc(sizeof(*progress));
215 if (!progress) {
216 /* unlikely, but here's a good fallback */
217 fprintf(stderr, "%s...\n", title);
218 fflush(stderr);
219 return NULL;
221 progress->title = title;
222 progress->total = total;
223 progress->last_value = -1;
224 progress->last_percent = -1;
225 progress->delayed_percent_treshold = percent_treshold;
226 progress->delay = delay;
227 progress->throughput = NULL;
228 set_progress_signal();
229 return progress;
232 struct progress *start_progress(const char *title, unsigned total)
234 return start_progress_delay(title, total, 0, 0);
237 void stop_progress(struct progress **p_progress)
239 stop_progress_msg(p_progress, "done");
242 void stop_progress_msg(struct progress **p_progress, const char *msg)
244 struct progress *progress = *p_progress;
245 if (!progress)
246 return;
247 *p_progress = NULL;
248 if (progress->last_value != -1) {
249 /* Force the last update */
250 char buf[128], *bufp;
251 size_t len = strlen(msg) + 5;
252 struct throughput *tp = progress->throughput;
254 bufp = (len < sizeof(buf)) ? buf : xmalloc(len + 1);
255 if (tp) {
256 unsigned int rate = !tp->avg_misecs ? 0 :
257 tp->avg_bytes / tp->avg_misecs;
258 throughput_string(tp, tp->curr_total, rate);
260 progress_update = 1;
261 sprintf(bufp, ", %s.\n", msg);
262 display(progress, progress->last_value, bufp);
263 if (buf != bufp)
264 free(bufp);
266 clear_progress_signal();
267 free(progress->throughput);
268 free(progress);