blob: 3cda090616f15fd22524ee668d5e57b6a23ccf00 [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 Miller05656962005-06-16 13:18:04 +100026RCSID("$OpenBSD: progressmeter.c,v 1.24 2005/06/07 13:25:23 jaredy Exp $");
Damien Miller6fd00e02003-01-10 21:46:02 +110027
Damien Miller71a51412003-01-14 22:23:23 +110028#include "progressmeter.h"
Darren Tucker06ef75b2003-08-02 23:28:38 +100029#include "atomicio.h"
Damien Miller0cbb9de2003-06-04 22:56:15 +100030#include "misc.h"
Damien Miller6fd00e02003-01-10 21:46:02 +110031
Darren Tucker06ef75b2003-08-02 23:28:38 +100032#define DEFAULT_WINSIZE 80
33#define MAX_WINSIZE 512
34#define PADDING 1 /* padding between the progress indicators */
35#define UPDATE_INTERVAL 1 /* update the progress meter every second */
36#define STALL_TIME 5 /* we're stalled after this many seconds */
Damien Miller6fd00e02003-01-10 21:46:02 +110037
Darren Tucker06ef75b2003-08-02 23:28:38 +100038/* determines whether we can output to the terminal */
39static int can_output(void);
40
41/* formats and inserts the specified size into the given buffer */
42static void format_size(char *, int, off_t);
43static void format_rate(char *, int, off_t);
44
Damien Miller05656962005-06-16 13:18:04 +100045/* window resizing */
46static void sig_winch(int);
47static void setscreensize(void);
48
Darren Tucker06ef75b2003-08-02 23:28:38 +100049/* updates the progressmeter to reflect the current state of the transfer */
50void refresh_progress_meter(void);
51
52/* signal handler for updating the progress meter */
Damien Miller6fd00e02003-01-10 21:46:02 +110053static void update_progress_meter(int);
54
Darren Tuckerfc959702004-07-17 16:12:08 +100055static time_t start; /* start progress */
56static time_t last_update; /* last progress update */
57static char *file; /* name of the file being transferred */
58static off_t end_pos; /* ending position of transfer */
59static off_t cur_pos; /* transfer position as of last refresh */
Darren Tucker06ef75b2003-08-02 23:28:38 +100060static volatile off_t *counter; /* progress counter */
Darren Tuckerfc959702004-07-17 16:12:08 +100061static long stalled; /* how long we have been stalled */
62static int bytes_per_second; /* current speed in bytes per second */
63static int win_size; /* terminal window size */
Damien Miller05656962005-06-16 13:18:04 +100064static volatile sig_atomic_t win_resized; /* for window resizing */
Damien Miller6fd00e02003-01-10 21:46:02 +110065
Darren Tucker06ef75b2003-08-02 23:28:38 +100066/* units for format_size */
67static const char unit[] = " KMGT";
Damien Miller6fd00e02003-01-10 21:46:02 +110068
Darren Tucker06ef75b2003-08-02 23:28:38 +100069static int
70can_output(void)
71{
72 return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
73}
Damien Miller6fd00e02003-01-10 21:46:02 +110074
Darren Tucker06ef75b2003-08-02 23:28:38 +100075static void
76format_rate(char *buf, int size, off_t bytes)
77{
78 int i;
Damien Miller6fd00e02003-01-10 21:46:02 +110079
Darren Tucker06ef75b2003-08-02 23:28:38 +100080 bytes *= 100;
81 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
82 bytes = (bytes + 512) / 1024;
83 if (i == 0) {
84 i++;
85 bytes = (bytes + 512) / 1024;
86 }
87 snprintf(buf, size, "%3lld.%1lld%c%s",
Damien Miller8c5e91c2003-11-21 23:09:10 +110088 (int64_t) (bytes + 5) / 100,
Darren Tucker06ef75b2003-08-02 23:28:38 +100089 (int64_t) (bytes + 5) / 10 % 10,
90 unit[i],
91 i ? "B" : " ");
92}
Damien Miller6fd00e02003-01-10 21:46:02 +110093
Darren Tucker06ef75b2003-08-02 23:28:38 +100094static void
95format_size(char *buf, int size, off_t bytes)
96{
97 int i;
Damien Miller6fd00e02003-01-10 21:46:02 +110098
Darren Tucker06ef75b2003-08-02 23:28:38 +100099 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
100 bytes = (bytes + 512) / 1024;
101 snprintf(buf, size, "%4lld%c%s",
102 (int64_t) bytes,
103 unit[i],
104 i ? "B" : " ");
105}
Damien Miller6fd00e02003-01-10 21:46:02 +1100106
107void
Darren Tucker06ef75b2003-08-02 23:28:38 +1000108refresh_progress_meter(void)
Damien Miller6fd00e02003-01-10 21:46:02 +1100109{
Darren Tucker06ef75b2003-08-02 23:28:38 +1000110 char buf[MAX_WINSIZE + 1];
111 time_t now;
112 off_t transferred;
113 double elapsed;
114 int percent;
Darren Tucker7f73a492004-02-06 16:41:37 +1100115 off_t bytes_left;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000116 int cur_speed;
117 int hours, minutes, seconds;
118 int i, len;
119 int file_len;
Damien Miller6fd00e02003-01-10 21:46:02 +1100120
Darren Tucker06ef75b2003-08-02 23:28:38 +1000121 transferred = *counter - cur_pos;
122 cur_pos = *counter;
123 now = time(NULL);
124 bytes_left = end_pos - cur_pos;
Damien Miller6fd00e02003-01-10 21:46:02 +1100125
Darren Tucker06ef75b2003-08-02 23:28:38 +1000126 if (bytes_left > 0)
127 elapsed = now - last_update;
Darren Tucker1fb04252003-12-09 19:07:13 +1100128 else {
Darren Tucker06ef75b2003-08-02 23:28:38 +1000129 elapsed = now - start;
Darren Tucker1fb04252003-12-09 19:07:13 +1100130 /* Calculate true total speed when done */
131 transferred = end_pos;
132 bytes_per_second = 0;
133 }
Darren Tucker06ef75b2003-08-02 23:28:38 +1000134
135 /* calculate speed */
136 if (elapsed != 0)
137 cur_speed = (transferred / elapsed);
138 else
Darren Tucker1fb04252003-12-09 19:07:13 +1100139 cur_speed = transferred;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000140
141#define AGE_FACTOR 0.9
142 if (bytes_per_second != 0) {
143 bytes_per_second = (bytes_per_second * AGE_FACTOR) +
144 (cur_speed * (1.0 - AGE_FACTOR));
145 } else
146 bytes_per_second = cur_speed;
147
148 /* filename */
149 buf[0] = '\0';
150 file_len = win_size - 35;
151 if (file_len > 0) {
Damien Miller17af1762003-09-02 22:53:01 +1000152 len = snprintf(buf, file_len + 1, "\r%s", file);
Damien Millerb5829f52003-09-02 22:53:32 +1000153 if (len < 0)
154 len = 0;
Damien Miller41bfc292005-05-26 12:07:32 +1000155 if (len >= file_len + 1)
156 len = file_len;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000157 for (i = len; i < file_len; i++ )
158 buf[i] = ' ';
159 buf[file_len] = '\0';
160 }
161
162 /* percent of transfer done */
163 if (end_pos != 0)
164 percent = ((float)cur_pos / end_pos) * 100;
165 else
166 percent = 100;
167 snprintf(buf + strlen(buf), win_size - strlen(buf),
168 " %3d%% ", percent);
169
170 /* amount transferred */
171 format_size(buf + strlen(buf), win_size - strlen(buf),
172 cur_pos);
173 strlcat(buf, " ", win_size);
174
175 /* bandwidth usage */
176 format_rate(buf + strlen(buf), win_size - strlen(buf),
Darren Tucker1f8311c2004-05-13 16:39:33 +1000177 (off_t)bytes_per_second);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000178 strlcat(buf, "/s ", win_size);
179
180 /* ETA */
181 if (!transferred)
182 stalled += elapsed;
183 else
184 stalled = 0;
185
186 if (stalled >= STALL_TIME)
187 strlcat(buf, "- stalled -", win_size);
188 else if (bytes_per_second == 0 && bytes_left)
189 strlcat(buf, " --:-- ETA", win_size);
190 else {
191 if (bytes_left > 0)
192 seconds = bytes_left / bytes_per_second;
193 else
194 seconds = elapsed;
195
196 hours = seconds / 3600;
197 seconds -= hours * 3600;
198 minutes = seconds / 60;
199 seconds -= minutes * 60;
200
201 if (hours != 0)
202 snprintf(buf + strlen(buf), win_size - strlen(buf),
203 "%d:%02d:%02d", hours, minutes, seconds);
204 else
205 snprintf(buf + strlen(buf), win_size - strlen(buf),
206 " %02d:%02d", minutes, seconds);
207
208 if (bytes_left > 0)
209 strlcat(buf, " ETA", win_size);
210 else
211 strlcat(buf, " ", win_size);
212 }
213
Darren Tucker6cc310b2003-10-02 16:15:15 +1000214 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000215 last_update = now;
216}
217
218static void
219update_progress_meter(int ignore)
220{
221 int save_errno;
222
223 save_errno = errno;
224
Damien Miller05656962005-06-16 13:18:04 +1000225 if (win_resized) {
226 setscreensize();
227 win_resized = 0;
228 }
Darren Tucker06ef75b2003-08-02 23:28:38 +1000229 if (can_output())
230 refresh_progress_meter();
231
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000232 signal(SIGALRM, update_progress_meter);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000233 alarm(UPDATE_INTERVAL);
234 errno = save_errno;
235}
236
237void
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000238start_progress_meter(char *f, off_t filesize, off_t *ctr)
Darren Tucker06ef75b2003-08-02 23:28:38 +1000239{
Darren Tucker06ef75b2003-08-02 23:28:38 +1000240 start = last_update = time(NULL);
241 file = f;
242 end_pos = filesize;
243 cur_pos = 0;
Darren Tucker3f9fdc72004-06-22 12:56:01 +1000244 counter = ctr;
Darren Tucker06ef75b2003-08-02 23:28:38 +1000245 stalled = 0;
246 bytes_per_second = 0;
247
Damien Miller05656962005-06-16 13:18:04 +1000248 setscreensize();
Darren Tucker06ef75b2003-08-02 23:28:38 +1000249 if (can_output())
250 refresh_progress_meter();
251
Ben Lindstrom5ade9ab2003-08-25 01:16:21 +0000252 signal(SIGALRM, update_progress_meter);
Damien Miller05656962005-06-16 13:18:04 +1000253 signal(SIGWINCH, sig_winch);
Darren Tucker06ef75b2003-08-02 23:28:38 +1000254 alarm(UPDATE_INTERVAL);
Damien Miller6fd00e02003-01-10 21:46:02 +1100255}
256
257void
Damien Miller2b92d322003-06-11 22:05:06 +1000258stop_progress_meter(void)
Damien Miller6fd00e02003-01-10 21:46:02 +1100259{
260 alarm(0);
Damien Miller6fd00e02003-01-10 21:46:02 +1100261
Darren Tucker06ef75b2003-08-02 23:28:38 +1000262 if (!can_output())
Damien Miller6fd00e02003-01-10 21:46:02 +1100263 return;
264
Darren Tucker06ef75b2003-08-02 23:28:38 +1000265 /* Ensure we complete the progress */
266 if (cur_pos != end_pos)
267 refresh_progress_meter();
Damien Miller6fd00e02003-01-10 21:46:02 +1100268
Darren Tucker06ef75b2003-08-02 23:28:38 +1000269 atomicio(vwrite, STDOUT_FILENO, "\n", 1);
Damien Miller6fd00e02003-01-10 21:46:02 +1100270}
Damien Miller05656962005-06-16 13:18:04 +1000271
272static void
273sig_winch(int sig)
274{
275 win_resized = 1;
276}
277
278static void
279setscreensize(void)
280{
281 struct winsize winsize;
282
283 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
284 winsize.ws_col != 0) {
285 if (winsize.ws_col > MAX_WINSIZE)
286 win_size = MAX_WINSIZE;
287 else
288 win_size = winsize.ws_col;
289 } else
290 win_size = DEFAULT_WINSIZE;
291 win_size += 1; /* trailing \0 */
292}