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.
27 /*RCSID("$OpenBSD: progressmeter.c,v 1.24 2005/06/07 13:25:23 jaredy Exp $");*/
29 #include "progressmeter.h"
33 #define DEFAULT_WINSIZE 80
34 #define MAX_WINSIZE 512
35 #define PADDING 1 /* padding between the progress indicators */
36 #define UPDATE_INTERVAL 1 /* update the progress meter every second */
37 #define STALL_TIME 5 /* we're stalled after this many seconds */
39 /* determines whether we can output to the terminal */
40 static int can_output(void);
42 /* formats and inserts the specified size into the given buffer */
43 static void format_size(char *, int, off_t
);
44 static void format_rate(char *, int, off_t
);
47 static void sig_winch(int);
48 static void setscreensize(void);
50 /* updates the progressmeter to reflect the current state of the transfer */
51 void refresh_progress_meter(void);
53 /* signal handler for updating the progress meter */
54 static void update_progress_meter(int);
56 static time_t start
; /* start progress */
57 static time_t last_update
; /* last progress update */
58 static char *file
; /* name of the file being transferred */
59 static off_t end_pos
; /* ending position of transfer */
60 static off_t cur_pos
; /* transfer position as of last refresh */
61 static volatile off_t
*counter
; /* progress counter */
62 static long stalled
; /* how long we have been stalled */
63 static int bytes_per_second
; /* current speed in bytes per second */
64 static int win_size
; /* terminal window size */
65 static volatile sig_atomic_t win_resized
; /* for window resizing */
67 /* units for format_size */
68 static const char unit
[] = " KMGT";
73 return (getpgrp() == tcgetpgrp(STDOUT_FILENO
));
77 format_rate(char *buf
, int size
, off_t bytes
)
82 for (i
= 0; bytes
>= 100*1000 && unit
[i
] != 'T'; i
++)
83 bytes
= (bytes
+ 512) / 1024;
86 bytes
= (bytes
+ 512) / 1024;
88 snprintf(buf
, size
, "%3lld.%1lld%c%s",
89 (long long) (bytes
+ 5) / 100,
90 (long long) (bytes
+ 5) / 10 % 10,
96 format_size(char *buf
, int size
, off_t bytes
)
100 for (i
= 0; bytes
>= 10000 && unit
[i
] != 'T'; i
++)
101 bytes
= (bytes
+ 512) / 1024;
102 snprintf(buf
, size
, "%4lld%c%s",
109 refresh_progress_meter(void)
111 char buf
[MAX_WINSIZE
+ 1];
118 int hours
, minutes
, seconds
;
122 transferred
= *counter
- cur_pos
;
125 bytes_left
= end_pos
- cur_pos
;
128 elapsed
= now
- last_update
;
130 elapsed
= now
- start
;
131 /* Calculate true total speed when done */
132 transferred
= end_pos
;
133 bytes_per_second
= 0;
136 /* calculate speed */
138 cur_speed
= (transferred
/ elapsed
);
140 cur_speed
= transferred
;
142 #define AGE_FACTOR 0.9
143 if (bytes_per_second
!= 0) {
144 bytes_per_second
= (bytes_per_second
* AGE_FACTOR
) +
145 (cur_speed
* (1.0 - AGE_FACTOR
));
147 bytes_per_second
= cur_speed
;
151 file_len
= win_size
- 35;
153 len
= snprintf(buf
, file_len
+ 1, "\r%s", file
);
156 if (len
>= file_len
+ 1)
158 for (i
= len
; i
< file_len
; i
++ )
160 buf
[file_len
] = '\0';
163 /* percent of transfer done */
165 percent
= ((float)cur_pos
/ end_pos
) * 100;
168 snprintf(buf
+ strlen(buf
), win_size
- strlen(buf
),
171 /* amount transferred */
172 format_size(buf
+ strlen(buf
), win_size
- strlen(buf
),
174 strlcat(buf
, " ", win_size
);
176 /* bandwidth usage */
177 format_rate(buf
+ strlen(buf
), win_size
- strlen(buf
),
178 (off_t
)bytes_per_second
);
179 strlcat(buf
, "/s ", win_size
);
187 if (stalled
>= STALL_TIME
)
188 strlcat(buf
, "- stalled -", win_size
);
189 else if (bytes_per_second
== 0 && bytes_left
)
190 strlcat(buf
, " --:-- ETA", win_size
);
193 seconds
= bytes_left
/ bytes_per_second
;
197 hours
= seconds
/ 3600;
198 seconds
-= hours
* 3600;
199 minutes
= seconds
/ 60;
200 seconds
-= minutes
* 60;
203 snprintf(buf
+ strlen(buf
), win_size
- strlen(buf
),
204 "%d:%02d:%02d", hours
, minutes
, seconds
);
206 snprintf(buf
+ strlen(buf
), win_size
- strlen(buf
),
207 " %02d:%02d", minutes
, seconds
);
210 strlcat(buf
, " ETA", win_size
);
212 strlcat(buf
, " ", win_size
);
215 atomicio(vwrite
, STDOUT_FILENO
, buf
, win_size
- 1);
220 update_progress_meter(int ignore
)
231 refresh_progress_meter();
233 signal(SIGALRM
, update_progress_meter
);
234 alarm(UPDATE_INTERVAL
);
239 start_progress_meter(char *f
, off_t filesize
, off_t
*ctr
)
241 start
= last_update
= time(NULL
);
247 bytes_per_second
= 0;
251 refresh_progress_meter();
253 signal(SIGALRM
, update_progress_meter
);
254 signal(SIGWINCH
, sig_winch
);
255 alarm(UPDATE_INTERVAL
);
259 stop_progress_meter(void)
266 /* Ensure we complete the progress */
267 if (cur_pos
!= end_pos
)
268 refresh_progress_meter();
270 atomicio(vwrite
, STDOUT_FILENO
, "\n", 1);
282 struct winsize winsize
;
284 if (ioctl(STDOUT_FILENO
, TIOCGWINSZ
, &winsize
) != -1 &&
285 winsize
.ws_col
!= 0) {
286 if (winsize
.ws_col
> MAX_WINSIZE
)
287 win_size
= MAX_WINSIZE
;
289 win_size
= winsize
.ws_col
;
291 win_size
= DEFAULT_WINSIZE
;
292 win_size
+= 1; /* trailing \0 */
294 #endif /* PROGRESS_METER */