1 /* $OpenBSD: progressmeter.c,v 1.50 2020/01/23 07:10:22 dtucker Exp $ */
2 /*
3 * Copyright (c) 2003 Nils Nordman. All rights reserved.
4 *
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
26 #include "includes.h"
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 <stdarg.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <time.h>
38 #include <unistd.h>
39
40 #include "progressmeter.h"
41 #include "atomicio.h"
42 #include "misc.h"
43 #include "utf8.h"
44
45 #define DEFAULT_WINSIZE 80
46 #define MAX_WINSIZE 512
47 #define PADDING 1 /* padding between the progress indicators */
48 #define UPDATE_INTERVAL 1 /* update the progress meter every second */
49 #define STALL_TIME 5 /* we're stalled after this many seconds */
50
51 /* determines whether we can output to the terminal */
52 static int can_output(void);
53
54 /* formats and inserts the specified size into the given buffer */
55 static void format_size(char *, int, off_t);
56 static void format_rate(char *, int, off_t);
57
58 /* window resizing */
59 static void sig_winch(int);
60 static void setscreensize(void);
61
62 /* signal handler for updating the progress meter */
63 static void sig_alarm(int);
64
65 static double start; /* start progress */
66 static double last_update; /* last progress update */
67 static const char *file; /* name of the file being transferred */
68 static off_t start_pos; /* initial position of transfer */
69 static off_t end_pos; /* ending position of transfer */
70 static off_t cur_pos; /* transfer position as of last refresh */
71 static volatile off_t *counter; /* progress counter */
72 static long stalled; /* how long we have been stalled */
73 static int bytes_per_second; /* current speed in bytes per second */
74 static int win_size; /* terminal window size */
75 static volatile sig_atomic_t win_resized; /* for window resizing */
76 static volatile sig_atomic_t alarm_fired;
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(int force_update)120 refresh_progress_meter(int force_update)
121 {
122 char buf[MAX_WINSIZE + 1];
123 off_t transferred;
124 double elapsed, now;
125 int percent;
126 off_t bytes_left;
127 int cur_speed;
128 int hours, minutes, seconds;
129 int file_len;
130
131 if ((!force_update && !alarm_fired && !win_resized) || !can_output())
132 return;
133 alarm_fired = 0;
134
135 if (win_resized) {
136 setscreensize();
137 win_resized = 0;
138 }
139
140 transferred = *counter - (cur_pos ? cur_pos : start_pos);
141 cur_pos = *counter;
142 now = monotime_double();
143 bytes_left = end_pos - cur_pos;
144
145 if (bytes_left > 0)
146 elapsed = now - last_update;
147 else {
148 elapsed = now - start;
149 /* Calculate true total speed when done */
150 transferred = end_pos - start_pos;
151 bytes_per_second = 0;
152 }
153
154 /* calculate speed */
155 if (elapsed != 0)
156 cur_speed = (transferred / elapsed);
157 else
158 cur_speed = transferred;
159
160 #define AGE_FACTOR 0.9
161 if (bytes_per_second != 0) {
162 bytes_per_second = (bytes_per_second * AGE_FACTOR) +
163 (cur_speed * (1.0 - AGE_FACTOR));
164 } else
165 bytes_per_second = cur_speed;
166
167 /* filename */
168 buf[0] = '\0';
169 file_len = win_size - 36;
170 if (file_len > 0) {
171 buf[0] = '\r';
172 snmprintf(buf+1, sizeof(buf)-1, &file_len, "%-*s",
173 file_len, file);
174 }
175
176 /* percent of transfer done */
177 if (end_pos == 0 || cur_pos == end_pos)
178 percent = 100;
179 else
180 percent = ((float)cur_pos / end_pos) * 100;
181 snprintf(buf + strlen(buf), win_size - strlen(buf),
182 " %3d%% ", percent);
183
184 /* amount transferred */
185 format_size(buf + strlen(buf), win_size - strlen(buf),
186 cur_pos);
187 strlcat(buf, " ", win_size);
188
189 /* bandwidth usage */
190 format_rate(buf + strlen(buf), win_size - strlen(buf),
191 (off_t)bytes_per_second);
192 strlcat(buf, "/s ", win_size);
193
194 /* ETA */
195 if (!transferred)
196 stalled += elapsed;
197 else
198 stalled = 0;
199
200 if (stalled >= STALL_TIME)
201 strlcat(buf, "- stalled -", win_size);
202 else if (bytes_per_second == 0 && bytes_left)
203 strlcat(buf, " --:-- ETA", win_size);
204 else {
205 if (bytes_left > 0)
206 seconds = bytes_left / bytes_per_second;
207 else
208 seconds = elapsed;
209
210 hours = seconds / 3600;
211 seconds -= hours * 3600;
212 minutes = seconds / 60;
213 seconds -= minutes * 60;
214
215 if (hours != 0)
216 snprintf(buf + strlen(buf), win_size - strlen(buf),
217 "%d:%02d:%02d", hours, minutes, seconds);
218 else
219 snprintf(buf + strlen(buf), win_size - strlen(buf),
220 " %02d:%02d", minutes, seconds);
221
222 if (bytes_left > 0)
223 strlcat(buf, " ETA", win_size);
224 else
225 strlcat(buf, " ", win_size);
226 }
227
228 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
229 last_update = now;
230 }
231
232 /*ARGSUSED*/
233 static void
sig_alarm(int ignore)234 sig_alarm(int ignore)
235 {
236 alarm_fired = 1;
237 alarm(UPDATE_INTERVAL);
238 }
239
240 void
start_progress_meter(const char * f,off_t filesize,off_t * ctr)241 start_progress_meter(const char *f, off_t filesize, off_t *ctr)
242 {
243 start = last_update = monotime_double();
244 file = f;
245 start_pos = *ctr;
246 end_pos = filesize;
247 cur_pos = 0;
248 counter = ctr;
249 stalled = 0;
250 bytes_per_second = 0;
251
252 setscreensize();
253 refresh_progress_meter(1);
254
255 ssh_signal(SIGALRM, sig_alarm);
256 ssh_signal(SIGWINCH, sig_winch);
257 alarm(UPDATE_INTERVAL);
258 }
259
260 void
stop_progress_meter(void)261 stop_progress_meter(void)
262 {
263 alarm(0);
264
265 if (!can_output())
266 return;
267
268 /* Ensure we complete the progress */
269 if (cur_pos != end_pos)
270 refresh_progress_meter(1);
271
272 atomicio(vwrite, STDOUT_FILENO, "\n", 1);
273 }
274
275 /*ARGSUSED*/
276 static void
sig_winch(int sig)277 sig_winch(int sig)
278 {
279 win_resized = 1;
280 }
281
282 static void
setscreensize(void)283 setscreensize(void)
284 {
285 struct winsize winsize;
286
287 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
288 winsize.ws_col != 0) {
289 if (winsize.ws_col > MAX_WINSIZE)
290 win_size = MAX_WINSIZE;
291 else
292 win_size = winsize.ws_col;
293 } else
294 win_size = DEFAULT_WINSIZE;
295 win_size += 1; /* trailing \0 */
296 }
297