File:  [ELWIX - Embedded LightWeight unIX -] / embedaddon / rsync / progress.c
Revision 1.1.1.4 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Wed Mar 17 00:32:36 2021 UTC (3 years, 3 months ago) by misho
Branches: rsync, MAIN
CVS tags: v3_2_3, HEAD
rsync 3.2.3

    1: /*
    2:  * Routines to output progress information during a file transfer.
    3:  *
    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
    8:  *
    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.
   13:  *
   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.
   18:  *
   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.
   21:  */
   22: 
   23: #include "rsync.h"
   24: #include "inums.h"
   25: 
   26: extern int am_server;
   27: extern int flist_eof;
   28: extern int quiet;
   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;
   34: 
   35: BOOL want_progress_now = False;
   36: 
   37: #define PROGRESS_HISTORY_SECS 5
   38: 
   39: #ifdef GETPGRP_VOID
   40: #define GETPGRP_ARG
   41: #else
   42: #define GETPGRP_ARG 0
   43: #endif
   44: 
   45: struct progress_history {
   46: 	struct timeval time;
   47: 	OFF_T ofs;
   48: };
   49: 
   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;
   54: 
   55: static unsigned long msdiff(struct timeval *t1, struct timeval *t2)
   56: {
   57: 	return (t2->tv_sec - t1->tv_sec) * 1000L
   58: 	     + (t2->tv_usec - t1->tv_usec) / 1000;
   59: }
   60: 
   61: 
   62: /**
   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.)
   68:  **/
   69: static void rprint_progress(OFF_T ofs, OFF_T size, struct timeval *now, int is_last)
   70: {
   71: 	char rembuf[64], eol[128];
   72: 	const char *units;
   73: 	unsigned long diff;
   74: 	double rate, remain;
   75: 	int pct;
   76: 
   77: 	if (is_last) {
   78: 		int len = snprintf(eol, sizeof eol,
   79: 			" (xfr#%d, %s-chk=%d/%d)\n",
   80: 			stats.xferred_files, flist_eof ? "to" : "ir",
   81: 			stats.num_files - current_file_index - 1,
   82: 			stats.num_files);
   83: 		if (INFO_GTE(PROGRESS, 2)) {
   84: 			static int last_len = 0;
   85: 			/* Drop \n and pad with spaces if line got shorter. */
   86: 			if (last_len < --len)
   87: 				last_len = len;
   88: 			eol[last_len] = '\0';
   89: 			while (last_len > len)
   90: 				eol[--last_len] = ' ';
   91: 			is_last = 0;
   92: 		}
   93: 		/* Compute stats based on the starting info. */
   94: 		if (!ph_start.time.tv_sec || !(diff = msdiff(&ph_start.time, now)))
   95: 			diff = 1;
   96: 		rate = (double) (ofs - ph_start.ofs) * 1000.0 / diff / 1024.0;
   97: 		/* Switch to total time taken for our last update. */
   98: 		remain = (double) diff / 1000.0;
   99: 	} else {
  100: 		strlcpy(eol, "  ", sizeof eol);
  101: 		/* Compute stats based on recent progress. */
  102: 		if (!(diff = msdiff(&ph_list[oldest_hpos].time, now)))
  103: 			diff = 1;
  104: 		rate = (double) (ofs - ph_list[oldest_hpos].ofs) * 1000.0 / diff / 1024.0;
  105: 		remain = rate ? (double) (size - ofs) / rate / 1000.0 : 0.0;
  106: 	}
  107: 
  108: 	if (rate > 1024*1024) {
  109: 		rate /= 1024.0 * 1024.0;
  110: 		units = "GB/s";
  111: 	} else if (rate > 1024) {
  112: 		rate /= 1024.0;
  113: 		units = "MB/s";
  114: 	} else {
  115: 		units = "kB/s";
  116: 	}
  117: 
  118: 	if (remain < 0)
  119: 		strlcpy(rembuf, "  ??:??:??", sizeof rembuf);
  120: 	else {
  121: 		snprintf(rembuf, sizeof rembuf, "%4d:%02d:%02d",
  122: 			 (int) (remain / 3600.0),
  123: 			 (int) (remain / 60.0) % 60,
  124: 			 (int) remain % 60);
  125: 	}
  126: 
  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;
  133: 		rflush(FCLIENT);
  134: 	}
  135: }
  136: 
  137: void progress_init(void)
  138: {
  139: 	if (!am_server && !INFO_GTE(PROGRESS, 1)) {
  140: 		struct timeval now;
  141: 		gettimeofday(&now, NULL);
  142: 		ph_start.time.tv_sec = now.tv_sec;
  143: 		ph_start.time.tv_usec = now.tv_usec;
  144: 	}
  145: }
  146: 
  147: void set_current_file_index(struct file_struct *file, int ndx)
  148: {
  149: 	if (!file)
  150: 		current_file_index = cur_flist->used + cur_flist->ndx_start - 1;
  151: 	else if (need_unsorted_flist)
  152: 		current_file_index = flist_find(cur_flist, file) + cur_flist->ndx_start;
  153: 	else
  154: 		current_file_index = ndx;
  155: 	current_file_index -= cur_flist->flist_num;
  156: }
  157: 
  158: void instant_progress(const char *fname)
  159: {
  160: 	/* We only get here if want_progress_now is True */
  161: 	if (!stdout_format_has_i && !INFO_GTE(NAME, 1))
  162: 		rprintf(FINFO, "%s\n", fname);
  163: 	end_progress(0);
  164: 	want_progress_now = False;
  165: }
  166: 
  167: void end_progress(OFF_T size)
  168: {
  169: 	if (!am_server) {
  170: 		struct timeval now;
  171: 		gettimeofday(&now, NULL);
  172: 		if (INFO_GTE(PROGRESS, 2) || want_progress_now) {
  173: 			rprint_progress(stats.total_transferred_size,
  174: 					stats.total_size, &now, True);
  175: 		} else {
  176: 			rprint_progress(size, size, &now, True);
  177: 			memset(&ph_start, 0, sizeof ph_start);
  178: 		}
  179: 	}
  180: }
  181: 
  182: void show_progress(OFF_T ofs, OFF_T size)
  183: {
  184: 	struct timeval now;
  185: #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
  186: 	static pid_t pgrp = -1;
  187: 	pid_t tc_pgrp;
  188: #endif
  189: 
  190: 	if (am_server)
  191: 		return;
  192: 
  193: #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
  194: 	if (pgrp == -1)
  195: 		pgrp = getpgrp(GETPGRP_ARG);
  196: #endif
  197: 
  198: 	gettimeofday(&now, NULL);
  199: 
  200: 	if (INFO_GTE(PROGRESS, 2)) {
  201: 		ofs = stats.total_transferred_size - size + ofs;
  202: 		size = stats.total_size;
  203: 	}
  204: 
  205: 	if (!ph_start.time.tv_sec) {
  206: 		int i;
  207: 
  208: 		/* Try to guess the real starting time when the sender started
  209: 		 * to send us data by using the time we last received some data
  210: 		 * in the last file (if it was recent enough). */
  211: 		if (msdiff(&ph_list[newest_hpos].time, &now) <= 1500) {
  212: 			ph_start.time = ph_list[newest_hpos].time;
  213: 			ph_start.ofs = 0;
  214: 		} else {
  215: 			ph_start.time.tv_sec = now.tv_sec;
  216: 			ph_start.time.tv_usec = now.tv_usec;
  217: 			ph_start.ofs = ofs;
  218: 		}
  219: 
  220: 		for (i = 0; i < PROGRESS_HISTORY_SECS; i++)
  221: 			ph_list[i] = ph_start;
  222: 	}
  223: 	else {
  224: 		if (msdiff(&ph_list[newest_hpos].time, &now) < 1000)
  225: 			return;
  226: 
  227: 		newest_hpos = oldest_hpos;
  228: 		oldest_hpos = (oldest_hpos + 1) % PROGRESS_HISTORY_SECS;
  229: 		ph_list[newest_hpos].time.tv_sec = now.tv_sec;
  230: 		ph_list[newest_hpos].time.tv_usec = now.tv_usec;
  231: 		ph_list[newest_hpos].ofs = ofs;
  232: 	}
  233: 
  234: #if defined HAVE_GETPGRP && defined HAVE_TCGETPGRP
  235: 	tc_pgrp = tcgetpgrp(STDOUT_FILENO);
  236: 	if (tc_pgrp != pgrp && tc_pgrp != -1)
  237: 		return;
  238: #endif
  239: 
  240: 	rprint_progress(ofs, size, &now, False);
  241: }

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>