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