1 /* $OpenBSD: progressmeter.c,v 1.37 2006/08/03 03:34:42 deraadt 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 <stdio.h> 35 #include <string.h> 36 #include <time.h> 37 #include <unistd.h> 38 39 #include "progressmeter.h" 40 #include "atomicio.h" 41 #include "misc.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 /* updates the progressmeter to reflect the current state of the transfer */ 61 void refresh_progress_meter(void); 62 63 /* signal handler for updating the progress meter */ 64 static void update_progress_meter(int); 65 66 static time_t start; /* start progress */ 67 static time_t last_update; /* last progress update */ 68 static char *file; /* name of the file being transferred */ 69 static off_t end_pos; /* ending position of transfer */ 70 static off_t cur_pos; /* transfer position as of last refresh */ 71 static off_t last_pos; 72 static off_t max_delta_pos = 0; 73 static volatile off_t *counter; /* progress counter */ 74 static long stalled; /* how long we have been stalled */ 75 static int bytes_per_second; /* current speed in bytes per second */ 76 static int win_size; /* terminal window size */ 77 static volatile sig_atomic_t win_resized; /* for window resizing */ 78 79 /* units for format_size */ 80 static const char unit[] = " KMGT"; 81 82 static int 83 can_output(void) 84 { 85 return (getpgrp() == tcgetpgrp(STDOUT_FILENO)); 86 } 87 88 static void 89 format_rate(char *buf, int size, off_t bytes) 90 { 91 int i; 92 93 bytes *= 100; 94 for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++) 95 bytes = (bytes + 512) / 1024; 96 if (i == 0) { 97 i++; 98 bytes = (bytes + 512) / 1024; 99 } 100 snprintf(buf, size, "%3lld.%1lld%c%s", 101 (long long) (bytes + 5) / 100, 102 (long long) (bytes + 5) / 10 % 10, 103 unit[i], 104 i ? "B" : " "); 105 } 106 107 static void 108 format_size(char *buf, int size, off_t bytes) 109 { 110 int i; 111 112 for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++) 113 bytes = (bytes + 512) / 1024; 114 snprintf(buf, size, "%4lld%c%s", 115 (long long) bytes, 116 unit[i], 117 i ? "B" : " "); 118 } 119 120 void 121 refresh_progress_meter(void) 122 { 123 char buf[MAX_WINSIZE + 1]; 124 time_t now; 125 off_t transferred; 126 double elapsed; 127 int percent; 128 off_t bytes_left; 129 int cur_speed; 130 int hours, minutes, seconds; 131 int i, len; 132 int file_len; 133 off_t delta_pos; 134 135 transferred = *counter - cur_pos; 136 cur_pos = *counter; 137 now = time(NULL); 138 bytes_left = end_pos - cur_pos; 139 140 delta_pos = cur_pos - last_pos; 141 if (delta_pos > max_delta_pos) 142 max_delta_pos = delta_pos; 143 144 if (bytes_left > 0) 145 elapsed = now - last_update; 146 else { 147 elapsed = now - start; 148 /* Calculate true total speed when done */ 149 transferred = end_pos; 150 bytes_per_second = 0; 151 } 152 153 /* calculate speed */ 154 if (elapsed != 0) 155 cur_speed = (transferred / elapsed); 156 else 157 cur_speed = transferred; 158 159 #define AGE_FACTOR 0.9 160 if (bytes_per_second != 0) { 161 bytes_per_second = (bytes_per_second * AGE_FACTOR) + 162 (cur_speed * (1.0 - AGE_FACTOR)); 163 } else 164 bytes_per_second = cur_speed; 165 166 /* filename */ 167 buf[0] = '\0'; 168 file_len = win_size - 45; 169 if (file_len > 0) { 170 len = snprintf(buf, file_len + 1, "\r%s", file); 171 if (len < 0) 172 len = 0; 173 if (len >= file_len + 1) 174 len = file_len; 175 for (i = len; i < file_len; i++) 176 buf[i] = ' '; 177 buf[file_len] = '\0'; 178 } 179 180 /* percent of transfer done */ 181 if (end_pos != 0) 182 percent = ((float)cur_pos / end_pos) * 100; 183 else 184 percent = 100; 185 186 snprintf(buf + strlen(buf), win_size - strlen(buf-8), 187 " %3d%% ", percent); 188 189 /* amount transferred */ 190 format_size(buf + strlen(buf), win_size - strlen(buf), 191 cur_pos); 192 strlcat(buf, " ", win_size); 193 194 /* bandwidth usage */ 195 format_rate(buf + strlen(buf), win_size - strlen(buf), 196 (off_t)bytes_per_second); 197 strlcat(buf, "/s ", win_size); 198 199 /* instantaneous rate */ 200 if (bytes_left > 0) 201 format_rate(buf + strlen(buf), win_size - strlen(buf), 202 delta_pos); 203 else 204 format_rate(buf + strlen(buf), win_size - strlen(buf), 205 max_delta_pos); 206 strlcat(buf, "/s ", win_size); 207 208 /* ETA */ 209 if (!transferred) 210 stalled += elapsed; 211 else 212 stalled = 0; 213 214 if (stalled >= STALL_TIME) 215 strlcat(buf, "- stalled -", win_size); 216 else if (bytes_per_second == 0 && bytes_left) 217 strlcat(buf, " --:-- ETA", win_size); 218 else { 219 if (bytes_left > 0) 220 seconds = bytes_left / bytes_per_second; 221 else 222 seconds = elapsed; 223 224 hours = seconds / 3600; 225 seconds -= hours * 3600; 226 minutes = seconds / 60; 227 seconds -= minutes * 60; 228 229 if (hours != 0) 230 snprintf(buf + strlen(buf), win_size - strlen(buf), 231 "%d:%02d:%02d", hours, minutes, seconds); 232 else 233 snprintf(buf + strlen(buf), win_size - strlen(buf), 234 " %02d:%02d", minutes, seconds); 235 236 if (bytes_left > 0) 237 strlcat(buf, " ETA", win_size); 238 else 239 strlcat(buf, " ", win_size); 240 } 241 242 atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1); 243 last_update = now; 244 last_pos = cur_pos; 245 } 246 247 /*ARGSUSED*/ 248 static void 249 update_progress_meter(int ignore) 250 { 251 int save_errno; 252 253 save_errno = errno; 254 255 if (win_resized) { 256 setscreensize(); 257 win_resized = 0; 258 } 259 if (can_output()) 260 refresh_progress_meter(); 261 262 signal(SIGALRM, update_progress_meter); 263 alarm(UPDATE_INTERVAL); 264 errno = save_errno; 265 } 266 267 void 268 start_progress_meter(char *f, off_t filesize, off_t *ctr) 269 { 270 start = last_update = time(NULL); 271 file = f; 272 end_pos = filesize; 273 cur_pos = 0; 274 counter = ctr; 275 stalled = 0; 276 bytes_per_second = 0; 277 278 setscreensize(); 279 if (can_output()) 280 refresh_progress_meter(); 281 282 signal(SIGALRM, update_progress_meter); 283 signal(SIGWINCH, sig_winch); 284 alarm(UPDATE_INTERVAL); 285 } 286 287 void 288 stop_progress_meter(void) 289 { 290 alarm(0); 291 292 if (!can_output()) 293 return; 294 295 /* Ensure we complete the progress */ 296 if (cur_pos != end_pos) 297 refresh_progress_meter(); 298 299 atomicio(vwrite, STDOUT_FILENO, "\n", 1); 300 } 301 302 /*ARGSUSED*/ 303 static void 304 sig_winch(int sig) 305 { 306 win_resized = 1; 307 } 308 309 static void 310 setscreensize(void) 311 { 312 struct winsize winsize; 313 314 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 && 315 winsize.ws_col != 0) { 316 if (winsize.ws_col > MAX_WINSIZE) 317 win_size = MAX_WINSIZE; 318 else 319 win_size = winsize.ws_col; 320 } else 321 win_size = DEFAULT_WINSIZE; 322 win_size += 1; /* trailing \0 */ 323 } 324