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