2 * Simple text-based progress display module for GIT
4 * Copyright (c) 2007 by Nicolas Pitre <nico@cam.org>
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.
11 #include "git-compat-util.h"
17 struct timeval prev_tv
;
19 unsigned long avg_bytes
;
20 unsigned long last_bytes
[TP_IDX_MAX
];
21 unsigned int avg_misecs
;
22 unsigned int last_misecs
[TP_IDX_MAX
];
31 unsigned last_percent
;
33 unsigned delayed_percent_treshold
;
34 struct throughput
*throughput
;
37 static volatile sig_atomic_t progress_update
;
39 static void progress_interval(int signum
)
44 static void set_progress_signal(void)
51 memset(&sa
, 0, sizeof(sa
));
52 sa
.sa_handler
= progress_interval
;
53 sigemptyset(&sa
.sa_mask
);
54 sa
.sa_flags
= SA_RESTART
;
55 sigaction(SIGALRM
, &sa
, NULL
);
57 v
.it_interval
.tv_sec
= 1;
58 v
.it_interval
.tv_usec
= 0;
59 v
.it_value
= v
.it_interval
;
60 setitimer(ITIMER_REAL
, &v
, NULL
);
63 static void clear_progress_signal(void)
65 struct itimerval v
= {{0,},};
66 setitimer(ITIMER_REAL
, &v
, NULL
);
67 signal(SIGALRM
, SIG_IGN
);
71 static int display(struct progress
*progress
, unsigned n
, int done
)
75 if (progress
->delay
) {
76 if (!progress_update
|| --progress
->delay
)
78 if (progress
->total
) {
79 unsigned percent
= n
* 100 / progress
->total
;
80 if (percent
> progress
->delayed_percent_treshold
) {
81 /* inhibit this progress report entirely */
82 clear_progress_signal();
90 progress
->last_value
= n
;
91 tp
= (progress
->throughput
) ? progress
->throughput
->display
: "";
92 eol
= done
? ", done. \n" : " \r";
93 if (progress
->total
) {
94 unsigned percent
= n
* 100 / progress
->total
;
95 if (percent
!= progress
->last_percent
|| progress_update
) {
96 progress
->last_percent
= percent
;
97 fprintf(stderr
, "%s: %3u%% (%u/%u)%s%s",
98 progress
->title
, percent
, n
,
99 progress
->total
, tp
, eol
);
103 } else if (progress_update
) {
104 fprintf(stderr
, "%s: %u%s%s", progress
->title
, n
, tp
, eol
);
112 void display_throughput(struct progress
*progress
, unsigned long n
)
114 struct throughput
*tp
;
120 tp
= progress
->throughput
;
122 gettimeofday(&tv
, NULL
);
125 progress
->throughput
= tp
= calloc(1, sizeof(*tp
));
134 * We have x = bytes and y = microsecs. We want z = KiB/s:
136 * z = (x / 1024) / (y / 1000000)
137 * z = x / y * 1000000 / 1024
138 * z = x / (y * 1024 / 1000000)
141 * To simplify things we'll keep track of misecs, or 1024th of a sec
144 * y' = y * 1024 / 1000000
145 * y' = y / (1000000 / 1024)
148 misecs
= (tv
.tv_sec
- tp
->prev_tv
.tv_sec
) * 1024;
149 misecs
+= (int)(tv
.tv_usec
- tp
->prev_tv
.tv_usec
) / 977;
153 tp
->avg_bytes
+= tp
->count
;
154 tp
->avg_misecs
+= misecs
;
155 snprintf(tp
->display
, sizeof(tp
->display
),
156 ", %lu KiB/s", tp
->avg_bytes
/ tp
->avg_misecs
);
157 tp
->avg_bytes
-= tp
->last_bytes
[tp
->idx
];
158 tp
->avg_misecs
-= tp
->last_misecs
[tp
->idx
];
159 tp
->last_bytes
[tp
->idx
] = tp
->count
;
160 tp
->last_misecs
[tp
->idx
] = misecs
;
161 tp
->idx
= (tp
->idx
+ 1) % TP_IDX_MAX
;
166 int display_progress(struct progress
*progress
, unsigned n
)
168 return progress
? display(progress
, n
, 0) : 0;
171 struct progress
*start_progress_delay(const char *title
, unsigned total
,
172 unsigned percent_treshold
, unsigned delay
)
174 struct progress
*progress
= malloc(sizeof(*progress
));
176 /* unlikely, but here's a good fallback */
177 fprintf(stderr
, "%s...\n", title
);
180 progress
->title
= title
;
181 progress
->total
= total
;
182 progress
->last_value
= -1;
183 progress
->last_percent
= -1;
184 progress
->delayed_percent_treshold
= percent_treshold
;
185 progress
->delay
= delay
;
186 progress
->throughput
= NULL
;
187 set_progress_signal();
191 struct progress
*start_progress(const char *title
, unsigned total
)
193 return start_progress_delay(title
, total
, 0, 0);
196 void stop_progress(struct progress
**p_progress
)
198 struct progress
*progress
= *p_progress
;
202 if (progress
->last_value
!= -1) {
203 /* Force the last update */
205 display(progress
, progress
->last_value
, 1);
207 clear_progress_signal();
208 free(progress
->throughput
);