1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
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.
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.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ***************************************************************************/
23 #include "curl_setup.h"
30 #include "curl_printf.h"
32 /* check rate limits within this many recent milliseconds, at minimum. */
33 #define MIN_RATE_LIMIT_PERIOD 3000
35 #ifndef CURL_DISABLE_PROGRESS_METER
36 /* Provide a string that is 2 + 1 + 2 + 1 + 2 = 8 letters long (plus the zero
38 static void time2str(char *r, curl_off_t seconds)
42 strcpy(r, "--:--:--");
45 h = seconds / CURL_OFF_T_C(3600);
46 if(h <= CURL_OFF_T_C(99)) {
47 curl_off_t m = (seconds - (h*CURL_OFF_T_C(3600))) / CURL_OFF_T_C(60);
48 curl_off_t s = (seconds - (h*CURL_OFF_T_C(3600))) - (m*CURL_OFF_T_C(60));
49 msnprintf(r, 9, "%2" CURL_FORMAT_CURL_OFF_T ":%02" CURL_FORMAT_CURL_OFF_T
50 ":%02" CURL_FORMAT_CURL_OFF_T, h, m, s);
53 /* this equals to more than 99 hours, switch to a more suitable output
54 format to fit within the limits. */
55 curl_off_t d = seconds / CURL_OFF_T_C(86400);
56 h = (seconds - (d*CURL_OFF_T_C(86400))) / CURL_OFF_T_C(3600);
57 if(d <= CURL_OFF_T_C(999))
58 msnprintf(r, 9, "%3" CURL_FORMAT_CURL_OFF_T
59 "d %02" CURL_FORMAT_CURL_OFF_T "h", d, h);
61 msnprintf(r, 9, "%7" CURL_FORMAT_CURL_OFF_T "d", d);
65 /* The point of this function would be to return a string of the input data,
66 but never longer than 5 columns (+ one zero byte).
67 Add suffix k, M, G when suitable... */
68 static char *max5data(curl_off_t bytes, char *max5)
70 #define ONE_KILOBYTE CURL_OFF_T_C(1024)
71 #define ONE_MEGABYTE (CURL_OFF_T_C(1024) * ONE_KILOBYTE)
72 #define ONE_GIGABYTE (CURL_OFF_T_C(1024) * ONE_MEGABYTE)
73 #define ONE_TERABYTE (CURL_OFF_T_C(1024) * ONE_GIGABYTE)
74 #define ONE_PETABYTE (CURL_OFF_T_C(1024) * ONE_TERABYTE)
76 if(bytes < CURL_OFF_T_C(100000))
77 msnprintf(max5, 6, "%5" CURL_FORMAT_CURL_OFF_T, bytes);
79 else if(bytes < CURL_OFF_T_C(10000) * ONE_KILOBYTE)
80 msnprintf(max5, 6, "%4" CURL_FORMAT_CURL_OFF_T "k", bytes/ONE_KILOBYTE);
82 else if(bytes < CURL_OFF_T_C(100) * ONE_MEGABYTE)
83 /* 'XX.XM' is good as long as we're less than 100 megs */
84 msnprintf(max5, 6, "%2" CURL_FORMAT_CURL_OFF_T ".%0"
85 CURL_FORMAT_CURL_OFF_T "M", bytes/ONE_MEGABYTE,
86 (bytes%ONE_MEGABYTE) / (ONE_MEGABYTE/CURL_OFF_T_C(10)) );
88 #if (SIZEOF_CURL_OFF_T > 4)
90 else if(bytes < CURL_OFF_T_C(10000) * ONE_MEGABYTE)
91 /* 'XXXXM' is good until we're at 10000MB or above */
92 msnprintf(max5, 6, "%4" CURL_FORMAT_CURL_OFF_T "M", bytes/ONE_MEGABYTE);
94 else if(bytes < CURL_OFF_T_C(100) * ONE_GIGABYTE)
95 /* 10000 MB - 100 GB, we show it as XX.XG */
96 msnprintf(max5, 6, "%2" CURL_FORMAT_CURL_OFF_T ".%0"
97 CURL_FORMAT_CURL_OFF_T "G", bytes/ONE_GIGABYTE,
98 (bytes%ONE_GIGABYTE) / (ONE_GIGABYTE/CURL_OFF_T_C(10)) );
100 else if(bytes < CURL_OFF_T_C(10000) * ONE_GIGABYTE)
101 /* up to 10000GB, display without decimal: XXXXG */
102 msnprintf(max5, 6, "%4" CURL_FORMAT_CURL_OFF_T "G", bytes/ONE_GIGABYTE);
104 else if(bytes < CURL_OFF_T_C(10000) * ONE_TERABYTE)
105 /* up to 10000TB, display without decimal: XXXXT */
106 msnprintf(max5, 6, "%4" CURL_FORMAT_CURL_OFF_T "T", bytes/ONE_TERABYTE);
109 /* up to 10000PB, display without decimal: XXXXP */
110 msnprintf(max5, 6, "%4" CURL_FORMAT_CURL_OFF_T "P", bytes/ONE_PETABYTE);
112 /* 16384 petabytes (16 exabytes) is the maximum a 64 bit unsigned number
113 can hold, but our data type is signed so 8192PB will be the maximum. */
118 msnprintf(max5, 6, "%4" CURL_FORMAT_CURL_OFF_T "M", bytes/ONE_MEGABYTE);
128 New proposed interface, 9th of February 2000:
130 pgrsStartNow() - sets start time
131 pgrsSetDownloadSize(x) - known expected download size
132 pgrsSetUploadSize(x) - known expected upload size
133 pgrsSetDownloadCounter() - amount of data currently downloaded
134 pgrsSetUploadCounter() - amount of data currently uploaded
135 pgrsUpdate() - show progress
136 pgrsDone() - transfer complete
140 int Curl_pgrsDone(struct Curl_easy *data)
143 data->progress.lastshow = 0;
144 rc = Curl_pgrsUpdate(data); /* the final (forced) update */
148 if(!(data->progress.flags & PGRS_HIDE) &&
149 !data->progress.callback)
150 /* only output if we don't use a progress callback and we're not
152 fprintf(data->set.err, "\n");
154 data->progress.speeder_c = 0; /* reset the progress meter display */
158 /* reset the known transfer sizes */
159 void Curl_pgrsResetTransferSizes(struct Curl_easy *data)
161 Curl_pgrsSetDownloadSize(data, -1);
162 Curl_pgrsSetUploadSize(data, -1);
167 * Curl_pgrsTime(). Store the current time at the given label. This fetches a
168 * fresh "now" and returns it.
172 struct curltime Curl_pgrsTime(struct Curl_easy *data, timerid timer)
174 struct curltime now = Curl_now();
175 timediff_t *delta = NULL;
183 /* This is set at the start of a transfer */
184 data->progress.t_startop = now;
186 case TIMER_STARTSINGLE:
187 /* This is set at the start of each single fetch */
188 data->progress.t_startsingle = now;
189 data->progress.is_t_startransfer_set = false;
191 case TIMER_STARTACCEPT:
192 data->progress.t_acceptdata = now;
194 case TIMER_NAMELOOKUP:
195 delta = &data->progress.t_nslookup;
198 delta = &data->progress.t_connect;
200 case TIMER_APPCONNECT:
201 delta = &data->progress.t_appconnect;
203 case TIMER_PRETRANSFER:
204 delta = &data->progress.t_pretransfer;
206 case TIMER_STARTTRANSFER:
207 delta = &data->progress.t_starttransfer;
208 /* prevent updating t_starttransfer unless:
209 * 1) this is the first time we're setting t_starttransfer
210 * 2) a redirect has occurred since the last time t_starttransfer was set
211 * This prevents repeated invocations of the function from incorrectly
212 * changing the t_starttransfer time.
214 if(data->progress.is_t_startransfer_set) {
218 data->progress.is_t_startransfer_set = true;
221 case TIMER_POSTRANSFER:
222 /* this is the normal end-of-transfer thing */
225 data->progress.t_redirect = Curl_timediff_us(now, data->progress.start);
229 timediff_t us = Curl_timediff_us(now, data->progress.t_startsingle);
231 us = 1; /* make sure at least one microsecond passed */
237 void Curl_pgrsStartNow(struct Curl_easy *data)
239 data->progress.speeder_c = 0; /* reset the progress meter display */
240 data->progress.start = Curl_now();
241 data->progress.is_t_startransfer_set = false;
242 data->progress.ul_limit_start = data->progress.start;
243 data->progress.dl_limit_start = data->progress.start;
244 data->progress.ul_limit_size = 0;
245 data->progress.dl_limit_size = 0;
246 data->progress.downloaded = 0;
247 data->progress.uploaded = 0;
248 /* clear all bits except HIDE and HEADERS_OUT */
249 data->progress.flags &= PGRS_HIDE|PGRS_HEADERS_OUT;
250 Curl_ratelimit(data, data->progress.start);
254 * This is used to handle speed limits, calculating how many milliseconds to
255 * wait until we're back under the speed limit, if needed.
257 * The way it works is by having a "starting point" (time & amount of data
258 * transferred by then) used in the speed computation, to be used instead of
259 * the start of the transfer. This starting point is regularly moved as
260 * transfer goes on, to keep getting accurate values (instead of average over
261 * the entire transfer).
263 * This function takes the current amount of data transferred, the amount at
264 * the starting point, the limit (in bytes/s), the time of the starting point
265 * and the current time.
267 * Returns 0 if no waiting is needed or when no waiting is needed but the
268 * starting point should be reset (to current); or the number of milliseconds
269 * to wait to get back under the speed limit.
271 timediff_t Curl_pgrsLimitWaitTime(curl_off_t cursize,
272 curl_off_t startsize,
274 struct curltime start,
277 curl_off_t size = cursize - startsize;
285 * 'minimum' is the number of milliseconds 'size' should take to download to
286 * stay below 'limit'.
288 if(size < CURL_OFF_T_MAX/1000)
289 minimum = (timediff_t) (CURL_OFF_T_C(1000) * size / limit);
291 minimum = (timediff_t) (size / limit);
292 if(minimum < TIMEDIFF_T_MAX/1000)
295 minimum = TIMEDIFF_T_MAX;
299 * 'actual' is the time in milliseconds it took to actually download the
302 actual = Curl_timediff(now, start);
303 if(actual < minimum) {
304 /* if it downloaded the data faster than the limit, make it wait the
306 return (minimum - actual);
313 * Set the number of downloaded bytes so far.
315 void Curl_pgrsSetDownloadCounter(struct Curl_easy *data, curl_off_t size)
317 data->progress.downloaded = size;
321 * Update the timestamp and sizestamp to use for rate limit calculations.
323 void Curl_ratelimit(struct Curl_easy *data, struct curltime now)
325 /* don't set a new stamp unless the time since last update is long enough */
326 if(data->set.max_recv_speed) {
327 if(Curl_timediff(now, data->progress.dl_limit_start) >=
328 MIN_RATE_LIMIT_PERIOD) {
329 data->progress.dl_limit_start = now;
330 data->progress.dl_limit_size = data->progress.downloaded;
333 if(data->set.max_send_speed) {
334 if(Curl_timediff(now, data->progress.ul_limit_start) >=
335 MIN_RATE_LIMIT_PERIOD) {
336 data->progress.ul_limit_start = now;
337 data->progress.ul_limit_size = data->progress.uploaded;
343 * Set the number of uploaded bytes so far.
345 void Curl_pgrsSetUploadCounter(struct Curl_easy *data, curl_off_t size)
347 data->progress.uploaded = size;
350 void Curl_pgrsSetDownloadSize(struct Curl_easy *data, curl_off_t size)
353 data->progress.size_dl = size;
354 data->progress.flags |= PGRS_DL_SIZE_KNOWN;
357 data->progress.size_dl = 0;
358 data->progress.flags &= ~PGRS_DL_SIZE_KNOWN;
362 void Curl_pgrsSetUploadSize(struct Curl_easy *data, curl_off_t size)
365 data->progress.size_ul = size;
366 data->progress.flags |= PGRS_UL_SIZE_KNOWN;
369 data->progress.size_ul = 0;
370 data->progress.flags &= ~PGRS_UL_SIZE_KNOWN;
374 /* returns the average speed in bytes / second */
375 static curl_off_t trspeed(curl_off_t size, /* number of bytes */
376 curl_off_t us) /* microseconds */
379 return size * 1000000;
380 else if(size < CURL_OFF_T_MAX/1000000)
381 return (size * 1000000) / us;
382 else if(us >= 1000000)
383 return size / (us / 1000000);
385 return CURL_OFF_T_MAX;
388 /* returns TRUE if it's time to show the progress meter */
389 static bool progress_calc(struct Curl_easy *data, struct curltime now)
391 bool timetoshow = FALSE;
392 struct Progress * const p = &data->progress;
394 /* The time spent so far (from the start) in microseconds */
395 p->timespent = Curl_timediff_us(now, p->start);
396 p->dlspeed = trspeed(p->downloaded, p->timespent);
397 p->ulspeed = trspeed(p->uploaded, p->timespent);
399 /* Calculations done at most once a second, unless end is reached */
400 if(p->lastshow != now.tv_sec) {
401 int countindex; /* amount of seconds stored in the speeder array */
402 int nowindex = p->speeder_c% CURR_TIME;
403 p->lastshow = now.tv_sec;
406 /* Let's do the "current speed" thing, with the dl + ul speeds
407 combined. Store the speed at entry 'nowindex'. */
408 p->speeder[ nowindex ] = p->downloaded + p->uploaded;
410 /* remember the exact time for this moment */
411 p->speeder_time [ nowindex ] = now;
413 /* advance our speeder_c counter, which is increased every time we get
414 here and we expect it to never wrap as 2^32 is a lot of seconds! */
417 /* figure out how many index entries of data we have stored in our speeder
418 array. With N_ENTRIES filled in, we have about N_ENTRIES-1 seconds of
419 transfer. Imagine, after one second we have filled in two entries,
420 after two seconds we've filled in three entries etc. */
421 countindex = ((p->speeder_c >= CURR_TIME)? CURR_TIME:p->speeder_c) - 1;
423 /* first of all, we don't do this if there's no counted seconds yet */
429 /* Get the index position to compare with the 'nowindex' position.
430 Get the oldest entry possible. While we have less than CURR_TIME
431 entries, the first entry will remain the oldest. */
432 checkindex = (p->speeder_c >= CURR_TIME)? p->speeder_c%CURR_TIME:0;
434 /* Figure out the exact time for the time span */
435 span_ms = Curl_timediff(now, p->speeder_time[checkindex]);
437 span_ms = 1; /* at least one millisecond MUST have passed */
439 /* Calculate the average speed the last 'span_ms' milliseconds */
440 amount = p->speeder[nowindex]- p->speeder[checkindex];
442 if(amount > CURL_OFF_T_C(4294967) /* 0xffffffff/1000 */)
443 /* the 'amount' value is bigger than would fit in 32 bits if
444 multiplied with 1000, so we use the double math for this */
445 p->current_speed = (curl_off_t)
446 ((double)amount/((double)span_ms/1000.0));
448 /* the 'amount' value is small enough to fit within 32 bits even
449 when multiplied with 1000 */
450 p->current_speed = amount*CURL_OFF_T_C(1000)/span_ms;
453 /* the first second we use the average */
454 p->current_speed = p->ulspeed + p->dlspeed;
456 } /* Calculations end */
460 #ifndef CURL_DISABLE_PROGRESS_METER
461 static void progress_meter(struct Curl_easy *data)
464 curl_off_t dlpercen = 0;
465 curl_off_t ulpercen = 0;
466 curl_off_t total_percen = 0;
467 curl_off_t total_transfer;
468 curl_off_t total_expected_transfer;
472 curl_off_t ulestimate = 0;
473 curl_off_t dlestimate = 0;
474 curl_off_t total_estimate;
475 curl_off_t timespent =
476 (curl_off_t)data->progress.timespent/1000000; /* seconds */
478 if(!(data->progress.flags & PGRS_HEADERS_OUT)) {
479 if(data->state.resume_from) {
480 fprintf(data->set.err,
481 "** Resuming transfer from byte position %"
482 CURL_FORMAT_CURL_OFF_T "\n", data->state.resume_from);
484 fprintf(data->set.err,
485 " %% Total %% Received %% Xferd Average Speed "
486 "Time Time Time Current\n"
488 "Total Spent Left Speed\n");
489 data->progress.flags |= PGRS_HEADERS_OUT; /* headers are shown */
492 /* Figure out the estimated time of arrival for the upload */
493 if((data->progress.flags & PGRS_UL_SIZE_KNOWN) &&
494 (data->progress.ulspeed > CURL_OFF_T_C(0))) {
495 ulestimate = data->progress.size_ul / data->progress.ulspeed;
497 if(data->progress.size_ul > CURL_OFF_T_C(10000))
498 ulpercen = data->progress.uploaded /
499 (data->progress.size_ul/CURL_OFF_T_C(100));
500 else if(data->progress.size_ul > CURL_OFF_T_C(0))
501 ulpercen = (data->progress.uploaded*100) /
502 data->progress.size_ul;
505 /* ... and the download */
506 if((data->progress.flags & PGRS_DL_SIZE_KNOWN) &&
507 (data->progress.dlspeed > CURL_OFF_T_C(0))) {
508 dlestimate = data->progress.size_dl / data->progress.dlspeed;
510 if(data->progress.size_dl > CURL_OFF_T_C(10000))
511 dlpercen = data->progress.downloaded /
512 (data->progress.size_dl/CURL_OFF_T_C(100));
513 else if(data->progress.size_dl > CURL_OFF_T_C(0))
514 dlpercen = (data->progress.downloaded*100) /
515 data->progress.size_dl;
518 /* Now figure out which of them is slower and use that one for the
520 total_estimate = ulestimate>dlestimate?ulestimate:dlestimate;
522 /* create the three time strings */
523 time2str(time_left, total_estimate > 0?(total_estimate - timespent):0);
524 time2str(time_total, total_estimate);
525 time2str(time_spent, timespent);
527 /* Get the total amount of data expected to get transferred */
528 total_expected_transfer =
529 ((data->progress.flags & PGRS_UL_SIZE_KNOWN)?
530 data->progress.size_ul:data->progress.uploaded)+
531 ((data->progress.flags & PGRS_DL_SIZE_KNOWN)?
532 data->progress.size_dl:data->progress.downloaded);
534 /* We have transferred this much so far */
535 total_transfer = data->progress.downloaded + data->progress.uploaded;
537 /* Get the percentage of data transferred so far */
538 if(total_expected_transfer > CURL_OFF_T_C(10000))
539 total_percen = total_transfer /
540 (total_expected_transfer/CURL_OFF_T_C(100));
541 else if(total_expected_transfer > CURL_OFF_T_C(0))
542 total_percen = (total_transfer*100) / total_expected_transfer;
544 fprintf(data->set.err,
546 "%3" CURL_FORMAT_CURL_OFF_T " %s "
547 "%3" CURL_FORMAT_CURL_OFF_T " %s "
548 "%3" CURL_FORMAT_CURL_OFF_T " %s %s %s %s %s %s %s",
549 total_percen, /* 3 letters */ /* total % */
550 max5data(total_expected_transfer, max5[2]), /* total size */
551 dlpercen, /* 3 letters */ /* rcvd % */
552 max5data(data->progress.downloaded, max5[0]), /* rcvd size */
553 ulpercen, /* 3 letters */ /* xfer % */
554 max5data(data->progress.uploaded, max5[1]), /* xfer size */
555 max5data(data->progress.dlspeed, max5[3]), /* avrg dl speed */
556 max5data(data->progress.ulspeed, max5[4]), /* avrg ul speed */
557 time_total, /* 8 letters */ /* total time */
558 time_spent, /* 8 letters */ /* time spent */
559 time_left, /* 8 letters */ /* time left */
560 max5data(data->progress.current_speed, max5[5])
563 /* we flush the output stream to make it appear as soon as possible */
564 fflush(data->set.err);
567 /* progress bar disabled */
568 #define progress_meter(x) Curl_nop_stmt
573 * Curl_pgrsUpdate() returns 0 for success or the value returned by the
576 int Curl_pgrsUpdate(struct Curl_easy *data)
578 struct curltime now = Curl_now(); /* what time is it */
579 bool showprogress = progress_calc(data, now);
580 if(!(data->progress.flags & PGRS_HIDE)) {
581 if(data->set.fxferinfo) {
583 /* There's a callback set, call that */
584 Curl_set_in_callback(data, true);
585 result = data->set.fxferinfo(data->set.progress_client,
586 data->progress.size_dl,
587 data->progress.downloaded,
588 data->progress.size_ul,
589 data->progress.uploaded);
590 Curl_set_in_callback(data, false);
591 if(result != CURL_PROGRESSFUNC_CONTINUE) {
593 failf(data, "Callback aborted");
597 else if(data->set.fprogress) {
599 /* The older deprecated callback is set, call that */
600 Curl_set_in_callback(data, true);
601 result = data->set.fprogress(data->set.progress_client,
602 (double)data->progress.size_dl,
603 (double)data->progress.downloaded,
604 (double)data->progress.size_ul,
605 (double)data->progress.uploaded);
606 Curl_set_in_callback(data, false);
607 if(result != CURL_PROGRESSFUNC_CONTINUE) {
609 failf(data, "Callback aborted");
615 progress_meter(data);