remove dead code from the csum-file interface
[git/spearce.git] / progress.c
bloba963bd8bfc84b1b5e0f05857d43ff3e04abce914
1 /*
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.
9 */
11 #include "git-compat-util.h"
12 #include "progress.h"
14 #define TP_IDX_MAX 8
16 struct throughput {
17 off_t prev_total;
18 struct timeval prev_tv;
19 unsigned int avg_bytes;
20 unsigned int last_bytes[TP_IDX_MAX];
21 unsigned int avg_misecs;
22 unsigned int last_misecs[TP_IDX_MAX];
23 unsigned int idx;
24 char display[32];
27 struct progress {
28 const char *title;
29 int last_value;
30 unsigned total;
31 unsigned last_percent;
32 unsigned delay;
33 unsigned delayed_percent_treshold;
34 struct throughput *throughput;
37 static volatile sig_atomic_t progress_update;
39 static void progress_interval(int signum)
41 progress_update = 1;
44 static void set_progress_signal(void)
46 struct sigaction sa;
47 struct itimerval v;
49 progress_update = 0;
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);
68 progress_update = 0;
71 static int display(struct progress *progress, unsigned n, int done)
73 char *eol, *tp;
75 if (progress->delay) {
76 if (!progress_update || --progress->delay)
77 return 0;
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();
83 progress->delay = -1;
84 progress->total = 0;
85 return 0;
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);
100 progress_update = 0;
101 return 1;
103 } else if (progress_update) {
104 fprintf(stderr, "%s: %u%s%s", progress->title, n, tp, eol);
105 progress_update = 0;
106 return 1;
109 return 0;
112 void display_throughput(struct progress *progress, off_t total)
114 struct throughput *tp;
115 struct timeval tv;
116 unsigned int misecs;
118 if (!progress)
119 return;
120 tp = progress->throughput;
122 gettimeofday(&tv, NULL);
124 if (!tp) {
125 progress->throughput = tp = calloc(1, sizeof(*tp));
126 if (tp) {
127 tp->prev_total = total;
128 tp->prev_tv = tv;
130 return;
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)
139 * z = x / y'
141 * To simplify things we'll keep track of misecs, or 1024th of a sec
142 * obtained with:
144 * y' = y * 1024 / 1000000
145 * y' = y / (1000000 / 1024)
146 * y' = y / 977
148 misecs = (tv.tv_sec - tp->prev_tv.tv_sec) * 1024;
149 misecs += (int)(tv.tv_usec - tp->prev_tv.tv_usec) / 977;
151 if (misecs > 512) {
152 int l = sizeof(tp->display);
153 unsigned int count = total - tp->prev_total;
154 tp->prev_total = total;
155 tp->prev_tv = tv;
156 tp->avg_bytes += count;
157 tp->avg_misecs += misecs;
159 if (total > 1 << 30) {
160 l -= snprintf(tp->display, l, ", %u.%2.2u GiB",
161 (int)(total >> 30),
162 (int)(total & ((1 << 30) - 1)) / 10737419);
163 } else if (total > 1 << 20) {
164 l -= snprintf(tp->display, l, ", %u.%2.2u MiB",
165 (int)(total >> 20),
166 ((int)(total & ((1 << 20) - 1))
167 * 100) >> 20);
168 } else if (total > 1 << 10) {
169 l -= snprintf(tp->display, l, ", %u.%2.2u KiB",
170 (int)(total >> 10),
171 ((int)(total & ((1 << 10) - 1))
172 * 100) >> 10);
173 } else {
174 l -= snprintf(tp->display, l, ", %u bytes", (int)total);
176 snprintf(tp->display + sizeof(tp->display) - l, l,
177 " | %u KiB/s", 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;
185 if (progress->last_value != -1 && progress_update)
186 display(progress, progress->last_value, 0);
190 int display_progress(struct progress *progress, unsigned n)
192 return progress ? display(progress, n, 0) : 0;
195 struct progress *start_progress_delay(const char *title, unsigned total,
196 unsigned percent_treshold, unsigned delay)
198 struct progress *progress = malloc(sizeof(*progress));
199 if (!progress) {
200 /* unlikely, but here's a good fallback */
201 fprintf(stderr, "%s...\n", title);
202 return NULL;
204 progress->title = title;
205 progress->total = total;
206 progress->last_value = -1;
207 progress->last_percent = -1;
208 progress->delayed_percent_treshold = percent_treshold;
209 progress->delay = delay;
210 progress->throughput = NULL;
211 set_progress_signal();
212 return progress;
215 struct progress *start_progress(const char *title, unsigned total)
217 return start_progress_delay(title, total, 0, 0);
220 void stop_progress(struct progress **p_progress)
222 struct progress *progress = *p_progress;
223 if (!progress)
224 return;
225 *p_progress = NULL;
226 if (progress->last_value != -1) {
227 /* Force the last update */
228 progress_update = 1;
229 display(progress, progress->last_value, 1);
231 clear_progress_signal();
232 free(progress->throughput);
233 free(progress);