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-2020 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 int stdout_format_has_i;
32 extern struct stats stats;
33 extern struct file_list *cur_flist;
35 BOOL want_progress_now = False;
37 #define PROGRESS_HISTORY_SECS 5
45 struct progress_history {
50 static struct progress_history ph_start;
51 static struct progress_history ph_list[PROGRESS_HISTORY_SECS];
52 static int newest_hpos, oldest_hpos;
53 static int current_file_index;
55 static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
57 return (t2->tv_sec - t1->tv_sec) * 1000L
58 + (t2->tv_usec - t1->tv_usec) / 1000;
63 * @param ofs Current position in file
64 * @param size Total size of file
65 * @param is_last True if this is the last time progress will be
66 * printed for this file, so we should output a newline. (Not
67 * necessarily the same as all bytes being received.)
69 static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now,
72 char rembuf[64], eol[128];
79 int len = snprintf(eol, sizeof eol,
80 " (xfr#%d, %s-chk=%d/%d)\n",
81 stats.xferred_files, flist_eof ? "to" : "ir",
82 stats.num_files - current_file_index - 1,
84 if (INFO_GTE(PROGRESS, 2)) {
85 static int last_len = 0;
86 /* Drop \n and pad with spaces if line got shorter. */
90 while (last_len > len)
91 eol[--last_len] = ' ';
94 /* Compute stats based on the starting info. */
95 if (!ph_start.time.tv_sec
96 || !(diff = msdiff(&ph_start.time, now)))
98 rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
99 /* Switch to total time taken for our last update. */
100 remain = (double) diff / 1000.0;
102 strlcpy(eol, " ", sizeof eol);
103 /* Compute stats based on recent progress. */
104 if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
106 rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0
108 remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
111 if (rate > 1024*1024) {
112 rate /= 1024.0 * 1024.0;
114 } else if (rate > 1024) {
122 strlcpy(rembuf, " ??:??:??", sizeof rembuf);
124 snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
125 (int) (remain / 3600.0),
126 (int) (remain / 60.0) % 60,
130 output_needs_newline = 0;
131 pct = ofs == size ? 100 : (int) (100.0 * ofs / size);
132 rprintf(FCLIENT, "\r%15s %3d%% %7.2f%s %s%s",
133 human_num(ofs), pct, rate, units, rembuf, eol);
134 if (!is_last && !quiet) {
135 output_needs_newline = 1;
140 void progress_init(void)
142 if (!am_server && !INFO_GTE(PROGRESS, 1)) {
144 gettimeofday(&now, NULL);
145 ph_start.time.tv_sec = now.tv_sec;
146 ph_start.time.tv_usec = now.tv_usec;
150 void set_current_file_index(struct file_struct *file, int ndx)
153 current_file_index = cur_flist->used + cur_flist->ndx_start - 1;
154 else if (need_unsorted_flist)
155 current_file_index = flist_find(cur_flist, file) + cur_flist->ndx_start;
157 current_file_index = ndx;
158 current_file_index -= cur_flist->flist_num;
161 void instant_progress(const char *fname)
163 /* We only get here if want_progress_now is True */
164 if (!stdout_format_has_i && !INFO_GTE(NAME, 1))
165 rprintf(FINFO, "%s\n", fname);
167 want_progress_now = False;
170 void end_progress(OFF_T size)
174 gettimeofday(&now, NULL);
175 if (INFO_GTE(PROGRESS, 2) || want_progress_now) {
176 rprint_progress(stats.total_transferred_size,
177 stats.total_size, &now, True);
179 rprint_progress(size, size, &now, True);
180 memset(&ph_start, 0, sizeof ph_start);
185 void show_progress(OFF_T ofs, OFF_T size)
188 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
189 static pid_t pgrp = -1;
196 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
198 pgrp = getpgrp(GETPGRP_ARG);
201 gettimeofday(&now, NULL);
203 if (INFO_GTE(PROGRESS, 2)) {
204 ofs = stats.total_transferred_size - size + ofs;
205 size = stats.total_size;
208 if (!ph_start.time.tv_sec) {
211 /* Try to guess the real starting time when the sender started
212 * to send us data by using the time we last received some data
213 * in the last file (if it was recent enough). */
214 if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
215 ph_start.time = ph_list[newest_hpos].time;
218 ph_start.time.tv_sec = now.tv_sec;
219 ph_start.time.tv_usec = now.tv_usec;
223 for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
224 ph_list[i] = ph_start;
227 if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
230 newest_hpos = oldest_hpos;
231 oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
232 ph_list[newest_hpos].time.tv_sec = now.tv_sec;
233 ph_list[newest_hpos].time.tv_usec = now.tv_usec;
234 ph_list[newest_hpos].ofs = ofs;
237 #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
238 tc_pgrp = tcgetpgrp(STDOUT_FILENO);
239 if (tc_pgrp != pgrp && tc_pgrp != -1)
243 rprint_progress(ofs, size, &now, False);