blob: 4f76c53d0f81419b9aa38cb05bae6355a319adc9 [file] [log] [blame]
Damien Miller6fd00e02003-01-10 21:46:02 +11001/*
Darren Tucker06ef75b2003-08-02 23:28:38 +10002 * Copyright (c) 2003 Nils Nordman. All rights reserved.
Damien Miller6fd00e02003-01-10 21:46:02 +11003 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
Damien Miller6fd00e02003-01-10 21:46:02 +110025#include "includes.h"
Damien Miller17e91c02006-03-15 11:28:34 +110026RCSID("$OpenBSD: progressmeter.c,v 1.25 2006/02/10 00:27:13 stevesk Exp $");
27
28#include <sys/ioctl.h>
Damien Miller6fd00e02003-01-10 21:46:02 +110029
Damien Miller71a51412003-01-14 22:23:23 +110030#include "progressmeter.h"
Darren Tucker06ef75b2003-08-02 23:28:38 +100031#include "atomicio.h"
Damien Miller0cbb9de2003-06-04 22:56:15 +100032#include "misc.h"
Damien Miller6fd00e02003-01-10 21:46:02 +110033
Darren Tucker06ef75b2003-08-02 23:28:38 +100034#define DEFAULT_WINSIZE 80
35#define MAX_WINSIZE 512
36#define PADDING 1 /* padding between the progress indicators */
37#define UPDATE_INTERVAL 1 /* update the progress meter every second */
38#define STALL_TIME 5 /* we're stalled after this many seconds */
Damien Miller6fd00e02003-01-10 21:46:02 +110039
Darren Tucker06ef75b2003-08-02 23:28:38 +100040/* determines whether we can output to the terminal */
41static int can_output(void);
42
43/* formats and inserts the specified size into the given buffer */
44static void format_size(char *, int, off_t);
45static void format_rate(char *, int, off_t);
46
Damien Miller05656962005-06-16 13:18:04 +100047/* window resizing */
48static void sig_winch(int);
49static void setscreensize(void);
50
Darren Tucker06ef75b2003-08-02 23:28:38 +100051/* updates the progressmeter to reflect the current state of the transfer */
52void refresh_progress_meter(void);
53
54/* signal handler for updating the progress meter */
Damien Miller6fd00e02003-01-10 21:46:02 +110055static void update_progress_meter(int);
56
Darren Tuckerfc959702004-07-17 16:12:08 +100057static time_t start; /* start progress */
58static time_t last_update; /* last progress update */
59static char *file; /* name of the file being transferred */
60static off_t end_pos; /* ending position of transfer */
61static off_t cur_pos; /* transfer position as of last refresh */
Darren Tucker06ef75b2003-08-02 23:28:38 +100062static volatile off_t *counter; /* progress counter */
Darren Tuckerfc959702004-07-17 16:12:08 +100063static long stalled; /* how long we have been stalled */
64static int bytes_per_second; /* current speed in bytes per second */
65static int win_size; /* terminal window size */
Damien Miller05656962005-06-16 13:18:04 +100066static volatile sig_atomic_t win_resized; /* for window resizing */
Damien Miller6fd00e02003-01-10 21:46:02 +110067
Darren Tucker06ef75b2003-08-02 23:28:38 +100068/* units for format_size */
69static const char unit[] = " KMGT";
Damien Miller6fd00e02003-01-10 21:46:02 +110070
Darren Tucker06ef75b2003-08-02 23:28:38 +100071static int
72can_output(void)
73{
74 return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
75}
Damien Miller6fd00e02003-01-10 21:46:02 +110076
Darren Tucker06ef75b2003-08-02 23:28:38 +100077static void
78format_rate(char *buf, int size, off_t bytes)
79{
80 int i;
Damien Miller6fd00e02003-01-10 21:46:02 +110081
Darren Tucker06ef75b2003-08-02 23:28:38 +100082 bytes *= 100;
83 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
84 bytes = (bytes + 512) / 1024;
85 if (i == 0) {
86 i++;
87 bytes = (bytes + 512) / 1024;
88 }
89 snprintf(buf, size, "%3lld.%1lld%c%s",
Darren Tuckere0be3042005-11-25 14:44:55 +110090 (long long) (bytes + 5) / 100,
91 (long long) (bytes + 5) / 10 % 10,
Darren Tucker06ef75b2003-08-02 23:28:38 +100092 unit[i],
93 i ? "B" : " ");
94}
Damien Miller6fd00e02003-01-10 21:46:02 +110095
Darren Tucker06ef75b2003-08-02 23:28:38 +100096static void
97format_size(char *buf, int size, off_t bytes)
98{
99 int i;
Damien Miller6fd00e02003-01-10 21:46:02 +1100100
Darren Tucker06ef75b2003-08-02 23:28:38 +1000101 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
102 bytes = (bytes + 512) / 1024;
103 snprintf(buf, size, "%4lld%c%s",
Darren Tuckere0be3042005-11-25 14:44:55 +1100104 (long long) bytes,
Darren Tucker06ef75b2003-08-02 23:28:38 +1000105 unit[i],
106 i ? "B" : " ");
107}
Damien Miller6fd00e02003-01-10 21:46:02 +1100108
109void
Darren Tucker06ef75b2003-08-02 23:28:38 +1000110refresh_progress_meter(void)
Damien Miller6fd00e02003-01-10 21:46:02 +1100111{
Darren Tucker06ef75b2003-08-02 23:28:38 +1000112 char buf[MAX_WINSIZE + 1];
113 time_t now;
114 off_t transferred;
115 double elapsed;
116 int percent;
Darren Tucker7f73a492004-02-06 16:41:37 +1100117 off_t bytes_left;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000118 int cur_speed;
119 int hours, minutes, seconds;
120 int i, len;
121 int file_len;
Damien Miller6fd00e02003-01-10 21:46:02 +1100122
Darren Tucker06ef75b2003-08-02 23:28:38 +1000123 transferred = *counter - cur_pos;
124 cur_pos = *counter;
125 now = time(NULL);
126 bytes_left = end_pos - cur_pos;
Damien Miller6fd00e02003-01-10 21:46:02 +1100127
Darren Tucker06ef75b2003-08-02 23:28:38 +1000128 if (bytes_left > 0)
129 elapsed = now - last_update;
Darren Tucker1fb04252003-12-09 19:07:13 +1100130 else {
Darren Tucker06ef75b2003-08-02 23:28:38 +1000131 elapsed = now - start;
Darren Tucker1fb04252003-12-09 19:07:13 +1100132 /* Calculate true total speed when done */
133 transferred = end_pos;
134 bytes_per_second = 0;
135 }
Darren Tucker06ef75b2003-08-02 23:28:38 +1000136
137 /* calculate speed */
138 if (elapsed != 0)
139 cur_speed = (transferred / elapsed);
140 else
Darren Tucker1fb04252003-12-09 19:07:13 +1100141 cur_speed = transferred;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000142
143#define AGE_FACTOR 0.9
144 if (bytes_per_second != 0) {
145 bytes_per_second = (bytes_per_second * AGE_FACTOR) +
146 (cur_speed * (1.0 - AGE_FACTOR));
147 } else
148 bytes_per_second = cur_speed;
149
150 /* filename */
151 buf[0] = '\0';
152 file_len = win_size - 35;
153 if (file_len > 0) {
Damien Miller17af1762003-09-02 22:53:01 +1000154 len = snprintf(buf, file_len + 1, "\r%s", file);
Damien Millerb5829f52003-09-02 22:53:32 +1000155 if (len < 0)
156 len = 0;
Damien Miller41bfc292005-05-26 12:07:32 +1000157 if (len >= file_len + 1)
158 len = file_len;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000159 for (i = len; i < file_len; i++ )
160 buf[i] = ' ';
161 buf[file_len] = '\0';
162 }
163
164 /* percent of transfer done */
165 if (end_pos != 0)
166 percent = ((float)cur_pos / end_pos) * 100;
167 else
168 percent = 100;
169 snprintf(buf + strlen(buf), win_size - strlen(buf),
170 " %3d%% ", percent);
171
172 /* amount transferred */
173 format_size(buf + strlen(buf), win_size - strlen(buf),
174 cur_pos);
175 strlcat(buf, " ", win_size);
176
177 /* bandwidth usage */
178 format_rate(buf + strlen(buf), win_size - strlen(buf),
Darren Tucker1f8311c2004-05-13 16:39:33 +1000179 (off_t)bytes_per_second);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000180 strlcat(buf, "/s ", win_size);
181
182 /* ETA */
183 if (!transferred)
184 stalled += elapsed;
185 else
186 stalled = 0;
187
188 if (stalled >= STALL_TIME)
189 strlcat(buf, "- stalled -", win_size);
190 else if (bytes_per_second == 0 && bytes_left)
191 strlcat(buf, " --:-- ETA", win_size);
192 else {
193 if (bytes_left > 0)
194 seconds = bytes_left / bytes_per_second;
195 else
196 seconds = elapsed;
197
198 hours = seconds / 3600;
199 seconds -= hours * 3600;
200 minutes = seconds / 60;
201 seconds -= minutes * 60;
202
203 if (hours != 0)
204 snprintf(buf + strlen(buf), win_size - strlen(buf),
205 "%d:%02d:%02d", hours, minutes, seconds);
206 else
207 snprintf(buf + strlen(buf), win_size - strlen(buf),
208 " %02d:%02d", minutes, seconds);
209
210 if (bytes_left > 0)
211 strlcat(buf, " ETA", win_size);
212 else
213 strlcat(buf, " ", win_size);
214 }
215
Darren Tucker6cc310b2003-10-02 16:15:15 +1000216 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000217 last_update = now;
218}
219
220static void
221update_progress_meter(int ignore)
222{
223 int save_errno;
224
225 save_errno = errno;
226
Damien Miller05656962005-06-16 13:18:04 +1000227 if (win_resized) {
228 setscreensize();
229 win_resized = 0;
230 }
Darren Tucker06ef75b2003-08-02 23:28:38 +1000231 if (can_output())
232 refresh_progress_meter();
233
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000234 signal(SIGALRM, update_progress_meter);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000235 alarm(UPDATE_INTERVAL);
236 errno = save_errno;
237}
238
239void
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000240start_progress_meter(char *f, off_t filesize, off_t *ctr)
Darren Tucker06ef75b2003-08-02 23:28:38 +1000241{
Darren Tucker06ef75b2003-08-02 23:28:38 +1000242 start = last_update = time(NULL);
243 file = f;
244 end_pos = filesize;
245 cur_pos = 0;
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000246 counter = ctr;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000247 stalled = 0;
248 bytes_per_second = 0;
249
Damien Miller05656962005-06-16 13:18:04 +1000250 setscreensize();
Darren Tucker06ef75b2003-08-02 23:28:38 +1000251 if (can_output())
252 refresh_progress_meter();
253
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000254 signal(SIGALRM, update_progress_meter);
Damien Miller05656962005-06-16 13:18:04 +1000255 signal(SIGWINCH, sig_winch);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000256 alarm(UPDATE_INTERVAL);
Damien Miller6fd00e02003-01-10 21:46:02 +1100257}
258
259void
Damien Miller2b92d322003-06-11 22:05:06 +1000260stop_progress_meter(void)
Damien Miller6fd00e02003-01-10 21:46:02 +1100261{
262 alarm(0);
Damien Miller6fd00e02003-01-10 21:46:02 +1100263
Darren Tucker06ef75b2003-08-02 23:28:38 +1000264 if (!can_output())
Damien Miller6fd00e02003-01-10 21:46:02 +1100265 return;
266
Darren Tucker06ef75b2003-08-02 23:28:38 +1000267 /* Ensure we complete the progress */
268 if (cur_pos != end_pos)
269 refresh_progress_meter();
Damien Miller6fd00e02003-01-10 21:46:02 +1100270
Darren Tucker06ef75b2003-08-02 23:28:38 +1000271 atomicio(vwrite, STDOUT_FILENO, "\n", 1);
Damien Miller6fd00e02003-01-10 21:46:02 +1100272}
Damien Miller05656962005-06-16 13:18:04 +1000273
274static void
275sig_winch(int sig)
276{
277 win_resized = 1;
278}
279
280static void
281setscreensize(void)
282{
283 struct winsize winsize;
284
285 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
286 winsize.ws_col != 0) {
287 if (winsize.ws_col > MAX_WINSIZE)
288 win_size = MAX_WINSIZE;
289 else
290 win_size = winsize.ws_col;
291 } else
292 win_size = DEFAULT_WINSIZE;
293 win_size += 1; /* trailing \0 */
294}