Merge branch 'jk/more-push-completion'
[git] / 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 #include "git-compat-util.h"
12 #include "gettext.h"
13 #include "progress.h"
14 #include "strbuf.h"
15 #include "trace.h"
16
17 #define TP_IDX_MAX      8
18
19 struct throughput {
20         off_t curr_total;
21         off_t prev_total;
22         uint64_t prev_ns;
23         unsigned int avg_bytes;
24         unsigned int avg_misecs;
25         unsigned int last_bytes[TP_IDX_MAX];
26         unsigned int last_misecs[TP_IDX_MAX];
27         unsigned int idx;
28         char display[32];
29 };
30
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;
38         struct throughput *throughput;
39 };
40
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
53         progress_update = 0;
54
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
75 static int display(struct progress *progress, unsigned n, const char *done)
76 {
77         const char *eol, *tp;
78
79         if (progress->delay) {
80                 if (!progress_update || --progress->delay)
81                         return 0;
82                 if (progress->total) {
83                         unsigned percent = n * 100 / progress->total;
84                         if (percent > progress->delayed_percent_treshold) {
85                                 /* inhibit this progress report entirely */
86                                 clear_progress_signal();
87                                 progress->delay = -1;
88                                 progress->total = 0;
89                                 return 0;
90                         }
91                 }
92         }
93
94         progress->last_value = n;
95         tp = (progress->throughput) ? progress->throughput->display : "";
96         eol = done ? done : "   \r";
97         if (progress->total) {
98                 unsigned percent = n * 100 / progress->total;
99                 if (percent != progress->last_percent || progress_update) {
100                         progress->last_percent = percent;
101                         fprintf(stderr, "%s: %3u%% (%u/%u)%s%s",
102                                 progress->title, percent, n,
103                                 progress->total, tp, eol);
104                         fflush(stderr);
105                         progress_update = 0;
106                         return 1;
107                 }
108         } else if (progress_update) {
109                 fprintf(stderr, "%s: %u%s%s", progress->title, n, tp, eol);
110                 fflush(stderr);
111                 progress_update = 0;
112                 return 1;
113         }
114
115         return 0;
116 }
117
118 static void throughput_string(struct strbuf *buf, off_t total,
119                               unsigned int rate)
120 {
121         strbuf_addstr(buf, ", ");
122         strbuf_humanise_bytes(buf, total);
123         strbuf_addstr(buf, " | ");
124         strbuf_humanise_bytes(buf, rate * 1024);
125         strbuf_addstr(buf, "/s");
126 }
127
128 void display_throughput(struct progress *progress, off_t total)
129 {
130         struct throughput *tp;
131         uint64_t now_ns;
132         unsigned int misecs, count, rate;
133         struct strbuf buf = STRBUF_INIT;
134
135         if (!progress)
136                 return;
137         tp = progress->throughput;
138
139         now_ns = getnanotime();
140
141         if (!tp) {
142                 progress->throughput = tp = calloc(1, sizeof(*tp));
143                 if (tp) {
144                         tp->prev_total = tp->curr_total = total;
145                         tp->prev_ns = now_ns;
146                 }
147                 return;
148         }
149         tp->curr_total = total;
150
151         /* only update throughput every 0.5 s */
152         if (now_ns - tp->prev_ns <= 500000000)
153                 return;
154
155         /*
156          * We have x = bytes and y = nanosecs.  We want z = KiB/s:
157          *
158          *      z = (x / 1024) / (y / 1000000000)
159          *      z = x / y * 1000000000 / 1024
160          *      z = x / (y * 1024 / 1000000000)
161          *      z = x / y'
162          *
163          * To simplify things we'll keep track of misecs, or 1024th of a sec
164          * obtained with:
165          *
166          *      y' = y * 1024 / 1000000000
167          *      y' = y * (2^10 / 2^42) * (2^42 / 1000000000)
168          *      y' = y / 2^32 * 4398
169          *      y' = (y * 4398) >> 32
170          */
171         misecs = ((now_ns - tp->prev_ns) * 4398) >> 32;
172
173         count = total - tp->prev_total;
174         tp->prev_total = total;
175         tp->prev_ns = now_ns;
176         tp->avg_bytes += count;
177         tp->avg_misecs += misecs;
178         rate = tp->avg_bytes / tp->avg_misecs;
179         tp->avg_bytes -= tp->last_bytes[tp->idx];
180         tp->avg_misecs -= tp->last_misecs[tp->idx];
181         tp->last_bytes[tp->idx] = count;
182         tp->last_misecs[tp->idx] = misecs;
183         tp->idx = (tp->idx + 1) % TP_IDX_MAX;
184
185         throughput_string(&buf, total, rate);
186         strncpy(tp->display, buf.buf, sizeof(tp->display));
187         strbuf_release(&buf);
188         if (progress->last_value != -1 && progress_update)
189                 display(progress, progress->last_value, NULL);
190 }
191
192 int display_progress(struct progress *progress, unsigned n)
193 {
194         return progress ? display(progress, n, NULL) : 0;
195 }
196
197 struct progress *start_progress_delay(const char *title, unsigned total,
198                                        unsigned percent_treshold, unsigned delay)
199 {
200         struct progress *progress = malloc(sizeof(*progress));
201         if (!progress) {
202                 /* unlikely, but here's a good fallback */
203                 fprintf(stderr, "%s...\n", title);
204                 fflush(stderr);
205                 return NULL;
206         }
207         progress->title = title;
208         progress->total = total;
209         progress->last_value = -1;
210         progress->last_percent = -1;
211         progress->delayed_percent_treshold = percent_treshold;
212         progress->delay = delay;
213         progress->throughput = NULL;
214         set_progress_signal();
215         return progress;
216 }
217
218 struct progress *start_progress(const char *title, unsigned total)
219 {
220         return start_progress_delay(title, total, 0, 0);
221 }
222
223 void stop_progress(struct progress **p_progress)
224 {
225         stop_progress_msg(p_progress, _("done"));
226 }
227
228 void stop_progress_msg(struct progress **p_progress, const char *msg)
229 {
230         struct progress *progress = *p_progress;
231         if (!progress)
232                 return;
233         *p_progress = NULL;
234         if (progress->last_value != -1) {
235                 /* Force the last update */
236                 char buf[128], *bufp;
237                 size_t len = strlen(msg) + 5;
238                 struct throughput *tp = progress->throughput;
239
240                 bufp = (len < sizeof(buf)) ? buf : xmalloc(len + 1);
241                 if (tp) {
242                         struct strbuf strbuf = STRBUF_INIT;
243                         unsigned int rate = !tp->avg_misecs ? 0 :
244                                         tp->avg_bytes / tp->avg_misecs;
245                         throughput_string(&strbuf, tp->curr_total, rate);
246                         strncpy(tp->display, strbuf.buf, sizeof(tp->display));
247                         strbuf_release(&strbuf);
248                 }
249                 progress_update = 1;
250                 sprintf(bufp, ", %s.\n", msg);
251                 display(progress, progress->last_value, bufp);
252                 if (buf != bufp)
253                         free(bufp);
254         }
255         clear_progress_signal();
256         free(progress->throughput);
257         free(progress);
258 }