X-Git-Url: http://sjero.net/git/?a=blobdiff_plain;f=src%2Fprogress.c;h=137794d6cb4c3047dc6933f210390b5f517cd154;hb=da084a2979d3de624e5ef1da51fd188cee0216c3;hp=a0689f152ab3676ed8bfc1e5a7620df905512f09;hpb=d403f7f83522ffdd7d1e267fba378c1ea4fce273;p=wget diff --git a/src/progress.c b/src/progress.c index a0689f15..137794d6 100644 --- a/src/progress.c +++ b/src/progress.c @@ -31,18 +31,12 @@ so, delete this exception statement from your version. */ #include #include -#ifdef HAVE_STRING_H -# include -#else -# include -#endif /* HAVE_STRING_H */ +#include #include #ifdef HAVE_UNISTD_H # include #endif -#ifdef HAVE_SIGNAL_H -# include -#endif +#include #include "wget.h" #include "progress.h" @@ -50,28 +44,29 @@ so, delete this exception statement from your version. */ #include "retr.h" struct progress_implementation { - char *name; - void *(*create) PARAMS ((long, long)); - void (*update) PARAMS ((void *, long, double)); - void (*finish) PARAMS ((void *, double)); - void (*set_params) PARAMS ((const char *)); + const char *name; + bool interactive; + void *(*create) (wgint, wgint); + void (*update) (void *, wgint, double); + void (*finish) (void *, double); + void (*set_params) (const char *); }; /* Necessary forward declarations. */ -static void *dot_create PARAMS ((long, long)); -static void dot_update PARAMS ((void *, long, double)); -static void dot_finish PARAMS ((void *, double)); -static void dot_set_params PARAMS ((const char *)); +static void *dot_create (wgint, wgint); +static void dot_update (void *, wgint, double); +static void dot_finish (void *, double); +static void dot_set_params (const char *); -static void *bar_create PARAMS ((long, long)); -static void bar_update PARAMS ((void *, long, double)); -static void bar_finish PARAMS ((void *, double)); -static void bar_set_params PARAMS ((const char *)); +static void *bar_create (wgint, wgint); +static void bar_update (void *, wgint, double); +static void bar_finish (void *, double); +static void bar_set_params (const char *); static struct progress_implementation implementations[] = { - { "dot", dot_create, dot_update, dot_finish, dot_set_params }, - { "bar", bar_create, bar_update, bar_finish, bar_set_params } + { "dot", 0, dot_create, dot_update, dot_finish, dot_set_params }, + { "bar", 1, bar_create, bar_update, bar_finish, bar_set_params } }; static struct progress_implementation *current_impl; static int current_impl_locked; @@ -89,21 +84,21 @@ static int current_impl_locked; #define FALLBACK_PROGRESS_IMPLEMENTATION "dot" -/* Return non-zero if NAME names a valid progress bar implementation. - The characters after the first : will be ignored. */ +/* Return true if NAME names a valid progress bar implementation. The + characters after the first : will be ignored. */ -int +bool valid_progress_implementation_p (const char *name) { - int i = 0; + int i; struct progress_implementation *pi = implementations; char *colon = strchr (name, ':'); int namelen = colon ? colon - name : strlen (name); for (i = 0; i < countof (implementations); i++, pi++) if (!strncmp (pi->name, name, namelen)) - return 1; - return 0; + return true; + return false; } /* Set the progress implementation to NAME. */ @@ -155,7 +150,7 @@ progress_schedule_redirect (void) advance. */ void * -progress_create (long initial, long total) +progress_create (wgint initial, wgint total) { /* Check if the log status has changed under our feet. */ if (output_redirected) @@ -168,11 +163,22 @@ progress_create (long initial, long total) return current_impl->create (initial, total); } +/* Return true if the progress gauge is "interactive", i.e. if it can + profit from being called regularly even in absence of data. The + progress bar is interactive because it regularly updates the ETA + and current update. */ + +bool +progress_interactive_p (void *progress) +{ + return current_impl->interactive; +} + /* Inform the progress gauge of newly received bytes. DLTIME is the time in milliseconds since the beginning of the download. */ void -progress_update (void *progress, long howmuch, double dltime) +progress_update (void *progress, wgint howmuch, double dltime) { current_impl->update (progress, howmuch, dltime); } @@ -189,9 +195,9 @@ progress_finish (void *progress, double dltime) /* Dot-printing. */ struct dot_progress { - long initial_length; /* how many bytes have been downloaded + wgint initial_length; /* how many bytes have been downloaded previously. */ - long total_length; /* expected total byte count when the + wgint total_length; /* expected total byte count when the download finishes */ int accumulated; @@ -204,22 +210,19 @@ struct dot_progress { /* Dot-progress backend for progress_create. */ static void * -dot_create (long initial, long total) +dot_create (wgint initial, wgint total) { - struct dot_progress *dp = xmalloc (sizeof (struct dot_progress)); - - memset (dp, 0, sizeof (*dp)); - + struct dot_progress *dp = xnew0 (struct dot_progress); dp->initial_length = initial; dp->total_length = total; if (dp->initial_length) { int dot_bytes = opt.dot_bytes; - long row_bytes = opt.dot_bytes * opt.dots_in_line; + wgint row_bytes = opt.dot_bytes * opt.dots_in_line; int remainder = (int) (dp->initial_length % row_bytes); - long skipped = dp->initial_length - remainder; + wgint skipped = dp->initial_length - remainder; if (skipped) { @@ -235,7 +238,7 @@ dot_create (long initial, long total) 2 + skipped_k_len, "", skipped_k); } - logprintf (LOG_VERBOSE, "\n%5ldK", skipped / 1024); + logprintf (LOG_VERBOSE, "\n%5ldK", (long) (skipped / 1024)); for (; remainder >= dot_bytes; remainder -= dot_bytes) { if (dp->dots % opt.dot_spacing == 0) @@ -253,14 +256,14 @@ dot_create (long initial, long total) } static void -print_percentage (long bytes, long expected) +print_percentage (wgint bytes, wgint expected) { int percentage = (int)(100.0 * bytes / expected); logprintf (LOG_VERBOSE, "%3d%%", percentage); } static void -print_download_speed (struct dot_progress *dp, long bytes, double dltime) +print_download_speed (struct dot_progress *dp, wgint bytes, double dltime) { logprintf (LOG_VERBOSE, " %s", retr_rate (bytes, dltime - dp->last_timer_value, 1)); @@ -270,19 +273,19 @@ print_download_speed (struct dot_progress *dp, long bytes, double dltime) /* Dot-progress backend for progress_update. */ static void -dot_update (void *progress, long howmuch, double dltime) +dot_update (void *progress, wgint howmuch, double dltime) { struct dot_progress *dp = progress; int dot_bytes = opt.dot_bytes; - long row_bytes = opt.dot_bytes * opt.dots_in_line; + wgint row_bytes = opt.dot_bytes * opt.dots_in_line; - log_set_flush (0); + log_set_flush (false); dp->accumulated += howmuch; for (; dp->accumulated >= dot_bytes; dp->accumulated -= dot_bytes) { if (dp->dots == 0) - logprintf (LOG_VERBOSE, "\n%5ldK", dp->rows * row_bytes / 1024); + logprintf (LOG_VERBOSE, "\n%5ldK", (long) (dp->rows * row_bytes / 1024)); if (dp->dots % opt.dot_spacing == 0) logputs (LOG_VERBOSE, " "); @@ -291,7 +294,7 @@ dot_update (void *progress, long howmuch, double dltime) ++dp->dots; if (dp->dots >= opt.dots_in_line) { - long row_qty = row_bytes; + wgint row_qty = row_bytes; if (dp->rows == dp->initial_length / row_bytes) row_qty -= dp->initial_length % row_bytes; @@ -304,7 +307,7 @@ dot_update (void *progress, long howmuch, double dltime) } } - log_set_flush (1); + log_set_flush (true); } /* Dot-progress backend for progress_finish. */ @@ -314,13 +317,13 @@ dot_finish (void *progress, double dltime) { struct dot_progress *dp = progress; int dot_bytes = opt.dot_bytes; - long row_bytes = opt.dot_bytes * opt.dots_in_line; + wgint row_bytes = opt.dot_bytes * opt.dots_in_line; int i; - log_set_flush (0); + log_set_flush (false); if (dp->dots == 0) - logprintf (LOG_VERBOSE, "\n%5ldK", dp->rows * row_bytes / 1024); + logprintf (LOG_VERBOSE, "\n%5ldK", (long) (dp->rows * row_bytes / 1024)); for (i = dp->dots; i < opt.dots_in_line; i++) { if (i % opt.dot_spacing == 0) @@ -336,14 +339,14 @@ dot_finish (void *progress, double dltime) } { - long row_qty = dp->dots * dot_bytes + dp->accumulated; + wgint row_qty = dp->dots * dot_bytes + dp->accumulated; if (dp->rows == dp->initial_length / row_bytes) row_qty -= dp->initial_length % row_bytes; print_download_speed (dp, row_qty, dltime); } logputs (LOG_VERBOSE, "\n\n"); - log_set_flush (0); + log_set_flush (false); xfree (dp); } @@ -411,7 +414,13 @@ dot_set_params (const char *params) create_image will overflow the buffer. */ #define MINIMUM_SCREEN_WIDTH 45 -static int screen_width = DEFAULT_SCREEN_WIDTH; +/* The last known screen width. This can be updated by the code that + detects that SIGWINCH was received (but it's never updated from the + signal handler). */ +static int screen_width; + +/* A flag that, when set, means SIGWINCH was received. */ +static volatile sig_atomic_t received_sigwinch; /* Size of the download speed history ring. */ #define DLSPEED_HISTORY_SIZE 20 @@ -422,12 +431,17 @@ static int screen_width = DEFAULT_SCREEN_WIDTH; past. */ #define DLSPEED_SAMPLE_MIN 150 +/* The time after which the download starts to be considered + "stalled", i.e. the current bandwidth is not printed and the recent + download speeds are scratched. */ +#define STALL_START_TIME 5000 + struct bar_progress { - long initial_length; /* how many bytes have been downloaded + wgint initial_length; /* how many bytes have been downloaded previously. */ - long total_length; /* expected total byte count when the + wgint total_length; /* expected total byte count when the download finishes */ - long count; /* bytes downloaded so far */ + wgint count; /* bytes downloaded so far */ double last_screen_update; /* time of the last screen update, measured since the beginning of @@ -450,36 +464,38 @@ struct bar_progress { details. */ struct bar_progress_hist { int pos; - long times[DLSPEED_HISTORY_SIZE]; - long bytes[DLSPEED_HISTORY_SIZE]; + wgint times[DLSPEED_HISTORY_SIZE]; + wgint bytes[DLSPEED_HISTORY_SIZE]; /* The sum of times and bytes respectively, maintained for efficiency. */ - long total_time; - long total_bytes; + wgint total_time; + wgint total_bytes; } hist; double recent_start; /* timestamp of beginning of current position. */ - long recent_bytes; /* bytes downloaded so far. */ + wgint recent_bytes; /* bytes downloaded so far. */ + + bool stalled; /* set when no data arrives for longer + than STALL_START_TIME, then reset + when new data arrives. */ /* create_image() uses these to make sure that ETA information - doesn't flash. */ + doesn't flicker. */ double last_eta_time; /* time of the last update to download speed and ETA, measured since the beginning of download. */ - long last_eta_value; + int last_eta_value; }; -static void create_image PARAMS ((struct bar_progress *, double)); -static void display_image PARAMS ((char *)); +static void create_image (struct bar_progress *, double); +static void display_image (char *); static void * -bar_create (long initial, long total) +bar_create (wgint initial, wgint total) { - struct bar_progress *bp = xmalloc (sizeof (struct bar_progress)); - - memset (bp, 0, sizeof (*bp)); + struct bar_progress *bp = xnew0 (struct bar_progress); /* In theory, our callers should take care of this pathological case, but it can sometimes happen. */ @@ -489,6 +505,18 @@ bar_create (long initial, long total) bp->initial_length = initial; bp->total_length = total; + /* Initialize screen_width if this hasn't been done or if it might + have changed, as indicated by receiving SIGWINCH. */ + if (!screen_width || received_sigwinch) + { + screen_width = determine_screen_width (); + if (!screen_width) + screen_width = DEFAULT_SCREEN_WIDTH; + else if (screen_width < MINIMUM_SCREEN_WIDTH) + screen_width = MINIMUM_SCREEN_WIDTH; + received_sigwinch = 0; + } + /* - 1 because we don't want to use the last screen column. */ bp->width = screen_width - 1; /* + 1 for the terminating zero. */ @@ -502,13 +530,13 @@ bar_create (long initial, long total) return bp; } -static void update_speed_ring PARAMS ((struct bar_progress *, long, double)); +static void update_speed_ring (struct bar_progress *, wgint, double); static void -bar_update (void *progress, long howmuch, double dltime) +bar_update (void *progress, wgint howmuch, double dltime) { struct bar_progress *bp = progress; - int force_screen_update = 0; + bool force_screen_update = false; bp->count += howmuch; if (bp->total_length > 0 @@ -522,11 +550,23 @@ bar_update (void *progress, long howmuch, double dltime) update_speed_ring (bp, howmuch, dltime); - if (screen_width - 1 != bp->width) + /* If SIGWINCH (the window size change signal) been received, + determine the new screen size and update the screen. */ + if (received_sigwinch) { - bp->width = screen_width - 1; - bp->buffer = xrealloc (bp->buffer, bp->width + 1); - force_screen_update = 1; + int old_width = screen_width; + screen_width = determine_screen_width (); + if (!screen_width) + screen_width = DEFAULT_SCREEN_WIDTH; + else if (screen_width < MINIMUM_SCREEN_WIDTH) + screen_width = MINIMUM_SCREEN_WIDTH; + if (screen_width != old_width) + { + bp->width = screen_width - 1; + bp->buffer = xrealloc (bp->buffer, bp->width + 1); + force_screen_update = true; + } + received_sigwinch = 0; } if (dltime - bp->last_screen_update < 200 && !force_screen_update) @@ -576,7 +616,7 @@ bar_finish (void *progress, double dltime) 3-second average would be too erratic. */ static void -update_speed_ring (struct bar_progress *bp, long howmuch, double dltime) +update_speed_ring (struct bar_progress *bp, wgint howmuch, double dltime) { struct bar_progress_hist *hist = &bp->hist; double recent_age = dltime - bp->recent_start; @@ -590,6 +630,38 @@ update_speed_ring (struct bar_progress *bp, long howmuch, double dltime) if (recent_age < DLSPEED_SAMPLE_MIN) return; + if (howmuch == 0) + { + /* If we're not downloading anything, we might be stalling, + i.e. not downloading anything for an extended period of time. + Since 0-reads do not enter the history ring, recent_age + effectively measures the time since last read. */ + if (recent_age >= STALL_START_TIME) + { + /* If we're stalling, reset the ring contents because it's + stale and because it will make bar_update stop printing + the (bogus) current bandwidth. */ + bp->stalled = true; + xzero (*hist); + bp->recent_bytes = 0; + } + return; + } + + /* We now have a non-zero amount of to store to the speed ring. */ + + /* If the stall status was acquired, reset it. */ + if (bp->stalled) + { + bp->stalled = false; + /* "recent_age" includes the the entired stalled period, which + could be very long. Don't update the speed ring with that + value because the current bandwidth would start too small. + Start with an arbitrary (but more reasonable) time value and + let it level out. */ + recent_age = 1000; + } + /* Store "recent" bytes and download time to history ring at the position POS. */ @@ -628,6 +700,8 @@ update_speed_ring (struct bar_progress *bp, long howmuch, double dltime) #endif } +static const char *eta_to_human (int); + #define APPEND_LITERAL(s) do { \ memcpy (p, s, sizeof (s) - 1); \ p += sizeof (s) - 1; \ @@ -641,15 +715,15 @@ static void create_image (struct bar_progress *bp, double dl_total_time) { char *p = bp->buffer; - long size = bp->initial_length + bp->count; + wgint size = bp->initial_length + bp->count; - char *size_legible = legible (size); + char *size_legible = with_thousand_seps (size); int size_legible_len = strlen (size_legible); struct bar_progress_hist *hist = &bp->hist; /* The progress bar should look like this: - xx% [=======> ] nn,nnn 12.34K/s ETA 00:00 + xx% [=======> ] nn,nnn 12.34K/s eta 36m 51s Calculate the geometry. The idea is to assign as much room as possible to the progress bar. The other idea is to never let @@ -662,7 +736,7 @@ create_image (struct bar_progress *bp, double dl_total_time) "[]" - progress bar decorations - 2 chars " nnn,nnn,nnn" - downloaded bytes - 12 chars or very rarely more " 1012.56K/s" - dl rate - 11 chars - " ETA xx:xx:xx" - ETA - 13 chars + " eta 36m 51s" - ETA - 13 chars "=====>..." - progress bar - the rest */ @@ -676,7 +750,6 @@ create_image (struct bar_progress *bp, double dl_total_time) if (bp->total_length > 0) { int percentage = (int)(100.0 * size / bp->total_length); - assert (percentage <= 100); if (percentage < 100) @@ -688,7 +761,7 @@ create_image (struct bar_progress *bp, double dl_total_time) else APPEND_LITERAL (" "); - /* The progress bar: "[====> ]" or "[--==> ]". */ + /* The progress bar: "[====> ]" or "[++==> ]". */ if (progress_size && bp->total_length > 0) { /* Size of the initial portion. */ @@ -706,10 +779,10 @@ create_image (struct bar_progress *bp, double dl_total_time) *p++ = '['; begin = p; - /* Print the initial portion of the download with '-' chars, the + /* Print the initial portion of the download with '+' chars, the rest with '=' and one '>'. */ for (i = 0; i < insz; i++) - *p++ = '-'; + *p++ = '+'; dlsz -= insz; if (dlsz > 0) { @@ -750,17 +823,17 @@ create_image (struct bar_progress *bp, double dl_total_time) } /* " 234,567,890" */ - sprintf (p, " %-11s", legible (size)); + sprintf (p, " %-11s", with_thousand_seps (size)); p += strlen (p); /* " 1012.45K/s" */ if (hist->total_time && hist->total_bytes) { - static char *short_units[] = { "B/s", "K/s", "M/s", "G/s" }; + static const char *short_units[] = { "B/s", "K/s", "M/s", "G/s" }; int units = 0; /* Calculate the download speed using the history ring and recent data that hasn't made it to the ring yet. */ - long dlquant = hist->total_bytes + bp->recent_bytes; + wgint dlquant = hist->total_bytes + bp->recent_bytes; double dltime = hist->total_time + (dl_total_time - bp->recent_start); double dlspeed = calc_rate (dlquant, dltime, &units); sprintf (p, " %7.2f%s", dlspeed, short_units[units]); @@ -769,19 +842,19 @@ create_image (struct bar_progress *bp, double dl_total_time) else APPEND_LITERAL (" --.--K/s"); - /* " ETA xx:xx:xx"; wait for three seconds before displaying the ETA. + /* " ETA ..m ..s"; wait for three seconds before displaying the ETA. That's because the ETA value needs a while to become reliable. */ - if (bp->total_length > 0 && dl_total_time > 3000) + if (bp->total_length > 0 && bp->count > 0 && dl_total_time > 3000) { - long eta; - int eta_hrs, eta_min, eta_sec; + int eta; /* Don't change the value of ETA more than approximately once per second; doing so would cause flashing without providing any value to the user. */ - if (dl_total_time - bp->last_eta_time < 900 - && bp->last_eta_value != 0) + if (bp->total_length != size + && bp->last_eta_value != 0 + && dl_total_time - bp->last_eta_time < 900) eta = bp->last_eta_value; else { @@ -791,38 +864,18 @@ create_image (struct bar_progress *bp, double dl_total_time) hist->total_time and bp->count with hist->total_bytes. I found that doing that results in a very jerky and ultimately unreliable ETA. */ - double time_sofar = (double)dl_total_time / 1000; - long bytes_remaining = bp->total_length - size; - eta = (long) (time_sofar * bytes_remaining / bp->count); + double time_sofar = (double) dl_total_time / 1000; + wgint bytes_remaining = bp->total_length - size; + eta = (int) (time_sofar * bytes_remaining / bp->count + 0.5); bp->last_eta_value = eta; bp->last_eta_time = dl_total_time; } - eta_hrs = eta / 3600, eta %= 3600; - eta_min = eta / 60, eta %= 60; - eta_sec = eta; - - if (eta_hrs > 99) - goto no_eta; - - if (eta_hrs == 0) - { - /* Hours not printed: pad with three spaces. */ - APPEND_LITERAL (" "); - sprintf (p, " ETA %02d:%02d", eta_min, eta_sec); - } - else - { - if (eta_hrs < 10) - /* Hours printed with one digit: pad with one space. */ - *p++ = ' '; - sprintf (p, " ETA %d:%02d:%02d", eta_hrs, eta_min, eta_sec); - } + sprintf (p, " eta %s", eta_to_human (eta)); p += strlen (p); } else if (bp->total_length > 0) { - no_eta: APPEND_LITERAL (" "); } @@ -839,7 +892,7 @@ create_image (struct bar_progress *bp, double dl_total_time) static void display_image (char *buf) { - int old = log_set_save_context (0); + bool old = log_set_save_context (false); logputs (LOG_VERBOSE, "\r"); logputs (LOG_VERBOSE, buf); log_set_save_context (old); @@ -848,7 +901,6 @@ display_image (char *buf) static void bar_set_params (const char *params) { - int sw; char *term = getenv ("TERM"); if (params @@ -861,8 +913,6 @@ bar_set_params (const char *params) TTY -- when logging to file, it is better to review the dots. */ || !isatty (fileno (stderr)) -#else - 1 #endif /* Normally we don't depend on terminal type because the progress bar only uses ^M to move the cursor to the @@ -881,19 +931,44 @@ bar_set_params (const char *params) set_progress_implementation (FALLBACK_PROGRESS_IMPLEMENTATION); return; } - - sw = determine_screen_width (); - if (sw && sw >= MINIMUM_SCREEN_WIDTH) - screen_width = sw; } #ifdef SIGWINCH -RETSIGTYPE +void progress_handle_sigwinch (int sig) { - int sw = determine_screen_width (); - if (sw && sw >= MINIMUM_SCREEN_WIDTH) - screen_width = sw; + received_sigwinch = 1; signal (SIGWINCH, progress_handle_sigwinch); } #endif + +/* Provide a human-readable rendition of the ETA. It never occupies + more than 7 characters of screen space. */ + +static const char * +eta_to_human (int secs) +{ + static char buf[10]; /* 8 is enough, but just in case */ + static int last = -1; + + /* Trivial optimization. This function can be called every 200 + msecs (see bar_update) for fast downloads, but ETA will only + change once per 900 msecs (see create_image). */ + if (secs == last) + return buf; + last = secs; + + if (secs < 100) + sprintf (buf, "%ds", secs); + else if (secs < 100 * 60) + sprintf (buf, "%dm %ds", secs / 60, secs % 60); + else if (secs < 100 * 3600) + sprintf (buf, "%dh %dm", secs / 3600, (secs / 60) % 60); + else if (secs < 100 * 86400) + sprintf (buf, "%dd %dh", secs / 86400, (secs / 3600) % 60); + else + /* (2^31-1)/86400 doesn't overflow BUF. */ + sprintf (buf, "%dd", secs / 86400); + + return buf; +}