blob: bbbc7066bcb7c0c49e802b40417bfce9b500033d [file] [log] [blame]
Darren Tucker5d80e452013-10-10 10:25:09 +11001/* $OpenBSD: progressmeter.c,v 1.40 2013/09/19 00:24:52 djm 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 Millerd7834352006-08-05 12:39:39 +100030#include <sys/uio.h>
Damien Miller6fd00e02003-01-10 21:46:02 +110031
Darren Tucker39972492006-07-12 22:22:46 +100032#include <errno.h>
Damien Miller6ff3cad2006-03-15 11:52:09 +110033#include <signal.h>
Damien Millera7a73ee2006-08-05 11:37:59 +100034#include <stdio.h>
Damien Millere3476ed2006-07-24 14:13:33 +100035#include <string.h>
Damien Miller5598b4f2006-07-24 14:09:40 +100036#include <time.h>
Damien Millere6b3b612006-07-24 14:01:23 +100037#include <unistd.h>
Damien Miller6ff3cad2006-03-15 11:52:09 +110038
Damien Miller71a51412003-01-14 22:23:23 +110039#include "progressmeter.h"
Darren Tucker06ef75b2003-08-02 23:28:38 +100040#include "atomicio.h"
Damien Miller0cbb9de2003-06-04 22:56:15 +100041#include "misc.h"
Damien Miller6fd00e02003-01-10 21:46:02 +110042
Darren Tucker06ef75b2003-08-02 23:28:38 +100043#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 */
Damien Miller6fd00e02003-01-10 21:46:02 +110048
Darren Tucker06ef75b2003-08-02 23:28:38 +100049/* determines whether we can output to the terminal */
50static int can_output(void);
51
52/* formats and inserts the specified size into the given buffer */
53static void format_size(char *, int, off_t);
54static void format_rate(char *, int, off_t);
55
Damien Miller05656962005-06-16 13:18:04 +100056/* window resizing */
57static void sig_winch(int);
58static void setscreensize(void);
59
Darren Tucker06ef75b2003-08-02 23:28:38 +100060/* updates the progressmeter to reflect the current state of the transfer */
61void refresh_progress_meter(void);
62
63/* signal handler for updating the progress meter */
Damien Miller6fd00e02003-01-10 21:46:02 +110064static void update_progress_meter(int);
65
Darren Tuckerfc959702004-07-17 16:12:08 +100066static time_t start; /* start progress */
67static time_t last_update; /* last progress update */
68static char *file; /* name of the file being transferred */
Darren Tucker5d80e452013-10-10 10:25:09 +110069static off_t start_pos; /* initial position of transfer */
Darren Tuckerfc959702004-07-17 16:12:08 +100070static off_t end_pos; /* ending position of transfer */
71static off_t cur_pos; /* transfer position as of last refresh */
Darren Tucker06ef75b2003-08-02 23:28:38 +100072static volatile off_t *counter; /* progress counter */
Darren Tuckerfc959702004-07-17 16:12:08 +100073static long stalled; /* how long we have been stalled */
74static int bytes_per_second; /* current speed in bytes per second */
75static int win_size; /* terminal window size */
Damien Miller05656962005-06-16 13:18:04 +100076static volatile sig_atomic_t win_resized; /* for window resizing */
Damien Miller6fd00e02003-01-10 21:46:02 +110077
Darren Tucker06ef75b2003-08-02 23:28:38 +100078/* units for format_size */
79static const char unit[] = " KMGT";
Damien Miller6fd00e02003-01-10 21:46:02 +110080
Darren Tucker06ef75b2003-08-02 23:28:38 +100081static int
82can_output(void)
83{
84 return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
85}
Damien Miller6fd00e02003-01-10 21:46:02 +110086
Darren Tucker06ef75b2003-08-02 23:28:38 +100087static void
88format_rate(char *buf, int size, off_t bytes)
89{
90 int i;
Damien Miller6fd00e02003-01-10 21:46:02 +110091
Darren Tucker06ef75b2003-08-02 23:28:38 +100092 bytes *= 100;
93 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
94 bytes = (bytes + 512) / 1024;
95 if (i == 0) {
96 i++;
97 bytes = (bytes + 512) / 1024;
98 }
99 snprintf(buf, size, "%3lld.%1lld%c%s",
Darren Tuckere0be3042005-11-25 14:44:55 +1100100 (long long) (bytes + 5) / 100,
101 (long long) (bytes + 5) / 10 % 10,
Darren Tucker06ef75b2003-08-02 23:28:38 +1000102 unit[i],
103 i ? "B" : " ");
104}
Damien Miller6fd00e02003-01-10 21:46:02 +1100105
Darren Tucker06ef75b2003-08-02 23:28:38 +1000106static void
107format_size(char *buf, int size, off_t bytes)
108{
109 int i;
Damien Miller6fd00e02003-01-10 21:46:02 +1100110
Darren Tucker06ef75b2003-08-02 23:28:38 +1000111 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
112 bytes = (bytes + 512) / 1024;
113 snprintf(buf, size, "%4lld%c%s",
Darren Tuckere0be3042005-11-25 14:44:55 +1100114 (long long) bytes,
Darren Tucker06ef75b2003-08-02 23:28:38 +1000115 unit[i],
116 i ? "B" : " ");
117}
Damien Miller6fd00e02003-01-10 21:46:02 +1100118
119void
Darren Tucker06ef75b2003-08-02 23:28:38 +1000120refresh_progress_meter(void)
Damien Miller6fd00e02003-01-10 21:46:02 +1100121{
Darren Tucker06ef75b2003-08-02 23:28:38 +1000122 char buf[MAX_WINSIZE + 1];
123 time_t now;
124 off_t transferred;
125 double elapsed;
126 int percent;
Darren Tucker7f73a492004-02-06 16:41:37 +1100127 off_t bytes_left;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000128 int cur_speed;
129 int hours, minutes, seconds;
130 int i, len;
131 int file_len;
Damien Miller6fd00e02003-01-10 21:46:02 +1100132
Darren Tucker5d80e452013-10-10 10:25:09 +1100133 transferred = *counter - (cur_pos ? cur_pos : start_pos);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000134 cur_pos = *counter;
Darren Tuckerb759c9c2013-06-02 07:46:16 +1000135 now = monotime();
Darren Tucker06ef75b2003-08-02 23:28:38 +1000136 bytes_left = end_pos - cur_pos;
Damien Miller6fd00e02003-01-10 21:46:02 +1100137
Darren Tucker06ef75b2003-08-02 23:28:38 +1000138 if (bytes_left > 0)
139 elapsed = now - last_update;
Darren Tucker1fb04252003-12-09 19:07:13 +1100140 else {
Darren Tucker06ef75b2003-08-02 23:28:38 +1000141 elapsed = now - start;
Darren Tucker1fb04252003-12-09 19:07:13 +1100142 /* Calculate true total speed when done */
Darren Tucker5d80e452013-10-10 10:25:09 +1100143 transferred = end_pos - start_pos;
Darren Tucker1fb04252003-12-09 19:07:13 +1100144 bytes_per_second = 0;
145 }
Darren Tucker06ef75b2003-08-02 23:28:38 +1000146
147 /* calculate speed */
148 if (elapsed != 0)
149 cur_speed = (transferred / elapsed);
150 else
Darren Tucker1fb04252003-12-09 19:07:13 +1100151 cur_speed = transferred;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000152
153#define AGE_FACTOR 0.9
154 if (bytes_per_second != 0) {
155 bytes_per_second = (bytes_per_second * AGE_FACTOR) +
156 (cur_speed * (1.0 - AGE_FACTOR));
157 } else
158 bytes_per_second = cur_speed;
159
160 /* filename */
161 buf[0] = '\0';
162 file_len = win_size - 35;
163 if (file_len > 0) {
Damien Miller17af1762003-09-02 22:53:01 +1000164 len = snprintf(buf, file_len + 1, "\r%s", file);
Damien Millerb5829f52003-09-02 22:53:32 +1000165 if (len < 0)
166 len = 0;
Damien Miller41bfc292005-05-26 12:07:32 +1000167 if (len >= file_len + 1)
168 len = file_len;
Damien Miller4dec5d72006-08-05 11:38:40 +1000169 for (i = len; i < file_len; i++)
Darren Tucker06ef75b2003-08-02 23:28:38 +1000170 buf[i] = ' ';
171 buf[file_len] = '\0';
172 }
173
174 /* percent of transfer done */
175 if (end_pos != 0)
176 percent = ((float)cur_pos / end_pos) * 100;
177 else
178 percent = 100;
179 snprintf(buf + strlen(buf), win_size - strlen(buf),
180 " %3d%% ", percent);
181
182 /* amount transferred */
183 format_size(buf + strlen(buf), win_size - strlen(buf),
184 cur_pos);
185 strlcat(buf, " ", win_size);
186
187 /* bandwidth usage */
188 format_rate(buf + strlen(buf), win_size - strlen(buf),
Darren Tucker1f8311c2004-05-13 16:39:33 +1000189 (off_t)bytes_per_second);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000190 strlcat(buf, "/s ", win_size);
191
192 /* ETA */
193 if (!transferred)
194 stalled += elapsed;
195 else
196 stalled = 0;
197
198 if (stalled >= STALL_TIME)
199 strlcat(buf, "- stalled -", win_size);
200 else if (bytes_per_second == 0 && bytes_left)
201 strlcat(buf, " --:-- ETA", win_size);
202 else {
203 if (bytes_left > 0)
204 seconds = bytes_left / bytes_per_second;
205 else
206 seconds = elapsed;
207
208 hours = seconds / 3600;
209 seconds -= hours * 3600;
210 minutes = seconds / 60;
211 seconds -= minutes * 60;
212
213 if (hours != 0)
214 snprintf(buf + strlen(buf), win_size - strlen(buf),
215 "%d:%02d:%02d", hours, minutes, seconds);
216 else
217 snprintf(buf + strlen(buf), win_size - strlen(buf),
218 " %02d:%02d", minutes, seconds);
219
220 if (bytes_left > 0)
221 strlcat(buf, " ETA", win_size);
222 else
223 strlcat(buf, " ", win_size);
224 }
225
Darren Tucker6cc310b2003-10-02 16:15:15 +1000226 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000227 last_update = now;
228}
229
Damien Milleree0d0db2006-07-24 14:08:50 +1000230/*ARGSUSED*/
Darren Tucker06ef75b2003-08-02 23:28:38 +1000231static void
232update_progress_meter(int ignore)
233{
234 int save_errno;
235
236 save_errno = errno;
237
Damien Miller05656962005-06-16 13:18:04 +1000238 if (win_resized) {
239 setscreensize();
240 win_resized = 0;
241 }
Darren Tucker06ef75b2003-08-02 23:28:38 +1000242 if (can_output())
243 refresh_progress_meter();
244
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000245 signal(SIGALRM, update_progress_meter);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000246 alarm(UPDATE_INTERVAL);
247 errno = save_errno;
248}
249
250void
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000251start_progress_meter(char *f, off_t filesize, off_t *ctr)
Darren Tucker06ef75b2003-08-02 23:28:38 +1000252{
Darren Tuckerb759c9c2013-06-02 07:46:16 +1000253 start = last_update = monotime();
Darren Tucker06ef75b2003-08-02 23:28:38 +1000254 file = f;
Darren Tucker5d80e452013-10-10 10:25:09 +1100255 start_pos = *ctr;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000256 end_pos = filesize;
257 cur_pos = 0;
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000258 counter = ctr;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000259 stalled = 0;
260 bytes_per_second = 0;
261
Damien Miller05656962005-06-16 13:18:04 +1000262 setscreensize();
Darren Tucker06ef75b2003-08-02 23:28:38 +1000263 if (can_output())
264 refresh_progress_meter();
265
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000266 signal(SIGALRM, update_progress_meter);
Damien Miller05656962005-06-16 13:18:04 +1000267 signal(SIGWINCH, sig_winch);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000268 alarm(UPDATE_INTERVAL);
Damien Miller6fd00e02003-01-10 21:46:02 +1100269}
270
271void
Damien Miller2b92d322003-06-11 22:05:06 +1000272stop_progress_meter(void)
Damien Miller6fd00e02003-01-10 21:46:02 +1100273{
274 alarm(0);
Damien Miller6fd00e02003-01-10 21:46:02 +1100275
Darren Tucker06ef75b2003-08-02 23:28:38 +1000276 if (!can_output())
Damien Miller6fd00e02003-01-10 21:46:02 +1100277 return;
278
Darren Tucker06ef75b2003-08-02 23:28:38 +1000279 /* Ensure we complete the progress */
280 if (cur_pos != end_pos)
281 refresh_progress_meter();
Damien Miller6fd00e02003-01-10 21:46:02 +1100282
Darren Tucker06ef75b2003-08-02 23:28:38 +1000283 atomicio(vwrite, STDOUT_FILENO, "\n", 1);
Damien Miller6fd00e02003-01-10 21:46:02 +1100284}
Damien Miller05656962005-06-16 13:18:04 +1000285
Damien Millerf0b15df2006-03-26 13:59:20 +1100286/*ARGSUSED*/
Damien Miller05656962005-06-16 13:18:04 +1000287static void
288sig_winch(int sig)
289{
290 win_resized = 1;
291}
292
293static void
294setscreensize(void)
295{
296 struct winsize winsize;
297
298 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
299 winsize.ws_col != 0) {
300 if (winsize.ws_col > MAX_WINSIZE)
301 win_size = MAX_WINSIZE;
302 else
303 win_size = winsize.ws_col;
304 } else
305 win_size = DEFAULT_WINSIZE;
306 win_size += 1; /* trailing \0 */
307}