blob: cc5f664abb0db78811379a291a0fbd1b82ac94a8 [file] [log] [blame]
Damien Millere6b3b612006-07-24 14:01:23 +10001/* $OpenBSD: progressmeter.c,v 1.31 2006/07/17 01:31:09 stevesk Exp $ */
Damien Miller6fd00e02003-01-10 21:46:02 +11002/*
Darren Tucker06ef75b2003-08-02 23:28:38 +10003 * Copyright (c) 2003 Nils Nordman. All rights reserved.
Damien Miller6fd00e02003-01-10 21:46:02 +11004 *
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
Damien Miller6fd00e02003-01-10 21:46:02 +110026#include "includes.h"
Damien Miller17e91c02006-03-15 11:28:34 +110027
Damien Millere6b3b612006-07-24 14:01:23 +100028#include <sys/types.h>
Damien Miller17e91c02006-03-15 11:28:34 +110029#include <sys/ioctl.h>
Damien Miller6fd00e02003-01-10 21:46:02 +110030
Darren Tucker39972492006-07-12 22:22:46 +100031#include <errno.h>
Damien Miller6ff3cad2006-03-15 11:52:09 +110032#include <signal.h>
Damien Millere6b3b612006-07-24 14:01:23 +100033#include <unistd.h>
Damien Miller6ff3cad2006-03-15 11:52:09 +110034
Damien Miller71a51412003-01-14 22:23:23 +110035#include "progressmeter.h"
Darren Tucker06ef75b2003-08-02 23:28:38 +100036#include "atomicio.h"
Damien Miller0cbb9de2003-06-04 22:56:15 +100037#include "misc.h"
Damien Miller6fd00e02003-01-10 21:46:02 +110038
Darren Tucker06ef75b2003-08-02 23:28:38 +100039#define DEFAULT_WINSIZE 80
40#define MAX_WINSIZE 512
41#define PADDING 1 /* padding between the progress indicators */
42#define UPDATE_INTERVAL 1 /* update the progress meter every second */
43#define STALL_TIME 5 /* we're stalled after this many seconds */
Damien Miller6fd00e02003-01-10 21:46:02 +110044
Darren Tucker06ef75b2003-08-02 23:28:38 +100045/* determines whether we can output to the terminal */
46static int can_output(void);
47
48/* formats and inserts the specified size into the given buffer */
49static void format_size(char *, int, off_t);
50static void format_rate(char *, int, off_t);
51
Damien Miller05656962005-06-16 13:18:04 +100052/* window resizing */
53static void sig_winch(int);
54static void setscreensize(void);
55
Darren Tucker06ef75b2003-08-02 23:28:38 +100056/* updates the progressmeter to reflect the current state of the transfer */
57void refresh_progress_meter(void);
58
59/* signal handler for updating the progress meter */
Damien Miller6fd00e02003-01-10 21:46:02 +110060static void update_progress_meter(int);
61
Darren Tuckerfc959702004-07-17 16:12:08 +100062static time_t start; /* start progress */
63static time_t last_update; /* last progress update */
64static char *file; /* name of the file being transferred */
65static off_t end_pos; /* ending position of transfer */
66static off_t cur_pos; /* transfer position as of last refresh */
Darren Tucker06ef75b2003-08-02 23:28:38 +100067static volatile off_t *counter; /* progress counter */
Darren Tuckerfc959702004-07-17 16:12:08 +100068static long stalled; /* how long we have been stalled */
69static int bytes_per_second; /* current speed in bytes per second */
70static int win_size; /* terminal window size */
Damien Miller05656962005-06-16 13:18:04 +100071static volatile sig_atomic_t win_resized; /* for window resizing */
Damien Miller6fd00e02003-01-10 21:46:02 +110072
Darren Tucker06ef75b2003-08-02 23:28:38 +100073/* units for format_size */
74static const char unit[] = " KMGT";
Damien Miller6fd00e02003-01-10 21:46:02 +110075
Darren Tucker06ef75b2003-08-02 23:28:38 +100076static int
77can_output(void)
78{
79 return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
80}
Damien Miller6fd00e02003-01-10 21:46:02 +110081
Darren Tucker06ef75b2003-08-02 23:28:38 +100082static void
83format_rate(char *buf, int size, off_t bytes)
84{
85 int i;
Damien Miller6fd00e02003-01-10 21:46:02 +110086
Darren Tucker06ef75b2003-08-02 23:28:38 +100087 bytes *= 100;
88 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
89 bytes = (bytes + 512) / 1024;
90 if (i == 0) {
91 i++;
92 bytes = (bytes + 512) / 1024;
93 }
94 snprintf(buf, size, "%3lld.%1lld%c%s",
Darren Tuckere0be3042005-11-25 14:44:55 +110095 (long long) (bytes + 5) / 100,
96 (long long) (bytes + 5) / 10 % 10,
Darren Tucker06ef75b2003-08-02 23:28:38 +100097 unit[i],
98 i ? "B" : " ");
99}
Damien Miller6fd00e02003-01-10 21:46:02 +1100100
Darren Tucker06ef75b2003-08-02 23:28:38 +1000101static void
102format_size(char *buf, int size, off_t bytes)
103{
104 int i;
Damien Miller6fd00e02003-01-10 21:46:02 +1100105
Darren Tucker06ef75b2003-08-02 23:28:38 +1000106 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
107 bytes = (bytes + 512) / 1024;
108 snprintf(buf, size, "%4lld%c%s",
Darren Tuckere0be3042005-11-25 14:44:55 +1100109 (long long) bytes,
Darren Tucker06ef75b2003-08-02 23:28:38 +1000110 unit[i],
111 i ? "B" : " ");
112}
Damien Miller6fd00e02003-01-10 21:46:02 +1100113
114void
Darren Tucker06ef75b2003-08-02 23:28:38 +1000115refresh_progress_meter(void)
Damien Miller6fd00e02003-01-10 21:46:02 +1100116{
Darren Tucker06ef75b2003-08-02 23:28:38 +1000117 char buf[MAX_WINSIZE + 1];
118 time_t now;
119 off_t transferred;
120 double elapsed;
121 int percent;
Darren Tucker7f73a492004-02-06 16:41:37 +1100122 off_t bytes_left;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000123 int cur_speed;
124 int hours, minutes, seconds;
125 int i, len;
126 int file_len;
Damien Miller6fd00e02003-01-10 21:46:02 +1100127
Darren Tucker06ef75b2003-08-02 23:28:38 +1000128 transferred = *counter - cur_pos;
129 cur_pos = *counter;
130 now = time(NULL);
131 bytes_left = end_pos - cur_pos;
Damien Miller6fd00e02003-01-10 21:46:02 +1100132
Darren Tucker06ef75b2003-08-02 23:28:38 +1000133 if (bytes_left > 0)
134 elapsed = now - last_update;
Darren Tucker1fb04252003-12-09 19:07:13 +1100135 else {
Darren Tucker06ef75b2003-08-02 23:28:38 +1000136 elapsed = now - start;
Darren Tucker1fb04252003-12-09 19:07:13 +1100137 /* Calculate true total speed when done */
138 transferred = end_pos;
139 bytes_per_second = 0;
140 }
Darren Tucker06ef75b2003-08-02 23:28:38 +1000141
142 /* calculate speed */
143 if (elapsed != 0)
144 cur_speed = (transferred / elapsed);
145 else
Darren Tucker1fb04252003-12-09 19:07:13 +1100146 cur_speed = transferred;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000147
148#define AGE_FACTOR 0.9
149 if (bytes_per_second != 0) {
150 bytes_per_second = (bytes_per_second * AGE_FACTOR) +
151 (cur_speed * (1.0 - AGE_FACTOR));
152 } else
153 bytes_per_second = cur_speed;
154
155 /* filename */
156 buf[0] = '\0';
157 file_len = win_size - 35;
158 if (file_len > 0) {
Damien Miller17af1762003-09-02 22:53:01 +1000159 len = snprintf(buf, file_len + 1, "\r%s", file);
Damien Millerb5829f52003-09-02 22:53:32 +1000160 if (len < 0)
161 len = 0;
Damien Miller41bfc292005-05-26 12:07:32 +1000162 if (len >= file_len + 1)
163 len = file_len;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000164 for (i = len; i < file_len; i++ )
165 buf[i] = ' ';
166 buf[file_len] = '\0';
167 }
168
169 /* percent of transfer done */
170 if (end_pos != 0)
171 percent = ((float)cur_pos / end_pos) * 100;
172 else
173 percent = 100;
174 snprintf(buf + strlen(buf), win_size - strlen(buf),
175 " %3d%% ", percent);
176
177 /* amount transferred */
178 format_size(buf + strlen(buf), win_size - strlen(buf),
179 cur_pos);
180 strlcat(buf, " ", win_size);
181
182 /* bandwidth usage */
183 format_rate(buf + strlen(buf), win_size - strlen(buf),
Darren Tucker1f8311c2004-05-13 16:39:33 +1000184 (off_t)bytes_per_second);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000185 strlcat(buf, "/s ", win_size);
186
187 /* ETA */
188 if (!transferred)
189 stalled += elapsed;
190 else
191 stalled = 0;
192
193 if (stalled >= STALL_TIME)
194 strlcat(buf, "- stalled -", win_size);
195 else if (bytes_per_second == 0 && bytes_left)
196 strlcat(buf, " --:-- ETA", win_size);
197 else {
198 if (bytes_left > 0)
199 seconds = bytes_left / bytes_per_second;
200 else
201 seconds = elapsed;
202
203 hours = seconds / 3600;
204 seconds -= hours * 3600;
205 minutes = seconds / 60;
206 seconds -= minutes * 60;
207
208 if (hours != 0)
209 snprintf(buf + strlen(buf), win_size - strlen(buf),
210 "%d:%02d:%02d", hours, minutes, seconds);
211 else
212 snprintf(buf + strlen(buf), win_size - strlen(buf),
213 " %02d:%02d", minutes, seconds);
214
215 if (bytes_left > 0)
216 strlcat(buf, " ETA", win_size);
217 else
218 strlcat(buf, " ", win_size);
219 }
220
Darren Tucker6cc310b2003-10-02 16:15:15 +1000221 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000222 last_update = now;
223}
224
225static void
226update_progress_meter(int ignore)
227{
228 int save_errno;
229
230 save_errno = errno;
231
Damien Miller05656962005-06-16 13:18:04 +1000232 if (win_resized) {
233 setscreensize();
234 win_resized = 0;
235 }
Darren Tucker06ef75b2003-08-02 23:28:38 +1000236 if (can_output())
237 refresh_progress_meter();
238
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000239 signal(SIGALRM, update_progress_meter);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000240 alarm(UPDATE_INTERVAL);
241 errno = save_errno;
242}
243
244void
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000245start_progress_meter(char *f, off_t filesize, off_t *ctr)
Darren Tucker06ef75b2003-08-02 23:28:38 +1000246{
Darren Tucker06ef75b2003-08-02 23:28:38 +1000247 start = last_update = time(NULL);
248 file = f;
249 end_pos = filesize;
250 cur_pos = 0;
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000251 counter = ctr;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000252 stalled = 0;
253 bytes_per_second = 0;
254
Damien Miller05656962005-06-16 13:18:04 +1000255 setscreensize();
Darren Tucker06ef75b2003-08-02 23:28:38 +1000256 if (can_output())
257 refresh_progress_meter();
258
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000259 signal(SIGALRM, update_progress_meter);
Damien Miller05656962005-06-16 13:18:04 +1000260 signal(SIGWINCH, sig_winch);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000261 alarm(UPDATE_INTERVAL);
Damien Miller6fd00e02003-01-10 21:46:02 +1100262}
263
264void
Damien Miller2b92d322003-06-11 22:05:06 +1000265stop_progress_meter(void)
Damien Miller6fd00e02003-01-10 21:46:02 +1100266{
267 alarm(0);
Damien Miller6fd00e02003-01-10 21:46:02 +1100268
Darren Tucker06ef75b2003-08-02 23:28:38 +1000269 if (!can_output())
Damien Miller6fd00e02003-01-10 21:46:02 +1100270 return;
271
Darren Tucker06ef75b2003-08-02 23:28:38 +1000272 /* Ensure we complete the progress */
273 if (cur_pos != end_pos)
274 refresh_progress_meter();
Damien Miller6fd00e02003-01-10 21:46:02 +1100275
Darren Tucker06ef75b2003-08-02 23:28:38 +1000276 atomicio(vwrite, STDOUT_FILENO, "\n", 1);
Damien Miller6fd00e02003-01-10 21:46:02 +1100277}
Damien Miller05656962005-06-16 13:18:04 +1000278
Damien Millerf0b15df2006-03-26 13:59:20 +1100279/*ARGSUSED*/
Damien Miller05656962005-06-16 13:18:04 +1000280static void
281sig_winch(int sig)
282{
283 win_resized = 1;
284}
285
286static void
287setscreensize(void)
288{
289 struct winsize winsize;
290
291 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
292 winsize.ws_col != 0) {
293 if (winsize.ws_col > MAX_WINSIZE)
294 win_size = MAX_WINSIZE;
295 else
296 win_size = winsize.ws_col;
297 } else
298 win_size = DEFAULT_WINSIZE;
299 win_size += 1; /* trailing \0 */
300}