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