[openssh.git] / progressmeter.c

/*
 * Copyright (c) 2003 Nils Nordman.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "includes.h"
RCSID("$OpenBSD: progressmeter.c,v 1.24 2005/06/07 13:25:23 jaredy Exp $");

#include "progressmeter.h"
#include "atomicio.h"
#include "misc.h"

#define DEFAULT_WINSIZE 80
#define MAX_WINSIZE 512
#define PADDING 1		/* padding between the progress indicators */
#define UPDATE_INTERVAL 1	/* update the progress meter every second */
#define STALL_TIME 5		/* we're stalled after this many seconds */

/* determines whether we can output to the terminal */
static int can_output(void);

/* formats and inserts the specified size into the given buffer */
static void format_size(char *, int, off_t);
static void format_rate(char *, int, off_t);

/* window resizing */
static void sig_winch(int);
static void setscreensize(void);

/* updates the progressmeter to reflect the current state of the transfer */
void refresh_progress_meter(void);

/* signal handler for updating the progress meter */
static void update_progress_meter(int);

static time_t start;		/* start progress */
static time_t last_update;	/* last progress update */
static char *file;		/* name of the file being transferred */
static off_t end_pos;		/* ending position of transfer */
static off_t cur_pos;		/* transfer position as of last refresh */
static volatile off_t *counter;	/* progress counter */
static long stalled;		/* how long we have been stalled */
static int bytes_per_second;	/* current speed in bytes per second */
static int win_size;		/* terminal window size */
static volatile sig_atomic_t win_resized; /* for window resizing */

/* units for format_size */
static const char unit[] = " KMGT";

static int
can_output(void)
{
	return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
}

static void
format_rate(char *buf, int size, off_t bytes)
{
	int i;

	bytes *= 100;
	for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
		bytes = (bytes + 512) / 1024;
	if (i == 0) {
		i++;
		bytes = (bytes + 512) / 1024;
	}
	snprintf(buf, size, "%3lld.%1lld%c%s",
	    (int64_t) (bytes + 5) / 100,
	    (int64_t) (bytes + 5) / 10 % 10,
	    unit[i],
	    i ? "B" : " ");
}

static void
format_size(char *buf, int size, off_t bytes)
{
	int i;

	for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
		bytes = (bytes + 512) / 1024;
	snprintf(buf, size, "%4lld%c%s",
	    (int64_t) bytes,
	    unit[i],
	    i ? "B" : " ");
}

void
refresh_progress_meter(void)
{
	char buf[MAX_WINSIZE + 1];
	time_t now;
	off_t transferred;
	double elapsed;
	int percent;
	off_t bytes_left;
	int cur_speed;
	int hours, minutes, seconds;
	int i, len;
	int file_len;

	transferred = *counter - cur_pos;
	cur_pos = *counter;
	now = time(NULL);
	bytes_left = end_pos - cur_pos;

	if (bytes_left > 0)
		elapsed = now - last_update;
	else {
		elapsed = now - start;
		/* Calculate true total speed when done */
		transferred = end_pos;
		bytes_per_second = 0;
	}

	/* calculate speed */
	if (elapsed != 0)
		cur_speed = (transferred / elapsed);
	else
		cur_speed = transferred;

#define AGE_FACTOR 0.9
	if (bytes_per_second != 0) {
		bytes_per_second = (bytes_per_second * AGE_FACTOR) +
		    (cur_speed * (1.0 - AGE_FACTOR));
	} else
		bytes_per_second = cur_speed;

	/* filename */
	buf[0] = '\0';
	file_len = win_size - 35;
	if (file_len > 0) {
		len = snprintf(buf, file_len + 1, "\r%s", file);
		if (len < 0)
			len = 0;
		if (len >= file_len + 1)
			len = file_len;
		for (i = len;  i < file_len; i++ )
			buf[i] = ' ';
		buf[file_len] = '\0';
	}

	/* percent of transfer done */
	if (end_pos != 0)
		percent = ((float)cur_pos / end_pos) * 100;
	else
		percent = 100;
	snprintf(buf + strlen(buf), win_size - strlen(buf),
	    " %3d%% ", percent);

	/* amount transferred */
	format_size(buf + strlen(buf), win_size - strlen(buf),
	    cur_pos);
	strlcat(buf, " ", win_size);

	/* bandwidth usage */
	format_rate(buf + strlen(buf), win_size - strlen(buf),
	    (off_t)bytes_per_second);
	strlcat(buf, "/s ", win_size);

	/* ETA */
	if (!transferred)
		stalled += elapsed;
	else
		stalled = 0;

	if (stalled >= STALL_TIME)
		strlcat(buf, "- stalled -", win_size);
	else if (bytes_per_second == 0 && bytes_left)
		strlcat(buf, "  --:-- ETA", win_size);
	else {
		if (bytes_left > 0)
			seconds = bytes_left / bytes_per_second;
		else
			seconds = elapsed;

		hours = seconds / 3600;
		seconds -= hours * 3600;
		minutes = seconds / 60;
		seconds -= minutes * 60;

		if (hours != 0)
			snprintf(buf + strlen(buf), win_size - strlen(buf),
			    "%d:%02d:%02d", hours, minutes, seconds);
		else
			snprintf(buf + strlen(buf), win_size - strlen(buf),
			    "  %02d:%02d", minutes, seconds);

		if (bytes_left > 0)
			strlcat(buf, " ETA", win_size);
		else
			strlcat(buf, "    ", win_size);
	}

	atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
	last_update = now;
}

static void
update_progress_meter(int ignore)
{
	int save_errno;

	save_errno = errno;

	if (win_resized) {
		setscreensize();
		win_resized = 0;
	}
	if (can_output())
		refresh_progress_meter();

	signal(SIGALRM, update_progress_meter);
	alarm(UPDATE_INTERVAL);
	errno = save_errno;
}

void
start_progress_meter(char *f, off_t filesize, off_t *ctr)
{
	start = last_update = time(NULL);
	file = f;
	end_pos = filesize;
	cur_pos = 0;
	counter = ctr;
	stalled = 0;
	bytes_per_second = 0;

	setscreensize();
	if (can_output())
		refresh_progress_meter();

	signal(SIGALRM, update_progress_meter);
	signal(SIGWINCH, sig_winch);
	alarm(UPDATE_INTERVAL);
}

void
stop_progress_meter(void)
{
	alarm(0);

	if (!can_output())
		return;

	/* Ensure we complete the progress */
	if (cur_pos != end_pos)
		refresh_progress_meter();

	atomicio(vwrite, STDOUT_FILENO, "\n", 1);
}

static void
sig_winch(int sig)
{
	win_resized = 1;
}

static void
setscreensize(void)
{
	struct winsize winsize;

	if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
	    winsize.ws_col != 0) {
		if (winsize.ws_col > MAX_WINSIZE)
			win_size = MAX_WINSIZE;
		else
			win_size = winsize.ws_col;
	} else
		win_size = DEFAULT_WINSIZE;
	win_size += 1;					/* trailing \0 */
}
Commit	Line	Data
c9c38b73	1	/*
178b1a1d	2	* Copyright (c) 2003 Nils Nordman. All rights reserved.
c9c38b73	3	*
	4	* Redistribution and use in source and binary forms, with or without
	5	* modification, are permitted provided that the following conditions
	6	* are met:
	7	* 1. Redistributions of source code must retain the above copyright
	8	* notice, this list of conditions and the following disclaimer.
	9	* 2. Redistributions in binary form must reproduce the above copyright
	10	* notice, this list of conditions and the following disclaimer in the
	11	* documentation and/or other materials provided with the distribution.
	12	*
	13	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	14	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	15	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	16	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	17	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	18	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	19	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	20	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	21	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	22	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	23	*/
	24
c9c38b73	25	#include "includes.h"
826563dc	26	RCSID("$OpenBSD: progressmeter.c,v 1.24 2005/06/07 13:25:23 jaredy Exp $");
c9c38b73	27
b7fd001f	28	#include "progressmeter.h"
178b1a1d	29	#include "atomicio.h"
8d9bb5dd	30	#include "misc.h"
c9c38b73	31
178b1a1d	32	#define DEFAULT_WINSIZE 80
	33	#define MAX_WINSIZE 512
	34	#define PADDING 1 /* padding between the progress indicators */
	35	#define UPDATE_INTERVAL 1 /* update the progress meter every second */
	36	#define STALL_TIME 5 /* we're stalled after this many seconds */
c9c38b73	37
178b1a1d	38	/* determines whether we can output to the terminal */
178b1a1d	39	static int can_output(void);
c9c38b73	40
178b1a1d	41	/* formats and inserts the specified size into the given buffer */
	42	static void format_size(char *, int, off_t);
	43	static void format_rate(char *, int, off_t);
c9c38b73	44
826563dc	45	/* window resizing */
	46	static void sig_winch(int);
	47	static void setscreensize(void);
	48
178b1a1d	49	/* updates the progressmeter to reflect the current state of the transfer */
178b1a1d	50	void refresh_progress_meter(void);
c9c38b73	51
178b1a1d	52	/* signal handler for updating the progress meter */
178b1a1d	53	static void update_progress_meter(int);
c9c38b73	54
f2107e97	55	static time_t start; /* start progress */
	56	static time_t last_update; /* last progress update */
	57	static char file; / name of the file being transferred */
	58	static off_t end_pos; /* ending position of transfer */
	59	static off_t cur_pos; /* transfer position as of last refresh */
178b1a1d	60	static volatile off_t counter; / progress counter */
f2107e97	61	static long stalled; /* how long we have been stalled */
	62	static int bytes_per_second; /* current speed in bytes per second */
	63	static int win_size; /* terminal window size */
826563dc	64	static volatile sig_atomic_t win_resized; /* for window resizing */
c9c38b73	65
178b1a1d	66	/* units for format_size */
178b1a1d	67	static const char unit[] = " KMGT";
c9c38b73	68
178b1a1d	69	static int
	70	can_output(void)
	71	{
	72	return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
	73	}
c9c38b73	74
178b1a1d	75	static void
	76	format_rate(char *buf, int size, off_t bytes)
	77	{
	78	int i;
	79
	80	bytes *= 100;
	81	for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
	82	bytes = (bytes + 512) / 1024;
	83	if (i == 0) {
	84	i++;
	85	bytes = (bytes + 512) / 1024;
	86	}
	87	snprintf(buf, size, "%3lld.%1lld%c%s",
81b161c2	88	(int64_t) (bytes + 5) / 100,
178b1a1d	89	(int64_t) (bytes + 5) / 10 % 10,
	90	unit[i],
	91	i ? "B" : " ");
	92	}
c9c38b73	93
178b1a1d	94	static void
	95	format_size(char *buf, int size, off_t bytes)
	96	{
	97	int i;
	98
	99	for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
	100	bytes = (bytes + 512) / 1024;
	101	snprintf(buf, size, "%4lld%c%s",
	102	(int64_t) bytes,
	103	unit[i],
	104	i ? "B" : " ");
	105	}
c9c38b73	106
c9c38b73	107	void
178b1a1d	108	refresh_progress_meter(void)
c9c38b73	109	{
178b1a1d	110	char buf[MAX_WINSIZE + 1];
	111	time_t now;
	112	off_t transferred;
	113	double elapsed;
	114	int percent;
7b0a59c9	115	off_t bytes_left;
178b1a1d	116	int cur_speed;
	117	int hours, minutes, seconds;
	118	int i, len;
	119	int file_len;
	120
	121	transferred = *counter - cur_pos;
	122	cur_pos = *counter;
	123	now = time(NULL);
	124	bytes_left = end_pos - cur_pos;
	125
	126	if (bytes_left > 0)
	127	elapsed = now - last_update;
adfde93f	128	else {
178b1a1d	129	elapsed = now - start;
adfde93f	130	/* Calculate true total speed when done */
	131	transferred = end_pos;
	132	bytes_per_second = 0;
	133	}
c9c38b73	134
178b1a1d	135	/* calculate speed */
	136	if (elapsed != 0)
	137	cur_speed = (transferred / elapsed);
	138	else
adfde93f	139	cur_speed = transferred;
c9c38b73	140
178b1a1d	141	#define AGE_FACTOR 0.9
	142	if (bytes_per_second != 0) {
	143	bytes_per_second = (bytes_per_second * AGE_FACTOR) +
	144	(cur_speed * (1.0 - AGE_FACTOR));
	145	} else
	146	bytes_per_second = cur_speed;
	147
	148	/* filename */
	149	buf[0] = '\0';
	150	file_len = win_size - 35;
	151	if (file_len > 0) {
8e382949	152	len = snprintf(buf, file_len + 1, "\r%s", file);
3845a9ac	153	if (len < 0)
3845a9ac	154	len = 0;
4b826d75	155	if (len >= file_len + 1)
4b826d75	156	len = file_len;
178b1a1d	157	for (i = len; i < file_len; i++ )
	158	buf[i] = ' ';
	159	buf[file_len] = '\0';
	160	}
c9c38b73	161
178b1a1d	162	/* percent of transfer done */
	163	if (end_pos != 0)
	164	percent = ((float)cur_pos / end_pos) * 100;
	165	else
	166	percent = 100;
	167	snprintf(buf + strlen(buf), win_size - strlen(buf),
	168	" %3d%% ", percent);
	169
	170	/* amount transferred */
	171	format_size(buf + strlen(buf), win_size - strlen(buf),
	172	cur_pos);
	173	strlcat(buf, " ", win_size);
	174
	175	/* bandwidth usage */
	176	format_rate(buf + strlen(buf), win_size - strlen(buf),
f6be21a0	177	(off_t)bytes_per_second);
178b1a1d	178	strlcat(buf, "/s ", win_size);
	179
	180	/* ETA */
	181	if (!transferred)
	182	stalled += elapsed;
	183	else
	184	stalled = 0;
	185
	186	if (stalled >= STALL_TIME)
	187	strlcat(buf, "- stalled -", win_size);
	188	else if (bytes_per_second == 0 && bytes_left)
	189	strlcat(buf, " --:-- ETA", win_size);
	190	else {
	191	if (bytes_left > 0)
	192	seconds = bytes_left / bytes_per_second;
	193	else
	194	seconds = elapsed;
	195
	196	hours = seconds / 3600;
	197	seconds -= hours * 3600;
	198	minutes = seconds / 60;
	199	seconds -= minutes * 60;
	200
	201	if (hours != 0)
	202	snprintf(buf + strlen(buf), win_size - strlen(buf),
	203	"%d:%02d:%02d", hours, minutes, seconds);
	204	else
	205	snprintf(buf + strlen(buf), win_size - strlen(buf),
	206	" %02d:%02d", minutes, seconds);
	207
	208	if (bytes_left > 0)
	209	strlcat(buf, " ETA", win_size);
	210	else
	211	strlcat(buf, " ", win_size);
	212	}
	213
0469be42	214	atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
178b1a1d	215	last_update = now;
c9c38b73	216	}
	217
	218	static void
	219	update_progress_meter(int ignore)
	220	{
178b1a1d	221	int save_errno;
	222
	223	save_errno = errno;
	224
826563dc	225	if (win_resized) {
	226	setscreensize();
	227	win_resized = 0;
	228	}
178b1a1d	229	if (can_output())
178b1a1d	230	refresh_progress_meter();
c9c38b73	231
f00d1f78	232	signal(SIGALRM, update_progress_meter);
178b1a1d	233	alarm(UPDATE_INTERVAL);
c9c38b73	234	errno = save_errno;
	235	}
	236
178b1a1d	237	void
ca75d7de	238	start_progress_meter(char f, off_t filesize, off_t ctr)
c9c38b73	239	{
178b1a1d	240	start = last_update = time(NULL);
	241	file = f;
	242	end_pos = filesize;
	243	cur_pos = 0;
ca75d7de	244	counter = ctr;
178b1a1d	245	stalled = 0;
	246	bytes_per_second = 0;
	247
826563dc	248	setscreensize();
178b1a1d	249	if (can_output())
178b1a1d	250	refresh_progress_meter();
c9c38b73	251
f00d1f78	252	signal(SIGALRM, update_progress_meter);
826563dc	253	signal(SIGWINCH, sig_winch);
178b1a1d	254	alarm(UPDATE_INTERVAL);
c9c38b73	255	}
c9c38b73	256
178b1a1d	257	void
178b1a1d	258	stop_progress_meter(void)
c9c38b73	259	{
178b1a1d	260	alarm(0);
c9c38b73	261
178b1a1d	262	if (!can_output())
	263	return;
	264
	265	/* Ensure we complete the progress */
	266	if (cur_pos != end_pos)
	267	refresh_progress_meter();
	268
	269	atomicio(vwrite, STDOUT_FILENO, "\n", 1);
c9c38b73	270	}
826563dc	271
	272	static void
	273	sig_winch(int sig)
	274	{
	275	win_resized = 1;
	276	}
	277
	278	static void
	279	setscreensize(void)
	280	{
	281	struct winsize winsize;
	282
	283	if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
	284	winsize.ws_col != 0) {
	285	if (winsize.ws_col > MAX_WINSIZE)
	286	win_size = MAX_WINSIZE;
	287	else
	288	win_size = winsize.ws_col;
	289	} else
	290	win_size = DEFAULT_WINSIZE;
	291	win_size += 1; /* trailing \0 */
	292	}