1 /* $OpenBSD: progressmeter.c,v 1.41 2015/01/14 13:54:13 djm Exp $ */
3 * Copyright (c) 2003 Nils Nordman. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
28 #include <sys/types.h>
29 #include <sys/ioctl.h>
39 #include "progressmeter.h"
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 */
49 /* determines whether we can output to the terminal */
50 static int can_output(void);
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
);
57 static void sig_winch(int);
58 static void setscreensize(void);
60 /* updates the progressmeter to reflect the current state of the transfer */
61 void refresh_progress_meter(void);
63 /* signal handler for updating the progress meter */
64 static void update_progress_meter(int);
66 static time_t start
; /* start progress */
67 static time_t last_update
; /* last progress update */
68 static const char *file
; /* name of the file being transferred */
69 static off_t start_pos
; /* initial position of transfer */
70 static off_t end_pos
; /* ending position of transfer */
71 static off_t cur_pos
; /* transfer position as of last refresh */
72 static volatile off_t
*counter
; /* progress counter */
73 static long stalled
; /* how long we have been stalled */
74 static int bytes_per_second
; /* current speed in bytes per second */
75 static int win_size
; /* terminal window size */
76 static volatile sig_atomic_t win_resized
; /* for window resizing */
78 /* units for format_size */
79 static const char unit
[] = " KMGT";
84 return (getpgrp() == tcgetpgrp(STDOUT_FILENO
));
88 format_rate(char *buf
, int size
, off_t bytes
)
93 for (i
= 0; bytes
>= 100*1000 && unit
[i
] != 'T'; i
++)
94 bytes
= (bytes
+ 512) / 1024;
97 bytes
= (bytes
+ 512) / 1024;
99 snprintf(buf
, size
, "%3lld.%1lld%c%s",
100 (long long) (bytes
+ 5) / 100,
101 (long long) (bytes
+ 5) / 10 % 10,
107 format_size(char *buf
, int size
, off_t bytes
)
111 for (i
= 0; bytes
>= 10000 && unit
[i
] != 'T'; i
++)
112 bytes
= (bytes
+ 512) / 1024;
113 snprintf(buf
, size
, "%4lld%c%s",
120 refresh_progress_meter(void)
122 char buf
[MAX_WINSIZE
+ 1];
129 int hours
, minutes
, seconds
;
133 transferred
= *counter
- (cur_pos
? cur_pos
: start_pos
);
136 bytes_left
= end_pos
- cur_pos
;
139 elapsed
= now
- last_update
;
141 elapsed
= now
- start
;
142 /* Calculate true total speed when done */
143 transferred
= end_pos
- start_pos
;
144 bytes_per_second
= 0;
147 /* calculate speed */
149 cur_speed
= (transferred
/ elapsed
);
151 cur_speed
= transferred
;
153 #define AGE_FACTOR 0.9
154 if (bytes_per_second
!= 0) {
155 bytes_per_second
= (bytes_per_second
* AGE_FACTOR
) +
156 (cur_speed
* (1.0 - AGE_FACTOR
));
158 bytes_per_second
= cur_speed
;
162 file_len
= win_size
- 35;
164 len
= snprintf(buf
, file_len
+ 1, "\r%s", file
);
167 if (len
>= file_len
+ 1)
169 for (i
= len
; i
< file_len
; i
++)
171 buf
[file_len
] = '\0';
174 /* percent of transfer done */
176 percent
= ((float)cur_pos
/ end_pos
) * 100;
179 snprintf(buf
+ strlen(buf
), win_size
- strlen(buf
),
182 /* amount transferred */
183 format_size(buf
+ strlen(buf
), win_size
- strlen(buf
),
185 strlcat(buf
, " ", win_size
);
187 /* bandwidth usage */
188 format_rate(buf
+ strlen(buf
), win_size
- strlen(buf
),
189 (off_t
)bytes_per_second
);
190 strlcat(buf
, "/s ", win_size
);
198 if (stalled
>= STALL_TIME
)
199 strlcat(buf
, "- stalled -", win_size
);
200 else if (bytes_per_second
== 0 && bytes_left
)
201 strlcat(buf
, " --:-- ETA", win_size
);
204 seconds
= bytes_left
/ bytes_per_second
;
208 hours
= seconds
/ 3600;
209 seconds
-= hours
* 3600;
210 minutes
= seconds
/ 60;
211 seconds
-= minutes
* 60;
214 snprintf(buf
+ strlen(buf
), win_size
- strlen(buf
),
215 "%d:%02d:%02d", hours
, minutes
, seconds
);
217 snprintf(buf
+ strlen(buf
), win_size
- strlen(buf
),
218 " %02d:%02d", minutes
, seconds
);
221 strlcat(buf
, " ETA", win_size
);
223 strlcat(buf
, " ", win_size
);
226 atomicio(vwrite
, STDOUT_FILENO
, buf
, win_size
- 1);
232 update_progress_meter(int ignore
)
243 refresh_progress_meter();
245 signal(SIGALRM
, update_progress_meter
);
246 alarm(UPDATE_INTERVAL
);
251 start_progress_meter(const char *f
, off_t filesize
, off_t
*ctr
)
253 start
= last_update
= monotime();
260 bytes_per_second
= 0;
264 refresh_progress_meter();
266 signal(SIGALRM
, update_progress_meter
);
267 signal(SIGWINCH
, sig_winch
);
268 alarm(UPDATE_INTERVAL
);
272 stop_progress_meter(void)
279 /* Ensure we complete the progress */
280 if (cur_pos
!= end_pos
)
281 refresh_progress_meter();
283 atomicio(vwrite
, STDOUT_FILENO
, "\n", 1);
296 struct winsize winsize
;
298 if (ioctl(STDOUT_FILENO
, TIOCGWINSZ
, &winsize
) != -1 &&
299 winsize
.ws_col
!= 0) {
300 if (winsize
.ws_col
> MAX_WINSIZE
)
301 win_size
= MAX_WINSIZE
;
303 win_size
= winsize
.ws_col
;
305 win_size
= DEFAULT_WINSIZE
;
306 win_size
+= 1; /* trailing \0 */