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