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-2009 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 as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
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.
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.
28 extern int need_unsorted_flist;
29 extern int output_needs_newline;
30 extern struct stats stats;
31 extern struct file_list *cur_flist;
33 #define PROGRESS_HISTORY_SECS 5
41 struct progress_history {
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;
51 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
53 return (t2->tv_sec - t1->tv_sec) * 1000L
54 + (t2->tv_usec - t1->tv_usec) / 1000;
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.)
65 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
68 char rembuf[64], eol[128];
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,
80 if (INFO_GTE(PROGRESS, 2)) {
81 static int last_len = 0;
82 /* Drop \n and pad with spaces if line got shorter. */
86 while (last_len > len)
87 eol[--last_len] = ' ';
90 /* Compute stats based on the starting info. */
91 if (!ph_start.time.tv_sec
92 || !(diff = msdiff(&ph_start.time, now)))
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;
98 strlcpy(eol, " ", sizeof eol);
99 /* Compute stats based on recent progress. */
100 if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
102 rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
104 remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
107 if (rate > 1024*1024) {
108 rate /= 1024.0 * 1024.0;
110 } else if (rate > 1024) {
118 strlcpy(rembuf, " ??:??:??", sizeof rembuf);
120 snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
121 (int) (remain / 3600.0),
122 (int) (remain / 60.0) % 60,
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);
131 output_needs_newline = 1;
136 void set_current_file_index(struct file_struct *file, int ndx)
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;
143 current_file_index = ndx;
144 current_file_index -= cur_flist->flist_num;
147 void end_progress(OFF_T size)
151 gettimeofday(&now, NULL);
152 if (INFO_GTE(PROGRESS, 2)) {
153 rprint_progress(stats.total_transferred_size,
154 stats.total_size, &now, True);
156 rprint_progress(size, size, &now, True);
157 memset(&ph_start, 0, sizeof ph_start);
162 void show_progress(OFF_T ofs, OFF_T size)
165 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
166 static pid_t pgrp = -1;
173 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
175 pgrp = getpgrp(GETPGRP_ARG);
178 gettimeofday(&now, NULL);
180 if (!ph_start.time.tv_sec) {
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;
190 ph_start.time.tv_sec = now.tv_sec;
191 ph_start.time.tv_usec = now.tv_usec;
195 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
196 ph_list[i] = ph_start;
199 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
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;
209 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
210 tc_pgrp = tcgetpgrp(STDOUT_FILENO);
211 if (tc_pgrp != pgrp && tc_pgrp != -1)
215 if (INFO_GTE(PROGRESS, 2)) {
216 rprint_progress(stats.total_transferred_size,
217 stats.total_size, &now, False);
219 rprint_progress(ofs, size, &now, False);