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