[gssapi-openssh.git] / openssh / progressmeter.c

/* $OpenBSD: progressmeter.c,v 1.37 2006/08/03 03:34:42 deraadt Exp $ */
/*
 * 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"

#include <sys/types.h>
#include <sys/ioctl.h>
#include <sys/uio.h>

#include <errno.h>
#include <signal.h>
#include <stdio.h>
#include <string.h>
#include <time.h>
#include <unistd.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 off_t last_pos;
static off_t max_delta_pos = 0;
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;
	off_t delta_pos;

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

	delta_pos = cur_pos - last_pos;
	if (delta_pos > max_delta_pos) 
		max_delta_pos = delta_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 - 45;
	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-8),
	    " %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);

	/* instantaneous rate */
	if (bytes_left > 0)
		format_rate(buf + strlen(buf), win_size - strlen(buf),
			    delta_pos);
	else
		format_rate(buf + strlen(buf), win_size - strlen(buf),
			    max_delta_pos);
	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;
	last_pos = cur_pos;
}

/*ARGSUSED*/
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);
}

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