GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: usr.bin/ssh/lib/../progressmeter.c Lines: 0 110 0.0 %
Date: 2017-11-13 Branches: 0 52 0.0 %

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
	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
	bytes *= 100;
91
	for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
92
		bytes = (bytes + 512) / 1024;
93
	if (i == 0) {
94
		i++;
95
		bytes = (bytes + 512) / 1024;
96
	}
97
	snprintf(buf, size, "%3lld.%1lld%c%s",
98
	    (long long) (bytes + 5) / 100,
99
	    (long long) (bytes + 5) / 10 % 10,
100
	    unit[i],
101
	    i ? "B" : " ");
102
}
103
104
static void
105
format_size(char *buf, int size, off_t bytes)
106
{
107
	int i;
108
109
	for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
110
		bytes = (bytes + 512) / 1024;
111
	snprintf(buf, size, "%4lld%c%s",
112
	    (long long) bytes,
113
	    unit[i],
114
	    i ? "B" : " ");
115
}
116
117
void
118
refresh_progress_meter(void)
119
{
120
	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
	transferred = *counter - (cur_pos ? cur_pos : start_pos);
131
	cur_pos = *counter;
132
	now = monotime_double();
133
	bytes_left = end_pos - cur_pos;
134
135
	if (bytes_left > 0)
136
		elapsed = now - last_update;
137
	else {
138
		elapsed = now - start;
139
		/* Calculate true total speed when done */
140
		transferred = end_pos - start_pos;
141
		bytes_per_second = 0;
142
	}
143
144
	/* calculate speed */
145
	if (elapsed != 0)
146
		cur_speed = (transferred / elapsed);
147
	else
148
		cur_speed = transferred;
149
150
#define AGE_FACTOR 0.9
151
	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
	buf[0] = '\0';
159
	file_len = win_size - 35;
160
	if (file_len > 0) {
161
		len = snprintf(buf, file_len + 1, "\r%s", file);
162
		if (len < 0)
163
			len = 0;
164
		if (len >= file_len + 1)
165
			len = file_len;
166
		for (i = len; i < file_len; i++)
167
			buf[i] = ' ';
168
		buf[file_len] = '\0';
169
	}
170
171
	/* percent of transfer done */
172
	if (end_pos == 0 || cur_pos == end_pos)
173
		percent = 100;
174
	else
175
		percent = ((float)cur_pos / end_pos) * 100;
176
	snprintf(buf + strlen(buf), win_size - strlen(buf),
177
	    " %3d%% ", percent);
178
179
	/* amount transferred */
180
	format_size(buf + strlen(buf), win_size - strlen(buf),
181
	    cur_pos);
182
	strlcat(buf, " ", win_size);
183
184
	/* bandwidth usage */
185
	format_rate(buf + strlen(buf), win_size - strlen(buf),
186
	    (off_t)bytes_per_second);
187
	strlcat(buf, "/s ", win_size);
188
189
	/* ETA */
190
	if (!transferred)
191
		stalled += elapsed;
192
	else
193
		stalled = 0;
194
195
	if (stalled >= STALL_TIME)
196
		strlcat(buf, "- stalled -", win_size);
197
	else if (bytes_per_second == 0 && bytes_left)
198
		strlcat(buf, "  --:-- ETA", win_size);
199
	else {
200
		if (bytes_left > 0)
201
			seconds = bytes_left / bytes_per_second;
202
		else
203
			seconds = elapsed;
204
205
		hours = seconds / 3600;
206
		seconds -= hours * 3600;
207
		minutes = seconds / 60;
208
		seconds -= minutes * 60;
209
210
		if (hours != 0)
211
			snprintf(buf + strlen(buf), win_size - strlen(buf),
212
			    "%d:%02d:%02d", hours, minutes, seconds);
213
		else
214
			snprintf(buf + strlen(buf), win_size - strlen(buf),
215
			    "  %02d:%02d", minutes, seconds);
216
217
		if (bytes_left > 0)
218
			strlcat(buf, " ETA", win_size);
219
		else
220
			strlcat(buf, "    ", win_size);
221
	}
222
223
	atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
224
	last_update = now;
225
}
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
	start = last_update = monotime_double();
251
	file = f;
252
	start_pos = *ctr;
253
	end_pos = filesize;
254
	cur_pos = 0;
255
	counter = ctr;
256
	stalled = 0;
257
	bytes_per_second = 0;
258
259
	setscreensize();
260
	if (can_output())
261
		refresh_progress_meter();
262
263
	signal(SIGALRM, update_progress_meter);
264
	signal(SIGWINCH, sig_winch);
265
	alarm(UPDATE_INTERVAL);
266
}
267
268
void
269
stop_progress_meter(void)
270
{
271
	alarm(0);
272
273
	if (!can_output())
274
		return;
275
276
	/* Ensure we complete the progress */
277
	if (cur_pos != end_pos)
278
		refresh_progress_meter();
279
280
	atomicio(vwrite, STDOUT_FILENO, "\n", 1);
281
}
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
	struct winsize winsize;
294
295
	if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
296
	    winsize.ws_col != 0) {
297
		if (winsize.ws_col > MAX_WINSIZE)
298
			win_size = MAX_WINSIZE;
299
		else
300
			win_size = winsize.ws_col;
301
	} else
302
		win_size = DEFAULT_WINSIZE;
303
	win_size += 1;					/* trailing \0 */
304
}