1 /* $OpenBSD: progressmeter.c,v 1.34 2006/07/22 20:48:23 stevesk 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>
37 #include "progressmeter.h"
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 */
47 /* determines whether we can output to the terminal */
48 static int can_output(void);
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);
55 static void sig_winch(int);
56 static void setscreensize(void);
58 /* updates the progressmeter to reflect the current state of the transfer */
59 void refresh_progress_meter(void);
61 /* signal handler for updating the progress meter */
62 static void update_progress_meter(int);
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 */
69 static volatile off_t *counter; /* progress counter */
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 */
73 static volatile sig_atomic_t win_resized; /* for window resizing */
75 /* units for format_size */
76 static const char unit[] = " KMGT";
81 return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
85 format_rate(char *buf, int size, off_t bytes)
90 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
91 bytes = (bytes + 512) / 1024;
94 bytes = (bytes + 512) / 1024;
96 snprintf(buf, size, "%3lld.%1lld%c%s",
97 (long long) (bytes + 5) / 100,
98 (long long) (bytes + 5) / 10 % 10,
104 format_size(char *buf, int size, off_t bytes)
108 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
109 bytes = (bytes + 512) / 1024;
110 snprintf(buf, size, "%4lld%c%s",
117 refresh_progress_meter(void)
119 char buf[MAX_WINSIZE + 1];
126 int hours, minutes, seconds;
130 transferred = *counter - cur_pos;
133 bytes_left = end_pos - cur_pos;
136 elapsed = now - last_update;
138 elapsed = now - start;
139 /* Calculate true total speed when done */
140 transferred = end_pos;
141 bytes_per_second = 0;
144 /* calculate speed */
146 cur_speed = (transferred / elapsed);
148 cur_speed = transferred;
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));
155 bytes_per_second = cur_speed;
159 file_len = win_size - 35;
161 len = snprintf(buf, file_len + 1, "\r%s", file);
164 if (len >= file_len + 1)
166 for (i = len; i < file_len; i++ )
168 buf[file_len] = '\0';
171 /* percent of transfer done */
173 percent = ((float)cur_pos / end_pos) * 100;
176 snprintf(buf + strlen(buf), win_size - strlen(buf),
179 /* amount transferred */
180 format_size(buf + strlen(buf), win_size - strlen(buf),
182 strlcat(buf, " ", win_size);
184 /* bandwidth usage */
185 format_rate(buf + strlen(buf), win_size - strlen(buf),
186 (off_t)bytes_per_second);
187 strlcat(buf, "/s ", win_size);
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);
201 seconds = bytes_left / bytes_per_second;
205 hours = seconds / 3600;
206 seconds -= hours * 3600;
207 minutes = seconds / 60;
208 seconds -= minutes * 60;
211 snprintf(buf + strlen(buf), win_size - strlen(buf),
212 "%d:%02d:%02d", hours, minutes, seconds);
214 snprintf(buf + strlen(buf), win_size - strlen(buf),
215 " %02d:%02d", minutes, seconds);
218 strlcat(buf, " ETA", win_size);
220 strlcat(buf, " ", win_size);
223 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
229 update_progress_meter(int ignore)
240 refresh_progress_meter();
242 signal(SIGALRM, update_progress_meter);
243 alarm(UPDATE_INTERVAL);
248 start_progress_meter(char *f, off_t filesize, off_t *ctr)
250 start = last_update = time(NULL);
256 bytes_per_second = 0;
260 refresh_progress_meter();
262 signal(SIGALRM, update_progress_meter);
263 signal(SIGWINCH, sig_winch);
264 alarm(UPDATE_INTERVAL);
268 stop_progress_meter(void)
275 /* Ensure we complete the progress */
276 if (cur_pos != end_pos)
277 refresh_progress_meter();
279 atomicio(vwrite, STDOUT_FILENO, "\n", 1);
292 struct winsize winsize;
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;
299 win_size = winsize.ws_col;
301 win_size = DEFAULT_WINSIZE;
302 win_size += 1; /* trailing \0 */