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 <sys/types.h> 27 #include <sys/ioctl.h> 28 #include <sys/uio.h> 29 30 #include <errno.h> 31 #include <signal.h> 32 #include <stdarg.h> 33 #include <stdio.h> 34 #include <string.h> 35 #include <time.h> 36 #include <unistd.h> 37 38 #include "progressmeter.h" 39 #include "atomicio.h" 40 #include "misc.h" 41 #include "utf8.h" 42 43 #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 */ 48 49 /* determines whether we can output to the terminal */ 50 static int can_output(void); 51 52 /* formats and inserts the specified size into the given buffer */ 53 static void format_size(char *, int, off_t); 54 static void format_rate(char *, int, off_t); 55 56 /* window resizing */ 57 static void sig_winch(int); 58 static void setscreensize(void); 59 60 /* signal handler for updating the progress meter */ 61 static void sig_alarm(int); 62 63 static double start; /* start progress */ 64 static double last_update; /* last progress update */ 65 static const char *file; /* name of the file being transferred */ 66 static off_t start_pos; /* initial position of transfer */ 67 static off_t end_pos; /* ending position of transfer */ 68 static off_t cur_pos; /* transfer position as of last refresh */ 69 static volatile off_t *counter; /* progress counter */ 70 static long stalled; /* how long we have been stalled */ 71 static int bytes_per_second; /* current speed in bytes per second */ 72 static int win_size; /* terminal window size */ 73 static volatile sig_atomic_t win_resized; /* for window resizing */ 74 static volatile sig_atomic_t alarm_fired; 75 76 /* units for format_size */ 77 static const char unit[] = " KMGT"; 78 79 static int 80 can_output(void) 81 { 82 return (getpgrp() == tcgetpgrp(STDOUT_FILENO)); 83 } 84 85 static void 86 format_rate(char *buf, int size, off_t bytes) 87 { 88 int i; 89 90 bytes *= 100; 91 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++) 92 bytes = (bytes + 512) / 1024; 93 if (i == 0) { 94 i++; 95 bytes = (bytes + 512) / 1024; 96 } 97 snprintf(buf, size, "%3lld.%1lld%c%s", 98 (long long) (bytes + 5) / 100, 99 (long long) (bytes + 5) / 10 % 10, 100 unit[i], 101 i ? "B" : " "); 102 } 103 104 static void 105 format_size(char *buf, int size, off_t bytes) 106 { 107 int i; 108 109 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++) 110 bytes = (bytes + 512) / 1024; 111 snprintf(buf, size, "%4lld%c%s", 112 (long long) bytes, 113 unit[i], 114 i ? "B" : " "); 115 } 116 117 void 118 refresh_progress_meter(int force_update) 119 { 120 char buf[MAX_WINSIZE + 1]; 121 off_t transferred; 122 double elapsed, now; 123 int percent; 124 off_t bytes_left; 125 int cur_speed; 126 int hours, minutes, seconds; 127 int file_len; 128 129 if ((!force_update && !alarm_fired && !win_resized) || !can_output()) 130 return; 131 alarm_fired = 0; 132 133 if (win_resized) { 134 setscreensize(); 135 win_resized = 0; 136 } 137 138 transferred = *counter - (cur_pos ? cur_pos : start_pos); 139 cur_pos = *counter; 140 now = monotime_double(); 141 bytes_left = end_pos - cur_pos; 142 143 if (bytes_left > 0) 144 elapsed = now - last_update; 145 else { 146 elapsed = now - start; 147 /* Calculate true total speed when done */ 148 transferred = end_pos - start_pos; 149 bytes_per_second = 0; 150 } 151 152 /* calculate speed */ 153 if (elapsed != 0) 154 cur_speed = (transferred / elapsed); 155 else 156 cur_speed = transferred; 157 158 #define AGE_FACTOR 0.9 159 if (bytes_per_second != 0) { 160 bytes_per_second = (bytes_per_second * AGE_FACTOR) + 161 (cur_speed * (1.0 - AGE_FACTOR)); 162 } else 163 bytes_per_second = cur_speed; 164 165 /* filename */ 166 buf[0] = '\0'; 167 file_len = win_size - 36; 168 if (file_len > 0) { 169 buf[0] = '\r'; 170 snmprintf(buf+1, sizeof(buf)-1, &file_len, "%-*s", 171 file_len, file); 172 } 173 174 /* percent of transfer done */ 175 if (end_pos == 0 || cur_pos == end_pos) 176 percent = 100; 177 else 178 percent = ((float)cur_pos / end_pos) * 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 232 sig_alarm(int ignore) 233 { 234 alarm_fired = 1; 235 alarm(UPDATE_INTERVAL); 236 } 237 238 void 239 start_progress_meter(const char *f, off_t filesize, off_t *ctr) 240 { 241 start = last_update = monotime_double(); 242 file = f; 243 start_pos = *ctr; 244 end_pos = filesize; 245 cur_pos = 0; 246 counter = ctr; 247 stalled = 0; 248 bytes_per_second = 0; 249 250 setscreensize(); 251 refresh_progress_meter(1); 252 253 ssh_signal(SIGALRM, sig_alarm); 254 ssh_signal(SIGWINCH, sig_winch); 255 alarm(UPDATE_INTERVAL); 256 } 257 258 void 259 stop_progress_meter(void) 260 { 261 alarm(0); 262 263 if (!can_output()) 264 return; 265 266 /* Ensure we complete the progress */ 267 if (cur_pos != end_pos) 268 refresh_progress_meter(1); 269 270 atomicio(vwrite, STDOUT_FILENO, "\n", 1); 271 } 272 273 /*ARGSUSED*/ 274 static void 275 sig_winch(int sig) 276 { 277 win_resized = 1; 278 } 279 280 static void 281 setscreensize(void) 282 { 283 struct winsize winsize; 284 285 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 && 286 winsize.ws_col != 0) { 287 if (winsize.ws_col > MAX_WINSIZE) 288 win_size = MAX_WINSIZE; 289 else 290 win_size = winsize.ws_col; 291 } else 292 win_size = DEFAULT_WINSIZE; 293 win_size += 1; /* trailing \0 */ 294 } 295