Include 2008 in the copyright years.
[rsync/rsync.git] / progress.c
index 42d8f35..d614806 100644 (file)
@@ -1,12 +1,14 @@
-/*  -*- c-file-style: "linux" -*-
+/*
+ * Routines to output progress information during a file transfer.
  *
- * Copyright (C) 1996-2000 by Andrew Tridgell
- * Copyright (C) Paul Mackerras 1996
- * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
+ * Copyright (C) 1996-2000 Andrew Tridgell
+ * Copyright (C) 1996 Paul Mackerras
+ * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2003-2008 Wayne Davison
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, visit the http://fsf.org website.
  */
 
 #include "rsync.h"
 
-extern struct stats stats;
 extern int am_server;
+extern int need_unsorted_flist;
+extern struct stats stats;
+extern struct file_list *cur_flist;
+
+#define PROGRESS_HISTORY_SECS 5
+
+#ifdef GETPGRP_VOID
+#define GETPGRP_ARG
+#else
+#define GETPGRP_ARG 0
+#endif
 
-static OFF_T  last_ofs;
-static struct timeval print_time;
-static struct timeval start_time;
-static OFF_T  start_ofs;
+struct progress_history {
+       struct timeval time;
+       OFF_T ofs;
+};
+
+static struct progress_history ph_start;
+static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
+static int newest_hpos, oldest_hpos;
+static int current_file_index;
 
 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
 {
-       return (t2->tv_sec - t1->tv_sec) * 1000
+       return (t2->tv_sec - t1->tv_sec) * 1000L
             + (t2->tv_usec - t1->tv_usec) / 1000;
 }
 
@@ -46,19 +62,28 @@ static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
                            int is_last)
 {
-       char eol[256];
-       int pct = (ofs == size) ? 100 : (int)((100.0*ofs)/size);
-       unsigned long diff = msdiff(&start_time, now);
-       double rate = diff ? (double) (ofs-start_ofs) * 1000.0 / diff / 1024.0 : 0;
+       char rembuf[64], eol[128];
        const char *units;
-       /* If we've finished transferring this file, show the time taken;
-        * otherwise show expected time to complete.  That's kind of
-        * inconsistent, but people can probably cope.  Hopefully we'll
-        * get more consistent and complete progress reporting soon. --
-        * mbp */
-       double remain = is_last ? (double) diff / 1000.0
-                     : rate ? (double) (size-ofs) / rate / 1000.0 : 0.0;
-       int remain_h, remain_m, remain_s;
+       int pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
+       unsigned long diff;
+       double rate, remain;
+
+       if (is_last) {
+               /* Compute stats based on the starting info. */
+               if (!ph_start.time.tv_sec
+                   || !(diff = msdiff(&ph_start.time, now)))
+                       diff = 1;
+               rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
+               /* Switch to total time taken for our last update. */
+               remain = (double) diff / 1000.0;
+       } else {
+               /* Compute stats based on recent progress. */
+               if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
+                       diff = 1;
+               rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
+                    / diff / 1024.0;
+               remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
+       }
 
        if (rate > 1024*1024) {
                rate /= 1024.0 * 1024.0;
@@ -70,20 +95,33 @@ static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
                units = "kB/s";
        }
 
-       remain_s = (int) remain % 60;
-       remain_m = (int) (remain / 60.0) % 60;
-       remain_h = (int) (remain / 3600.0);
+       if (remain < 0)
+               strlcpy(rembuf, "  ??:??:??", sizeof rembuf);
+       else {
+               snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
+                        (int) (remain / 3600.0),
+                        (int) (remain / 60.0) % 60,
+                        (int) remain % 60);
+       }
 
        if (is_last) {
-               snprintf(eol, sizeof eol, "  (%d, %.1f%% of %d)\n",
+               snprintf(eol, sizeof eol, " (xfer#%d, to-check=%d/%d)\n",
                        stats.num_transferred_files,
-                       (float)(stats.current_file_index * 100) / stats.num_files,
+                       stats.num_files - current_file_index - 1,
                        stats.num_files);
        } else
-               strcpy(eol, "\r");
-       rprintf(FINFO, "%12.0f %3d%% %7.2f%s %4d:%02d:%02d%s",
-               (double) ofs, pct, rate, units,
-               remain_h, remain_m, remain_s, eol);
+               strlcpy(eol, "\r", sizeof eol);
+       rprintf(FCLIENT, "%12s %3d%% %7.2f%s %s%s",
+               human_num(ofs), pct, rate, units, rembuf, eol);
+}
+
+void set_current_file_index(struct file_struct *file, int ndx)
+{
+       if (need_unsorted_flist)
+               current_file_index = flist_find(cur_flist, file) + cur_flist->ndx_start;
+       else
+               current_file_index = ndx;
+       current_file_index -= cur_flist->flist_num;
 }
 
 void end_progress(OFF_T size)
@@ -93,34 +131,61 @@ void end_progress(OFF_T size)
                gettimeofday(&now, NULL);
                rprint_progress(size, size, &now, True);
        }
-       last_ofs = 0;
-       start_ofs = 0;
-       print_time.tv_sec = print_time.tv_usec = 0;
-       start_time.tv_sec = start_time.tv_usec = 0;
+       memset(&ph_start, 0, sizeof ph_start);
 }
 
 void show_progress(OFF_T ofs, OFF_T size)
 {
        struct timeval now;
+#if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
+       static pid_t pgrp = -1;
+       pid_t tc_pgrp;
+#endif
 
-       if (!start_time.tv_sec) {
-               gettimeofday(&now, NULL);
-               start_time.tv_sec = now.tv_sec;
-               start_time.tv_usec = now.tv_usec;
-               start_ofs = ofs;
-               if (am_server)
-                       return;
+       if (am_server)
+               return;
+
+#if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
+       if (pgrp == -1)
+               pgrp = getpgrp(GETPGRP_ARG);
+#endif
+
+       gettimeofday(&now, NULL);
+
+       if (!ph_start.time.tv_sec) {
+               int i;
+
+               /* Try to guess the real starting time when the sender started
+                * to send us data by using the time we last received some data
+                * in the last file (if it was recent enough). */
+               if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
+                       ph_start.time = ph_list[newest_hpos].time;
+                       ph_start.ofs = 0;
+               } else {
+                       ph_start.time.tv_sec = now.tv_sec;
+                       ph_start.time.tv_usec = now.tv_usec;
+                       ph_start.ofs = ofs;
+               }
+
+               for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
+                       ph_list[i] = ph_start;
        }
        else {
-               if (am_server)
+               if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
                        return;
-               gettimeofday(&now, NULL);
-       }
 
-       if (ofs > last_ofs + 1000 && msdiff(&print_time, &now) > 250) {
-               rprint_progress(ofs, size, &now, False);
-               last_ofs = ofs;
-               print_time.tv_sec = now.tv_sec;
-               print_time.tv_usec = now.tv_usec;
+               newest_hpos = oldest_hpos;
+               oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
+               ph_list[newest_hpos].time.tv_sec = now.tv_sec;
+               ph_list[newest_hpos].time.tv_usec = now.tv_usec;
+               ph_list[newest_hpos].ofs = ofs;
        }
+
+#if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
+       tc_pgrp = tcgetpgrp(STDOUT_FILENO);
+       if (tc_pgrp != pgrp && tc_pgrp != -1)
+               return;
+#endif
+
+       rprint_progress(ofs, size, &now, False);
 }