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 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 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 rembuf[64], eol[128];
  63         const char *units;
  64         int pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
  65         unsigned long diff;
  66         double rate, remain;
  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         if (remain < 0)
  96                 strlcpy(rembuf, "  ??:??:??", sizeof rembuf);
  97         else {
  98                 snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
  99                          (int) (remain / 3600.0),
 100                          (int) (remain / 60.0) % 60,
 101                          (int) remain % 60);
 102         }
 103
 104         if (is_last) {
 105                 snprintf(eol, sizeof eol, " (xfer#%d, to-check=%d/%d)\n",
 106                         stats.num_transferred_files,
 107                         stats.num_files - stats.current_file_index - 1,
 108                         stats.num_files);
 109         } else
 110                 strlcpy(eol, "\r", sizeof eol);
 111         rprintf(FCLIENT, "%12s %3d%% %7.2f%s %s%s",
 112                 human_num(ofs), pct, rate, units, rembuf, eol);
 113 }
 114
 115 void end_progress(OFF_T size)
 116 {
 117         if (!am_server) {
 118                 struct timeval now;
 119                 gettimeofday(&now, NULL);
 120                 rprint_progress(size, size, &now, True);
 121         }
 122         memset(&ph_start, 0, sizeof ph_start);
 123 }
 124
 125 void show_progress(OFF_T ofs, OFF_T size)
 126 {
 127         struct timeval now;
 128 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 129         static pid_t pgrp = -1;
 130         pid_t tc_pgrp;
 131 #endif
 132
 133         if (am_server)
 134                 return;
 135
 136 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 137         if (pgrp == -1)
 138                 pgrp = getpgrp(GETPGRP_ARG);
 139 #endif
 140
 141         gettimeofday(&now, NULL);
 142
 143         if (!ph_start.time.tv_sec) {
 144                 int i;
 145
 146                 /* Try to guess the real starting time when the sender started
 147                  * to send us data by using the time we last received some data
 148                  * in the last file (if it was recent enough). */
 149                 if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
 150                         ph_start.time = ph_list[newest_hpos].time;
 151                         ph_start.ofs = 0;
 152                 } else {
 153                         ph_start.time.tv_sec = now.tv_sec;
 154                         ph_start.time.tv_usec = now.tv_usec;
 155                         ph_start.ofs = ofs;
 156                 }
 157
 158                 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
 159                         ph_list[i] = ph_start;
 160         }
 161         else {
 162                 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
 163                         return;
 164
 165                 newest_hpos = oldest_hpos;
 166                 oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
 167                 ph_list[newest_hpos].time.tv_sec = now.tv_sec;
 168                 ph_list[newest_hpos].time.tv_usec = now.tv_usec;
 169                 ph_list[newest_hpos].ofs = ofs;
 170         }
 171
 172 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 173         tc_pgrp = tcgetpgrp(STDOUT_FILENO);
 174         if (tc_pgrp != pgrp && tc_pgrp != -1)
 175                 return;
 176 #endif
 177
 178         rprint_progress(ofs, size, &now, False);
 179 }