Annotation of src/usr.bin/ssh/progressmeter.c, Revision 1.42
1.42 ! dtucker 1: /* $OpenBSD: progressmeter.c,v 1.41 2015/01/14 13:54:13 djm Exp $ */
1.1 fgsch 2: /*
1.9 markus 3: * Copyright (c) 2003 Nils Nordman. All rights reserved.
1.1 fgsch 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:
1.31 stevesk 26: #include <sys/types.h>
1.25 stevesk 27: #include <sys/ioctl.h>
1.37 deraadt 28: #include <sys/uio.h>
1.26 stevesk 29:
1.30 stevesk 30: #include <errno.h>
1.26 stevesk 31: #include <signal.h>
1.35 stevesk 32: #include <stdio.h>
1.34 stevesk 33: #include <string.h>
1.33 stevesk 34: #include <time.h>
1.31 stevesk 35: #include <unistd.h>
1.1 fgsch 36:
1.9 markus 37: #include "progressmeter.h"
38: #include "atomicio.h"
1.39 dtucker 39: #include "misc.h"
1.9 markus 40:
41: #define DEFAULT_WINSIZE 80
42: #define MAX_WINSIZE 512
43: #define PADDING 1 /* padding between the progress indicators */
44: #define UPDATE_INTERVAL 1 /* update the progress meter every second */
45: #define STALL_TIME 5 /* we're stalled after this many seconds */
46:
47: /* determines whether we can output to the terminal */
48: static int can_output(void);
1.1 fgsch 49:
1.9 markus 50: /* formats and inserts the specified size into the given buffer */
51: static void format_size(char *, int, off_t);
1.13 markus 52: static void format_rate(char *, int, off_t);
1.1 fgsch 53:
1.24 jaredy 54: /* window resizing */
55: static void sig_winch(int);
56: static void setscreensize(void);
57:
1.9 markus 58: /* updates the progressmeter to reflect the current state of the transfer */
59: void refresh_progress_meter(void);
1.1 fgsch 60:
1.9 markus 61: /* signal handler for updating the progress meter */
1.1 fgsch 62: static void update_progress_meter(int);
63:
1.42 ! dtucker 64: static double start; /* start progress */
! 65: static double last_update; /* last progress update */
1.41 djm 66: static const char *file; /* name of the file being transferred */
1.40 djm 67: static off_t start_pos; /* initial position of transfer */
1.22 deraadt 68: static off_t end_pos; /* ending position of transfer */
69: static off_t cur_pos; /* transfer position as of last refresh */
1.9 markus 70: static volatile off_t *counter; /* progress counter */
1.22 deraadt 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 */
1.24 jaredy 74: static volatile sig_atomic_t win_resized; /* for window resizing */
1.9 markus 75:
1.13 markus 76: /* units for format_size */
77: static const char unit[] = " KMGT";
78:
1.9 markus 79: static int
80: can_output(void)
81: {
82: return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
83: }
84:
85: static void
1.13 markus 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",
1.17 markus 98: (long long) (bytes + 5) / 100,
1.13 markus 99: (long long) (bytes + 5) / 10 % 10,
100: unit[i],
101: i ? "B" : " ");
102: }
103:
104: static void
1.9 markus 105: format_size(char *buf, int size, off_t bytes)
106: {
107: int i;
1.1 fgsch 108:
1.11 markus 109: for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
1.13 markus 110: bytes = (bytes + 512) / 1024;
1.11 markus 111: snprintf(buf, size, "%4lld%c%s",
1.9 markus 112: (long long) bytes,
113: unit[i],
114: i ? "B" : " ");
115: }
1.1 fgsch 116:
1.9 markus 117: void
118: refresh_progress_meter(void)
119: {
120: char buf[MAX_WINSIZE + 1];
121: off_t transferred;
1.42 ! dtucker 122: double elapsed, now;
1.9 markus 123: int percent;
1.19 markus 124: off_t bytes_left;
1.9 markus 125: int cur_speed;
126: int hours, minutes, seconds;
127: int i, len;
128: int file_len;
129:
1.40 djm 130: transferred = *counter - (cur_pos ? cur_pos : start_pos);
1.9 markus 131: cur_pos = *counter;
1.42 ! dtucker 132: now = monotime_double();
1.9 markus 133: bytes_left = end_pos - cur_pos;
1.1 fgsch 134:
1.9 markus 135: if (bytes_left > 0)
136: elapsed = now - last_update;
1.18 markus 137: else {
1.9 markus 138: elapsed = now - start;
1.18 markus 139: /* Calculate true total speed when done */
1.40 djm 140: transferred = end_pos - start_pos;
1.18 markus 141: bytes_per_second = 0;
142: }
1.1 fgsch 143:
1.9 markus 144: /* calculate speed */
145: if (elapsed != 0)
146: cur_speed = (transferred / elapsed);
147: else
1.18 markus 148: cur_speed = transferred;
1.1 fgsch 149:
1.9 markus 150: #define AGE_FACTOR 0.9
151: if (bytes_per_second != 0) {
152: bytes_per_second = (bytes_per_second * AGE_FACTOR) +
153: (cur_speed * (1.0 - AGE_FACTOR));
154: } else
155: bytes_per_second = cur_speed;
1.1 fgsch 156:
1.9 markus 157: /* filename */
158: buf[0] = '\0';
1.13 markus 159: file_len = win_size - 35;
1.9 markus 160: if (file_len > 0) {
1.14 markus 161: len = snprintf(buf, file_len + 1, "\r%s", file);
1.15 markus 162: if (len < 0)
163: len = 0;
1.23 moritz 164: if (len >= file_len + 1)
165: len = file_len;
1.36 stevesk 166: for (i = len; i < file_len; i++)
1.9 markus 167: buf[i] = ' ';
168: buf[file_len] = '\0';
169: }
1.1 fgsch 170:
1.9 markus 171: /* percent of transfer done */
172: if (end_pos != 0)
173: percent = ((float)cur_pos / end_pos) * 100;
174: else
175: percent = 100;
176: snprintf(buf + strlen(buf), win_size - strlen(buf),
177: " %3d%% ", percent);
178:
179: /* amount transferred */
180: format_size(buf + strlen(buf), win_size - strlen(buf),
181: cur_pos);
182: strlcat(buf, " ", win_size);
183:
184: /* bandwidth usage */
1.13 markus 185: format_rate(buf + strlen(buf), win_size - strlen(buf),
1.20 deraadt 186: (off_t)bytes_per_second);
1.9 markus 187: strlcat(buf, "/s ", win_size);
188:
189: /* ETA */
190: if (!transferred)
191: stalled += elapsed;
192: else
193: stalled = 0;
1.1 fgsch 194:
1.9 markus 195: if (stalled >= STALL_TIME)
1.10 markus 196: strlcat(buf, "- stalled -", win_size);
1.9 markus 197: else if (bytes_per_second == 0 && bytes_left)
198: strlcat(buf, " --:-- ETA", win_size);
199: else {
200: if (bytes_left > 0)
201: seconds = bytes_left / bytes_per_second;
202: else
203: seconds = elapsed;
1.1 fgsch 204:
1.9 markus 205: hours = seconds / 3600;
206: seconds -= hours * 3600;
207: minutes = seconds / 60;
208: seconds -= minutes * 60;
209:
210: if (hours != 0)
211: snprintf(buf + strlen(buf), win_size - strlen(buf),
212: "%d:%02d:%02d", hours, minutes, seconds);
213: else
214: snprintf(buf + strlen(buf), win_size - strlen(buf),
215: " %02d:%02d", minutes, seconds);
1.1 fgsch 216:
1.9 markus 217: if (bytes_left > 0)
218: strlcat(buf, " ETA", win_size);
219: else
220: strlcat(buf, " ", win_size);
221: }
1.1 fgsch 222:
1.16 markus 223: atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
1.9 markus 224: last_update = now;
1.1 fgsch 225: }
226:
1.32 stevesk 227: /*ARGSUSED*/
1.1 fgsch 228: static void
229: update_progress_meter(int ignore)
230: {
1.9 markus 231: int save_errno;
232:
233: save_errno = errno;
234:
1.24 jaredy 235: if (win_resized) {
236: setscreensize();
237: win_resized = 0;
238: }
1.9 markus 239: if (can_output())
240: refresh_progress_meter();
1.1 fgsch 241:
242: signal(SIGALRM, update_progress_meter);
1.9 markus 243: alarm(UPDATE_INTERVAL);
1.1 fgsch 244: errno = save_errno;
245: }
246:
1.9 markus 247: void
1.41 djm 248: start_progress_meter(const char *f, off_t filesize, off_t *ctr)
1.1 fgsch 249: {
1.42 ! dtucker 250: start = last_update = monotime_double();
1.9 markus 251: file = f;
1.40 djm 252: start_pos = *ctr;
1.9 markus 253: end_pos = filesize;
254: cur_pos = 0;
1.21 avsm 255: counter = ctr;
1.9 markus 256: stalled = 0;
257: bytes_per_second = 0;
258:
1.24 jaredy 259: setscreensize();
1.9 markus 260: if (can_output())
261: refresh_progress_meter();
1.1 fgsch 262:
1.9 markus 263: signal(SIGALRM, update_progress_meter);
1.24 jaredy 264: signal(SIGWINCH, sig_winch);
1.9 markus 265: alarm(UPDATE_INTERVAL);
1.1 fgsch 266: }
267:
1.9 markus 268: void
269: stop_progress_meter(void)
1.1 fgsch 270: {
1.9 markus 271: alarm(0);
1.1 fgsch 272:
1.9 markus 273: if (!can_output())
1.1 fgsch 274: return;
275:
1.9 markus 276: /* Ensure we complete the progress */
277: if (cur_pos != end_pos)
278: refresh_progress_meter();
1.12 markus 279:
1.9 markus 280: atomicio(vwrite, STDOUT_FILENO, "\n", 1);
1.24 jaredy 281: }
282:
1.28 deraadt 283: /*ARGSUSED*/
1.24 jaredy 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 */
1.1 fgsch 304: }
![[BACK]](/icons/back.gif){kind=icon}
Return to progressmeter.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh