1 /* $OpenBSD: progressmeter.c,v 1.29 2006/03/25 13:17:02 djm 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/ioctl.h>
32 #include "progressmeter.h"
36 #define DEFAULT_WINSIZE 80
37 #define MAX_WINSIZE 512
38 #define PADDING 1 /* padding between the progress indicators */
39 #define UPDATE_INTERVAL 1 /* update the progress meter every second */
40 #define STALL_TIME 5 /* we're stalled after this many seconds */
42 /* determines whether we can output to the terminal */
43 static int can_output(void);
45 /* formats and inserts the specified size into the given buffer */
46 static void format_size(char *, int, off_t);
47 static void format_rate(char *, int, off_t);
50 static void sig_winch(int);
51 static void setscreensize(void);
53 /* updates the progressmeter to reflect the current state of the transfer */
54 void refresh_progress_meter(void);
56 /* signal handler for updating the progress meter */
57 static void update_progress_meter(int);
59 static time_t start; /* start progress */
60 static time_t last_update; /* last progress update */
61 static char *file; /* name of the file being transferred */
62 static off_t end_pos; /* ending position of transfer */
63 static off_t cur_pos; /* transfer position as of last refresh */
64 static volatile off_t *counter; /* progress counter */
65 static long stalled; /* how long we have been stalled */
66 static int bytes_per_second; /* current speed in bytes per second */
67 static int win_size; /* terminal window size */
68 static volatile sig_atomic_t win_resized; /* for window resizing */
70 /* units for format_size */
71 static const char unit[] = " KMGT";
76 return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
80 format_rate(char *buf, int size, off_t bytes)
85 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
86 bytes = (bytes + 512) / 1024;
89 bytes = (bytes + 512) / 1024;
91 snprintf(buf, size, "%3lld.%1lld%c%s",
92 (long long) (bytes + 5) / 100,
93 (long long) (bytes + 5) / 10 % 10,
99 format_size(char *buf, int size, off_t bytes)
103 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
104 bytes = (bytes + 512) / 1024;
105 snprintf(buf, size, "%4lld%c%s",
112 refresh_progress_meter(void)
114 char buf[MAX_WINSIZE + 1];
121 int hours, minutes, seconds;
125 transferred = *counter - cur_pos;
128 bytes_left = end_pos - cur_pos;
131 elapsed = now - last_update;
133 elapsed = now - start;
134 /* Calculate true total speed when done */
135 transferred = end_pos;
136 bytes_per_second = 0;
139 /* calculate speed */
141 cur_speed = (transferred / elapsed);
143 cur_speed = transferred;
145 #define AGE_FACTOR 0.9
146 if (bytes_per_second != 0) {
147 bytes_per_second = (bytes_per_second * AGE_FACTOR) +
148 (cur_speed * (1.0 - AGE_FACTOR));
150 bytes_per_second = cur_speed;
154 file_len = win_size - 35;
156 len = snprintf(buf, file_len + 1, "\r%s", file);
159 if (len >= file_len + 1)
161 for (i = len; i < file_len; i++ )
163 buf[file_len] = '\0';
166 /* percent of transfer done */
168 percent = ((float)cur_pos / end_pos) * 100;
171 snprintf(buf + strlen(buf), win_size - strlen(buf),
174 /* amount transferred */
175 format_size(buf + strlen(buf), win_size - strlen(buf),
177 strlcat(buf, " ", win_size);
179 /* bandwidth usage */
180 format_rate(buf + strlen(buf), win_size - strlen(buf),
181 (off_t)bytes_per_second);
182 strlcat(buf, "/s ", win_size);
190 if (stalled >= STALL_TIME)
191 strlcat(buf, "- stalled -", win_size);
192 else if (bytes_per_second == 0 && bytes_left)
193 strlcat(buf, " --:-- ETA", win_size);
196 seconds = bytes_left / bytes_per_second;
200 hours = seconds / 3600;
201 seconds -= hours * 3600;
202 minutes = seconds / 60;
203 seconds -= minutes * 60;
206 snprintf(buf + strlen(buf), win_size - strlen(buf),
207 "%d:%02d:%02d", hours, minutes, seconds);
209 snprintf(buf + strlen(buf), win_size - strlen(buf),
210 " %02d:%02d", minutes, seconds);
213 strlcat(buf, " ETA", win_size);
215 strlcat(buf, " ", win_size);
218 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
223 update_progress_meter(int ignore)
234 refresh_progress_meter();
236 signal(SIGALRM, update_progress_meter);
237 alarm(UPDATE_INTERVAL);
242 start_progress_meter(char *f, off_t filesize, off_t *ctr)
244 start = last_update = time(NULL);
250 bytes_per_second = 0;
254 refresh_progress_meter();
256 signal(SIGALRM, update_progress_meter);
257 signal(SIGWINCH, sig_winch);
258 alarm(UPDATE_INTERVAL);
262 stop_progress_meter(void)
269 /* Ensure we complete the progress */
270 if (cur_pos != end_pos)
271 refresh_progress_meter();
273 atomicio(vwrite, STDOUT_FILENO, "\n", 1);
286 struct winsize winsize;
288 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
289 winsize.ws_col != 0) {
290 if (winsize.ws_col > MAX_WINSIZE)
291 win_size = MAX_WINSIZE;
293 win_size = winsize.ws_col;
295 win_size = DEFAULT_WINSIZE;
296 win_size += 1; /* trailing \0 */