2 * Routines to output progress information during a file transfer.
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-2007 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
25 extern struct stats stats;
28 #define PROGRESS_HISTORY_SECS 5
36 struct progress_history {
41 static struct progress_history ph_start;
42 static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
43 static int newest_hpos, oldest_hpos;
45 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
47 return (t2->tv_sec - t1->tv_sec) * 1000L
48 + (t2->tv_usec - t1->tv_usec) / 1000;
53 * @param ofs Current position in file
54 * @param size Total size of file
55 * @param is_last True if this is the last time progress will be
56 * printed for this file, so we should output a newline. (Not
57 * necessarily the same as all bytes being received.)
59 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
64 int pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
67 int remain_h, remain_m, remain_s;
70 /* Compute stats based on the starting info. */
71 if (!ph_start.time.tv_sec
72 || !(diff = msdiff(&ph_start.time, now)))
74 rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
75 /* Switch to total time taken for our last update. */
76 remain = (double) diff / 1000.0;
78 /* Compute stats based on recent progress. */
79 if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
81 rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
83 remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
86 if (rate > 1024*1024) {
87 rate /= 1024.0 * 1024.0;
89 } else if (rate > 1024) {
96 remain_s = (int) remain % 60;
97 remain_m = (int) (remain / 60.0) % 60;
98 remain_h = (int) (remain / 3600.0);
101 snprintf(eol, sizeof eol, " (xfer#%d, to-check=%d/%d)\n",
102 stats.num_transferred_files,
103 stats.num_files - stats.current_file_index - 1,
106 strlcpy(eol, "\r", sizeof eol);
107 rprintf(FCLIENT, "%12s %3d%% %7.2f%s %4d:%02d:%02d%s",
108 human_num(ofs), pct, rate, units,
109 remain_h, remain_m, remain_s, eol);
112 void end_progress(OFF_T size)
116 gettimeofday(&now, NULL);
117 rprint_progress(size, size, &now, True);
119 memset(&ph_start, 0, sizeof ph_start);
122 void show_progress(OFF_T ofs, OFF_T size)
125 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
126 static pid_t pgrp = -1;
133 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
135 pgrp = getpgrp(GETPGRP_ARG);
138 gettimeofday(&now, NULL);
140 if (!ph_start.time.tv_sec) {
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;
150 ph_start.time.tv_sec = now.tv_sec;
151 ph_start.time.tv_usec = now.tv_usec;
155 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
156 ph_list[i] = ph_start;
159 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
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;
169 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
170 tc_pgrp = tcgetpgrp(STDOUT_FILENO);
171 if (tc_pgrp != pgrp && tc_pgrp != -1)
175 rprint_progress(ofs, size, &now, False);