lib/progress.c

   1 /***************************************************************************
   2  *                                  _   _ ____  _
   3  *  Project                     ___| | | |  _ \| |
   4  *                             / __| | | | |_) | |
   5  *                            | (__| |_| |  _ <| |___
   6  *                             \___|\___/|_| \_\_____|
   7  *
   8  * Copyright (C) 1998 - 2011, 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 http://curl.haxx.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  ***************************************************************************/
  22
  23 #include "setup.h"
  24
  25 #include "urldata.h"
  26 #include "sendf.h"
  27 #include "progress.h"
  28
  29 #define _MPRINTF_REPLACE /* use our functions only */
  30 #include <curl/mprintf.h>
  31
  32 /* Provide a string that is 2 + 1 + 2 + 1 + 2 = 8 letters long (plus the zero
  33    byte) */
  34 static void time2str(char *r, curl_off_t seconds)
  35 {
  36   curl_off_t d, h, m, s;
  37   if(seconds <= 0) {
  38     strcpy(r, "--:--:--");
  39     return;
  40   }
  41   h = seconds / CURL_OFF_T_C(3600);
  42   if(h <= CURL_OFF_T_C(99)) {
  43     m = (seconds - (h*CURL_OFF_T_C(3600))) / CURL_OFF_T_C(60);
  44     s = (seconds - (h*CURL_OFF_T_C(3600))) - (m*CURL_OFF_T_C(60));
  45     snprintf(r, 9, "%2" FORMAT_OFF_T ":%02" FORMAT_OFF_T ":%02" FORMAT_OFF_T,
  46              h, m, s);
  47   }
  48   else {
  49     /* this equals to more than 99 hours, switch to a more suitable output
  50        format to fit within the limits. */
  51     d = seconds / CURL_OFF_T_C(86400);
  52     h = (seconds - (d*CURL_OFF_T_C(86400))) / CURL_OFF_T_C(3600);
  53     if(d <= CURL_OFF_T_C(999))
  54       snprintf(r, 9, "%3" FORMAT_OFF_T "d %02" FORMAT_OFF_T "h", d, h);
  55     else
  56       snprintf(r, 9, "%7" FORMAT_OFF_T "d", d);
  57   }
  58 }
  59
  60 /* The point of this function would be to return a string of the input data,
  61    but never longer than 5 columns (+ one zero byte).
  62    Add suffix k, M, G when suitable... */
  63 static char *max5data(curl_off_t bytes, char *max5)
  64 {
  65 #define ONE_KILOBYTE  CURL_OFF_T_C(1024)
  66 #define ONE_MEGABYTE (CURL_OFF_T_C(1024) * ONE_KILOBYTE)
  67 #define ONE_GIGABYTE (CURL_OFF_T_C(1024) * ONE_MEGABYTE)
  68 #define ONE_TERABYTE (CURL_OFF_T_C(1024) * ONE_GIGABYTE)
  69 #define ONE_PETABYTE (CURL_OFF_T_C(1024) * ONE_TERABYTE)
  70
  71   if(bytes < CURL_OFF_T_C(100000))
  72     snprintf(max5, 6, "%5" FORMAT_OFF_T, bytes);
  73
  74   else if(bytes < CURL_OFF_T_C(10000) * ONE_KILOBYTE)
  75     snprintf(max5, 6, "%4" FORMAT_OFF_T "k", bytes/ONE_KILOBYTE);
  76
  77   else if(bytes < CURL_OFF_T_C(100) * ONE_MEGABYTE)
  78     /* 'XX.XM' is good as long as we're less than 100 megs */
  79     snprintf(max5, 6, "%2" FORMAT_OFF_T ".%0" FORMAT_OFF_T "M",
  80               bytes/ONE_MEGABYTE,
  81              (bytes%ONE_MEGABYTE) / (ONE_MEGABYTE/CURL_OFF_T_C(10)) );
  82
  83 #if (CURL_SIZEOF_CURL_OFF_T > 4)
  84
  85   else if(bytes < CURL_OFF_T_C(10000) * ONE_MEGABYTE)
  86     /* 'XXXXM' is good until we're at 10000MB or above */
  87     snprintf(max5, 6, "%4" FORMAT_OFF_T "M", bytes/ONE_MEGABYTE);
  88
  89   else if(bytes < CURL_OFF_T_C(100) * ONE_GIGABYTE)
  90     /* 10000 MB - 100 GB, we show it as XX.XG */
  91     snprintf(max5, 6, "%2" FORMAT_OFF_T ".%0" FORMAT_OFF_T "G",
  92               bytes/ONE_GIGABYTE,
  93              (bytes%ONE_GIGABYTE) / (ONE_GIGABYTE/CURL_OFF_T_C(10)) );
  94
  95   else if(bytes < CURL_OFF_T_C(10000) * ONE_GIGABYTE)
  96     /* up to 10000GB, display without decimal: XXXXG */
  97     snprintf(max5, 6, "%4" FORMAT_OFF_T "G", bytes/ONE_GIGABYTE);
  98
  99   else if(bytes < CURL_OFF_T_C(10000) * ONE_TERABYTE)
 100     /* up to 10000TB, display without decimal: XXXXT */
 101     snprintf(max5, 6, "%4" FORMAT_OFF_T "T", bytes/ONE_TERABYTE);
 102
 103   else
 104     /* up to 10000PB, display without decimal: XXXXP */
 105     snprintf(max5, 6, "%4" FORMAT_OFF_T "P", bytes/ONE_PETABYTE);
 106
 107     /* 16384 petabytes (16 exabytes) is the maximum a 64 bit unsigned number
 108        can hold, but our data type is signed so 8192PB will be the maximum. */
 109
 110 #else
 111
 112   else
 113     snprintf(max5, 6, "%4" FORMAT_OFF_T "M", bytes/ONE_MEGABYTE);
 114
 115 #endif
 116
 117   return max5;
 118 }
 119
 120 /*
 121
 122    New proposed interface, 9th of February 2000:
 123
 124    pgrsStartNow() - sets start time
 125    pgrsSetDownloadSize(x) - known expected download size
 126    pgrsSetUploadSize(x) - known expected upload size
 127    pgrsSetDownloadCounter() - amount of data currently downloaded
 128    pgrsSetUploadCounter() - amount of data currently uploaded
 129    pgrsUpdate() - show progress
 130    pgrsDone() - transfer complete
 131
 132 */
 133
 134 void Curl_pgrsDone(struct connectdata *conn)
 135 {
 136   struct SessionHandle *data = conn->data;
 137   data->progress.lastshow=0;
 138   Curl_pgrsUpdate(conn); /* the final (forced) update */
 139
 140   if(!(data->progress.flags & PGRS_HIDE) &&
 141      !data->progress.callback)
 142     /* only output if we don't use a progress callback and we're not
 143      * hidden */
 144     fprintf(data->set.err, "\n");
 145
 146   data->progress.speeder_c = 0; /* reset the progress meter display */
 147 }
 148
 149 /* reset all times except redirect */
 150 void Curl_pgrsResetTimes(struct SessionHandle *data)
 151 {
 152   data->progress.t_nslookup = 0.0;
 153   data->progress.t_connect = 0.0;
 154   data->progress.t_pretransfer = 0.0;
 155   data->progress.t_starttransfer = 0.0;
 156 }
 157
 158 void Curl_pgrsTime(struct SessionHandle *data, timerid timer)
 159 {
 160   struct timeval now = Curl_tvnow();
 161
 162   switch(timer) {
 163   default:
 164   case TIMER_NONE:
 165     /* mistake filter */
 166     break;
 167   case TIMER_STARTSINGLE:
 168     /* This is set at the start of a single fetch */
 169     data->progress.t_startsingle = now;
 170     break;
 171
 172   case TIMER_STARTACCEPT:
 173     data->progress.t_acceptdata = Curl_tvnow();
 174     break;
 175
 176   case TIMER_NAMELOOKUP:
 177     data->progress.t_nslookup =
 178       Curl_tvdiff_secs(now, data->progress.t_startsingle);
 179     break;
 180   case TIMER_CONNECT:
 181     data->progress.t_connect =
 182       Curl_tvdiff_secs(now, data->progress.t_startsingle);
 183     break;
 184   case TIMER_APPCONNECT:
 185     data->progress.t_appconnect =
 186       Curl_tvdiff_secs(now, data->progress.t_startsingle);
 187     break;
 188   case TIMER_PRETRANSFER:
 189     data->progress.t_pretransfer =
 190       Curl_tvdiff_secs(now, data->progress.t_startsingle);
 191     break;
 192   case TIMER_STARTTRANSFER:
 193     data->progress.t_starttransfer =
 194       Curl_tvdiff_secs(now, data->progress.t_startsingle);
 195     break;
 196   case TIMER_POSTRANSFER:
 197     /* this is the normal end-of-transfer thing */
 198     break;
 199   case TIMER_REDIRECT:
 200     data->progress.t_redirect = Curl_tvdiff_secs(now, data->progress.start);
 201     break;
 202   }
 203 }
 204
 205 void Curl_pgrsStartNow(struct SessionHandle *data)
 206 {
 207   data->progress.speeder_c = 0; /* reset the progress meter display */
 208   data->progress.start = Curl_tvnow();
 209   /* clear all bits except HIDE and HEADERS_OUT */
 210   data->progress.flags &= PGRS_HIDE|PGRS_HEADERS_OUT;
 211 }
 212
 213 void Curl_pgrsSetDownloadCounter(struct SessionHandle *data, curl_off_t size)
 214 {
 215   data->progress.downloaded = size;
 216 }
 217
 218 void Curl_pgrsSetUploadCounter(struct SessionHandle *data, curl_off_t size)
 219 {
 220   data->progress.uploaded = size;
 221 }
 222
 223 void Curl_pgrsSetDownloadSize(struct SessionHandle *data, curl_off_t size)
 224 {
 225   data->progress.size_dl = size;
 226   if(size >= 0)
 227     data->progress.flags |= PGRS_DL_SIZE_KNOWN;
 228   else
 229     data->progress.flags &= ~PGRS_DL_SIZE_KNOWN;
 230 }
 231
 232 void Curl_pgrsSetUploadSize(struct SessionHandle *data, curl_off_t size)
 233 {
 234   data->progress.size_ul = size;
 235   if(size >= 0)
 236     data->progress.flags |= PGRS_UL_SIZE_KNOWN;
 237   else
 238     data->progress.flags &= ~PGRS_UL_SIZE_KNOWN;
 239 }
 240
 241 int Curl_pgrsUpdate(struct connectdata *conn)
 242 {
 243   struct timeval now;
 244   int result;
 245   char max5[6][10];
 246   curl_off_t dlpercen=0;
 247   curl_off_t ulpercen=0;
 248   curl_off_t total_percen=0;
 249   curl_off_t total_transfer;
 250   curl_off_t total_expected_transfer;
 251   curl_off_t timespent;
 252   struct SessionHandle *data = conn->data;
 253   int nowindex = data->progress.speeder_c% CURR_TIME;
 254   int checkindex;
 255   int countindex; /* amount of seconds stored in the speeder array */
 256   char time_left[10];
 257   char time_total[10];
 258   char time_spent[10];
 259   curl_off_t ulestimate=0;
 260   curl_off_t dlestimate=0;
 261   curl_off_t total_estimate;
 262   bool shownow=FALSE;
 263
 264   now = Curl_tvnow(); /* what time is it */
 265
 266   /* The time spent so far (from the start) */
 267   data->progress.timespent =
 268     (double)(now.tv_sec - data->progress.start.tv_sec) +
 269     (double)(now.tv_usec - data->progress.start.tv_usec)/1000000.0;
 270   timespent = (curl_off_t)data->progress.timespent;
 271
 272   /* The average download speed this far */
 273   data->progress.dlspeed = (curl_off_t)
 274     ((double)data->progress.downloaded/
 275      (data->progress.timespent>0?data->progress.timespent:1));
 276
 277   /* The average upload speed this far */
 278   data->progress.ulspeed = (curl_off_t)
 279     ((double)data->progress.uploaded/
 280      (data->progress.timespent>0?data->progress.timespent:1));
 281
 282   /* Calculations done at most once a second, unless end is reached */
 283   if(data->progress.lastshow != (long)now.tv_sec) {
 284     shownow = TRUE;
 285
 286     data->progress.lastshow = now.tv_sec;
 287
 288     /* Let's do the "current speed" thing, which should use the fastest
 289        of the dl/ul speeds. Store the faster speed at entry 'nowindex'. */
 290     data->progress.speeder[ nowindex ] =
 291       data->progress.downloaded>data->progress.uploaded?
 292       data->progress.downloaded:data->progress.uploaded;
 293
 294     /* remember the exact time for this moment */
 295     data->progress.speeder_time [ nowindex ] = now;
 296
 297     /* advance our speeder_c counter, which is increased every time we get
 298        here and we expect it to never wrap as 2^32 is a lot of seconds! */
 299     data->progress.speeder_c++;
 300
 301     /* figure out how many index entries of data we have stored in our speeder
 302        array. With N_ENTRIES filled in, we have about N_ENTRIES-1 seconds of
 303        transfer. Imagine, after one second we have filled in two entries,
 304        after two seconds we've filled in three entries etc. */
 305     countindex = ((data->progress.speeder_c>=CURR_TIME)?
 306                   CURR_TIME:data->progress.speeder_c) - 1;
 307
 308     /* first of all, we don't do this if there's no counted seconds yet */
 309     if(countindex) {
 310       long span_ms;
 311
 312       /* Get the index position to compare with the 'nowindex' position.
 313          Get the oldest entry possible. While we have less than CURR_TIME
 314          entries, the first entry will remain the oldest. */
 315       checkindex = (data->progress.speeder_c>=CURR_TIME)?
 316         data->progress.speeder_c%CURR_TIME:0;
 317
 318       /* Figure out the exact time for the time span */
 319       span_ms = Curl_tvdiff(now,
 320                             data->progress.speeder_time[checkindex]);
 321       if(0 == span_ms)
 322         span_ms=1; /* at least one millisecond MUST have passed */
 323
 324       /* Calculate the average speed the last 'span_ms' milliseconds */
 325       {
 326         curl_off_t amount = data->progress.speeder[nowindex]-
 327           data->progress.speeder[checkindex];
 328
 329         if(amount > CURL_OFF_T_C(4294967) /* 0xffffffff/1000 */)
 330           /* the 'amount' value is bigger than would fit in 32 bits if
 331              multiplied with 1000, so we use the double math for this */
 332           data->progress.current_speed = (curl_off_t)
 333             ((double)amount/((double)span_ms/1000.0));
 334         else
 335           /* the 'amount' value is small enough to fit within 32 bits even
 336              when multiplied with 1000 */
 337           data->progress.current_speed = amount*CURL_OFF_T_C(1000)/span_ms;
 338       }
 339     }
 340     else
 341       /* the first second we use the main average */
 342       data->progress.current_speed =
 343         (data->progress.ulspeed>data->progress.dlspeed)?
 344         data->progress.ulspeed:data->progress.dlspeed;
 345
 346   } /* Calculations end */
 347
 348   if(!(data->progress.flags & PGRS_HIDE)) {
 349
 350     /* progress meter has not been shut off */
 351
 352     if(data->set.fprogress) {
 353       /* There's a callback set, so we call that instead of writing
 354          anything ourselves. This really is the way to go. */
 355       result= data->set.fprogress(data->set.progress_client,
 356                                   (double)data->progress.size_dl,
 357                                   (double)data->progress.downloaded,
 358                                   (double)data->progress.size_ul,
 359                                   (double)data->progress.uploaded);
 360       if(result)
 361         failf(data, "Callback aborted");
 362       return result;
 363     }
 364
 365     if(!shownow)
 366       /* only show the internal progress meter once per second */
 367       return 0;
 368
 369     /* If there's no external callback set, use internal code to show
 370        progress */
 371
 372     if(!(data->progress.flags & PGRS_HEADERS_OUT)) {
 373       if(data->state.resume_from) {
 374         fprintf(data->set.err,
 375                 "** Resuming transfer from byte position %" FORMAT_OFF_T "\n",
 376                 data->state.resume_from);
 377       }
 378       fprintf(data->set.err,
 379               "  %% Total    %% Received %% Xferd  Average Speed   "
 380               "Time    Time     Time  Current\n"
 381               "                                 Dload  Upload   "
 382               "Total   Spent    Left  Speed\n");
 383       data->progress.flags |= PGRS_HEADERS_OUT; /* headers are shown */
 384     }
 385
 386     /* Figure out the estimated time of arrival for the upload */
 387     if((data->progress.flags & PGRS_UL_SIZE_KNOWN) &&
 388        (data->progress.ulspeed > CURL_OFF_T_C(0))) {
 389       ulestimate = data->progress.size_ul / data->progress.ulspeed;
 390
 391       if(data->progress.size_ul > CURL_OFF_T_C(10000))
 392         ulpercen = data->progress.uploaded /
 393           (data->progress.size_ul/CURL_OFF_T_C(100));
 394       else if(data->progress.size_ul > CURL_OFF_T_C(0))
 395         ulpercen = (data->progress.uploaded*100) /
 396           data->progress.size_ul;
 397     }
 398
 399     /* ... and the download */
 400     if((data->progress.flags & PGRS_DL_SIZE_KNOWN) &&
 401        (data->progress.dlspeed > CURL_OFF_T_C(0))) {
 402       dlestimate = data->progress.size_dl / data->progress.dlspeed;
 403
 404       if(data->progress.size_dl > CURL_OFF_T_C(10000))
 405         dlpercen = data->progress.downloaded /
 406           (data->progress.size_dl/CURL_OFF_T_C(100));
 407       else if(data->progress.size_dl > CURL_OFF_T_C(0))
 408         dlpercen = (data->progress.downloaded*100) /
 409           data->progress.size_dl;
 410     }
 411
 412     /* Now figure out which of them is slower and use that one for the
 413        total estimate! */
 414     total_estimate = ulestimate>dlestimate?ulestimate:dlestimate;
 415
 416     /* create the three time strings */
 417     time2str(time_left, total_estimate > 0?(total_estimate - timespent):0);
 418     time2str(time_total, total_estimate);
 419     time2str(time_spent, timespent);
 420
 421     /* Get the total amount of data expected to get transferred */
 422     total_expected_transfer =
 423       (data->progress.flags & PGRS_UL_SIZE_KNOWN?
 424        data->progress.size_ul:data->progress.uploaded)+
 425       (data->progress.flags & PGRS_DL_SIZE_KNOWN?
 426        data->progress.size_dl:data->progress.downloaded);
 427
 428     /* We have transferred this much so far */
 429     total_transfer = data->progress.downloaded + data->progress.uploaded;
 430
 431     /* Get the percentage of data transferred so far */
 432     if(total_expected_transfer > CURL_OFF_T_C(10000))
 433       total_percen = total_transfer /
 434         (total_expected_transfer/CURL_OFF_T_C(100));
 435     else if(total_expected_transfer > CURL_OFF_T_C(0))
 436       total_percen = (total_transfer*100) / total_expected_transfer;
 437
 438     fprintf(data->set.err,
 439             "\r"
 440             "%3" FORMAT_OFF_T " %s  "
 441             "%3" FORMAT_OFF_T " %s  "
 442             "%3" FORMAT_OFF_T " %s  %s  %s %s %s %s %s",
 443             total_percen,  /* 3 letters */                /* total % */
 444             max5data(total_expected_transfer, max5[2]),   /* total size */
 445             dlpercen,      /* 3 letters */                /* rcvd % */
 446             max5data(data->progress.downloaded, max5[0]), /* rcvd size */
 447             ulpercen,      /* 3 letters */                /* xfer % */
 448             max5data(data->progress.uploaded, max5[1]),   /* xfer size */
 449             max5data(data->progress.dlspeed, max5[3]),    /* avrg dl speed */
 450             max5data(data->progress.ulspeed, max5[4]),    /* avrg ul speed */
 451             time_total,    /* 8 letters */                /* total time */
 452             time_spent,    /* 8 letters */                /* time spent */
 453             time_left,     /* 8 letters */                /* time left */
 454             max5data(data->progress.current_speed, max5[5]) /* current speed */
 455             );
 456
 457     /* we flush the output stream to make it appear as soon as possible */
 458     fflush(data->set.err);
 459
 460   } /* !(data->progress.flags & PGRS_HIDE) */
 461
 462   return 0;
 463 }