1 /* $NetBSD: progressmeter.c,v 1.13 2020/02/27 00:24:40 christos Exp $ */ 2 /* $OpenBSD: progressmeter.c,v 1.50 2020/01/23 07:10:22 dtucker Exp $ */ 3 /* 4 * Copyright (c) 2003 Nils Nordman. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #include "includes.h" 28 __RCSID("$NetBSD: progressmeter.c,v 1.13 2020/02/27 00:24:40 christos Exp $"); 29 #include <sys/types.h> 30 #include <sys/ioctl.h> 31 #include <sys/uio.h> 32 33 #include <errno.h> 34 #include <signal.h> 35 #include <stdarg.h> 36 #include <stdio.h> 37 #include <string.h> 38 #include <time.h> 39 #include <unistd.h> 40 41 #include "progressmeter.h" 42 #include "atomicio.h" 43 #include "misc.h" 44 #include "utf8.h" 45 46 #define DEFAULT_WINSIZE 80 47 #define MAX_WINSIZE 512 48 #define PADDING 1 /* padding between the progress indicators */ 49 #define UPDATE_INTERVAL 1 /* update the progress meter every second */ 50 #define STALL_TIME 5 /* we're stalled after this many seconds */ 51 52 /* determines whether we can output to the terminal */ 53 static int can_output(void); 54 55 /* formats and inserts the specified size into the given buffer */ 56 static void format_size(char *, int, off_t); 57 static void format_rate(char *, int, off_t); 58 59 /* window resizing */ 60 static void sig_winch(int); 61 static void setscreensize(void); 62 63 /* signal handler for updating the progress meter */ 64 static void sig_alarm(int); 65 66 static double start; /* start progress */ 67 static double last_update; /* last progress update */ 68 static const char *file; /* name of the file being transferred */ 69 static off_t start_pos; /* initial position of transfer */ 70 static off_t end_pos; /* ending position of transfer */ 71 static off_t cur_pos; /* transfer position as of last refresh */ 72 static off_t last_pos; 73 static off_t max_delta_pos = 0; 74 static volatile off_t *counter; /* progress counter */ 75 static long stalled; /* how long we have been stalled */ 76 static int bytes_per_second; /* current speed in bytes per second */ 77 static int win_size; /* terminal window size */ 78 static volatile sig_atomic_t win_resized; /* for window resizing */ 79 static volatile sig_atomic_t alarm_fired; 80 81 /* units for format_size */ 82 static const char unit[] = " KMGT"; 83 84 static int 85 can_output(void) 86 { 87 return (getpgrp() == tcgetpgrp(STDOUT_FILENO)); 88 } 89 90 static void 91 format_rate(char *buf, int size, off_t bytes) 92 { 93 int i; 94 95 bytes *= 100; 96 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++) 97 bytes = (bytes + 512) / 1024; 98 if (i == 0) { 99 i++; 100 bytes = (bytes + 512) / 1024; 101 } 102 snprintf(buf, size, "%3lld.%1lld%c%s", 103 (long long) (bytes + 5) / 100, 104 (long long) (bytes + 5) / 10 % 10, 105 unit[i], 106 i ? "B" : " "); 107 } 108 109 static void 110 format_size(char *buf, int size, off_t bytes) 111 { 112 int i; 113 114 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++) 115 bytes = (bytes + 512) / 1024; 116 snprintf(buf, size, "%4lld%c%s", 117 (long long) bytes, 118 unit[i], 119 i ? "B" : " "); 120 } 121 122 void 123 refresh_progress_meter(int force_update) 124 { 125 char buf[MAX_WINSIZE + 1]; 126 off_t transferred; 127 double elapsed, now; 128 int percent; 129 off_t bytes_left; 130 int cur_speed; 131 int hours, minutes, seconds; 132 int file_len; 133 off_t delta_pos; 134 135 if ((!force_update && !alarm_fired && !win_resized) || !can_output()) 136 return; 137 alarm_fired = 0; 138 139 if (win_resized) { 140 setscreensize(); 141 win_resized = 0; 142 } 143 144 transferred = *counter - (cur_pos ? cur_pos : start_pos); 145 cur_pos = *counter; 146 now = monotime_double(); 147 bytes_left = end_pos - cur_pos; 148 149 delta_pos = cur_pos - last_pos; 150 if (delta_pos > max_delta_pos) 151 max_delta_pos = delta_pos; 152 153 if (bytes_left > 0) 154 elapsed = now - last_update; 155 else { 156 elapsed = now - start; 157 /* Calculate true total speed when done */ 158 transferred = end_pos - start_pos; 159 bytes_per_second = 0; 160 } 161 162 /* calculate speed */ 163 if (elapsed != 0) 164 cur_speed = (transferred / elapsed); 165 else 166 cur_speed = transferred; 167 168 #define AGE_FACTOR 0.9 169 if (bytes_per_second != 0) { 170 bytes_per_second = (bytes_per_second * AGE_FACTOR) + 171 (cur_speed * (1.0 - AGE_FACTOR)); 172 } else 173 bytes_per_second = cur_speed; 174 175 /* filename */ 176 buf[0] = '\0'; 177 file_len = win_size - 36; 178 if (file_len > 0) { 179 buf[0] = '\r'; 180 snmprintf(buf+1, sizeof(buf)-1, &file_len, "%-*s", 181 file_len, file); 182 } 183 184 /* percent of transfer done */ 185 if (end_pos == 0 || cur_pos == end_pos) 186 percent = 100; 187 else 188 percent = ((float)cur_pos / end_pos) * 100; 189 snprintf(buf + strlen(buf), win_size - strlen(buf), 190 " %3d%% ", percent); 191 192 /* amount transferred */ 193 format_size(buf + strlen(buf), win_size - strlen(buf), 194 cur_pos); 195 strlcat(buf, " ", win_size); 196 197 /* bandwidth usage */ 198 format_rate(buf + strlen(buf), win_size - strlen(buf), 199 (off_t)bytes_per_second); 200 strlcat(buf, "/s ", win_size); 201 202 /* instantaneous rate */ 203 if (bytes_left > 0) 204 format_rate(buf + strlen(buf), win_size - strlen(buf), 205 delta_pos); 206 else 207 format_rate(buf + strlen(buf), win_size - strlen(buf), 208 max_delta_pos); 209 strlcat(buf, "/s ", win_size); 210 211 /* ETA */ 212 if (!transferred) 213 stalled += elapsed; 214 else 215 stalled = 0; 216 217 if (stalled >= STALL_TIME) 218 strlcat(buf, "- stalled -", win_size); 219 else if (bytes_per_second == 0 && bytes_left) 220 strlcat(buf, " --:-- ETA", win_size); 221 else { 222 if (bytes_left > 0) 223 seconds = bytes_left / bytes_per_second; 224 else 225 seconds = elapsed; 226 227 hours = seconds / 3600; 228 seconds -= hours * 3600; 229 minutes = seconds / 60; 230 seconds -= minutes * 60; 231 232 if (hours != 0) 233 snprintf(buf + strlen(buf), win_size - strlen(buf), 234 "%d:%02d:%02d", hours, minutes, seconds); 235 else 236 snprintf(buf + strlen(buf), win_size - strlen(buf), 237 " %02d:%02d", minutes, seconds); 238 239 if (bytes_left > 0) 240 strlcat(buf, " ETA", win_size); 241 else 242 strlcat(buf, " ", win_size); 243 } 244 245 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1); 246 last_update = now; 247 last_pos = cur_pos; 248 } 249 250 /*ARGSUSED*/ 251 static void 252 sig_alarm(int ignore) 253 { 254 alarm_fired = 1; 255 alarm(UPDATE_INTERVAL); 256 } 257 258 void 259 start_progress_meter(const char *f, off_t filesize, off_t *ctr) 260 { 261 start = last_update = monotime_double(); 262 file = f; 263 start_pos = *ctr; 264 end_pos = filesize; 265 cur_pos = 0; 266 counter = ctr; 267 stalled = 0; 268 bytes_per_second = 0; 269 270 setscreensize(); 271 refresh_progress_meter(1); 272 273 ssh_signal(SIGALRM, sig_alarm); 274 ssh_signal(SIGWINCH, sig_winch); 275 alarm(UPDATE_INTERVAL); 276 } 277 278 void 279 stop_progress_meter(void) 280 { 281 alarm(0); 282 283 if (!can_output()) 284 return; 285 286 /* Ensure we complete the progress */ 287 if (cur_pos != end_pos) 288 refresh_progress_meter(1); 289 290 atomicio(vwrite, STDOUT_FILENO, __UNCONST("\n"), 1); 291 } 292 293 /*ARGSUSED*/ 294 static void 295 sig_winch(int sig) 296 { 297 win_resized = 1; 298 } 299 300 static void 301 setscreensize(void) 302 { 303 struct winsize winsize; 304 305 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 && 306 winsize.ws_col != 0) { 307 if (winsize.ws_col > MAX_WINSIZE) 308 win_size = MAX_WINSIZE; 309 else 310 win_size = winsize.ws_col; 311 } else 312 win_size = DEFAULT_WINSIZE; 313 win_size += 1; /* trailing \0 */ 314 } 315