1 /* $OpenBSD: progressmeter.c,v 1.41 2015/01/14 13:54:13 djm 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 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 volatile off_t *counter; /* progress counter */ 73 static long stalled; /* how long we have been stalled */ 74 static int bytes_per_second; /* current speed in bytes per second */ 75 static int win_size; /* terminal window size */ 76 static volatile sig_atomic_t win_resized; /* for window resizing */ 77 78 /* units for format_size */ 79 static const char unit[] = " KMGT"; 80 81 static int 82 can_output(void) 83 { 84 return (getpgrp() == tcgetpgrp(STDOUT_FILENO)); 85 } 86 87 static void 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 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 120 refresh_progress_meter(void) 121 { 122 char buf[MAX_WINSIZE + 1]; 123 time_t now; 124 off_t transferred; 125 double elapsed; 126 int percent; 127 off_t bytes_left; 128 int cur_speed; 129 int hours, minutes, seconds; 130 int i, len; 131 int file_len; 132 133 transferred = *counter - (cur_pos ? cur_pos : start_pos); 134 cur_pos = *counter; 135 now = monotime(); 136 bytes_left = end_pos - cur_pos; 137 138 if (bytes_left > 0) 139 elapsed = now - last_update; 140 else { 141 elapsed = now - start; 142 /* Calculate true total speed when done */ 143 transferred = end_pos - start_pos; 144 bytes_per_second = 0; 145 } 146 147 /* calculate speed */ 148 if (elapsed != 0) 149 cur_speed = (transferred / elapsed); 150 else 151 cur_speed = transferred; 152 153 #define AGE_FACTOR 0.9 154 if (bytes_per_second != 0) { 155 bytes_per_second = (bytes_per_second * AGE_FACTOR) + 156 (cur_speed * (1.0 - AGE_FACTOR)); 157 } else 158 bytes_per_second = cur_speed; 159 160 /* filename */ 161 buf[0] = '\0'; 162 file_len = win_size - 35; 163 if (file_len > 0) { 164 len = snprintf(buf, file_len + 1, "\r%s", file); 165 if (len < 0) 166 len = 0; 167 if (len >= file_len + 1) 168 len = file_len; 169 for (i = len; i < file_len; i++) 170 buf[i] = ' '; 171 buf[file_len] = '\0'; 172 } 173 174 /* percent of transfer done */ 175 if (end_pos != 0) 176 percent = ((float)cur_pos / end_pos) * 100; 177 else 178 percent = 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 update_progress_meter(int ignore) 233 { 234 int save_errno; 235 236 save_errno = errno; 237 238 if (win_resized) { 239 setscreensize(); 240 win_resized = 0; 241 } 242 if (can_output()) 243 refresh_progress_meter(); 244 245 signal(SIGALRM, update_progress_meter); 246 alarm(UPDATE_INTERVAL); 247 errno = save_errno; 248 } 249 250 void 251 start_progress_meter(const char *f, off_t filesize, off_t *ctr) 252 { 253 start = last_update = monotime(); 254 file = f; 255 start_pos = *ctr; 256 end_pos = filesize; 257 cur_pos = 0; 258 counter = ctr; 259 stalled = 0; 260 bytes_per_second = 0; 261 262 setscreensize(); 263 if (can_output()) 264 refresh_progress_meter(); 265 266 signal(SIGALRM, update_progress_meter); 267 signal(SIGWINCH, sig_winch); 268 alarm(UPDATE_INTERVAL); 269 } 270 271 void 272 stop_progress_meter(void) 273 { 274 alarm(0); 275 276 if (!can_output()) 277 return; 278 279 /* Ensure we complete the progress */ 280 if (cur_pos != end_pos) 281 refresh_progress_meter(); 282 283 atomicio(vwrite, STDOUT_FILENO, "\n", 1); 284 } 285 286 /*ARGSUSED*/ 287 static void 288 sig_winch(int sig) 289 { 290 win_resized = 1; 291 } 292 293 static void 294 setscreensize(void) 295 { 296 struct winsize winsize; 297 298 if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 && 299 winsize.ws_col != 0) { 300 if (winsize.ws_col > MAX_WINSIZE) 301 win_size = MAX_WINSIZE; 302 else 303 win_size = winsize.ws_col; 304 } else 305 win_size = DEFAULT_WINSIZE; 306 win_size += 1; /* trailing \0 */ 307 } 308