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