]>
Commit | Line | Data |
---|---|---|
00146caa | 1 | /* $OpenBSD: progressmeter.c,v 1.34 2006/07/22 20:48:23 stevesk Exp $ */ |
c9c38b73 | 2 | /* |
178b1a1d | 3 | * Copyright (c) 2003 Nils Nordman. All rights reserved. |
c9c38b73 | 4 | * |
5 | * Redistribution and use in source and binary forms, with or without | |
6 | * modification, are permitted provided that the following conditions | |
7 | * are met: | |
8 | * 1. Redistributions of source code must retain the above copyright | |
9 | * notice, this list of conditions and the following disclaimer. | |
10 | * 2. Redistributions in binary form must reproduce the above copyright | |
11 | * notice, this list of conditions and the following disclaimer in the | |
12 | * documentation and/or other materials provided with the distribution. | |
13 | * | |
14 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
15 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | |
16 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | |
17 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | |
18 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | |
19 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
20 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
21 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
22 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | |
23 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
24 | */ | |
25 | ||
c9c38b73 | 26 | #include "includes.h" |
bd7c69ea | 27 | |
5188ba17 | 28 | #include <sys/types.h> |
bd7c69ea | 29 | #include <sys/ioctl.h> |
c9c38b73 | 30 | |
028094f4 | 31 | #include <errno.h> |
ada68823 | 32 | #include <signal.h> |
00146caa | 33 | #include <string.h> |
b0f6943a | 34 | #include <time.h> |
5188ba17 | 35 | #include <unistd.h> |
ada68823 | 36 | |
b7fd001f | 37 | #include "progressmeter.h" |
178b1a1d | 38 | #include "atomicio.h" |
8d9bb5dd | 39 | #include "misc.h" |
c9c38b73 | 40 | |
178b1a1d | 41 | #define DEFAULT_WINSIZE 80 |
42 | #define MAX_WINSIZE 512 | |
43 | #define PADDING 1 /* padding between the progress indicators */ | |
44 | #define UPDATE_INTERVAL 1 /* update the progress meter every second */ | |
45 | #define STALL_TIME 5 /* we're stalled after this many seconds */ | |
c9c38b73 | 46 | |
178b1a1d | 47 | /* determines whether we can output to the terminal */ |
48 | static int can_output(void); | |
c9c38b73 | 49 | |
178b1a1d | 50 | /* formats and inserts the specified size into the given buffer */ |
51 | static void format_size(char *, int, off_t); | |
52 | static void format_rate(char *, int, off_t); | |
c9c38b73 | 53 | |
826563dc | 54 | /* window resizing */ |
55 | static void sig_winch(int); | |
56 | static void setscreensize(void); | |
57 | ||
178b1a1d | 58 | /* updates the progressmeter to reflect the current state of the transfer */ |
59 | void refresh_progress_meter(void); | |
c9c38b73 | 60 | |
178b1a1d | 61 | /* signal handler for updating the progress meter */ |
62 | static void update_progress_meter(int); | |
c9c38b73 | 63 | |
f2107e97 | 64 | static time_t start; /* start progress */ |
65 | static time_t last_update; /* last progress update */ | |
66 | static char *file; /* name of the file being transferred */ | |
67 | static off_t end_pos; /* ending position of transfer */ | |
68 | static off_t cur_pos; /* transfer position as of last refresh */ | |
178b1a1d | 69 | static volatile off_t *counter; /* progress counter */ |
f2107e97 | 70 | static long stalled; /* how long we have been stalled */ |
71 | static int bytes_per_second; /* current speed in bytes per second */ | |
72 | static int win_size; /* terminal window size */ | |
826563dc | 73 | static volatile sig_atomic_t win_resized; /* for window resizing */ |
c9c38b73 | 74 | |
178b1a1d | 75 | /* units for format_size */ |
76 | static const char unit[] = " KMGT"; | |
c9c38b73 | 77 | |
178b1a1d | 78 | static int |
79 | can_output(void) | |
80 | { | |
81 | return (getpgrp() == tcgetpgrp(STDOUT_FILENO)); | |
82 | } | |
c9c38b73 | 83 | |
178b1a1d | 84 | static void |
85 | format_rate(char *buf, int size, off_t bytes) | |
86 | { | |
87 | int i; | |
88 | ||
89 | bytes *= 100; | |
90 | for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++) | |
91 | bytes = (bytes + 512) / 1024; | |
92 | if (i == 0) { | |
93 | i++; | |
94 | bytes = (bytes + 512) / 1024; | |
95 | } | |
96 | snprintf(buf, size, "%3lld.%1lld%c%s", | |
419094c6 | 97 | (long long) (bytes + 5) / 100, |
98 | (long long) (bytes + 5) / 10 % 10, | |
178b1a1d | 99 | unit[i], |
100 | i ? "B" : " "); | |
101 | } | |
c9c38b73 | 102 | |
178b1a1d | 103 | static void |
104 | format_size(char *buf, int size, off_t bytes) | |
105 | { | |
106 | int i; | |
107 | ||
108 | for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++) | |
109 | bytes = (bytes + 512) / 1024; | |
110 | snprintf(buf, size, "%4lld%c%s", | |
419094c6 | 111 | (long long) bytes, |
178b1a1d | 112 | unit[i], |
113 | i ? "B" : " "); | |
114 | } | |
c9c38b73 | 115 | |
116 | void | |
178b1a1d | 117 | refresh_progress_meter(void) |
c9c38b73 | 118 | { |
178b1a1d | 119 | char buf[MAX_WINSIZE + 1]; |
120 | time_t now; | |
121 | off_t transferred; | |
122 | double elapsed; | |
123 | int percent; | |
7b0a59c9 | 124 | off_t bytes_left; |
178b1a1d | 125 | int cur_speed; |
126 | int hours, minutes, seconds; | |
127 | int i, len; | |
128 | int file_len; | |
129 | ||
130 | transferred = *counter - cur_pos; | |
131 | cur_pos = *counter; | |
132 | now = time(NULL); | |
133 | bytes_left = end_pos - cur_pos; | |
134 | ||
135 | if (bytes_left > 0) | |
136 | elapsed = now - last_update; | |
adfde93f | 137 | else { |
178b1a1d | 138 | elapsed = now - start; |
adfde93f | 139 | /* Calculate true total speed when done */ |
140 | transferred = end_pos; | |
141 | bytes_per_second = 0; | |
142 | } | |
c9c38b73 | 143 | |
178b1a1d | 144 | /* calculate speed */ |
145 | if (elapsed != 0) | |
146 | cur_speed = (transferred / elapsed); | |
147 | else | |
adfde93f | 148 | cur_speed = transferred; |
c9c38b73 | 149 | |
178b1a1d | 150 | #define AGE_FACTOR 0.9 |
151 | if (bytes_per_second != 0) { | |
152 | bytes_per_second = (bytes_per_second * AGE_FACTOR) + | |
153 | (cur_speed * (1.0 - AGE_FACTOR)); | |
154 | } else | |
155 | bytes_per_second = cur_speed; | |
156 | ||
157 | /* filename */ | |
158 | buf[0] = '\0'; | |
159 | file_len = win_size - 35; | |
160 | if (file_len > 0) { | |
8e382949 | 161 | len = snprintf(buf, file_len + 1, "\r%s", file); |
3845a9ac | 162 | if (len < 0) |
163 | len = 0; | |
4b826d75 | 164 | if (len >= file_len + 1) |
165 | len = file_len; | |
178b1a1d | 166 | for (i = len; i < file_len; i++ ) |
167 | buf[i] = ' '; | |
168 | buf[file_len] = '\0'; | |
169 | } | |
c9c38b73 | 170 | |
178b1a1d | 171 | /* percent of transfer done */ |
172 | if (end_pos != 0) | |
173 | percent = ((float)cur_pos / end_pos) * 100; | |
174 | else | |
175 | percent = 100; | |
176 | snprintf(buf + strlen(buf), win_size - strlen(buf), | |
177 | " %3d%% ", percent); | |
178 | ||
179 | /* amount transferred */ | |
180 | format_size(buf + strlen(buf), win_size - strlen(buf), | |
181 | cur_pos); | |
182 | strlcat(buf, " ", win_size); | |
183 | ||
184 | /* bandwidth usage */ | |
185 | format_rate(buf + strlen(buf), win_size - strlen(buf), | |
f6be21a0 | 186 | (off_t)bytes_per_second); |
178b1a1d | 187 | strlcat(buf, "/s ", win_size); |
188 | ||
189 | /* ETA */ | |
190 | if (!transferred) | |
191 | stalled += elapsed; | |
192 | else | |
193 | stalled = 0; | |
194 | ||
195 | if (stalled >= STALL_TIME) | |
196 | strlcat(buf, "- stalled -", win_size); | |
197 | else if (bytes_per_second == 0 && bytes_left) | |
198 | strlcat(buf, " --:-- ETA", win_size); | |
199 | else { | |
200 | if (bytes_left > 0) | |
201 | seconds = bytes_left / bytes_per_second; | |
202 | else | |
203 | seconds = elapsed; | |
204 | ||
205 | hours = seconds / 3600; | |
206 | seconds -= hours * 3600; | |
207 | minutes = seconds / 60; | |
208 | seconds -= minutes * 60; | |
209 | ||
210 | if (hours != 0) | |
211 | snprintf(buf + strlen(buf), win_size - strlen(buf), | |
212 | "%d:%02d:%02d", hours, minutes, seconds); | |
213 | else | |
214 | snprintf(buf + strlen(buf), win_size - strlen(buf), | |
215 | " %02d:%02d", minutes, seconds); | |
216 | ||
217 | if (bytes_left > 0) | |
218 | strlcat(buf, " ETA", win_size); | |
219 | else | |
220 | strlcat(buf, " ", win_size); | |
221 | } | |
222 | ||
0469be42 | 223 | atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1); |
178b1a1d | 224 | last_update = now; |
c9c38b73 | 225 | } |
226 | ||
c88c3fb9 | 227 | /*ARGSUSED*/ |
c9c38b73 | 228 | static void |
229 | update_progress_meter(int ignore) | |
230 | { | |
178b1a1d | 231 | int save_errno; |
232 | ||
233 | save_errno = errno; | |
234 | ||
826563dc | 235 | if (win_resized) { |
236 | setscreensize(); | |
237 | win_resized = 0; | |
238 | } | |
178b1a1d | 239 | if (can_output()) |
240 | refresh_progress_meter(); | |
c9c38b73 | 241 | |
f00d1f78 | 242 | signal(SIGALRM, update_progress_meter); |
178b1a1d | 243 | alarm(UPDATE_INTERVAL); |
c9c38b73 | 244 | errno = save_errno; |
245 | } | |
246 | ||
178b1a1d | 247 | void |
ca75d7de | 248 | start_progress_meter(char *f, off_t filesize, off_t *ctr) |
c9c38b73 | 249 | { |
178b1a1d | 250 | start = last_update = time(NULL); |
251 | file = f; | |
252 | end_pos = filesize; | |
253 | cur_pos = 0; | |
ca75d7de | 254 | counter = ctr; |
178b1a1d | 255 | stalled = 0; |
256 | bytes_per_second = 0; | |
257 | ||
826563dc | 258 | setscreensize(); |
178b1a1d | 259 | if (can_output()) |
260 | refresh_progress_meter(); | |
c9c38b73 | 261 | |
f00d1f78 | 262 | signal(SIGALRM, update_progress_meter); |
826563dc | 263 | signal(SIGWINCH, sig_winch); |
178b1a1d | 264 | alarm(UPDATE_INTERVAL); |
c9c38b73 | 265 | } |
266 | ||
178b1a1d | 267 | void |
268 | stop_progress_meter(void) | |
c9c38b73 | 269 | { |
178b1a1d | 270 | alarm(0); |
c9c38b73 | 271 | |
178b1a1d | 272 | if (!can_output()) |
273 | return; | |
274 | ||
275 | /* Ensure we complete the progress */ | |
276 | if (cur_pos != end_pos) | |
277 | refresh_progress_meter(); | |
278 | ||
279 | atomicio(vwrite, STDOUT_FILENO, "\n", 1); | |
c9c38b73 | 280 | } |
826563dc | 281 | |
3efa8ea9 | 282 | /*ARGSUSED*/ |
826563dc | 283 | static void |
284 | sig_winch(int sig) | |
285 | { | |
286 | win_resized = 1; | |
287 | } | |
288 | ||
289 | static void | |
290 | setscreensize(void) | |
291 | { | |
292 | struct winsize winsize; | |
293 | ||
294 | if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 && | |
295 | winsize.ws_col != 0) { | |
296 | if (winsize.ws_col > MAX_WINSIZE) | |
297 | win_size = MAX_WINSIZE; | |
298 | else | |
299 | win_size = winsize.ws_col; | |
300 | } else | |
301 | win_size = DEFAULT_WINSIZE; | |
302 | win_size += 1; /* trailing \0 */ | |
303 | } |