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