/src/CMake/Utilities/cmcurl/lib/progress.c
Line | Count | Source |
1 | | /*************************************************************************** |
2 | | * _ _ ____ _ |
3 | | * Project ___| | | | _ \| | |
4 | | * / __| | | | |_) | | |
5 | | * | (__| |_| | _ <| |___ |
6 | | * \___|\___/|_| \_\_____| |
7 | | * |
8 | | * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. |
9 | | * |
10 | | * This software is licensed as described in the file COPYING, which |
11 | | * you should have received as part of this distribution. The terms |
12 | | * are also available at https://curl.se/docs/copyright.html. |
13 | | * |
14 | | * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
15 | | * copies of the Software, and permit persons to whom the Software is |
16 | | * furnished to do so, under the terms of the COPYING file. |
17 | | * |
18 | | * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
19 | | * KIND, either express or implied. |
20 | | * |
21 | | * SPDX-License-Identifier: curl |
22 | | * |
23 | | ***************************************************************************/ |
24 | | #include "curl_setup.h" |
25 | | |
26 | | #include "urldata.h" |
27 | | #include "curl_trc.h" |
28 | | #include "multiif.h" |
29 | | #include "progress.h" |
30 | | #include "transfer.h" |
31 | | #include "curlx/strcopy.h" |
32 | | |
33 | | #ifndef CURL_DISABLE_PROGRESS_METER |
34 | | /* Provide a string that is 7 letters long (plus the zero byte). |
35 | | |
36 | | @unittest 1636 |
37 | | */ |
38 | | UNITTEST void time2str(char *r, size_t rsize, curl_off_t seconds); |
39 | | UNITTEST void time2str(char *r, size_t rsize, curl_off_t seconds) |
40 | 0 | { |
41 | 0 | curl_off_t h; |
42 | 0 | if(seconds <= 0) { |
43 | 0 | curlx_strcopy(r, rsize, STRCONST(" ")); |
44 | 0 | return; |
45 | 0 | } |
46 | 0 | h = seconds / 3600; |
47 | 0 | if(h <= 99) { |
48 | 0 | curl_off_t m = (seconds - (h * 3600)) / 60; |
49 | 0 | if(h <= 9) { |
50 | 0 | curl_off_t s = (seconds - (h * 3600)) - (m * 60); |
51 | 0 | if(h) |
52 | 0 | curl_msnprintf(r, rsize, "%" FMT_OFF_T ":%02" FMT_OFF_T ":" |
53 | 0 | "%02" FMT_OFF_T, h, m, s); |
54 | 0 | else |
55 | 0 | curl_msnprintf(r, rsize, " %02" FMT_OFF_T ":%02" FMT_OFF_T, m, s); |
56 | 0 | } |
57 | 0 | else |
58 | 0 | curl_msnprintf(r, rsize, "%" FMT_OFF_T "h %02" FMT_OFF_T "m", h, m); |
59 | 0 | } |
60 | 0 | else { |
61 | 0 | curl_off_t d = seconds / 86400; |
62 | 0 | h = (seconds - (d * 86400)) / 3600; |
63 | 0 | if(d <= 99) |
64 | 0 | curl_msnprintf(r, rsize, "%2" FMT_OFF_T "d %02" FMT_OFF_T "h", d, h); |
65 | 0 | else if(d <= 999) |
66 | 0 | curl_msnprintf(r, rsize, "%6" FMT_OFF_T "d", d); |
67 | 0 | else { /* more than 999 days */ |
68 | 0 | curl_off_t m = d / 30; |
69 | 0 | if(m <= 999) |
70 | 0 | curl_msnprintf(r, rsize, "%6" FMT_OFF_T "m", m); |
71 | 0 | else { /* more than 999 months */ |
72 | 0 | curl_off_t y = d / 365; |
73 | 0 | if(y <= 99999) |
74 | 0 | curl_msnprintf(r, rsize, "%6" FMT_OFF_T "y", y); |
75 | 0 | else |
76 | 0 | curlx_strcopy(r, rsize, STRCONST(">99999y")); |
77 | 0 | } |
78 | 0 | } |
79 | 0 | } |
80 | 0 | } |
81 | | |
82 | | /* The point of this function would be to return a string of the input data, |
83 | | but never longer than 6 columns (+ one zero byte). |
84 | | Add suffix k, M, G when suitable... |
85 | | |
86 | | @unittest 1636 |
87 | | */ |
88 | | UNITTEST char *max6out(curl_off_t bytes, char *max6, size_t mlen); |
89 | | UNITTEST char *max6out(curl_off_t bytes, char *max6, size_t mlen) |
90 | 0 | { |
91 | | /* a signed 64-bit value is 8192 petabytes maximum, shown as |
92 | | 8.0E (exabytes)*/ |
93 | 0 | if(bytes < 100000) |
94 | 0 | curl_msnprintf(max6, mlen, "%6" CURL_FORMAT_CURL_OFF_T, bytes); |
95 | 0 | else { |
96 | 0 | const char unit[] = { 'k', 'M', 'G', 'T', 'P', 'E', 0 }; |
97 | 0 | int k = 0; |
98 | 0 | curl_off_t nbytes; |
99 | 0 | curl_off_t rest; |
100 | 0 | do { |
101 | 0 | nbytes = bytes / 1024; |
102 | 0 | if(nbytes < 1000) |
103 | 0 | break; |
104 | 0 | bytes = nbytes; |
105 | 0 | k++; |
106 | 0 | DEBUGASSERT(unit[k]); |
107 | 0 | } while(unit[k]); |
108 | 0 | rest = bytes % 1024; |
109 | 0 | if(nbytes <= 99) |
110 | | /* xx.yyU */ |
111 | 0 | curl_msnprintf(max6, mlen, "%2" CURL_FORMAT_CURL_OFF_T |
112 | 0 | ".%02" CURL_FORMAT_CURL_OFF_T "%c", nbytes, |
113 | 0 | rest * 100 / 1024, unit[k]); |
114 | 0 | else |
115 | | /* xxx.yU */ |
116 | 0 | curl_msnprintf(max6, mlen, "%3" CURL_FORMAT_CURL_OFF_T |
117 | 0 | ".%" CURL_FORMAT_CURL_OFF_T "%c", nbytes, |
118 | 0 | rest * 10 / 1024, unit[k]); |
119 | 0 | } |
120 | 0 | return max6; |
121 | 0 | } |
122 | | #endif |
123 | | |
124 | | static void pgrs_speedinit(struct Curl_easy *data) |
125 | 0 | { |
126 | 0 | memset(&data->state.keeps_speed, 0, sizeof(struct curltime)); |
127 | 0 | } |
128 | | |
129 | | /* |
130 | | * @unittest 1606 |
131 | | */ |
132 | | UNITTEST CURLcode pgrs_speedcheck(struct Curl_easy *data, |
133 | | const struct curltime *pnow); |
134 | | UNITTEST CURLcode pgrs_speedcheck(struct Curl_easy *data, |
135 | | const struct curltime *pnow) |
136 | 0 | { |
137 | 0 | if(!data->set.low_speed_time || !data->set.low_speed_limit || |
138 | 0 | Curl_xfer_recv_is_paused(data) || Curl_xfer_send_is_paused(data)) |
139 | | /* A paused transfer is not qualified for speed checks */ |
140 | 0 | return CURLE_OK; |
141 | | |
142 | 0 | if(data->progress.current_speed >= 0) { |
143 | 0 | if(data->progress.current_speed < data->set.low_speed_limit) { |
144 | 0 | if(!data->state.keeps_speed.tv_sec) |
145 | | /* under the limit at this moment */ |
146 | 0 | data->state.keeps_speed = *pnow; |
147 | 0 | else { |
148 | | /* how long has it been under the limit */ |
149 | 0 | timediff_t howlong = |
150 | 0 | curlx_ptimediff_ms(pnow, &data->state.keeps_speed); |
151 | |
|
152 | 0 | if(howlong >= data->set.low_speed_time * 1000) { |
153 | | /* too long */ |
154 | 0 | failf(data, "Operation too slow. Less than %" FMT_OFF_T |
155 | 0 | " bytes/sec transferred the last %u seconds", |
156 | 0 | data->set.low_speed_limit, data->set.low_speed_time); |
157 | 0 | return CURLE_OPERATION_TIMEDOUT; |
158 | 0 | } |
159 | 0 | } |
160 | 0 | } |
161 | 0 | else |
162 | | /* faster right now */ |
163 | 0 | data->state.keeps_speed.tv_sec = 0; |
164 | 0 | } |
165 | | |
166 | | /* since low speed limit is enabled, set the expire timer to make this |
167 | | connection's speed get checked again in a second */ |
168 | 0 | Curl_expire(data, 1000, EXPIRE_SPEEDCHECK); |
169 | |
|
170 | 0 | return CURLE_OK; |
171 | 0 | } |
172 | | |
173 | | const struct curltime *Curl_pgrs_now(struct Curl_easy *data) |
174 | 0 | { |
175 | 0 | struct curltime *pnow = data->multi ? |
176 | 0 | &data->multi->now : &data->progress.now; |
177 | 0 | curlx_pnow(pnow); |
178 | 0 | return pnow; |
179 | 0 | } |
180 | | |
181 | | /* |
182 | | New proposed interface, 9th of February 2000: |
183 | | |
184 | | pgrsStartNow() - sets start time |
185 | | pgrsSetDownloadSize(x) - known expected download size |
186 | | pgrsSetUploadSize(x) - known expected upload size |
187 | | pgrsSetDownloadCounter() - amount of data currently downloaded |
188 | | pgrsSetUploadCounter() - amount of data currently uploaded |
189 | | pgrsUpdate() - show progress |
190 | | pgrsDone() - transfer complete |
191 | | */ |
192 | | |
193 | | int Curl_pgrsDone(struct Curl_easy *data) |
194 | 0 | { |
195 | 0 | int rc; |
196 | 0 | data->progress.lastshow = 0; |
197 | 0 | rc = Curl_pgrsUpdate(data); /* the final (forced) update */ |
198 | 0 | if(rc) |
199 | 0 | return rc; |
200 | | |
201 | 0 | if(!data->progress.hide && !data->progress.callback) |
202 | | /* only output if we do not use a progress callback and we are not |
203 | | * hidden */ |
204 | 0 | curl_mfprintf(data->set.err, "\n"); |
205 | |
|
206 | 0 | return 0; |
207 | 0 | } |
208 | | |
209 | | void Curl_pgrsReset(struct Curl_easy *data) |
210 | 0 | { |
211 | 0 | Curl_pgrsSetUploadCounter(data, 0); |
212 | 0 | data->progress.dl.cur_size = 0; |
213 | 0 | Curl_pgrsSetUploadSize(data, -1); |
214 | 0 | Curl_pgrsSetDownloadSize(data, -1); |
215 | 0 | data->progress.speeder_c = 0; /* reset speed records */ |
216 | 0 | data->progress.deliver = 0; |
217 | 0 | pgrs_speedinit(data); |
218 | 0 | } |
219 | | |
220 | | /* reset the known transfer sizes */ |
221 | | void Curl_pgrsResetTransferSizes(struct Curl_easy *data) |
222 | 0 | { |
223 | 0 | Curl_pgrsSetDownloadSize(data, -1); |
224 | 0 | Curl_pgrsSetUploadSize(data, -1); |
225 | 0 | } |
226 | | |
227 | | void Curl_pgrsRecvPause(struct Curl_easy *data, bool enable) |
228 | 0 | { |
229 | 0 | if(!enable) { |
230 | 0 | data->progress.speeder_c = 0; /* reset speed records */ |
231 | 0 | pgrs_speedinit(data); /* reset low speed measurements */ |
232 | 0 | } |
233 | 0 | } |
234 | | |
235 | | void Curl_pgrsSendPause(struct Curl_easy *data, bool enable) |
236 | 0 | { |
237 | 0 | if(!enable) { |
238 | 0 | data->progress.speeder_c = 0; /* reset speed records */ |
239 | 0 | pgrs_speedinit(data); /* reset low speed measurements */ |
240 | 0 | } |
241 | 0 | } |
242 | | |
243 | | #ifdef CURLVERBOSE |
244 | | static const char * const pgrs_timer_names[] = { |
245 | | "PGRS-NONE", |
246 | | "PGRS-STARTOP", |
247 | | "PGRS-STARTSINGLE", |
248 | | "PGRS-POSTQUEUE", |
249 | | "PGRS-NAMELOOKUP", |
250 | | "PGRS-CONNECT", |
251 | | "PGRS-APPCONNECT", |
252 | | "PGRS-PRETRANSFER", |
253 | | "PGRS-STARTTRANSFER", |
254 | | "PGRS-POSTRANSFER", |
255 | | "PGRS-STARTACCEPT", |
256 | | "PGRS-REDIRECT", |
257 | | }; |
258 | | |
259 | | static const char *pgrs_timer_name(timerid timer) |
260 | 0 | { |
261 | 0 | if((size_t)timer < CURL_ARRAYSIZE(pgrs_timer_names)) |
262 | 0 | return pgrs_timer_names[(size_t)timer]; |
263 | 0 | return "?"; |
264 | 0 | } |
265 | | #endif /* CURLVERBOSE */ |
266 | | |
267 | | /* |
268 | | * Curl_pgrsTimeWas(). Store the timestamp time at the given label. |
269 | | */ |
270 | | void Curl_pgrsTimeWas(struct Curl_easy *data, timerid timer, |
271 | | struct curltime timestamp) |
272 | 0 | { |
273 | 0 | timediff_t *delta = NULL; |
274 | |
|
275 | 0 | switch(timer) { |
276 | 0 | default: |
277 | 0 | case TIMER_NONE: |
278 | | /* mistake filter */ |
279 | 0 | break; |
280 | 0 | case TIMER_STARTOP: |
281 | | /* This is set at the start of a transfer */ |
282 | 0 | data->progress.t_startop = timestamp; |
283 | 0 | data->progress.t_startqueue = timestamp; |
284 | 0 | data->progress.t_postqueue = 0; |
285 | 0 | break; |
286 | 0 | case TIMER_STARTSINGLE: |
287 | | /* This is set at the start of each single transfer */ |
288 | 0 | data->progress.t_startsingle = timestamp; |
289 | 0 | data->progress.is_t_startransfer_set = FALSE; |
290 | 0 | break; |
291 | 0 | case TIMER_POSTQUEUE: |
292 | | /* Queue time is accumulative from all involved redirects */ |
293 | 0 | data->progress.t_postqueue += |
294 | 0 | curlx_ptimediff_us(×tamp, &data->progress.t_startqueue); |
295 | 0 | break; |
296 | 0 | case TIMER_STARTACCEPT: |
297 | 0 | data->progress.t_acceptdata = timestamp; |
298 | 0 | break; |
299 | 0 | case TIMER_NAMELOOKUP: |
300 | 0 | delta = &data->progress.t_nslookup; |
301 | 0 | break; |
302 | 0 | case TIMER_CONNECT: |
303 | 0 | delta = &data->progress.t_connect; |
304 | 0 | break; |
305 | 0 | case TIMER_APPCONNECT: |
306 | 0 | delta = &data->progress.t_appconnect; |
307 | 0 | break; |
308 | 0 | case TIMER_PRETRANSFER: |
309 | 0 | delta = &data->progress.t_pretransfer; |
310 | 0 | break; |
311 | 0 | case TIMER_STARTTRANSFER: |
312 | | /* prevent updating t_starttransfer unless: |
313 | | * 1. this is the first time we are setting t_starttransfer |
314 | | * 2. a redirect has occurred since the last time t_starttransfer was set |
315 | | * This prevents repeated invocations of the function from incorrectly |
316 | | * changing the t_starttransfer time. |
317 | | */ |
318 | 0 | if(data->progress.is_t_startransfer_set) { |
319 | 0 | CURL_TRC_M(data, "[%s] ignored", pgrs_timer_name(timer)); |
320 | 0 | return; |
321 | 0 | } |
322 | 0 | data->progress.is_t_startransfer_set = TRUE; |
323 | 0 | delta = &data->progress.t_starttransfer; |
324 | 0 | break; |
325 | 0 | case TIMER_POSTRANSFER: |
326 | 0 | delta = &data->progress.t_posttransfer; |
327 | 0 | break; |
328 | 0 | case TIMER_REDIRECT: |
329 | 0 | data->progress.t_redirect = curlx_ptimediff_us(×tamp, |
330 | 0 | &data->progress.start); |
331 | 0 | data->progress.t_startqueue = timestamp; |
332 | 0 | break; |
333 | 0 | } |
334 | 0 | if(delta) { |
335 | 0 | timediff_t us = curlx_ptimediff_us(×tamp, |
336 | 0 | &data->progress.t_startsingle); |
337 | 0 | if(us < 1) |
338 | 0 | us = 1; /* make sure at least one microsecond passed */ |
339 | 0 | *delta += us; |
340 | 0 | CURL_TRC_M(data, "[%s] added %" FMT_TIMEDIFF_T "ns", |
341 | 0 | pgrs_timer_name(timer), us); |
342 | 0 | } |
343 | 0 | else |
344 | 0 | CURL_TRC_M(data, "[%s] set", pgrs_timer_name(timer)); |
345 | 0 | } |
346 | | |
347 | | /* |
348 | | * Curl_pgrsTime(). Store the current time at the given label. This fetches a |
349 | | * fresh "now" and returns it. |
350 | | * |
351 | | * @unittest: 1399 |
352 | | */ |
353 | | void Curl_pgrsTime(struct Curl_easy *data, timerid timer) |
354 | 0 | { |
355 | 0 | Curl_pgrsTimeWas(data, timer, *Curl_pgrs_now(data)); |
356 | 0 | } |
357 | | |
358 | | void Curl_pgrsStartNow(struct Curl_easy *data) |
359 | 0 | { |
360 | 0 | struct Progress *p = &data->progress; |
361 | |
|
362 | 0 | p->speeder_c = 0; /* reset the progress meter display */ |
363 | 0 | p->start = *Curl_pgrs_now(data); |
364 | 0 | p->is_t_startransfer_set = FALSE; |
365 | 0 | p->dl.cur_size = 0; |
366 | 0 | p->ul.cur_size = 0; |
367 | | /* the sizes are unknown at start */ |
368 | 0 | p->dl_size_known = FALSE; |
369 | 0 | p->ul_size_known = FALSE; |
370 | 0 | } |
371 | | |
372 | | /* check that the 'delta' amount of bytes are okay to deliver to the |
373 | | application, or return error if not. */ |
374 | | CURLcode Curl_pgrs_deliver_check(struct Curl_easy *data, size_t delta) |
375 | 0 | { |
376 | 0 | if(data->set.max_filesize && |
377 | 0 | ((curl_off_t)delta > data->set.max_filesize - data->progress.deliver)) { |
378 | 0 | failf(data, "Would have exceeded max file size"); |
379 | 0 | return CURLE_FILESIZE_EXCEEDED; |
380 | 0 | } |
381 | 0 | return CURLE_OK; |
382 | 0 | } |
383 | | |
384 | | /* this counts how much data is delivered to the application, which |
385 | | in compressed cases may differ from downloaded amount */ |
386 | | void Curl_pgrs_deliver_inc(struct Curl_easy *data, size_t delta) |
387 | 0 | { |
388 | 0 | data->progress.deliver += delta; |
389 | 0 | } |
390 | | |
391 | | void Curl_pgrs_download_inc(struct Curl_easy *data, size_t delta) |
392 | 0 | { |
393 | 0 | if(delta) { |
394 | 0 | data->progress.dl.cur_size += delta; |
395 | 0 | Curl_rlimit_drain(&data->progress.dl.rlimit, delta, Curl_pgrs_now(data)); |
396 | 0 | } |
397 | 0 | } |
398 | | |
399 | | void Curl_pgrs_upload_inc(struct Curl_easy *data, size_t delta) |
400 | 0 | { |
401 | 0 | if(delta) { |
402 | 0 | data->progress.ul.cur_size += delta; |
403 | 0 | Curl_rlimit_drain(&data->progress.ul.rlimit, delta, Curl_pgrs_now(data)); |
404 | 0 | } |
405 | 0 | } |
406 | | |
407 | | /* |
408 | | * Set the number of uploaded bytes so far. |
409 | | */ |
410 | | void Curl_pgrsSetUploadCounter(struct Curl_easy *data, curl_off_t size) |
411 | 0 | { |
412 | 0 | data->progress.ul.cur_size = size; |
413 | 0 | } |
414 | | |
415 | | void Curl_pgrsSetDownloadSize(struct Curl_easy *data, curl_off_t size) |
416 | 0 | { |
417 | 0 | if(size >= 0) { |
418 | 0 | data->progress.dl.total_size = size; |
419 | 0 | data->progress.dl_size_known = TRUE; |
420 | 0 | } |
421 | 0 | else { |
422 | 0 | data->progress.dl.total_size = 0; |
423 | 0 | data->progress.dl_size_known = FALSE; |
424 | 0 | } |
425 | 0 | } |
426 | | |
427 | | void Curl_pgrsSetUploadSize(struct Curl_easy *data, curl_off_t size) |
428 | 0 | { |
429 | 0 | if(size >= 0) { |
430 | 0 | data->progress.ul.total_size = size; |
431 | 0 | data->progress.ul_size_known = TRUE; |
432 | 0 | } |
433 | 0 | else { |
434 | 0 | data->progress.ul.total_size = 0; |
435 | 0 | data->progress.ul_size_known = FALSE; |
436 | 0 | } |
437 | 0 | } |
438 | | |
439 | | void Curl_pgrsEarlyData(struct Curl_easy *data, curl_off_t sent) |
440 | 0 | { |
441 | 0 | data->progress.earlydata_sent = sent; |
442 | 0 | } |
443 | | |
444 | | /* returns the average speed in bytes / second */ |
445 | | static curl_off_t trspeed(curl_off_t size, /* number of bytes */ |
446 | | curl_off_t us) /* microseconds */ |
447 | 0 | { |
448 | 0 | if(us < 1) |
449 | 0 | return size * 1000000; |
450 | 0 | else if(size < CURL_OFF_T_MAX / 1000000) |
451 | 0 | return (size * 1000000) / us; |
452 | 0 | else if(us >= 1000000) |
453 | 0 | return size / (us / 1000000); |
454 | 0 | else |
455 | 0 | return CURL_OFF_T_MAX; |
456 | 0 | } |
457 | | |
458 | | /* returns TRUE if it is time to show the progress meter */ |
459 | | static bool progress_calc(struct Curl_easy *data, |
460 | | const struct curltime *pnow) |
461 | 0 | { |
462 | 0 | struct Progress * const p = &data->progress; |
463 | 0 | int i_next, i_oldest, i_latest; |
464 | 0 | timediff_t duration_us; |
465 | 0 | curl_off_t amount; |
466 | | |
467 | | /* The time spent so far (from the start) in microseconds */ |
468 | 0 | p->timespent = curlx_ptimediff_us(pnow, &p->start); |
469 | 0 | p->dl.speed = trspeed(p->dl.cur_size, p->timespent); |
470 | 0 | p->ul.speed = trspeed(p->ul.cur_size, p->timespent); |
471 | |
|
472 | 0 | if(!p->speeder_c) { /* no previous record exists */ |
473 | 0 | p->speed_amount[0] = p->dl.cur_size + p->ul.cur_size; |
474 | 0 | p->speed_time[0] = *pnow; |
475 | 0 | p->speeder_c++; |
476 | | /* use the overall average at the start */ |
477 | 0 | p->current_speed = p->ul.speed + p->dl.speed; |
478 | 0 | p->lastshow = pnow->tv_sec; |
479 | 0 | return TRUE; |
480 | 0 | } |
481 | | /* We have at least one record now. Where to put the next and |
482 | | * where is the latest one? */ |
483 | 0 | i_next = p->speeder_c % CURL_SPEED_RECORDS; |
484 | 0 | i_latest = (i_next > 0) ? (i_next - 1) : (CURL_SPEED_RECORDS - 1); |
485 | | |
486 | | /* Make a new record only when some time has passed. |
487 | | * Too frequent calls otherwise ruin the history. */ |
488 | 0 | if(curlx_ptimediff_ms(pnow, &p->speed_time[i_latest]) >= 1000) { |
489 | 0 | p->speeder_c++; |
490 | 0 | i_latest = i_next; |
491 | 0 | p->speed_amount[i_latest] = p->dl.cur_size + p->ul.cur_size; |
492 | 0 | p->speed_time[i_latest] = *pnow; |
493 | 0 | } |
494 | 0 | else if(data->req.done) { |
495 | | /* When a transfer is done, and we did not have a current speed |
496 | | * already, update the last record. Otherwise, stay at the speed |
497 | | * we have. The last chunk of data, when rate limiting, would increase |
498 | | * reported speed since it no longer measures a full second. */ |
499 | 0 | if(!p->current_speed) { |
500 | 0 | p->speed_amount[i_latest] = p->dl.cur_size + p->ul.cur_size; |
501 | 0 | p->speed_time[i_latest] = *pnow; |
502 | 0 | } |
503 | 0 | } |
504 | 0 | else { |
505 | | /* transfer ongoing, wait for more time to pass. */ |
506 | 0 | return FALSE; |
507 | 0 | } |
508 | | |
509 | 0 | i_oldest = (p->speeder_c < CURL_SPEED_RECORDS) ? 0 : |
510 | 0 | ((i_latest + 1) % CURL_SPEED_RECORDS); |
511 | | |
512 | | /* How much we transferred between oldest and current records */ |
513 | 0 | amount = p->speed_amount[i_latest] - p->speed_amount[i_oldest]; |
514 | | /* How long this took */ |
515 | 0 | duration_us = curlx_ptimediff_us(&p->speed_time[i_latest], |
516 | 0 | &p->speed_time[i_oldest]); |
517 | 0 | if(duration_us <= 0) |
518 | 0 | duration_us = 1; |
519 | |
|
520 | 0 | if(amount > (CURL_OFF_T_MAX / 1000000)) { |
521 | | /* the 'amount' value is bigger than would fit in 64 bits if |
522 | | multiplied with 1000000, so we use the double math for this */ |
523 | 0 | p->current_speed = |
524 | 0 | (curl_off_t)(((double)amount * 1000000.0) / (double)duration_us); |
525 | 0 | } |
526 | 0 | else { |
527 | 0 | p->current_speed = amount * 1000000 / duration_us; |
528 | 0 | } |
529 | |
|
530 | 0 | if((p->lastshow == pnow->tv_sec) && !data->req.done) |
531 | 0 | return FALSE; |
532 | 0 | p->lastshow = pnow->tv_sec; |
533 | 0 | return TRUE; |
534 | 0 | } |
535 | | |
536 | | #ifndef CURL_DISABLE_PROGRESS_METER |
537 | | |
538 | | struct pgrs_estimate { |
539 | | curl_off_t secs; |
540 | | curl_off_t percent; |
541 | | }; |
542 | | |
543 | | static curl_off_t pgrs_est_percent(curl_off_t total, curl_off_t cur) |
544 | 0 | { |
545 | 0 | if(total > 10000) |
546 | 0 | return cur / (total / 100); |
547 | 0 | else if(total > 0) |
548 | 0 | return (cur * 100) / total; |
549 | 0 | return 0; |
550 | 0 | } |
551 | | |
552 | | static void pgrs_estimates(struct pgrs_dir *d, |
553 | | bool total_known, |
554 | | struct pgrs_estimate *est) |
555 | 0 | { |
556 | 0 | est->secs = 0; |
557 | 0 | est->percent = 0; |
558 | 0 | if(total_known && (d->speed > 0)) { |
559 | 0 | est->secs = d->total_size / d->speed; |
560 | 0 | est->percent = pgrs_est_percent(d->total_size, d->cur_size); |
561 | 0 | } |
562 | 0 | } |
563 | | |
564 | | static void progress_meter(struct Curl_easy *data) |
565 | 0 | { |
566 | 0 | struct Progress *p = &data->progress; |
567 | 0 | char max6[6][7]; |
568 | 0 | struct pgrs_estimate dl_estm; |
569 | 0 | struct pgrs_estimate ul_estm; |
570 | 0 | struct pgrs_estimate total_estm; |
571 | 0 | curl_off_t total_cur_size; |
572 | 0 | curl_off_t total_expected_size; |
573 | 0 | curl_off_t dl_size; |
574 | 0 | char time_left[8]; |
575 | 0 | char time_total[8]; |
576 | 0 | char time_spent[8]; |
577 | 0 | curl_off_t cur_secs = (curl_off_t)p->timespent / 1000000; /* seconds */ |
578 | |
|
579 | 0 | if(!p->headers_out) { |
580 | 0 | if(data->state.resume_from) { |
581 | 0 | curl_mfprintf(data->set.err, |
582 | 0 | "** Resuming transfer from byte position %" FMT_OFF_T "\n", |
583 | 0 | data->state.resume_from); |
584 | 0 | } |
585 | 0 | curl_mfprintf(data->set.err, |
586 | 0 | " %% Total %% Received %% Xferd Average Speed " |
587 | 0 | "Time Time Time Current\n" |
588 | 0 | " Dload Upload " |
589 | 0 | "Total Spent Left Speed\n"); |
590 | 0 | p->headers_out = TRUE; /* headers are shown */ |
591 | 0 | } |
592 | | |
593 | | /* Figure out the estimated time of arrival for upload and download */ |
594 | 0 | pgrs_estimates(&p->ul, (bool)p->ul_size_known, &ul_estm); |
595 | 0 | pgrs_estimates(&p->dl, (bool)p->dl_size_known, &dl_estm); |
596 | | |
597 | | /* Since both happen at the same time, total expected duration is max. */ |
598 | 0 | total_estm.secs = CURLMAX(ul_estm.secs, dl_estm.secs); |
599 | | /* create the three time strings */ |
600 | 0 | time2str(time_left, sizeof(time_left), |
601 | 0 | total_estm.secs > 0 ? (total_estm.secs - cur_secs) : 0); |
602 | 0 | time2str(time_total, sizeof(time_total), total_estm.secs); |
603 | 0 | time2str(time_spent, sizeof(time_spent), cur_secs); |
604 | | |
605 | | /* Get the total amount of data expected to get transferred */ |
606 | 0 | total_expected_size = p->ul_size_known ? p->ul.total_size : p->ul.cur_size; |
607 | |
|
608 | 0 | dl_size = p->dl_size_known ? p->dl.total_size : p->dl.cur_size; |
609 | | |
610 | | /* integer overflow check */ |
611 | 0 | if((CURL_OFF_T_MAX - total_expected_size) < dl_size) |
612 | 0 | total_expected_size = CURL_OFF_T_MAX; /* capped */ |
613 | 0 | else |
614 | 0 | total_expected_size += dl_size; |
615 | | |
616 | | /* We have transferred this much so far */ |
617 | 0 | total_cur_size = p->dl.cur_size + p->ul.cur_size; |
618 | | |
619 | | /* Get the percentage of data transferred so far */ |
620 | 0 | total_estm.percent = pgrs_est_percent(total_expected_size, total_cur_size); |
621 | |
|
622 | 0 | curl_mfprintf(data->set.err, |
623 | 0 | "\r" |
624 | 0 | "%3" FMT_OFF_T " %s " |
625 | 0 | "%3" FMT_OFF_T " %s " |
626 | 0 | "%3" FMT_OFF_T " %s %s %s %s %s %s %s", |
627 | 0 | total_estm.percent, /* 3 letters */ /* total % */ |
628 | 0 | max6out(total_expected_size, max6[2], |
629 | 0 | sizeof(max6[2])), /* total size */ |
630 | 0 | dl_estm.percent, /* 3 letters */ /* rcvd % */ |
631 | 0 | max6out(p->dl.cur_size, max6[0], |
632 | 0 | sizeof(max6[0])), /* rcvd size */ |
633 | 0 | ul_estm.percent, /* 3 letters */ /* xfer % */ |
634 | 0 | max6out(p->ul.cur_size, max6[1], |
635 | 0 | sizeof(max6[1])), /* xfer size */ |
636 | 0 | max6out(p->dl.speed, max6[3], |
637 | 0 | sizeof(max6[3])), /* avrg dl speed */ |
638 | 0 | max6out(p->ul.speed, max6[4], |
639 | 0 | sizeof(max6[4])), /* avrg ul speed */ |
640 | 0 | time_total, /* 7 letters */ /* total time */ |
641 | 0 | time_spent, /* 7 letters */ /* time spent */ |
642 | 0 | time_left, /* 7 letters */ /* time left */ |
643 | 0 | max6out(p->current_speed, max6[5], |
644 | 0 | sizeof(max6[5])) /* current speed */ |
645 | 0 | ); |
646 | | |
647 | | /* we flush the output stream to make it appear as soon as possible */ |
648 | 0 | fflush(data->set.err); |
649 | 0 | } |
650 | | #else /* CURL_DISABLE_PROGRESS_METER */ |
651 | | #define progress_meter(x) Curl_nop_stmt |
652 | | #endif |
653 | | |
654 | | /* |
655 | | * Curl_pgrsUpdate() returns 0 for success or the value returned by the |
656 | | * progress callback! |
657 | | */ |
658 | | static CURLcode pgrsupdate(struct Curl_easy *data, bool showprogress) |
659 | 0 | { |
660 | 0 | if(!data->progress.hide) { |
661 | 0 | int rc; |
662 | 0 | if(data->set.fxferinfo) { |
663 | | /* There is a callback set, call that */ |
664 | 0 | Curl_set_in_callback(data, TRUE); |
665 | 0 | rc = data->set.fxferinfo(data->set.progress_client, |
666 | 0 | data->progress.dl.total_size, |
667 | 0 | data->progress.dl.cur_size, |
668 | 0 | data->progress.ul.total_size, |
669 | 0 | data->progress.ul.cur_size); |
670 | 0 | Curl_set_in_callback(data, FALSE); |
671 | 0 | if(rc != CURL_PROGRESSFUNC_CONTINUE) { |
672 | 0 | if(rc) { |
673 | 0 | failf(data, "Callback aborted"); |
674 | 0 | return CURLE_ABORTED_BY_CALLBACK; |
675 | 0 | } |
676 | 0 | return CURLE_OK; |
677 | 0 | } |
678 | 0 | } |
679 | 0 | else if(data->set.fprogress) { |
680 | | /* The older deprecated callback is set, call that */ |
681 | 0 | Curl_set_in_callback(data, TRUE); |
682 | 0 | rc = data->set.fprogress(data->set.progress_client, |
683 | 0 | (double)data->progress.dl.total_size, |
684 | 0 | (double)data->progress.dl.cur_size, |
685 | 0 | (double)data->progress.ul.total_size, |
686 | 0 | (double)data->progress.ul.cur_size); |
687 | 0 | Curl_set_in_callback(data, FALSE); |
688 | 0 | if(rc != CURL_PROGRESSFUNC_CONTINUE) { |
689 | 0 | if(rc) { |
690 | 0 | failf(data, "Callback aborted"); |
691 | 0 | return CURLE_ABORTED_BY_CALLBACK; |
692 | 0 | } |
693 | 0 | return CURLE_OK; |
694 | 0 | } |
695 | 0 | } |
696 | | |
697 | 0 | if(showprogress) |
698 | 0 | progress_meter(data); |
699 | 0 | } |
700 | | |
701 | 0 | return CURLE_OK; |
702 | 0 | } |
703 | | |
704 | | static CURLcode pgrs_update(struct Curl_easy *data, |
705 | | const struct curltime *pnow) |
706 | 0 | { |
707 | 0 | bool showprogress = progress_calc(data, pnow); |
708 | 0 | return pgrsupdate(data, showprogress); |
709 | 0 | } |
710 | | |
711 | | CURLcode Curl_pgrsUpdate(struct Curl_easy *data) |
712 | 0 | { |
713 | 0 | return pgrs_update(data, Curl_pgrs_now(data)); |
714 | 0 | } |
715 | | |
716 | | CURLcode Curl_pgrsCheck(struct Curl_easy *data) |
717 | 0 | { |
718 | 0 | CURLcode result; |
719 | |
|
720 | 0 | result = pgrs_update(data, Curl_pgrs_now(data)); |
721 | 0 | if(!result && !data->req.done) |
722 | 0 | result = pgrs_speedcheck(data, Curl_pgrs_now(data)); |
723 | 0 | return result; |
724 | 0 | } |
725 | | |
726 | | /* |
727 | | * Update all progress, do not do progress meter/callbacks. |
728 | | */ |
729 | | void Curl_pgrsUpdate_nometer(struct Curl_easy *data) |
730 | 0 | { |
731 | 0 | (void)progress_calc(data, Curl_pgrs_now(data)); |
732 | 0 | } |
733 | | |
734 | | void Curl_pgrsCompleted(struct Curl_easy *data) |
735 | 0 | { |
736 | 0 | struct Progress * const p = &data->progress; |
737 | 0 | p->timespent = curlx_ptimediff_us(Curl_pgrs_now(data), &p->start); |
738 | 0 | } |