crypto/openssh/progressmeter.c

   1 /* $OpenBSD: progressmeter.c,v 1.40 2013/09/19 00:24:52 djm Exp $ */
   2 /*
   3  * Copyright (c) 2003 Nils Nordman.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include "includes.h"
  27
  28 #include <sys/types.h>
  29 #include <sys/ioctl.h>
  30 #include <sys/uio.h>
  31
  32 #include <errno.h>
  33 #include <signal.h>
  34 #include <stdio.h>
  35 #include <string.h>
  36 #include <time.h>
  37 #include <unistd.h>
  38
  39 #include "progressmeter.h"
  40 #include "atomicio.h"
  41 #include "misc.h"
  42
  43 #define DEFAULT_WINSIZE 80
  44 #define MAX_WINSIZE 512
  45 #define PADDING 1               /* padding between the progress indicators */
  46 #define UPDATE_INTERVAL 1       /* update the progress meter every second */
  47 #define STALL_TIME 5            /* we're stalled after this many seconds */
  48
  49 /* determines whether we can output to the terminal */
  50 static int can_output(void);
  51
  52 /* formats and inserts the specified size into the given buffer */
  53 static void format_size(char *, int, off_t);
  54 static void format_rate(char *, int, off_t);
  55
  56 /* window resizing */
  57 static void sig_winch(int);
  58 static void setscreensize(void);
  59
  60 /* updates the progressmeter to reflect the current state of the transfer */
  61 void refresh_progress_meter(void);
  62
  63 /* signal handler for updating the progress meter */
  64 static void update_progress_meter(int);
  65
  66 static time_t start;            /* start progress */
  67 static time_t last_update;      /* last progress update */
  68 static char *file;              /* name of the file being transferred */
  69 static off_t start_pos;         /* initial position of transfer */
  70 static off_t end_pos;           /* ending position of transfer */
  71 static off_t cur_pos;           /* transfer position as of last refresh */
  72 static off_t last_pos;
  73 static off_t max_delta_pos = 0;
  74 static volatile off_t *counter; /* progress counter */
  75 static long stalled;            /* how long we have been stalled */
  76 static int bytes_per_second;    /* current speed in bytes per second */
  77 static int win_size;            /* terminal window size */
  78 static volatile sig_atomic_t win_resized; /* for window resizing */
  79
  80 /* units for format_size */
  81 static const char unit[] = " KMGT";
  82
  83 static int
  84 can_output(void)
  85 {
  86         return (getpgrp() == tcgetpgrp(STDOUT_FILENO));
  87 }
  88
  89 static void
  90 format_rate(char *buf, int size, off_t bytes)
  91 {
  92         int i;
  93
  94         bytes *= 100;
  95         for (i = 0; bytes >= 100*1000 && unit[i] != 'T'; i++)
  96                 bytes = (bytes + 512) / 1024;
  97         if (i == 0) {
  98                 i++;
  99                 bytes = (bytes + 512) / 1024;
 100         }
 101         snprintf(buf, size, "%3lld.%1lld%c%s",
 102             (long long) (bytes + 5) / 100,
 103             (long long) (bytes + 5) / 10 % 10,
 104             unit[i],
 105             i ? "B" : " ");
 106 }
 107
 108 static void
 109 format_size(char *buf, int size, off_t bytes)
 110 {
 111         int i;
 112
 113         for (i = 0; bytes >= 10000 && unit[i] != 'T'; i++)
 114                 bytes = (bytes + 512) / 1024;
 115         snprintf(buf, size, "%4lld%c%s",
 116             (long long) bytes,
 117             unit[i],
 118             i ? "B" : " ");
 119 }
 120
 121 void
 122 refresh_progress_meter(void)
 123 {
 124         char buf[MAX_WINSIZE + 1];
 125         time_t now;
 126         off_t transferred;
 127         double elapsed;
 128         int percent;
 129         off_t bytes_left;
 130         int cur_speed;
 131         int hours, minutes, seconds;
 132         int i, len;
 133         int file_len;
 134         off_t delta_pos;
 135
 136         transferred = *counter - (cur_pos ? cur_pos : start_pos);
 137         cur_pos = *counter;
 138         now = monotime();
 139         bytes_left = end_pos - cur_pos;
 140
 141         delta_pos = cur_pos - last_pos;
 142         if (delta_pos > max_delta_pos)
 143                 max_delta_pos = delta_pos;
 144
 145         if (bytes_left > 0)
 146                 elapsed = now - last_update;
 147         else {
 148                 elapsed = now - start;
 149                 /* Calculate true total speed when done */
 150                 transferred = end_pos - start_pos;
 151                 bytes_per_second = 0;
 152         }
 153
 154         /* calculate speed */
 155         if (elapsed != 0)
 156                 cur_speed = (transferred / elapsed);
 157         else
 158                 cur_speed = transferred;
 159
 160 #define AGE_FACTOR 0.9
 161         if (bytes_per_second != 0) {
 162                 bytes_per_second = (bytes_per_second * AGE_FACTOR) +
 163                     (cur_speed * (1.0 - AGE_FACTOR));
 164         } else
 165                 bytes_per_second = cur_speed;
 166
 167         /* filename */
 168         buf[0] = '\0';
 169         file_len = win_size - 45;
 170         if (file_len > 0) {
 171                 len = snprintf(buf, file_len + 1, "\r%s", file);
 172                 if (len < 0)
 173                         len = 0;
 174                 if (len >= file_len + 1)
 175                         len = file_len;
 176                 for (i = len; i < file_len; i++)
 177                         buf[i] = ' ';
 178                 buf[file_len] = '\0';
 179         }
 180
 181         /* percent of transfer done */
 182         if (end_pos != 0)
 183                 percent = ((float)cur_pos / end_pos) * 100;
 184         else
 185                 percent = 100;
 186
 187         snprintf(buf + strlen(buf), win_size - strlen(buf-8),
 188             " %3d%% ", percent);
 189
 190         /* amount transferred */
 191         format_size(buf + strlen(buf), win_size - strlen(buf),
 192             cur_pos);
 193         strlcat(buf, " ", win_size);
 194
 195         /* bandwidth usage */
 196         format_rate(buf + strlen(buf), win_size - strlen(buf),
 197             (off_t)bytes_per_second);
 198         strlcat(buf, "/s ", win_size);
 199
 200         /* instantaneous rate */
 201         if (bytes_left > 0)
 202                 format_rate(buf + strlen(buf), win_size - strlen(buf),
 203                             delta_pos);
 204         else
 205                 format_rate(buf + strlen(buf), win_size - strlen(buf),
 206                             max_delta_pos);
 207         strlcat(buf, "/s ", win_size);
 208
 209         /* ETA */
 210         if (!transferred)
 211                 stalled += elapsed;
 212         else
 213                 stalled = 0;
 214
 215         if (stalled >= STALL_TIME)
 216                 strlcat(buf, "- stalled -", win_size);
 217         else if (bytes_per_second == 0 && bytes_left)
 218                 strlcat(buf, "  --:-- ETA", win_size);
 219         else {
 220                 if (bytes_left > 0)
 221                         seconds = bytes_left / bytes_per_second;
 222                 else
 223                         seconds = elapsed;
 224
 225                 hours = seconds / 3600;
 226                 seconds -= hours * 3600;
 227                 minutes = seconds / 60;
 228                 seconds -= minutes * 60;
 229
 230                 if (hours != 0)
 231                         snprintf(buf + strlen(buf), win_size - strlen(buf),
 232                             "%d:%02d:%02d", hours, minutes, seconds);
 233                 else
 234                         snprintf(buf + strlen(buf), win_size - strlen(buf),
 235                             "  %02d:%02d", minutes, seconds);
 236
 237                 if (bytes_left > 0)
 238                         strlcat(buf, " ETA", win_size);
 239                 else
 240                         strlcat(buf, "    ", win_size);
 241         }
 242
 243         atomicio(vwrite, STDOUT_FILENO, buf, win_size - 1);
 244         last_update = now;
 245         last_pos = cur_pos;
 246 }
 247
 248 /*ARGSUSED*/
 249 static void
 250 update_progress_meter(int ignore)
 251 {
 252         int save_errno;
 253
 254         save_errno = errno;
 255
 256         if (win_resized) {
 257                 setscreensize();
 258                 win_resized = 0;
 259         }
 260         if (can_output())
 261                 refresh_progress_meter();
 262
 263         signal(SIGALRM, update_progress_meter);
 264         alarm(UPDATE_INTERVAL);
 265         errno = save_errno;
 266 }
 267
 268 void
 269 start_progress_meter(char *f, off_t filesize, off_t *ctr)
 270 {
 271         start = last_update = monotime();
 272         file = f;
 273         start_pos = *ctr;
 274         end_pos = filesize;
 275         cur_pos = 0;
 276         counter = ctr;
 277         stalled = 0;
 278         bytes_per_second = 0;
 279
 280         setscreensize();
 281         if (can_output())
 282                 refresh_progress_meter();
 283
 284         signal(SIGALRM, update_progress_meter);
 285         signal(SIGWINCH, sig_winch);
 286         alarm(UPDATE_INTERVAL);
 287 }
 288
 289 void
 290 stop_progress_meter(void)
 291 {
 292         alarm(0);
 293
 294         if (!can_output())
 295                 return;
 296
 297         /* Ensure we complete the progress */
 298         if (cur_pos != end_pos)
 299                 refresh_progress_meter();
 300
 301         atomicio(vwrite, STDOUT_FILENO, "\n", 1);
 302 }
 303
 304 /*ARGSUSED*/
 305 static void
 306 sig_winch(int sig)
 307 {
 308         win_resized = 1;
 309 }
 310
 311 static void
 312 setscreensize(void)
 313 {
 314         struct winsize winsize;
 315
 316         if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 &&
 317             winsize.ws_col != 0) {
 318                 if (winsize.ws_col > MAX_WINSIZE)
 319                         win_size = MAX_WINSIZE;
 320                 else
 321                         win_size = winsize.ws_col;
 322         } else
 323                 win_size = DEFAULT_WINSIZE;
 324         win_size += 1;                                  /* trailing \0 */
 325 }