[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.25 2006/02/10 00:27:13 stevesk Exp $");

#include <sys/ioctl.h>

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