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