If rsync is put in the background, output fewer progress-report
[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 struct progress_history {
30         struct timeval time;
31         OFF_T ofs;
32 };
33
34 static struct progress_history ph_start;
35 static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
36 static int newest_hpos, oldest_hpos;
37
38 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
39 {
40         return (t2->tv_sec - t1->tv_sec) * 1000L
41              + (t2->tv_usec - t1->tv_usec) / 1000;
42 }
43
44
45 /**
46  * @param ofs Current position in file
47  * @param size Total size of file
48  * @param is_last True if this is the last time progress will be
49  * printed for this file, so we should output a newline.  (Not
50  * necessarily the same as all bytes being received.)
51  **/
52 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
53                             int is_last)
54 {
55         char eol[256];
56         const char *units;
57         int pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
58         unsigned long diff;
59         double rate, remain;
60         int remain_h, remain_m, remain_s;
61
62         if (is_last) {
63                 /* Compute stats based on the starting info. */
64                 diff = msdiff(&ph_start.time, now);
65                 if (!diff)
66                         diff = 1;
67                 rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
68                 /* Switch to total time taken for our last update. */
69                 remain = (double) diff / 1000.0;
70         } else {
71                 /* Compute stats based on recent progress. */
72                 diff = msdiff(&ph_list[oldest_hpos].time, now);
73                 rate = diff ? (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
74                     / diff / 1024.0 : 0;
75                 remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
76         }
77
78         if (rate > 1024*1024) {
79                 rate /= 1024.0 * 1024.0;
80                 units = "GB/s";
81         } else if (rate > 1024) {
82                 rate /= 1024.0;
83                 units = "MB/s";
84         } else {
85                 units = "kB/s";
86         }
87
88         remain_s = (int) remain % 60;
89         remain_m = (int) (remain / 60.0) % 60;
90         remain_h = (int) (remain / 3600.0);
91
92         if (is_last) {
93                 snprintf(eol, sizeof eol, "  (%d, %.1f%% of %d)\n",
94                         stats.num_transferred_files,
95                         (float)((stats.current_file_index+1) * 100)
96                                 / stats.num_files,
97                         stats.num_files);
98         } else
99                 strcpy(eol, "\r");
100         rprintf(FINFO, "%12.0f %3d%% %7.2f%s %4d:%02d:%02d%s",
101                 (double) ofs, pct, rate, units,
102                 remain_h, remain_m, remain_s, eol);
103 }
104
105 void end_progress(OFF_T size)
106 {
107         if (!am_server) {
108                 struct timeval now;
109                 gettimeofday(&now, NULL);
110                 rprint_progress(size, size, &now, True);
111         }
112         memset(&ph_start, 0, sizeof ph_start);
113 }
114
115 void show_progress(OFF_T ofs, OFF_T size)
116 {
117         struct timeval now;
118 #if HAVE_GETPGRP && HAVE_TCGETPGRP
119         static pid_t pgrp = -1;
120         pid_t tc_pgrp;
121 #endif
122
123         if (am_server)
124                 return;
125
126 #if HAVE_GETPGRP && HAVE_TCGETPGRP
127         if (pgrp == -1) {
128 # if GETPGRP_VOID
129                 pgrp = getpgrp();
130 # else
131                 pgrp = getpgrp(0);
132 # endif
133         }
134 #endif
135
136         gettimeofday(&now, NULL);
137
138         if (!ph_start.time.tv_sec) {
139                 int i;
140
141                 /* Try to guess the real starting time when the sender started
142                  * to send us data by using the time we last received some data
143                  * in the last file (if it was recent enough). */
144                 if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
145                         ph_start.time = ph_list[newest_hpos].time;
146                         ph_start.ofs = 0;
147                 } else {
148                         ph_start.time.tv_sec = now.tv_sec;
149                         ph_start.time.tv_usec = now.tv_usec;
150                         ph_start.ofs = ofs;
151                 }
152
153                 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
154                         ph_list[i] = ph_start;
155         }
156         else {
157                 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
158                         return;
159
160                 newest_hpos = oldest_hpos;
161                 oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
162                 ph_list[newest_hpos].time.tv_sec = now.tv_sec;
163                 ph_list[newest_hpos].time.tv_usec = now.tv_usec;
164                 ph_list[newest_hpos].ofs = ofs;
165         }
166
167 #if HAVE_GETPGRP && HAVE_TCGETPGRP
168         tc_pgrp = tcgetpgrp(STDOUT_FILENO);
169         if (tc_pgrp != pgrp && tc_pgrp != -1)
170                 return;
171 #endif
172
173         rprint_progress(ofs, size, &now, False);
174 }