Fixed the elapsed time reported for 0-length files.
[rsync.git] / progress.c
1 /*  -*- c-file-style: "linux" -*-
2  *
3  * Copyright (C) 1996-2000 by Andrew Tridgell
4  * Copyright (C) Paul Mackerras 1996
5  * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 #include "rsync.h"
23
24 extern struct stats stats;
25 extern int am_server;
26
27 #define PROGRESS_HISTORY_SECS 5
28
29 #ifdef GETPGRP_VOID
30 #define GETPGRP_ARG
31 #else
32 #define GETPGRP_ARG 0
33 #endif
34
35 struct progress_history {
36         struct timeval time;
37         OFF_T ofs;
38 };
39
40 static struct progress_history ph_start;
41 static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
42 static int newest_hpos, oldest_hpos;
43
44 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
45 {
46         return (t2->tv_sec - t1->tv_sec) * 1000L
47              + (t2->tv_usec - t1->tv_usec) / 1000;
48 }
49
50
51 /**
52  * @param ofs Current position in file
53  * @param size Total size of file
54  * @param is_last True if this is the last time progress will be
55  * printed for this file, so we should output a newline.  (Not
56  * necessarily the same as all bytes being received.)
57  **/
58 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
59                             int is_last)
60 {
61         char eol[256];
62         const char *units;
63         int pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
64         unsigned long diff;
65         double rate, remain;
66         int remain_h, remain_m, remain_s;
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         remain_s = (int) remain % 60;
96         remain_m = (int) (remain / 60.0) % 60;
97         remain_h = (int) (remain / 3600.0);
98
99         if (is_last) {
100                 snprintf(eol, sizeof eol, "  (%d, %.1f%% of %d)\n",
101                         stats.num_transferred_files,
102                         (float)((stats.current_file_index+1) * 100)
103                                 / stats.num_files,
104                         stats.num_files);
105         } else
106                 strcpy(eol, "\r");
107         rprintf(FINFO, "%12.0f %3d%% %7.2f%s %4d:%02d:%02d%s",
108                 (double) ofs, pct, rate, units,
109                 remain_h, remain_m, remain_s, eol);
110 }
111
112 void end_progress(OFF_T size)
113 {
114         if (!am_server) {
115                 struct timeval now;
116                 gettimeofday(&now, NULL);
117                 rprint_progress(size, size, &now, True);
118         }
119         memset(&ph_start, 0, sizeof ph_start);
120 }
121
122 void show_progress(OFF_T ofs, OFF_T size)
123 {
124         struct timeval now;
125 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
126         static pid_t pgrp = -1;
127         pid_t tc_pgrp;
128 #endif
129
130         if (am_server)
131                 return;
132
133 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
134         if (pgrp == -1)
135                 pgrp = getpgrp(GETPGRP_ARG);
136 #endif
137
138         gettimeofday(&now, NULL);
139
140         if (!ph_start.time.tv_sec) {
141                 int i;
142
143                 /* Try to guess the real starting time when the sender started
144                  * to send us data by using the time we last received some data
145                  * in the last file (if it was recent enough). */
146                 if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
147                         ph_start.time = ph_list[newest_hpos].time;
148                         ph_start.ofs = 0;
149                 } else {
150                         ph_start.time.tv_sec = now.tv_sec;
151                         ph_start.time.tv_usec = now.tv_usec;
152                         ph_start.ofs = ofs;
153                 }
154
155                 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
156                         ph_list[i] = ph_start;
157         }
158         else {
159                 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
160                         return;
161
162                 newest_hpos = oldest_hpos;
163                 oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
164                 ph_list[newest_hpos].time.tv_sec = now.tv_sec;
165                 ph_list[newest_hpos].time.tv_usec = now.tv_usec;
166                 ph_list[newest_hpos].ofs = ofs;
167         }
168
169 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
170         tc_pgrp = tcgetpgrp(STDOUT_FILENO);
171         if (tc_pgrp != pgrp && tc_pgrp != -1)
172                 return;
173 #endif
174
175         rprint_progress(ofs, size, &now, False);
176 }