Annotation of src/usr.bin/ssh/progressmeter.c, Revision 1.27
1.1 fgsch 1: /*
1.9 markus 2: * Copyright (c) 2003 Nils Nordman. All rights reserved.
1.1 fgsch 3: *
4: * Redistribution and use in source and binary forms, with or without
5: * modification, are permitted provided that the following conditions
6: * are met:
7: * 1. Redistributions of source code must retain the above copyright
8: * notice, this list of conditions and the following disclaimer.
9: * 2. Redistributions in binary form must reproduce the above copyright
10: * notice, this list of conditions and the following disclaimer in the
11: * documentation and/or other materials provided with the distribution.
12: *
13: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16: * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22: * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: */
24:
25: #include "includes.h"
1.25 stevesk 26:
27: #include <sys/ioctl.h>
1.26 stevesk 28:
29: #include <signal.h>
1.1 fgsch 30:
1.9 markus 31: #include "progressmeter.h"
32: #include "atomicio.h"
33:
34: #define DEFAULT_WINSIZE 80
35: #define MAX_WINSIZE 512
36: #define PADDING 1 /* padding between the progress indicators */
37: #define UPDATE_INTERVAL 1 /* update the progress meter every second */
38: #define STALL_TIME 5 /* we're stalled after this many seconds */
39:
40: /* determines whether we can output to the terminal */
41: static int can_output(void);
1.1 fgsch 42:
1.9 markus 43: /* formats and inserts the specified size into the given buffer */
44: static void format_size(char *, int, off_t);
1.13 markus 45: static void format_rate(char *, int, off_t);
1.1 fgsch 46:
1.24 jaredy 47: /* window resizing */
48: static void sig_winch(int);
49: static void setscreensize(void);
50:
1.9 markus 51: /* updates the progressmeter to reflect the current state of the transfer */
52: void refresh_progress_meter(void);
1.1 fgsch 53:
1.9 markus 54: /* signal handler for updating the progress meter */
1.1 fgsch 55: static void update_progress_meter(int);
56:
1.22 deraadt 57: static time_t start; /* start progress */
58: static time_t last_update; /* last progress update */
59: static char *file; /* name of the file being transferred */
60: static off_t end_pos; /* ending position of transfer */
61: static off_t cur_pos; /* transfer position as of last refresh */
1.9 markus 62: static volatile off_t *counter; /* progress counter */
1.22 deraadt 63: static long stalled; /* how long we have been stalled */
64: static int bytes_per_second; /* current speed in bytes per second */
65: static int win_size; /* terminal window size */
1.24 jaredy 66: static volatile sig_atomic_t win_resized; /* for window resizing */
1.9 markus 67:
1.13 markus 68: /* units for format_size */
69: static const char unit[] = " KMGT";
70:
1.9 markus 71: static int
72: can_output(void)
73: {
74: return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
75: }
76:
77: static void
1.13 markus 78: format_rate(char *buf, int size, off_t bytes)
79: {
80: int i;
81:
82: bytes *= 100;
83: for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
84: bytes = (bytes + 512) / 1024;
85: if (i == 0) {
86: i++;
87: bytes = (bytes + 512) / 1024;
88: }
89: snprintf(buf, size, "%3lld.%1lld%c%s",
1.17 markus 90: (long long) (bytes + 5) / 100,
1.13 markus 91: (long long) (bytes + 5) / 10 % 10,
92: unit[i],
93: i ? "B" : " ");
94: }
95:
96: static void
1.9 markus 97: format_size(char *buf, int size, off_t bytes)
98: {
99: int i;
1.1 fgsch 100:
1.11 markus 101: for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
1.13 markus 102: bytes = (bytes + 512) / 1024;
1.11 markus 103: snprintf(buf, size, "%4lld%c%s",
1.9 markus 104: (long long) bytes,
105: unit[i],
106: i ? "B" : " ");
107: }
1.1 fgsch 108:
1.9 markus 109: void
110: refresh_progress_meter(void)
111: {
112: char buf[MAX_WINSIZE + 1];
113: time_t now;
114: off_t transferred;
115: double elapsed;
116: int percent;
1.19 markus 117: off_t bytes_left;
1.9 markus 118: int cur_speed;
119: int hours, minutes, seconds;
120: int i, len;
121: int file_len;
122:
123: transferred = *counter - cur_pos;
124: cur_pos = *counter;
125: now = time(NULL);
126: bytes_left = end_pos - cur_pos;
1.1 fgsch 127:
1.9 markus 128: if (bytes_left > 0)
129: elapsed = now - last_update;
1.18 markus 130: else {
1.9 markus 131: elapsed = now - start;
1.18 markus 132: /* Calculate true total speed when done */
133: transferred = end_pos;
134: bytes_per_second = 0;
135: }
1.1 fgsch 136:
1.9 markus 137: /* calculate speed */
138: if (elapsed != 0)
139: cur_speed = (transferred / elapsed);
140: else
1.18 markus 141: cur_speed = transferred;
1.1 fgsch 142:
1.9 markus 143: #define AGE_FACTOR 0.9
144: if (bytes_per_second != 0) {
145: bytes_per_second = (bytes_per_second * AGE_FACTOR) +
146: (cur_speed * (1.0 - AGE_FACTOR));
147: } else
148: bytes_per_second = cur_speed;
1.1 fgsch 149:
1.9 markus 150: /* filename */
151: buf[0] = '\0';
1.13 markus 152: file_len = win_size - 35;
1.9 markus 153: if (file_len > 0) {
1.14 markus 154: len = snprintf(buf, file_len + 1, "\r%s", file);
1.15 markus 155: if (len < 0)
156: len = 0;
1.23 moritz 157: if (len >= file_len + 1)
158: len = file_len;
1.9 markus 159: for (i = len; i < file_len; i++ )
160: buf[i] = ' ';
161: buf[file_len] = '\0';
162: }
1.1 fgsch 163:
1.9 markus 164: /* percent of transfer done */
165: if (end_pos != 0)
166: percent = ((float)cur_pos / end_pos) * 100;
167: else
168: percent = 100;
169: snprintf(buf + strlen(buf), win_size - strlen(buf),
170: " %3d%% ", percent);
171:
172: /* amount transferred */
173: format_size(buf + strlen(buf), win_size - strlen(buf),
174: cur_pos);
175: strlcat(buf, " ", win_size);
176:
177: /* bandwidth usage */
1.13 markus 178: format_rate(buf + strlen(buf), win_size - strlen(buf),
1.20 deraadt 179: (off_t)bytes_per_second);
1.9 markus 180: strlcat(buf, "/s ", win_size);
181:
182: /* ETA */
183: if (!transferred)
184: stalled += elapsed;
185: else
186: stalled = 0;
1.1 fgsch 187:
1.9 markus 188: if (stalled >= STALL_TIME)
1.10 markus 189: strlcat(buf, "- stalled -", win_size);
1.9 markus 190: else if (bytes_per_second == 0 && bytes_left)
191: strlcat(buf, " --:-- ETA", win_size);
192: else {
193: if (bytes_left > 0)
194: seconds = bytes_left / bytes_per_second;
195: else
196: seconds = elapsed;
1.1 fgsch 197:
1.9 markus 198: hours = seconds / 3600;
199: seconds -= hours * 3600;
200: minutes = seconds / 60;
201: seconds -= minutes * 60;
202:
203: if (hours != 0)
204: snprintf(buf + strlen(buf), win_size - strlen(buf),
205: "%d:%02d:%02d", hours, minutes, seconds);
206: else
207: snprintf(buf + strlen(buf), win_size - strlen(buf),
208: " %02d:%02d", minutes, seconds);
1.1 fgsch 209:
1.9 markus 210: if (bytes_left > 0)
211: strlcat(buf, " ETA", win_size);
212: else
213: strlcat(buf, " ", win_size);
214: }
1.1 fgsch 215:
1.16 markus 216: atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
1.9 markus 217: last_update = now;
1.1 fgsch 218: }
219:
220: static void
221: update_progress_meter(int ignore)
222: {
1.9 markus 223: int save_errno;
224:
225: save_errno = errno;
226:
1.24 jaredy 227: if (win_resized) {
228: setscreensize();
229: win_resized = 0;
230: }
1.9 markus 231: if (can_output())
232: refresh_progress_meter();
1.1 fgsch 233:
234: signal(SIGALRM, update_progress_meter);
1.9 markus 235: alarm(UPDATE_INTERVAL);
1.1 fgsch 236: errno = save_errno;
237: }
238:
1.9 markus 239: void
1.21 avsm 240: start_progress_meter(char *f, off_t filesize, off_t *ctr)
1.1 fgsch 241: {
1.9 markus 242: start = last_update = time(NULL);
243: file = f;
244: end_pos = filesize;
245: cur_pos = 0;
1.21 avsm 246: counter = ctr;
1.9 markus 247: stalled = 0;
248: bytes_per_second = 0;
249:
1.24 jaredy 250: setscreensize();
1.9 markus 251: if (can_output())
252: refresh_progress_meter();
1.1 fgsch 253:
1.9 markus 254: signal(SIGALRM, update_progress_meter);
1.24 jaredy 255: signal(SIGWINCH, sig_winch);
1.9 markus 256: alarm(UPDATE_INTERVAL);
1.1 fgsch 257: }
258:
1.9 markus 259: void
260: stop_progress_meter(void)
1.1 fgsch 261: {
1.9 markus 262: alarm(0);
1.1 fgsch 263:
1.9 markus 264: if (!can_output())
1.1 fgsch 265: return;
266:
1.9 markus 267: /* Ensure we complete the progress */
268: if (cur_pos != end_pos)
269: refresh_progress_meter();
1.12 markus 270:
1.9 markus 271: atomicio(vwrite, STDOUT_FILENO, "\n", 1);
1.24 jaredy 272: }
273:
274: static void
275: sig_winch(int sig)
276: {
277: win_resized = 1;
278: }
279:
280: static void
281: setscreensize(void)
282: {
283: struct winsize winsize;
284:
285: if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
286: winsize.ws_col != 0) {
287: if (winsize.ws_col > MAX_WINSIZE)
288: win_size = MAX_WINSIZE;
289: else
290: win_size = winsize.ws_col;
291: } else
292: win_size = DEFAULT_WINSIZE;
293: win_size += 1; /* trailing \0 */
1.1 fgsch 294: }
![[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