Annotation of src/usr.bin/ssh/progressmeter.c, Revision 1.37
1.37 ! deraadt 1: /* $OpenBSD: progressmeter.c,v 1.36 2006/08/01 23:36:12 stevesk 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"
39:
40: #define DEFAULT_WINSIZE 80
41: #define MAX_WINSIZE 512
42: #define PADDING 1 /* padding between the progress indicators */
43: #define UPDATE_INTERVAL 1 /* update the progress meter every second */
44: #define STALL_TIME 5 /* we're stalled after this many seconds */
45:
46: /* determines whether we can output to the terminal */
47: static int can_output(void);
1.1 fgsch 48:
1.9 markus 49: /* formats and inserts the specified size into the given buffer */
50: static void format_size(char *, int, off_t);
1.13 markus 51: static void format_rate(char *, int, off_t);
1.1 fgsch 52:
1.24 jaredy 53: /* window resizing */
54: static void sig_winch(int);
55: static void setscreensize(void);
56:
1.9 markus 57: /* updates the progressmeter to reflect the current state of the transfer */
58: void refresh_progress_meter(void);
1.1 fgsch 59:
1.9 markus 60: /* signal handler for updating the progress meter */
1.1 fgsch 61: static void update_progress_meter(int);
62:
1.22 deraadt 63: static time_t start; /* start progress */
64: static time_t last_update; /* last progress update */
65: static char *file; /* name of the file being transferred */
66: static off_t end_pos; /* ending position of transfer */
67: static off_t cur_pos; /* transfer position as of last refresh */
1.9 markus 68: static volatile off_t *counter; /* progress counter */
1.22 deraadt 69: static long stalled; /* how long we have been stalled */
70: static int bytes_per_second; /* current speed in bytes per second */
71: static int win_size; /* terminal window size */
1.24 jaredy 72: static volatile sig_atomic_t win_resized; /* for window resizing */
1.9 markus 73:
1.13 markus 74: /* units for format_size */
75: static const char unit[] = " KMGT";
76:
1.9 markus 77: static int
78: can_output(void)
79: {
80: return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
81: }
82:
83: static void
1.13 markus 84: format_rate(char *buf, int size, off_t bytes)
85: {
86: int i;
87:
88: bytes *= 100;
89: for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
90: bytes = (bytes + 512) / 1024;
91: if (i == 0) {
92: i++;
93: bytes = (bytes + 512) / 1024;
94: }
95: snprintf(buf, size, "%3lld.%1lld%c%s",
1.17 markus 96: (long long) (bytes + 5) / 100,
1.13 markus 97: (long long) (bytes + 5) / 10 % 10,
98: unit[i],
99: i ? "B" : " ");
100: }
101:
102: static void
1.9 markus 103: format_size(char *buf, int size, off_t bytes)
104: {
105: int i;
1.1 fgsch 106:
1.11 markus 107: for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
1.13 markus 108: bytes = (bytes + 512) / 1024;
1.11 markus 109: snprintf(buf, size, "%4lld%c%s",
1.9 markus 110: (long long) bytes,
111: unit[i],
112: i ? "B" : " ");
113: }
1.1 fgsch 114:
1.9 markus 115: void
116: refresh_progress_meter(void)
117: {
118: char buf[MAX_WINSIZE + 1];
119: time_t now;
120: off_t transferred;
121: double elapsed;
122: int percent;
1.19 markus 123: off_t bytes_left;
1.9 markus 124: int cur_speed;
125: int hours, minutes, seconds;
126: int i, len;
127: int file_len;
128:
129: transferred = *counter - cur_pos;
130: cur_pos = *counter;
131: now = time(NULL);
132: bytes_left = end_pos - cur_pos;
1.1 fgsch 133:
1.9 markus 134: if (bytes_left > 0)
135: elapsed = now - last_update;
1.18 markus 136: else {
1.9 markus 137: elapsed = now - start;
1.18 markus 138: /* Calculate true total speed when done */
139: transferred = end_pos;
140: bytes_per_second = 0;
141: }
1.1 fgsch 142:
1.9 markus 143: /* calculate speed */
144: if (elapsed != 0)
145: cur_speed = (transferred / elapsed);
146: else
1.18 markus 147: cur_speed = transferred;
1.1 fgsch 148:
1.9 markus 149: #define AGE_FACTOR 0.9
150: if (bytes_per_second != 0) {
151: bytes_per_second = (bytes_per_second * AGE_FACTOR) +
152: (cur_speed * (1.0 - AGE_FACTOR));
153: } else
154: bytes_per_second = cur_speed;
1.1 fgsch 155:
1.9 markus 156: /* filename */
157: buf[0] = '\0';
1.13 markus 158: file_len = win_size - 35;
1.9 markus 159: if (file_len > 0) {
1.14 markus 160: len = snprintf(buf, file_len + 1, "\r%s", file);
1.15 markus 161: if (len < 0)
162: len = 0;
1.23 moritz 163: if (len >= file_len + 1)
164: len = file_len;
1.36 stevesk 165: for (i = len; i < file_len; i++)
1.9 markus 166: buf[i] = ' ';
167: buf[file_len] = '\0';
168: }
1.1 fgsch 169:
1.9 markus 170: /* percent of transfer done */
171: if (end_pos != 0)
172: percent = ((float)cur_pos / end_pos) * 100;
173: else
174: percent = 100;
175: snprintf(buf + strlen(buf), win_size - strlen(buf),
176: " %3d%% ", percent);
177:
178: /* amount transferred */
179: format_size(buf + strlen(buf), win_size - strlen(buf),
180: cur_pos);
181: strlcat(buf, " ", win_size);
182:
183: /* bandwidth usage */
1.13 markus 184: format_rate(buf + strlen(buf), win_size - strlen(buf),
1.20 deraadt 185: (off_t)bytes_per_second);
1.9 markus 186: strlcat(buf, "/s ", win_size);
187:
188: /* ETA */
189: if (!transferred)
190: stalled += elapsed;
191: else
192: stalled = 0;
1.1 fgsch 193:
1.9 markus 194: if (stalled >= STALL_TIME)
1.10 markus 195: strlcat(buf, "- stalled -", win_size);
1.9 markus 196: else if (bytes_per_second == 0 && bytes_left)
197: strlcat(buf, " --:-- ETA", win_size);
198: else {
199: if (bytes_left > 0)
200: seconds = bytes_left / bytes_per_second;
201: else
202: seconds = elapsed;
1.1 fgsch 203:
1.9 markus 204: hours = seconds / 3600;
205: seconds -= hours * 3600;
206: minutes = seconds / 60;
207: seconds -= minutes * 60;
208:
209: if (hours != 0)
210: snprintf(buf + strlen(buf), win_size - strlen(buf),
211: "%d:%02d:%02d", hours, minutes, seconds);
212: else
213: snprintf(buf + strlen(buf), win_size - strlen(buf),
214: " %02d:%02d", minutes, seconds);
1.1 fgsch 215:
1.9 markus 216: if (bytes_left > 0)
217: strlcat(buf, " ETA", win_size);
218: else
219: strlcat(buf, " ", win_size);
220: }
1.1 fgsch 221:
1.16 markus 222: atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
1.9 markus 223: last_update = now;
1.1 fgsch 224: }
225:
1.32 stevesk 226: /*ARGSUSED*/
1.1 fgsch 227: static void
228: update_progress_meter(int ignore)
229: {
1.9 markus 230: int save_errno;
231:
232: save_errno = errno;
233:
1.24 jaredy 234: if (win_resized) {
235: setscreensize();
236: win_resized = 0;
237: }
1.9 markus 238: if (can_output())
239: refresh_progress_meter();
1.1 fgsch 240:
241: signal(SIGALRM, update_progress_meter);
1.9 markus 242: alarm(UPDATE_INTERVAL);
1.1 fgsch 243: errno = save_errno;
244: }
245:
1.9 markus 246: void
1.21 avsm 247: start_progress_meter(char *f, off_t filesize, off_t *ctr)
1.1 fgsch 248: {
1.9 markus 249: start = last_update = time(NULL);
250: file = f;
251: end_pos = filesize;
252: cur_pos = 0;
1.21 avsm 253: counter = ctr;
1.9 markus 254: stalled = 0;
255: bytes_per_second = 0;
256:
1.24 jaredy 257: setscreensize();
1.9 markus 258: if (can_output())
259: refresh_progress_meter();
1.1 fgsch 260:
1.9 markus 261: signal(SIGALRM, update_progress_meter);
1.24 jaredy 262: signal(SIGWINCH, sig_winch);
1.9 markus 263: alarm(UPDATE_INTERVAL);
1.1 fgsch 264: }
265:
1.9 markus 266: void
267: stop_progress_meter(void)
1.1 fgsch 268: {
1.9 markus 269: alarm(0);
1.1 fgsch 270:
1.9 markus 271: if (!can_output())
1.1 fgsch 272: return;
273:
1.9 markus 274: /* Ensure we complete the progress */
275: if (cur_pos != end_pos)
276: refresh_progress_meter();
1.12 markus 277:
1.9 markus 278: atomicio(vwrite, STDOUT_FILENO, "\n", 1);
1.24 jaredy 279: }
280:
1.28 deraadt 281: /*ARGSUSED*/
1.24 jaredy 282: static void
283: sig_winch(int sig)
284: {
285: win_resized = 1;
286: }
287:
288: static void
289: setscreensize(void)
290: {
291: struct winsize winsize;
292:
293: if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
294: winsize.ws_col != 0) {
295: if (winsize.ws_col > MAX_WINSIZE)
296: win_size = MAX_WINSIZE;
297: else
298: win_size = winsize.ws_col;
299: } else
300: win_size = DEFAULT_WINSIZE;
301: win_size += 1; /* trailing \0 */
1.1 fgsch 302: }
![[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