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-2015 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.
29 extern int need_unsorted_flist;
30 extern int output_needs_newline;
31 extern struct stats stats;
32 extern struct file_list *cur_flist;
34 #define PROGRESS_HISTORY_SECS 5
42 struct progress_history {
47 static struct progress_history ph_start;
48 static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
49 static int newest_hpos, oldest_hpos;
50 static int current_file_index;
52 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
54 return (t2->tv_sec - t1->tv_sec) * 1000L
55 + (t2->tv_usec - t1->tv_usec) / 1000;
60 * @param ofs Current position in file
61 * @param size Total size of file
62 * @param is_last True if this is the last time progress will be
63 * printed for this file, so we should output a newline. (Not
64 * necessarily the same as all bytes being received.)
66 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
69 char rembuf[64], eol[128];
76 int len = snprintf(eol, sizeof eol,
77 " (xfr#%d, %s-chk=%d/%d)\n",
78 stats.xferred_files, flist_eof ? "to" : "ir",
79 stats.num_files - current_file_index - 1,
81 if (INFO_GTE(PROGRESS, 2)) {
82 static int last_len = 0;
83 /* Drop \n and pad with spaces if line got shorter. */
87 while (last_len > len)
88 eol[--last_len] = ' ';
91 /* Compute stats based on the starting info. */
92 if (!ph_start.time.tv_sec
93 || !(diff = msdiff(&ph_start.time, now)))
95 rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
96 /* Switch to total time taken for our last update. */
97 remain = (double) diff / 1000.0;
99 strlcpy(eol, " ", sizeof eol);
100 /* Compute stats based on recent progress. */
101 if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
103 rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
105 remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
108 if (rate > 1024*1024) {
109 rate /= 1024.0 * 1024.0;
111 } else if (rate > 1024) {
119 strlcpy(rembuf, " ??:??:??", sizeof rembuf);
121 snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
122 (int) (remain / 3600.0),
123 (int) (remain / 60.0) % 60,
127 output_needs_newline = 0;
128 pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
129 rprintf(FCLIENT, "\r%15s %3d%% %7.2f%s %s%s",
130 human_num(ofs), pct, rate, units, rembuf, eol);
131 if (!is_last && !quiet) {
132 output_needs_newline = 1;
137 void set_current_file_index(struct file_struct *file, int ndx)
140 current_file_index = cur_flist->used + cur_flist->ndx_start - 1;
141 else if (need_unsorted_flist)
142 current_file_index = flist_find(cur_flist, file) + cur_flist->ndx_start;
144 current_file_index = ndx;
145 current_file_index -= cur_flist->flist_num;
148 void end_progress(OFF_T size)
152 gettimeofday(&now, NULL);
153 if (INFO_GTE(PROGRESS, 2)) {
154 rprint_progress(stats.total_transferred_size,
155 stats.total_size, &now, True);
157 rprint_progress(size, size, &now, True);
158 memset(&ph_start, 0, sizeof ph_start);
163 void show_progress(OFF_T ofs, OFF_T size)
166 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
167 static pid_t pgrp = -1;
174 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
176 pgrp = getpgrp(GETPGRP_ARG);
179 gettimeofday(&now, NULL);
181 if (INFO_GTE(PROGRESS, 2)) {
182 ofs = stats.total_transferred_size - size + ofs;
183 size = stats.total_size;
186 if (!ph_start.time.tv_sec) {
189 /* Try to guess the real starting time when the sender started
190 * to send us data by using the time we last received some data
191 * in the last file (if it was recent enough). */
192 if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
193 ph_start.time = ph_list[newest_hpos].time;
196 ph_start.time.tv_sec = now.tv_sec;
197 ph_start.time.tv_usec = now.tv_usec;
201 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
202 ph_list[i] = ph_start;
205 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
208 newest_hpos = oldest_hpos;
209 oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
210 ph_list[newest_hpos].time.tv_sec = now.tv_sec;
211 ph_list[newest_hpos].time.tv_usec = now.tv_usec;
212 ph_list[newest_hpos].ofs = ofs;
215 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
216 tc_pgrp = tcgetpgrp(STDOUT_FILENO);
217 if (tc_pgrp != pgrp && tc_pgrp != -1)
221 rprint_progress(ofs, size, &now, False);