progress.c

   1 /*
   2  * Routines to output progress information during a file transfer.
   3  *
   4  * Copyright (C) 1996-2000 Andrew Tridgell
   5  * Copyright (C) 1996 Paul Mackerras
   6  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
   7  * Copyright (C) 2003-2008 Wayne Davison
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, visit the http://fsf.org website.
  21  */
  22
  23 #include "rsync.h"
  24
  25 extern int am_server;
  26 extern int need_unsorted_flist;
  27 extern struct stats stats;
  28 extern struct file_list *cur_flist;
  29
  30 #define PROGRESS_HISTORY_SECS 5
  31
  32 #ifdef GETPGRP_VOID
  33 #define GETPGRP_ARG
  34 #else
  35 #define GETPGRP_ARG 0
  36 #endif
  37
  38 struct progress_history {
  39         struct timeval time;
  40         OFF_T ofs;
  41 };
  42
  43 static struct progress_history ph_start;
  44 static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
  45 static int newest_hpos, oldest_hpos;
  46 static int current_file_index;
  47
  48 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
  49 {
  50         return (t2->tv_sec - t1->tv_sec) * 1000L
  51              + (t2->tv_usec - t1->tv_usec) / 1000;
  52 }
  53
  54
  55 /**
  56  * @param ofs Current position in file
  57  * @param size Total size of file
  58  * @param is_last True if this is the last time progress will be
  59  * printed for this file, so we should output a newline.  (Not
  60  * necessarily the same as all bytes being received.)
  61  **/
  62 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
  63                             int is_last)
  64 {
  65         char rembuf[64], eol[128];
  66         const char *units;
  67         int pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
  68         unsigned long diff;
  69         double rate, remain;
  70
  71         if (is_last) {
  72                 /* Compute stats based on the starting info. */
  73                 if (!ph_start.time.tv_sec
  74                     || !(diff = msdiff(&ph_start.time, now)))
  75                         diff = 1;
  76                 rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
  77                 /* Switch to total time taken for our last update. */
  78                 remain = (double) diff / 1000.0;
  79         } else {
  80                 /* Compute stats based on recent progress. */
  81                 if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
  82                         diff = 1;
  83                 rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
  84                      / diff / 1024.0;
  85                 remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
  86         }
  87
  88         if (rate > 1024*1024) {
  89                 rate /= 1024.0 * 1024.0;
  90                 units = "GB/s";
  91         } else if (rate > 1024) {
  92                 rate /= 1024.0;
  93                 units = "MB/s";
  94         } else {
  95                 units = "kB/s";
  96         }
  97
  98         if (remain < 0)
  99                 strlcpy(rembuf, "  ??:??:??", sizeof rembuf);
 100         else {
 101                 snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
 102                          (int) (remain / 3600.0),
 103                          (int) (remain / 60.0) % 60,
 104                          (int) remain % 60);
 105         }
 106
 107         if (is_last) {
 108                 snprintf(eol, sizeof eol, " (xfer#%d, to-check=%d/%d)\n",
 109                         stats.num_transferred_files,
 110                         stats.num_files - current_file_index - 1,
 111                         stats.num_files);
 112         } else
 113                 strlcpy(eol, "\r", sizeof eol);
 114         rprintf(FCLIENT, "%12s %3d%% %7.2f%s %s%s",
 115                 human_num(ofs), pct, rate, units, rembuf, eol);
 116 }
 117
 118 void set_current_file_index(struct file_struct *file, int ndx)
 119 {
 120         if (need_unsorted_flist)
 121                 current_file_index = flist_find(cur_flist, file) + cur_flist->ndx_start;
 122         else
 123                 current_file_index = ndx;
 124         current_file_index -= cur_flist->flist_num;
 125 }
 126
 127 void end_progress(OFF_T size)
 128 {
 129         if (!am_server) {
 130                 struct timeval now;
 131                 gettimeofday(&now, NULL);
 132                 rprint_progress(size, size, &now, True);
 133         }
 134         memset(&ph_start, 0, sizeof ph_start);
 135 }
 136
 137 void show_progress(OFF_T ofs, OFF_T size)
 138 {
 139         struct timeval now;
 140 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 141         static pid_t pgrp = -1;
 142         pid_t tc_pgrp;
 143 #endif
 144
 145         if (am_server)
 146                 return;
 147
 148 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 149         if (pgrp == -1)
 150                 pgrp = getpgrp(GETPGRP_ARG);
 151 #endif
 152
 153         gettimeofday(&now, NULL);
 154
 155         if (!ph_start.time.tv_sec) {
 156                 int i;
 157
 158                 /* Try to guess the real starting time when the sender started
 159                  * to send us data by using the time we last received some data
 160                  * in the last file (if it was recent enough). */
 161                 if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
 162                         ph_start.time = ph_list[newest_hpos].time;
 163                         ph_start.ofs = 0;
 164                 } else {
 165                         ph_start.time.tv_sec = now.tv_sec;
 166                         ph_start.time.tv_usec = now.tv_usec;
 167                         ph_start.ofs = ofs;
 168                 }
 169
 170                 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
 171                         ph_list[i] = ph_start;
 172         }
 173         else {
 174                 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
 175                         return;
 176
 177                 newest_hpos = oldest_hpos;
 178                 oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
 179                 ph_list[newest_hpos].time.tv_sec = now.tv_sec;
 180                 ph_list[newest_hpos].time.tv_usec = now.tv_usec;
 181                 ph_list[newest_hpos].ofs = ofs;
 182         }
 183
 184 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 185         tc_pgrp = tcgetpgrp(STDOUT_FILENO);
 186         if (tc_pgrp != pgrp && tc_pgrp != -1)
 187                 return;
 188 #endif
 189
 190         rprint_progress(ofs, size, &now, False);
 191 }