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-2008 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.
26 extern int need_unsorted_flist;
27 extern struct stats stats;
28 extern struct file_list *cur_flist;
30 #define PROGRESS_HISTORY_SECS 5
38 struct progress_history {
43 int progress_is_active = 0;
45 static struct progress_history ph_start;
46 static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
47 static int newest_hpos, oldest_hpos;
48 static int current_file_index;
50 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
52 return (t2->tv_sec - t1->tv_sec) * 1000L
53 + (t2->tv_usec - t1->tv_usec) / 1000;
58 * @param ofs Current position in file
59 * @param size Total size of file
60 * @param is_last True if this is the last time progress will be
61 * printed for this file, so we should output a newline. (Not
62 * necessarily the same as all bytes being received.)
64 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
67 char rembuf[64], eol[128];
69 int pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
74 snprintf(eol, sizeof eol,
75 " (xfer#%d, to-check=%d/%d)\n",
76 stats.num_transferred_files,
77 stats.num_files - current_file_index - 1,
79 /* Compute stats based on the starting info. */
80 if (!ph_start.time.tv_sec
81 || !(diff = msdiff(&ph_start.time, now)))
83 rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
84 /* Switch to total time taken for our last update. */
85 remain = (double) diff / 1000.0;
87 strlcpy(eol, " ", sizeof eol);
88 /* Compute stats based on recent progress. */
89 if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
91 rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
93 remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
96 if (rate > 1024*1024) {
97 rate /= 1024.0 * 1024.0;
99 } else if (rate > 1024) {
107 strlcpy(rembuf, " ??:??:??", sizeof rembuf);
109 snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
110 (int) (remain / 3600.0),
111 (int) (remain / 60.0) % 60,
115 progress_is_active = 0;
116 rprintf(FCLIENT, "\r%12s %3d%% %7.2f%s %s%s",
117 human_num(ofs), pct, rate, units, rembuf, eol);
119 progress_is_active = 1;
124 void set_current_file_index(struct file_struct *file, int ndx)
126 if (need_unsorted_flist)
127 current_file_index = flist_find(cur_flist, file) + cur_flist->ndx_start;
129 current_file_index = ndx;
130 current_file_index -= cur_flist->flist_num;
133 void end_progress(OFF_T size)
137 gettimeofday(&now, NULL);
138 rprint_progress(size, size, &now, True);
140 memset(&ph_start, 0, sizeof ph_start);
143 void show_progress(OFF_T ofs, OFF_T size)
146 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
147 static pid_t pgrp = -1;
154 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
156 pgrp = getpgrp(GETPGRP_ARG);
159 gettimeofday(&now, NULL);
161 if (!ph_start.time.tv_sec) {
164 /* Try to guess the real starting time when the sender started
165 * to send us data by using the time we last received some data
166 * in the last file (if it was recent enough). */
167 if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
168 ph_start.time = ph_list[newest_hpos].time;
171 ph_start.time.tv_sec = now.tv_sec;
172 ph_start.time.tv_usec = now.tv_usec;
176 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
177 ph_list[i] = ph_start;
180 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
183 newest_hpos = oldest_hpos;
184 oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
185 ph_list[newest_hpos].time.tv_sec = now.tv_sec;
186 ph_list[newest_hpos].time.tv_usec = now.tv_usec;
187 ph_list[newest_hpos].ofs = ofs;
190 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
191 tc_pgrp = tcgetpgrp(STDOUT_FILENO);
192 if (tc_pgrp != pgrp && tc_pgrp != -1)
196 rprint_progress(ofs, size, &now, False);