Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	usr.bin/ssh/lib/../progressmeter.c	Lines:	101	118	85.6 %
Date:	2017-11-07	Branches:	33	52	63.5 %


/* $OpenBSD: progressmeter.c,v 1.45 2016/06/30 05:17:05 dtucker 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 <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 double start;		/* start progress */
static double last_update;	/* last progress update */
static const char *file;	/* name of the file being transferred */
static off_t start_pos;		/* initial position of transfer */
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];
	off_t transferred;
	double elapsed, now;
	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 : start_pos);
	cur_pos = *counter;
	now = monotime_double();
	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 - start_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 || cur_pos == end_pos)
		percent = 100;
	else
		percent = ((float)cur_pos / end_pos) * 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;
}

/*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(const char *f, off_t filesize, off_t *ctr)
{
	start = last_update = monotime_double();
	file = f;
	start_pos = *ctr;
	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 */
}


Generated by: GCOVR (Version 3.3)

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