nologin: make it possible to build it as single applet
[oweals/busybox.git] / libbb / progress.c
index 372feb0c2423e155de181c66b031113065ff43c0..d071ce70511b47054be773bf917c1d867f11244d 100644 (file)
@@ -25,7 +25,7 @@
  *    may be used to endorse or promote products derived from this software
  *    without specific prior written permission.
  *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
@@ -45,13 +45,6 @@ enum {
        STALLTIME = 5
 };
 
-static unsigned int get_tty2_width(void)
-{
-       unsigned width;
-       get_terminal_width_height(2, &width, NULL);
-       return width;
-}
-
 void FAST_FUNC bb_progress_init(bb_progress_t *p, const char *curfile)
 {
 #if ENABLE_UNICODE_SUPPORT
@@ -64,6 +57,9 @@ void FAST_FUNC bb_progress_init(bb_progress_t *p, const char *curfile)
        p->last_update_sec = p->start_sec;
        p->last_change_sec = p->start_sec;
        p->last_size = 0;
+#if 0
+       p->last_eta = INT_MAX;
+#endif
 }
 
 /* File already had beg_size bytes.
@@ -73,15 +69,14 @@ void FAST_FUNC bb_progress_init(bb_progress_t *p, const char *curfile)
  * will be "totalsize" bytes.
  * If totalsize == 0, then it is unknown.
  */
-void FAST_FUNC bb_progress_update(bb_progress_t *p,
+int FAST_FUNC bb_progress_update(bb_progress_t *p,
                uoff_t beg_size,
                uoff_t transferred,
                uoff_t totalsize)
 {
-       uoff_t beg_and_transferred;
+       char numbuf5[6]; /* 5 + 1 for NUL */
        unsigned since_last_update, elapsed;
-       int barlength;
-       int kiloscale;
+       int notty;
 
        //transferred = 1234; /* use for stall detection testing */
        //totalsize = 0; /* use for unknown size download testing */
@@ -99,74 +94,72 @@ void FAST_FUNC bb_progress_update(bb_progress_t *p,
                 * Do not update on every call
                 * (we can be called on every network read!)
                 */
-               return;
+               return -1;
        }
 
-       kiloscale = 0;
+       /* Before we lose real, unscaled sizes, produce human-readable size string */
+       smart_ulltoa5(beg_size + transferred, numbuf5, " kMGTPEZY")[0] = '\0';
+
        /*
         * Scale sizes down if they are close to overflowing.
         * This allows calculations like (100 * transferred / totalsize)
         * without risking overflow: we guarantee 10 highest bits to be 0.
         * Introduced error is less than 1 / 2^12 ~= 0.025%
         */
-       if (ULONG_MAX > 0xffffffff || sizeof(off_t) == 4 || sizeof(off_t) != 8) {
-               /*
-                * 64-bit CPU || small off_t: in either case,
-                * >> is cheap, single-word operation.
-                * ... || strange off_t: also use this code
-                * (it is safe, just suboptimal wrt code size),
-                * because 32/64 optimized one works only for 64-bit off_t.
-                */
-               if (totalsize >= (1 << 22)) {
-                       totalsize >>= 10;
-                       beg_size >>= 10;
-                       transferred >>= 10;
-                       kiloscale = 1;
-               }
-       } else {
-               /* 32-bit CPU and 64-bit off_t.
-                * Use a 40-bit shift, it is easier to do on 32-bit CPU.
-                */
-/* ONE suppresses "warning: shift count >= width of type" */
-#define ONE (sizeof(off_t) > 4)
-               if (totalsize >= (uoff_t)(1ULL << 54*ONE)) {
-                       totalsize = (uint32_t)(totalsize >> 32*ONE) >> 8;
-                       beg_size = (uint32_t)(beg_size >> 32*ONE) >> 8;
-                       transferred = (uint32_t)(transferred >> 32*ONE) >> 8;
-                       kiloscale = 4;
-               }
+       while (totalsize >= (1 << 20)) {
+               totalsize >>= 8;
+               beg_size >>= 8;
+               transferred >>= 8;
        }
+       /* If they were huge, now they are scaled down to [1048575,4096] range.
+        * (N * totalsize) won't overflow 32 bits for N up to 4096.
+        */
+#if ULONG_MAX == 0xffffffff
+/* 32-bit CPU, uoff_t arithmetic is complex on it, cast variables to narrower types */
+# define totalsize   ((unsigned)totalsize)
+# define beg_size    ((unsigned)beg_size)
+# define transferred ((unsigned)transferred)
+#endif
+
+       notty = !isatty(STDERR_FILENO);
 
        if (ENABLE_UNICODE_SUPPORT)
-               fprintf(stderr, "\r%s", p->curfile);
+               fprintf(stderr, "\r%s " + notty, p->curfile);
        else
-               fprintf(stderr, "\r%-20.20s", p->curfile);
-
-       beg_and_transferred = beg_size + transferred;
+               fprintf(stderr, "\r%-20.20s " + notty, p->curfile);
 
        if (totalsize != 0) {
-               unsigned ratio = 100 * beg_and_transferred / totalsize;
-               fprintf(stderr, "%4u%%", ratio);
-
-               barlength = get_tty2_width() - 49;
-               if (barlength > 0) {
-                       /* god bless gcc for variable arrays :) */
-                       char buf[barlength + 1];
-                       unsigned stars = (unsigned)barlength * beg_and_transferred / totalsize;
-                       memset(buf, ' ', barlength);
-                       buf[barlength] = '\0';
-                       memset(buf, '*', stars);
-                       fprintf(stderr, " |%s|", buf);
+               int barlength;
+               unsigned beg_and_transferred; /* does not need uoff_t, see scaling code */
+               unsigned ratio;
+
+               beg_and_transferred = beg_size + transferred;
+               ratio = 100 * beg_and_transferred / totalsize;
+               /* can't overflow ^^^^^^^^^^^^^^^ */
+               fprintf(stderr, "%3u%% ", ratio);
+
+               barlength = get_terminal_width(2) - 48;
+               /*
+                * Must reject barlength <= 0 (terminal too narrow). While at it,
+                * also reject: 1-char bar (useless), 2-char bar (ridiculous).
+                */
+               if (barlength > 2) {
+                       if (barlength > 999)
+                               barlength = 999;
+                       {
+                               /* god bless gcc for variable arrays :) */
+                               char buf[barlength + 1];
+                               unsigned stars = (unsigned)barlength * beg_and_transferred / totalsize;
+                               /* can't overflow ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ */
+                               memset(buf, ' ', barlength);
+                               buf[barlength] = '\0';
+                               memset(buf, '*', stars);
+                               fprintf(stderr, "|%s| ", buf);
+                       }
                }
        }
 
-       while (beg_and_transferred >= 100000) {
-               beg_and_transferred >>= 10;
-               kiloscale++;
-       }
-       /* see http://en.wikipedia.org/wiki/Tera */
-       fprintf(stderr, "%6u%c", (unsigned)beg_and_transferred, " kMGTPEZY"[kiloscale]);
-#define beg_and_transferred dont_use_beg_and_transferred_below()
+       fputs(numbuf5, stderr); /* "NNNNk" */
 
        since_last_update = elapsed - p->last_change_sec;
        if ((unsigned)transferred != p->last_size) {
@@ -188,20 +181,35 @@ void FAST_FUNC bb_progress_update(bb_progress_t *p,
                fprintf(stderr, " --:--:-- ETA");
        } else {
                unsigned eta, secs, hours;
+               unsigned bytes;
 
-               totalsize -= beg_size; /* now it's "total to upload" */
+               bytes = totalsize - beg_size;
 
                /* Estimated remaining time =
-                * estimated_sec_to_dl_totalsize_bytes - elapsed_sec =
-                * totalsize / average_bytes_sec_so_far - elapsed =
-                * totalsize / (transferred/elapsed) - elapsed =
-                * totalsize * elapsed / transferred - elapsed
+                * estimated_sec_to_dl_bytes - elapsed_sec =
+                * bytes / average_bytes_sec_so_far - elapsed =
+                * bytes / (transferred/elapsed) - elapsed =
+                * bytes * elapsed / transferred - elapsed
                 */
-               eta = totalsize * elapsed / transferred - elapsed;
+               eta = (unsigned long)bytes * elapsed / transferred - elapsed;
+               /* if 32bit, can overflow ^^^^^^^^^^, but this would only show bad ETA */
                if (eta >= 1000*60*60)
                        eta = 1000*60*60 - 1;
+#if 0
+               /* To prevent annoying "back-and-forth" estimation jitter,
+                * if new ETA is larger than the last just by a few seconds,
+                * disregard it, and show last one. The end result is that
+                * ETA usually only decreases, unless download slows down a lot.
+                */
+               if ((unsigned)(eta - p->last_eta) < 10)
+                       eta = p->last_eta;
+               p->last_eta = eta;
+#endif
                secs = eta % 3600;
                hours = eta / 3600;
                fprintf(stderr, "%3u:%02u:%02u ETA", hours, secs / 60, secs % 60);
        }
+       if (notty)
+               fputc('\n', stderr);
+       return notty;
 }