1 /* $OpenBSD: progressmeter.c,v 1.37 2006/08/03 03:34:42 deraadt Exp $ */
2 /*
3 * Copyright © 2013
4 * Thorsten “mirabilos” Glaser <tg@mirbsd.org>
5 * Copyright (c) 2003 Nils Nordman. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #include <sys/types.h>
29 #include <sys/ioctl.h>
30 #include <sys/uio.h>
31
32 #include <errno.h>
33 #include <signal.h>
34 #include <stdio.h>
35 #include <string.h>
36 #include <time.h>
37 #include <unistd.h>
38
39 #include "progressmeter.h"
40 #include "atomicio.h"
41
42 __RCSID("$MirOS: src/usr.bin/ssh/progressmeter.c,v 1.5 2013/10/31 20:07:12 tg Exp $");
43
44 #define DEFAULT_WINSIZE 80
45 #define MAX_WINSIZE 512
46 #define PADDING 1 /* padding between the progress indicators */
47 #define UPDATE_INTERVAL 1 /* update the progress meter every second */
48 #define STALL_TIME 5 /* we're stalled after this many seconds */
49
50 /* determines whether we can output to the terminal */
51 static int can_output(void);
52
53 /* formats and inserts the specified size into the given buffer */
54 static void format_size(char *, int, off_t);
55 static void format_rate(char *, int, off_t);
56
57 /* window resizing */
58 static void sig_winch(int);
59 static void setscreensize(void);
60
61 /* updates the progressmeter to reflect the current state of the transfer */
62 void refresh_progress_meter(void);
63
64 /* signal handler for updating the progress meter */
65 static void update_progress_meter(int);
66
67 static time_t start; /* start progress */
68 static time_t last_update; /* last progress update */
69 static char *file; /* name of the file being transferred */
70 static off_t end_pos; /* ending position of transfer */
71 static off_t cur_pos; /* transfer position as of last refresh */
72 static volatile off_t *counter; /* progress counter */
73 static long stalled; /* how long we have been stalled */
74 static int bytes_per_second; /* current speed in bytes per second */
75 static int win_size; /* terminal window size */
76 static volatile sig_atomic_t win_resized; /* for window resizing */
77
78 /* units for format_size */
79 static const char unit[] = " KMGT";
80
81 static int
can_output(void)82 can_output(void)
83 {
84 return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
85 }
86
87 static void
format_rate(char * buf,int size,off_t bytes)88 format_rate(char *buf, int size, off_t bytes)
89 {
90 int i;
91
92 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",
100 (long long) (bytes + 5) / 100,
101 (long long) (bytes + 5) / 10 % 10,
102 unit[i],
103 i ? "B" : " ");
104 }
105
106 static void
format_size(char * buf,int size,off_t bytes)107 format_size(char *buf, int size, off_t bytes)
108 {
109 int i;
110
111 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
112 bytes = (bytes + 512) / 1024;
113 snprintf(buf, size, "%4lld%c%s",
114 (long long) bytes,
115 unit[i],
116 i ? "B" : " ");
117 }
118
119 void
refresh_progress_meter(void)120 refresh_progress_meter(void)
121 {
122 char buf[MAX_WINSIZE + 1];
123 time_t now;
124 off_t transferred;
125 double elapsed;
126 int percent;
127 off_t bytes_left;
128 int cur_speed;
129 int hours, minutes, seconds;
130 int i, len;
131 int file_len;
132
133 transferred = *counter - cur_pos;
134 cur_pos = *counter;
135 now = time(NULL);
136 bytes_left = end_pos - cur_pos;
137
138 if (bytes_left > 0)
139 elapsed = now - last_update;
140 else {
141 elapsed = now - start;
142 /* Calculate true total speed when done */
143 transferred = end_pos;
144 bytes_per_second = 0;
145 }
146
147 /* calculate speed */
148 if (elapsed != 0)
149 cur_speed = (transferred / elapsed);
150 else
151 cur_speed = transferred;
152
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) {
164 len = snprintf(buf, file_len + 1, "\r%s", file);
165 if (len < 0)
166 len = 0;
167 if (len >= file_len + 1)
168 len = file_len;
169 for (i = len; i < file_len; i++)
170 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),
189 (off_t)bytes_per_second);
190 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
226 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
227 last_update = now;
228 }
229
230 /*ARGSUSED*/
231 static void
update_progress_meter(int ignore)232 update_progress_meter(int ignore __attribute__((__unused__)))
233 {
234 int save_errno;
235
236 save_errno = errno;
237
238 if (win_resized) {
239 setscreensize();
240 win_resized = 0;
241 }
242 if (can_output())
243 refresh_progress_meter();
244
245 signal(SIGALRM, update_progress_meter);
246 alarm(UPDATE_INTERVAL);
247 errno = save_errno;
248 }
249
250 void
start_progress_meter(char * f,off_t filesize,off_t * ctr)251 start_progress_meter(char *f, off_t filesize, off_t *ctr)
252 {
253 start = last_update = time(NULL);
254 file = f;
255 end_pos = filesize;
256 cur_pos = 0;
257 counter = ctr;
258 stalled = 0;
259 bytes_per_second = 0;
260
261 setscreensize();
262 if (can_output())
263 refresh_progress_meter();
264
265 signal(SIGALRM, update_progress_meter);
266 signal(SIGWINCH, sig_winch);
267 alarm(UPDATE_INTERVAL);
268 }
269
270 void
stop_progress_meter(void)271 stop_progress_meter(void)
272 {
273 alarm(0);
274
275 if (!can_output())
276 return;
277
278 /* Ensure we complete the progress */
279 if (cur_pos != end_pos)
280 refresh_progress_meter();
281
282 atomicio(vwrite, STDOUT_FILENO, (char *)"\n", 1);
283 }
284
285 /*ARGSUSED*/
286 static void
sig_winch(int sig)287 sig_winch(int sig __attribute__((__unused__)))
288 {
289 win_resized = 1;
290 }
291
292 static void
setscreensize(void)293 setscreensize(void)
294 {
295 struct winsize winsize;
296
297 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
298 winsize.ws_col != 0) {
299 if (winsize.ws_col > MAX_WINSIZE)
300 win_size = MAX_WINSIZE;
301 else
302 win_size = winsize.ws_col;
303 } else
304 win_size = DEFAULT_WINSIZE;
305 win_size += 1; /* trailing \0 */
306 }
307