Annotation of src/usr.bin/ssh/progressmeter.c, Revision 1.3
1.1 fgsch 1: /*
2: * Copyright (c) 1999 Theo de Raadt. All rights reserved.
3: * Copyright (c) 1999 Aaron Campbell. All rights reserved.
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:
26: /*
27: * Parts from:
28: *
29: * Copyright (c) 1983, 1990, 1992, 1993, 1995
30: * The Regents of the University of California. All rights reserved.
31: *
32: * Redistribution and use in source and binary forms, with or without
33: * modification, are permitted provided that the following conditions
34: * are met:
35: * 1. Redistributions of source code must retain the above copyright
36: * notice, this list of conditions and the following disclaimer.
37: * 2. Redistributions in binary form must reproduce the above copyright
38: * notice, this list of conditions and the following disclaimer in the
39: * documentation and/or other materials provided with the distribution.
40: * 3. All advertising materials mentioning features or use of this software
41: * must display the following acknowledgement:
42: * This product includes software developed by the University of
43: * California, Berkeley and its contributors.
44: * 4. Neither the name of the University nor the names of its contributors
45: * may be used to endorse or promote products derived from this software
46: * without specific prior written permission.
47: *
48: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58: * SUCH DAMAGE.
59: *
60: */
61:
62: #include "includes.h"
1.3 ! markus 63: RCSID("$OpenBSD: progressmeter.c,v 1.2 2003/01/12 16:57:02 markus Exp $");
1.1 fgsch 64:
65: #include <libgen.h>
66:
67: #include "atomicio.h"
1.2 markus 68: #include "progressmeter.h"
1.1 fgsch 69:
70: /* Number of seconds before xfer considered "stalled". */
71: #define STALLTIME 5
72: /* alarm() interval for updating progress meter. */
73: #define PROGRESSTIME 1
74:
75: /* Signal handler used for updating the progress meter. */
76: static void update_progress_meter(int);
77:
78: /* Returns non-zero if we are the foreground process. */
79: static int foregroundproc(void);
80:
81: /* Returns width of the terminal (for progress meter calculations). */
82: static int get_tty_width(void);
83:
84: /* Visual statistics about files as they are transferred. */
1.2 markus 85: static void draw_progress_meter(void);
1.1 fgsch 86:
87: /* Time a transfer started. */
88: static struct timeval start;
89:
90: /* Number of bytes of current file transferred so far. */
91: static volatile off_t *statbytes;
92:
93: /* Total size of current file. */
94: static off_t totalbytes;
95:
96: /* Name of current file being transferred. */
97: static char *curfile;
98:
99: /* Time of last update. */
100: static struct timeval lastupdate;
101:
102: /* Size at the time of the last update. */
103: static off_t lastsize;
104:
105: void
106: start_progress_meter(char *file, off_t filesize, off_t *counter)
107: {
108: if ((curfile = basename(file)) == NULL)
109: curfile = file;
110:
111: totalbytes = filesize;
112: statbytes = counter;
113: (void) gettimeofday(&start, (struct timezone *) 0);
114: lastupdate = start;
115: lastsize = 0;
116:
117: draw_progress_meter();
118: signal(SIGALRM, update_progress_meter);
119: alarm(PROGRESSTIME);
120: }
121:
122: void
123: stop_progress_meter()
124: {
125: alarm(0);
126: draw_progress_meter();
1.3 ! markus 127: if (foregroundproc() != 0)
! 128: atomicio(write, fileno(stdout), "\n", 1);
1.1 fgsch 129: }
130:
131: static void
132: update_progress_meter(int ignore)
133: {
134: int save_errno = errno;
135:
136: draw_progress_meter();
137: signal(SIGALRM, update_progress_meter);
138: alarm(PROGRESSTIME);
139: errno = save_errno;
140: }
141:
142: static int
143: foregroundproc(void)
144: {
145: static pid_t pgrp = -1;
146: int ctty_pgrp;
147:
148: if (pgrp == -1)
149: pgrp = getpgrp();
150:
151: return ((ioctl(STDOUT_FILENO, TIOCGPGRP, &ctty_pgrp) != -1 &&
152: ctty_pgrp == pgrp));
153: }
154:
155: static void
156: draw_progress_meter()
157: {
158: static const char spaces[] = " "
159: " "
160: " "
161: " "
162: " "
163: " ";
164: static const char prefixes[] = " KMGTP";
165: struct timeval now, td, wait;
166: off_t cursize, abbrevsize, bytespersec;
167: double elapsed;
168: int ratio, remaining, i, ai, bi, nspaces;
169: char buf[512];
170:
171: if (foregroundproc() == 0)
172: return;
173:
174: (void) gettimeofday(&now, (struct timezone *) 0);
175: cursize = *statbytes;
176: if (totalbytes != 0) {
177: ratio = 100.0 * cursize / totalbytes;
178: ratio = MAX(ratio, 0);
179: ratio = MIN(ratio, 100);
180: } else
181: ratio = 100;
182:
183: abbrevsize = cursize;
184: for (ai = 0; abbrevsize >= 10000 && ai < sizeof(prefixes); ai++)
185: abbrevsize >>= 10;
186:
187: timersub(&now, &lastupdate, &wait);
188: if (cursize > lastsize) {
189: lastupdate = now;
190: lastsize = cursize;
191: wait.tv_sec = 0;
192: }
193: timersub(&now, &start, &td);
194: elapsed = td.tv_sec + (td.tv_usec / 1000000.0);
195:
196: bytespersec = 0;
197: if (cursize > 0) {
198: bytespersec = cursize;
199: if (elapsed > 0.0)
200: bytespersec /= elapsed;
201: }
202: for (bi = 1; bytespersec >= 1024000 && bi < sizeof(prefixes); bi++)
203: bytespersec >>= 10;
204:
205: nspaces = MIN(get_tty_width() - 79, sizeof(spaces) - 1);
206:
207: snprintf(buf, sizeof(buf),
208: "\r%-45.45s%.*s%3d%% %4lld%c%c %3lld.%01d%cB/s",
209: curfile,
210: nspaces,
211: spaces,
212: ratio,
213: (long long)abbrevsize,
214: prefixes[ai],
215: ai == 0 ? ' ' : 'B',
216: (long long)(bytespersec / 1024),
217: (int)((bytespersec % 1024) * 10 / 1024),
218: prefixes[bi]
219: );
220:
221: if (cursize <= 0 || elapsed <= 0.0 || cursize > totalbytes) {
222: snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf),
223: " --:-- ETA");
224: } else if (wait.tv_sec >= STALLTIME) {
225: snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf),
226: " - stalled -");
227: } else {
228: if (cursize != totalbytes)
229: remaining = (int)(totalbytes / (cursize / elapsed) -
230: elapsed);
231: else
232: remaining = elapsed;
233:
234: i = remaining / 3600;
235: if (i)
236: snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf),
237: "%2d:", i);
238: else
239: snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf),
240: " ");
241: i = remaining % 3600;
242: snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf),
243: "%02d:%02d%s", i / 60, i % 60,
244: (cursize != totalbytes) ? " ETA" : " ");
245: }
246: atomicio(write, fileno(stdout), buf, strlen(buf));
247: }
248:
249: static int
250: get_tty_width(void)
251: {
252: struct winsize winsize;
253:
254: if (ioctl(fileno(stdout), TIOCGWINSZ, &winsize) != -1)
255: return (winsize.ws_col ? winsize.ws_col : 80);
256: else
257: return (80);
258: }