Annotation of src/usr.bin/ssh/progressmeter.c, Revision 1.50
1.50 ! dtucker 1: /* $OpenBSD: progressmeter.c,v 1.49 2019/10/29 07:47:27 dtucker 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.46 dtucker 32: #include <stdarg.h>
1.35 stevesk 33: #include <stdio.h>
1.34 stevesk 34: #include <string.h>
1.33 stevesk 35: #include <time.h>
1.31 stevesk 36: #include <unistd.h>
1.1 fgsch 37:
1.9 markus 38: #include "progressmeter.h"
39: #include "atomicio.h"
1.39 dtucker 40: #include "misc.h"
1.46 dtucker 41: #include "utf8.h"
1.9 markus 42:
43: #define DEFAULT_WINSIZE 80
44: #define MAX_WINSIZE 512
45: #define PADDING 1 /* padding between the progress indicators */
46: #define UPDATE_INTERVAL 1 /* update the progress meter every second */
47: #define STALL_TIME 5 /* we're stalled after this many seconds */
48:
49: /* determines whether we can output to the terminal */
50: static int can_output(void);
1.1 fgsch 51:
1.9 markus 52: /* formats and inserts the specified size into the given buffer */
53: static void format_size(char *, int, off_t);
1.13 markus 54: static void format_rate(char *, int, off_t);
1.1 fgsch 55:
1.24 jaredy 56: /* window resizing */
57: static void sig_winch(int);
58: static void setscreensize(void);
59:
1.9 markus 60: /* signal handler for updating the progress meter */
1.46 dtucker 61: static void sig_alarm(int);
1.1 fgsch 62:
1.42 dtucker 63: static double start; /* start progress */
64: static double last_update; /* last progress update */
1.41 djm 65: static const char *file; /* name of the file being transferred */
1.40 djm 66: static off_t start_pos; /* initial position of transfer */
1.22 deraadt 67: static off_t end_pos; /* ending position of transfer */
68: static off_t cur_pos; /* transfer position as of last refresh */
1.9 markus 69: static volatile off_t *counter; /* progress counter */
1.22 deraadt 70: static long stalled; /* how long we have been stalled */
71: static int bytes_per_second; /* current speed in bytes per second */
72: static int win_size; /* terminal window size */
1.24 jaredy 73: static volatile sig_atomic_t win_resized; /* for window resizing */
1.46 dtucker 74: static volatile sig_atomic_t alarm_fired;
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
1.47 dtucker 118: refresh_progress_meter(int force_update)
1.9 markus 119: {
1.44 schwarze 120: char buf[MAX_WINSIZE + 1];
1.9 markus 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 file_len;
128:
1.47 dtucker 129: if ((!force_update && !alarm_fired && !win_resized) || !can_output())
1.46 dtucker 130: return;
131: alarm_fired = 0;
132:
133: if (win_resized) {
134: setscreensize();
135: win_resized = 0;
136: }
137:
1.40 djm 138: transferred = *counter - (cur_pos ? cur_pos : start_pos);
1.9 markus 139: cur_pos = *counter;
1.42 dtucker 140: now = monotime_double();
1.9 markus 141: bytes_left = end_pos - cur_pos;
1.1 fgsch 142:
1.9 markus 143: if (bytes_left > 0)
144: elapsed = now - last_update;
1.18 markus 145: else {
1.9 markus 146: elapsed = now - start;
1.18 markus 147: /* Calculate true total speed when done */
1.40 djm 148: transferred = end_pos - start_pos;
1.18 markus 149: bytes_per_second = 0;
150: }
1.1 fgsch 151:
1.9 markus 152: /* calculate speed */
153: if (elapsed != 0)
154: cur_speed = (transferred / elapsed);
155: else
1.18 markus 156: cur_speed = transferred;
1.1 fgsch 157:
1.9 markus 158: #define AGE_FACTOR 0.9
159: if (bytes_per_second != 0) {
160: bytes_per_second = (bytes_per_second * AGE_FACTOR) +
161: (cur_speed * (1.0 - AGE_FACTOR));
162: } else
163: bytes_per_second = cur_speed;
1.1 fgsch 164:
1.9 markus 165: /* filename */
1.44 schwarze 166: buf[0] = '\0';
1.46 dtucker 167: file_len = win_size - 36;
1.9 markus 168: if (file_len > 0) {
1.46 dtucker 169: buf[0] = '\r';
1.48 dtucker 170: snmprintf(buf+1, sizeof(buf)-1, &file_len, "%-*s",
171: file_len, file);
1.9 markus 172: }
1.1 fgsch 173:
1.9 markus 174: /* percent of transfer done */
1.45 dtucker 175: if (end_pos == 0 || cur_pos == end_pos)
176: percent = 100;
177: else
1.9 markus 178: percent = ((float)cur_pos / end_pos) * 100;
1.44 schwarze 179: snprintf(buf + strlen(buf), win_size - strlen(buf),
1.9 markus 180: " %3d%% ", percent);
181:
182: /* amount transferred */
1.44 schwarze 183: format_size(buf + strlen(buf), win_size - strlen(buf),
1.9 markus 184: cur_pos);
1.44 schwarze 185: strlcat(buf, " ", win_size);
1.9 markus 186:
187: /* bandwidth usage */
1.44 schwarze 188: format_rate(buf + strlen(buf), win_size - strlen(buf),
1.20 deraadt 189: (off_t)bytes_per_second);
1.44 schwarze 190: strlcat(buf, "/s ", win_size);
1.9 markus 191:
192: /* ETA */
193: if (!transferred)
194: stalled += elapsed;
195: else
196: stalled = 0;
1.1 fgsch 197:
1.9 markus 198: if (stalled >= STALL_TIME)
1.44 schwarze 199: strlcat(buf, "- stalled -", win_size);
1.9 markus 200: else if (bytes_per_second == 0 && bytes_left)
1.44 schwarze 201: strlcat(buf, " --:-- ETA", win_size);
1.9 markus 202: else {
203: if (bytes_left > 0)
204: seconds = bytes_left / bytes_per_second;
205: else
206: seconds = elapsed;
1.1 fgsch 207:
1.9 markus 208: hours = seconds / 3600;
209: seconds -= hours * 3600;
210: minutes = seconds / 60;
211: seconds -= minutes * 60;
212:
213: if (hours != 0)
1.44 schwarze 214: snprintf(buf + strlen(buf), win_size - strlen(buf),
1.9 markus 215: "%d:%02d:%02d", hours, minutes, seconds);
216: else
1.44 schwarze 217: snprintf(buf + strlen(buf), win_size - strlen(buf),
1.9 markus 218: " %02d:%02d", minutes, seconds);
1.1 fgsch 219:
1.9 markus 220: if (bytes_left > 0)
1.44 schwarze 221: strlcat(buf, " ETA", win_size);
1.9 markus 222: else
1.44 schwarze 223: strlcat(buf, " ", win_size);
1.9 markus 224: }
1.1 fgsch 225:
1.44 schwarze 226: atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
1.9 markus 227: last_update = now;
1.1 fgsch 228: }
229:
1.32 stevesk 230: /*ARGSUSED*/
1.1 fgsch 231: static void
1.46 dtucker 232: sig_alarm(int ignore)
1.1 fgsch 233: {
1.46 dtucker 234: alarm_fired = 1;
1.9 markus 235: alarm(UPDATE_INTERVAL);
1.1 fgsch 236: }
237:
1.9 markus 238: void
1.41 djm 239: start_progress_meter(const char *f, off_t filesize, off_t *ctr)
1.1 fgsch 240: {
1.42 dtucker 241: start = last_update = monotime_double();
1.9 markus 242: file = f;
1.40 djm 243: start_pos = *ctr;
1.9 markus 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.47 dtucker 251: refresh_progress_meter(1);
1.1 fgsch 252:
1.50 ! dtucker 253: ssh_signal(SIGALRM, sig_alarm);
! 254: ssh_signal(SIGWINCH, sig_winch);
1.9 markus 255: alarm(UPDATE_INTERVAL);
1.1 fgsch 256: }
257:
1.9 markus 258: void
259: stop_progress_meter(void)
1.1 fgsch 260: {
1.9 markus 261: alarm(0);
1.1 fgsch 262:
1.9 markus 263: if (!can_output())
1.1 fgsch 264: return;
265:
1.9 markus 266: /* Ensure we complete the progress */
267: if (cur_pos != end_pos)
1.47 dtucker 268: refresh_progress_meter(1);
1.12 markus 269:
1.9 markus 270: atomicio(vwrite, STDOUT_FILENO, "\n", 1);
1.24 jaredy 271: }
272:
1.28 deraadt 273: /*ARGSUSED*/
1.24 jaredy 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