]>
Commit | Line | Data |
---|---|---|
c9c38b73 | 1 | /* |
178b1a1d | 2 | * Copyright (c) 2003 Nils Nordman. All rights reserved. |
c9c38b73 | 3 | * |
4 | * Redistribution and use in source and binary forms, with or without | |
5 | * modification, are permitted provided that the following conditions | |
6 | * are met: | |
7 | * 1. Redistributions of source code must retain the above copyright | |
8 | * notice, this list of conditions and the following disclaimer. | |
9 | * 2. Redistributions in binary form must reproduce the above copyright | |
10 | * notice, this list of conditions and the following disclaimer in the | |
11 | * documentation and/or other materials provided with the distribution. | |
12 | * | |
13 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
14 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | |
15 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | |
16 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | |
17 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | |
18 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
19 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
20 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
21 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | |
22 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
23 | */ | |
24 | ||
c9c38b73 | 25 | #include "includes.h" |
0469be42 | 26 | RCSID("$OpenBSD: progressmeter.c,v 1.16 2003/09/23 20:18:52 markus Exp $"); |
c9c38b73 | 27 | |
b7fd001f | 28 | #include "progressmeter.h" |
178b1a1d | 29 | #include "atomicio.h" |
8d9bb5dd | 30 | #include "misc.h" |
c9c38b73 | 31 | |
178b1a1d | 32 | #define DEFAULT_WINSIZE 80 |
33 | #define MAX_WINSIZE 512 | |
34 | #define PADDING 1 /* padding between the progress indicators */ | |
35 | #define UPDATE_INTERVAL 1 /* update the progress meter every second */ | |
36 | #define STALL_TIME 5 /* we're stalled after this many seconds */ | |
c9c38b73 | 37 | |
178b1a1d | 38 | /* determines whether we can output to the terminal */ |
39 | static int can_output(void); | |
c9c38b73 | 40 | |
178b1a1d | 41 | /* formats and inserts the specified size into the given buffer */ |
42 | static void format_size(char *, int, off_t); | |
43 | static void format_rate(char *, int, off_t); | |
c9c38b73 | 44 | |
178b1a1d | 45 | /* updates the progressmeter to reflect the current state of the transfer */ |
46 | void refresh_progress_meter(void); | |
c9c38b73 | 47 | |
178b1a1d | 48 | /* signal handler for updating the progress meter */ |
49 | static void update_progress_meter(int); | |
c9c38b73 | 50 | |
178b1a1d | 51 | static time_t start; /* start progress */ |
52 | static time_t last_update; /* last progress update */ | |
53 | static char *file; /* name of the file being transferred */ | |
54 | static off_t end_pos; /* ending position of transfer */ | |
55 | static off_t cur_pos; /* transfer position as of last refresh */ | |
56 | static volatile off_t *counter; /* progress counter */ | |
57 | static long stalled; /* how long we have been stalled */ | |
58 | static int bytes_per_second; /* current speed in bytes per second */ | |
59 | static int win_size; /* terminal window size */ | |
c9c38b73 | 60 | |
178b1a1d | 61 | /* units for format_size */ |
62 | static const char unit[] = " KMGT"; | |
c9c38b73 | 63 | |
178b1a1d | 64 | static int |
65 | can_output(void) | |
66 | { | |
67 | return (getpgrp() == tcgetpgrp(STDOUT_FILENO)); | |
68 | } | |
c9c38b73 | 69 | |
178b1a1d | 70 | static void |
71 | format_rate(char *buf, int size, off_t bytes) | |
72 | { | |
73 | int i; | |
74 | ||
75 | bytes *= 100; | |
76 | for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++) | |
77 | bytes = (bytes + 512) / 1024; | |
78 | if (i == 0) { | |
79 | i++; | |
80 | bytes = (bytes + 512) / 1024; | |
81 | } | |
82 | snprintf(buf, size, "%3lld.%1lld%c%s", | |
83 | (int64_t) bytes / 100, | |
84 | (int64_t) (bytes + 5) / 10 % 10, | |
85 | unit[i], | |
86 | i ? "B" : " "); | |
87 | } | |
c9c38b73 | 88 | |
178b1a1d | 89 | static void |
90 | format_size(char *buf, int size, off_t bytes) | |
91 | { | |
92 | int i; | |
93 | ||
94 | for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++) | |
95 | bytes = (bytes + 512) / 1024; | |
96 | snprintf(buf, size, "%4lld%c%s", | |
97 | (int64_t) bytes, | |
98 | unit[i], | |
99 | i ? "B" : " "); | |
100 | } | |
c9c38b73 | 101 | |
102 | void | |
178b1a1d | 103 | refresh_progress_meter(void) |
c9c38b73 | 104 | { |
178b1a1d | 105 | char buf[MAX_WINSIZE + 1]; |
106 | time_t now; | |
107 | off_t transferred; | |
108 | double elapsed; | |
109 | int percent; | |
110 | int bytes_left; | |
111 | int cur_speed; | |
112 | int hours, minutes, seconds; | |
113 | int i, len; | |
114 | int file_len; | |
115 | ||
116 | transferred = *counter - cur_pos; | |
117 | cur_pos = *counter; | |
118 | now = time(NULL); | |
119 | bytes_left = end_pos - cur_pos; | |
120 | ||
121 | if (bytes_left > 0) | |
122 | elapsed = now - last_update; | |
123 | else | |
124 | elapsed = now - start; | |
c9c38b73 | 125 | |
178b1a1d | 126 | /* calculate speed */ |
127 | if (elapsed != 0) | |
128 | cur_speed = (transferred / elapsed); | |
129 | else | |
130 | cur_speed = 0; | |
c9c38b73 | 131 | |
178b1a1d | 132 | #define AGE_FACTOR 0.9 |
133 | if (bytes_per_second != 0) { | |
134 | bytes_per_second = (bytes_per_second * AGE_FACTOR) + | |
135 | (cur_speed * (1.0 - AGE_FACTOR)); | |
136 | } else | |
137 | bytes_per_second = cur_speed; | |
138 | ||
139 | /* filename */ | |
140 | buf[0] = '\0'; | |
141 | file_len = win_size - 35; | |
142 | if (file_len > 0) { | |
8e382949 | 143 | len = snprintf(buf, file_len + 1, "\r%s", file); |
3845a9ac | 144 | if (len < 0) |
145 | len = 0; | |
178b1a1d | 146 | for (i = len; i < file_len; i++ ) |
147 | buf[i] = ' '; | |
148 | buf[file_len] = '\0'; | |
149 | } | |
c9c38b73 | 150 | |
178b1a1d | 151 | /* percent of transfer done */ |
152 | if (end_pos != 0) | |
153 | percent = ((float)cur_pos / end_pos) * 100; | |
154 | else | |
155 | percent = 100; | |
156 | snprintf(buf + strlen(buf), win_size - strlen(buf), | |
157 | " %3d%% ", percent); | |
158 | ||
159 | /* amount transferred */ | |
160 | format_size(buf + strlen(buf), win_size - strlen(buf), | |
161 | cur_pos); | |
162 | strlcat(buf, " ", win_size); | |
163 | ||
164 | /* bandwidth usage */ | |
165 | format_rate(buf + strlen(buf), win_size - strlen(buf), | |
166 | bytes_per_second); | |
167 | strlcat(buf, "/s ", win_size); | |
168 | ||
169 | /* ETA */ | |
170 | if (!transferred) | |
171 | stalled += elapsed; | |
172 | else | |
173 | stalled = 0; | |
174 | ||
175 | if (stalled >= STALL_TIME) | |
176 | strlcat(buf, "- stalled -", win_size); | |
177 | else if (bytes_per_second == 0 && bytes_left) | |
178 | strlcat(buf, " --:-- ETA", win_size); | |
179 | else { | |
180 | if (bytes_left > 0) | |
181 | seconds = bytes_left / bytes_per_second; | |
182 | else | |
183 | seconds = elapsed; | |
184 | ||
185 | hours = seconds / 3600; | |
186 | seconds -= hours * 3600; | |
187 | minutes = seconds / 60; | |
188 | seconds -= minutes * 60; | |
189 | ||
190 | if (hours != 0) | |
191 | snprintf(buf + strlen(buf), win_size - strlen(buf), | |
192 | "%d:%02d:%02d", hours, minutes, seconds); | |
193 | else | |
194 | snprintf(buf + strlen(buf), win_size - strlen(buf), | |
195 | " %02d:%02d", minutes, seconds); | |
196 | ||
197 | if (bytes_left > 0) | |
198 | strlcat(buf, " ETA", win_size); | |
199 | else | |
200 | strlcat(buf, " ", win_size); | |
201 | } | |
202 | ||
0469be42 | 203 | atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1); |
178b1a1d | 204 | last_update = now; |
c9c38b73 | 205 | } |
206 | ||
207 | static void | |
208 | update_progress_meter(int ignore) | |
209 | { | |
178b1a1d | 210 | int save_errno; |
211 | ||
212 | save_errno = errno; | |
213 | ||
214 | if (can_output()) | |
215 | refresh_progress_meter(); | |
c9c38b73 | 216 | |
f00d1f78 | 217 | signal(SIGALRM, update_progress_meter); |
178b1a1d | 218 | alarm(UPDATE_INTERVAL); |
c9c38b73 | 219 | errno = save_errno; |
220 | } | |
221 | ||
178b1a1d | 222 | void |
223 | start_progress_meter(char *f, off_t filesize, off_t *stat) | |
c9c38b73 | 224 | { |
178b1a1d | 225 | struct winsize winsize; |
c9c38b73 | 226 | |
178b1a1d | 227 | start = last_update = time(NULL); |
228 | file = f; | |
229 | end_pos = filesize; | |
230 | cur_pos = 0; | |
231 | counter = stat; | |
232 | stalled = 0; | |
233 | bytes_per_second = 0; | |
234 | ||
235 | if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 && | |
236 | winsize.ws_col != 0) { | |
237 | if (winsize.ws_col > MAX_WINSIZE) | |
238 | win_size = MAX_WINSIZE; | |
239 | else | |
240 | win_size = winsize.ws_col; | |
c9c38b73 | 241 | } else |
178b1a1d | 242 | win_size = DEFAULT_WINSIZE; |
243 | win_size += 1; /* trailing \0 */ | |
c9c38b73 | 244 | |
178b1a1d | 245 | if (can_output()) |
246 | refresh_progress_meter(); | |
c9c38b73 | 247 | |
f00d1f78 | 248 | signal(SIGALRM, update_progress_meter); |
178b1a1d | 249 | alarm(UPDATE_INTERVAL); |
c9c38b73 | 250 | } |
251 | ||
178b1a1d | 252 | void |
253 | stop_progress_meter(void) | |
c9c38b73 | 254 | { |
178b1a1d | 255 | alarm(0); |
c9c38b73 | 256 | |
178b1a1d | 257 | if (!can_output()) |
258 | return; | |
259 | ||
260 | /* Ensure we complete the progress */ | |
261 | if (cur_pos != end_pos) | |
262 | refresh_progress_meter(); | |
263 | ||
264 | atomicio(vwrite, STDOUT_FILENO, "\n", 1); | |
c9c38b73 | 265 | } |