1 /* $OpenBSD: progressmeter.c,v 1.37 2006/08/03 03:34:42 deraadt Exp $ */
3 * Copyright (c) 2003 Nils Nordman. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
28 #include <sys/types.h>
29 #include <sys/ioctl.h>
39 #include "progressmeter.h"
43 #define DEFAULT_WINSIZE 80
44 #define MAX_WINSIZE 512
45 #define PADDING 1 /* padding between the progress indicators */
46 #define UPDATE_INTERVAL 1 /* update the progress meter every second */
47 #define STALL_TIME 5 /* we're stalled after this many seconds */
49 /* determines whether we can output to the terminal */
50 static int can_output(void);
52 /* formats and inserts the specified size into the given buffer */
53 static void format_size(char *, int, off_t);
54 static void format_rate(char *, int, off_t);
57 static void sig_winch(int);
58 static void setscreensize(void);
60 /* updates the progressmeter to reflect the current state of the transfer */
61 void refresh_progress_meter(void);
63 /* signal handler for updating the progress meter */
64 static void update_progress_meter(int);
66 static time_t start; /* start progress */
67 static time_t last_update; /* last progress update */
68 static char *file; /* name of the file being transferred */
69 static off_t end_pos; /* ending position of transfer */
70 static off_t cur_pos; /* transfer position as of last refresh */
71 static off_t last_pos;
72 static off_t max_delta_pos = 0;
73 static volatile off_t *counter; /* progress counter */
74 static long stalled; /* how long we have been stalled */
75 static int bytes_per_second; /* current speed in bytes per second */
76 static int win_size; /* terminal window size */
77 static volatile sig_atomic_t win_resized; /* for window resizing */
79 /* units for format_size */
80 static const char unit[] = " KMGT";
85 return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
89 format_rate(char *buf, int size, off_t bytes)
94 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
95 bytes = (bytes + 512) / 1024;
98 bytes = (bytes + 512) / 1024;
100 snprintf(buf, size, "%3lld.%1lld%c%s",
101 (long long) (bytes + 5) / 100,
102 (long long) (bytes + 5) / 10 % 10,
108 format_size(char *buf, int size, off_t bytes)
112 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
113 bytes = (bytes + 512) / 1024;
114 snprintf(buf, size, "%4lld%c%s",
121 refresh_progress_meter(void)
123 char buf[MAX_WINSIZE + 1];
130 int hours, minutes, seconds;
135 transferred = *counter - cur_pos;
138 bytes_left = end_pos - cur_pos;
140 delta_pos = cur_pos - last_pos;
141 if (delta_pos > max_delta_pos)
142 max_delta_pos = delta_pos;
145 elapsed = now - last_update;
147 elapsed = now - start;
148 /* Calculate true total speed when done */
149 transferred = end_pos;
150 bytes_per_second = 0;
153 /* calculate speed */
155 cur_speed = (transferred / elapsed);
157 cur_speed = transferred;
159 #define AGE_FACTOR 0.9
160 if (bytes_per_second != 0) {
161 bytes_per_second = (bytes_per_second * AGE_FACTOR) +
162 (cur_speed * (1.0 - AGE_FACTOR));
164 bytes_per_second = cur_speed;
168 file_len = win_size - 45;
170 len = snprintf(buf, file_len + 1, "\r%s", file);
173 if (len >= file_len + 1)
175 for (i = len; i < file_len; i++)
177 buf[file_len] = '\0';
180 /* percent of transfer done */
182 percent = ((float)cur_pos / end_pos) * 100;
186 snprintf(buf + strlen(buf), win_size - strlen(buf-8),
189 /* amount transferred */
190 format_size(buf + strlen(buf), win_size - strlen(buf),
192 strlcat(buf, " ", win_size);
194 /* bandwidth usage */
195 format_rate(buf + strlen(buf), win_size - strlen(buf),
196 (off_t)bytes_per_second);
197 strlcat(buf, "/s ", win_size);
199 /* instantaneous rate */
201 format_rate(buf + strlen(buf), win_size - strlen(buf),
204 format_rate(buf + strlen(buf), win_size - strlen(buf),
206 strlcat(buf, "/s ", win_size);
214 if (stalled >= STALL_TIME)
215 strlcat(buf, "- stalled -", win_size);
216 else if (bytes_per_second == 0 && bytes_left)
217 strlcat(buf, " --:-- ETA", win_size);
220 seconds = bytes_left / bytes_per_second;
224 hours = seconds / 3600;
225 seconds -= hours * 3600;
226 minutes = seconds / 60;
227 seconds -= minutes * 60;
230 snprintf(buf + strlen(buf), win_size - strlen(buf),
231 "%d:%02d:%02d", hours, minutes, seconds);
233 snprintf(buf + strlen(buf), win_size - strlen(buf),
234 " %02d:%02d", minutes, seconds);
237 strlcat(buf, " ETA", win_size);
239 strlcat(buf, " ", win_size);
242 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
249 update_progress_meter(int ignore)
260 refresh_progress_meter();
262 signal(SIGALRM, update_progress_meter);
263 alarm(UPDATE_INTERVAL);
268 start_progress_meter(char *f, off_t filesize, off_t *ctr)
270 start = last_update = time(NULL);
276 bytes_per_second = 0;
280 refresh_progress_meter();
282 signal(SIGALRM, update_progress_meter);
283 signal(SIGWINCH, sig_winch);
284 alarm(UPDATE_INTERVAL);
288 stop_progress_meter(void)
295 /* Ensure we complete the progress */
296 if (cur_pos != end_pos)
297 refresh_progress_meter();
299 atomicio(vwrite, STDOUT_FILENO, "\n", 1);
312 struct winsize winsize;
314 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
315 winsize.ws_col != 0) {
316 if (winsize.ws_col > MAX_WINSIZE)
317 win_size = MAX_WINSIZE;
319 win_size = winsize.ws_col;
321 win_size = DEFAULT_WINSIZE;
322 win_size += 1; /* trailing \0 */