Annotation of src/usr.bin/ssh/progressmeter.c, Revision 1.41
1.41 ! djm 1: /* $OpenBSD: progressmeter.c,v 1.40 2013/09/19 00:24:52 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.22 deraadt 64: static time_t start; /* start progress */
65: static time_t 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: time_t now;
122: off_t transferred;
123: double elapsed;
124: int percent;
1.19 markus 125: off_t bytes_left;
1.9 markus 126: int cur_speed;
127: int hours, minutes, seconds;
128: int i, len;
129: int file_len;
130:
1.40 djm 131: transferred = *counter - (cur_pos ? cur_pos : start_pos);
1.9 markus 132: cur_pos = *counter;
1.38 dtucker 133: now = monotime();
1.9 markus 134: bytes_left = end_pos - cur_pos;
1.1 fgsch 135:
1.9 markus 136: if (bytes_left > 0)
137: elapsed = now - last_update;
1.18 markus 138: else {
1.9 markus 139: elapsed = now - start;
1.18 markus 140: /* Calculate true total speed when done */
1.40 djm 141: transferred = end_pos - start_pos;
1.18 markus 142: bytes_per_second = 0;
143: }
1.1 fgsch 144:
1.9 markus 145: /* calculate speed */
146: if (elapsed != 0)
147: cur_speed = (transferred / elapsed);
148: else
1.18 markus 149: cur_speed = transferred;
1.1 fgsch 150:
1.9 markus 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;
1.1 fgsch 157:
1.9 markus 158: /* filename */
159: buf[0] = '\0';
1.13 markus 160: file_len = win_size - 35;
1.9 markus 161: if (file_len > 0) {
1.14 markus 162: len = snprintf(buf, file_len + 1, "\r%s", file);
1.15 markus 163: if (len < 0)
164: len = 0;
1.23 moritz 165: if (len >= file_len + 1)
166: len = file_len;
1.36 stevesk 167: for (i = len; i < file_len; i++)
1.9 markus 168: buf[i] = ' ';
169: buf[file_len] = '\0';
170: }
1.1 fgsch 171:
1.9 markus 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 */
1.13 markus 186: format_rate(buf + strlen(buf), win_size - strlen(buf),
1.20 deraadt 187: (off_t)bytes_per_second);
1.9 markus 188: strlcat(buf, "/s ", win_size);
189:
190: /* ETA */
191: if (!transferred)
192: stalled += elapsed;
193: else
194: stalled = 0;
1.1 fgsch 195:
1.9 markus 196: if (stalled >= STALL_TIME)
1.10 markus 197: strlcat(buf, "- stalled -", win_size);
1.9 markus 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;
1.1 fgsch 205:
1.9 markus 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);
1.1 fgsch 217:
1.9 markus 218: if (bytes_left > 0)
219: strlcat(buf, " ETA", win_size);
220: else
221: strlcat(buf, " ", win_size);
222: }
1.1 fgsch 223:
1.16 markus 224: atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
1.9 markus 225: last_update = now;
1.1 fgsch 226: }
227:
1.32 stevesk 228: /*ARGSUSED*/
1.1 fgsch 229: static void
230: update_progress_meter(int ignore)
231: {
1.9 markus 232: int save_errno;
233:
234: save_errno = errno;
235:
1.24 jaredy 236: if (win_resized) {
237: setscreensize();
238: win_resized = 0;
239: }
1.9 markus 240: if (can_output())
241: refresh_progress_meter();
1.1 fgsch 242:
243: signal(SIGALRM, update_progress_meter);
1.9 markus 244: alarm(UPDATE_INTERVAL);
1.1 fgsch 245: errno = save_errno;
246: }
247:
1.9 markus 248: void
1.41 ! djm 249: start_progress_meter(const char *f, off_t filesize, off_t *ctr)
1.1 fgsch 250: {
1.38 dtucker 251: start = last_update = monotime();
1.9 markus 252: file = f;
1.40 djm 253: start_pos = *ctr;
1.9 markus 254: end_pos = filesize;
255: cur_pos = 0;
1.21 avsm 256: counter = ctr;
1.9 markus 257: stalled = 0;
258: bytes_per_second = 0;
259:
1.24 jaredy 260: setscreensize();
1.9 markus 261: if (can_output())
262: refresh_progress_meter();
1.1 fgsch 263:
1.9 markus 264: signal(SIGALRM, update_progress_meter);
1.24 jaredy 265: signal(SIGWINCH, sig_winch);
1.9 markus 266: alarm(UPDATE_INTERVAL);
1.1 fgsch 267: }
268:
1.9 markus 269: void
270: stop_progress_meter(void)
1.1 fgsch 271: {
1.9 markus 272: alarm(0);
1.1 fgsch 273:
1.9 markus 274: if (!can_output())
1.1 fgsch 275: return;
276:
1.9 markus 277: /* Ensure we complete the progress */
278: if (cur_pos != end_pos)
279: refresh_progress_meter();
1.12 markus 280:
1.9 markus 281: atomicio(vwrite, STDOUT_FILENO, "\n", 1);
1.24 jaredy 282: }
283:
1.28 deraadt 284: /*ARGSUSED*/
1.24 jaredy 285: static void
286: sig_winch(int sig)
287: {
288: win_resized = 1;
289: }
290:
291: static void
292: setscreensize(void)
293: {
294: struct winsize winsize;
295:
296: if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
297: winsize.ws_col != 0) {
298: if (winsize.ws_col > MAX_WINSIZE)
299: win_size = MAX_WINSIZE;
300: else
301: win_size = winsize.ws_col;
302: } else
303: win_size = DEFAULT_WINSIZE;
304: win_size += 1; /* trailing \0 */
1.1 fgsch 305: }
![[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