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 int output_needs_newline;
  28 extern struct stats stats;
  29 extern struct file_list *cur_flist;
  30
  31 #define PROGRESS_HISTORY_SECS 5
  32
  33 #ifdef GETPGRP_VOID
  34 #define GETPGRP_ARG
  35 #else
  36 #define GETPGRP_ARG 0
  37 #endif
  38
  39 struct progress_history {
  40         struct timeval time;
  41         OFF_T ofs;
  42 };
  43
  44 static struct progress_history ph_start;
  45 static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
  46 static int newest_hpos, oldest_hpos;
  47 static int current_file_index;
  48
  49 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
  50 {
  51         return (t2->tv_sec - t1->tv_sec) * 1000L
  52              + (t2->tv_usec - t1->tv_usec) / 1000;
  53 }
  54
  55
  56 /**
  57  * @param ofs Current position in file
  58  * @param size Total size of file
  59  * @param is_last True if this is the last time progress will be
  60  * printed for this file, so we should output a newline.  (Not
  61  * necessarily the same as all bytes being received.)
  62  **/
  63 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
  64                             int is_last)
  65 {
  66         char rembuf[64], eol[128];
  67         const char *units;
  68         unsigned long diff;
  69         double rate, remain;
  70         int pct;
  71
  72         if (is_last) {
  73                 int len = snprintf(eol, sizeof eol,
  74                         " (xfer#%d, to-check=%d/%d)\n",
  75                         stats.num_transferred_files,
  76                         stats.num_files - current_file_index - 1,
  77                         stats.num_files);
  78                 if (INFO_GTE(PROGRESS, 2)) {
  79                         static int last_len = 0;
  80                         /* Drop \n and pad with spaces if line got shorter. */
  81                         if (last_len < --len)
  82                                 last_len = len;
  83                         eol[last_len] = '\0';
  84                         while (last_len > len)
  85                                 eol[--last_len] = ' ';
  86                         is_last = 0;
  87                 }
  88                 /* Compute stats based on the starting info. */
  89                 if (!ph_start.time.tv_sec
  90                     || !(diff = msdiff(&ph_start.time, now)))
  91                         diff = 1;
  92                 rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
  93                 /* Switch to total time taken for our last update. */
  94                 remain = (double) diff / 1000.0;
  95         } else {
  96                 strlcpy(eol, "  ", sizeof eol);
  97                 /* Compute stats based on recent progress. */
  98                 if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
  99                         diff = 1;
 100                 rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
 101                      / diff / 1024.0;
 102                 remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
 103         }
 104
 105         if (rate > 1024*1024) {
 106                 rate /= 1024.0 * 1024.0;
 107                 units = "GB/s";
 108         } else if (rate > 1024) {
 109                 rate /= 1024.0;
 110                 units = "MB/s";
 111         } else {
 112                 units = "kB/s";
 113         }
 114
 115         if (remain < 0)
 116                 strlcpy(rembuf, "  ??:??:??", sizeof rembuf);
 117         else {
 118                 snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
 119                          (int) (remain / 3600.0),
 120                          (int) (remain / 60.0) % 60,
 121                          (int) remain % 60);
 122         }
 123
 124         output_needs_newline = 0;
 125         pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
 126         rprintf(FCLIENT, "\r%12s %3d%% %7.2f%s %s%s",
 127                 human_num(ofs), pct, rate, units, rembuf, eol);
 128         if (!is_last) {
 129                 output_needs_newline = 1;
 130                 rflush(FCLIENT);
 131         }
 132 }
 133
 134 void set_current_file_index(struct file_struct *file, int ndx)
 135 {
 136         if (!file)
 137                 current_file_index = cur_flist->used + cur_flist->ndx_start - 1;
 138         else if (need_unsorted_flist)
 139                 current_file_index = flist_find(cur_flist, file) + cur_flist->ndx_start;
 140         else
 141                 current_file_index = ndx;
 142         current_file_index -= cur_flist->flist_num;
 143 }
 144
 145 void end_progress(OFF_T size)
 146 {
 147         if (!am_server) {
 148                 struct timeval now;
 149                 gettimeofday(&now, NULL);
 150                 if (INFO_GTE(PROGRESS, 2)) {
 151                         rprint_progress(stats.total_transferred_size,
 152                                         stats.total_size, &now, True);
 153                 } else {
 154                         rprint_progress(size, size, &now, True);
 155                         memset(&ph_start, 0, sizeof ph_start);
 156                 }
 157         }
 158 }
 159
 160 void show_progress(OFF_T ofs, OFF_T size)
 161 {
 162         struct timeval now;
 163 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 164         static pid_t pgrp = -1;
 165         pid_t tc_pgrp;
 166 #endif
 167
 168         if (am_server)
 169                 return;
 170
 171 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 172         if (pgrp == -1)
 173                 pgrp = getpgrp(GETPGRP_ARG);
 174 #endif
 175
 176         gettimeofday(&now, NULL);
 177
 178         if (!ph_start.time.tv_sec) {
 179                 int i;
 180
 181                 /* Try to guess the real starting time when the sender started
 182                  * to send us data by using the time we last received some data
 183                  * in the last file (if it was recent enough). */
 184                 if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
 185                         ph_start.time = ph_list[newest_hpos].time;
 186                         ph_start.ofs = 0;
 187                 } else {
 188                         ph_start.time.tv_sec = now.tv_sec;
 189                         ph_start.time.tv_usec = now.tv_usec;
 190                         ph_start.ofs = ofs;
 191                 }
 192
 193                 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
 194                         ph_list[i] = ph_start;
 195         }
 196         else {
 197                 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
 198                         return;
 199
 200                 newest_hpos = oldest_hpos;
 201                 oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
 202                 ph_list[newest_hpos].time.tv_sec = now.tv_sec;
 203                 ph_list[newest_hpos].time.tv_usec = now.tv_usec;
 204                 ph_list[newest_hpos].ofs = ofs;
 205         }
 206
 207 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
 208         tc_pgrp = tcgetpgrp(STDOUT_FILENO);
 209         if (tc_pgrp != pgrp && tc_pgrp != -1)
 210                 return;
 211 #endif
 212
 213         if (INFO_GTE(PROGRESS, 2)) {
 214                 rprint_progress(stats.total_transferred_size,
 215                                 stats.total_size, &now, False);
 216         } else
 217                 rprint_progress(ofs, size, &now, False);
 218 }