progress.c revision 287203
1295016Sjkim/* $NetBSD: progressbar.c,v 1.21 2009/04/12 10:18:52 lukem Exp $ */ 2280304Sjkim 3280304Sjkim/*- 4280304Sjkim * Copyright (c) 1997-2009 The NetBSD Foundation, Inc. 5109998Smarkm * All rights reserved. 6109998Smarkm * 7109998Smarkm * This code is derived from software contributed to The NetBSD Foundation 8109998Smarkm * by Luke Mewburn. 9109998Smarkm * 10109998Smarkm * Redistribution and use in source and binary forms, with or without 11109998Smarkm * modification, are permitted provided that the following conditions 12109998Smarkm * are met: 13109998Smarkm * 1. Redistributions of source code must retain the above copyright 14280304Sjkim * notice, this list of conditions and the following disclaimer. 15109998Smarkm * 2. Redistributions in binary form must reproduce the above copyright 16109998Smarkm * notice, this list of conditions and the following disclaimer in the 17109998Smarkm * documentation and/or other materials provided with the distribution. 18109998Smarkm * 19109998Smarkm * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20109998Smarkm * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21109998Smarkm * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22109998Smarkm * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23109998Smarkm * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24109998Smarkm * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25109998Smarkm * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26109998Smarkm * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27109998Smarkm * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28109998Smarkm * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29109998Smarkm * POSSIBILITY OF SUCH DAMAGE. 30109998Smarkm */ 31109998Smarkm 32109998Smarkm#include <sys/types.h> 33109998Smarkm#include <sys/param.h> 34109998Smarkm#include <sys/ioctl.h> 35109998Smarkm 36109998Smarkm#include <errno.h> 37109998Smarkm#include <stdio.h> 38109998Smarkm#include <stdlib.h> 39109998Smarkm#include <string.h> 40109998Smarkm#include <termios.h> 41109998Smarkm#include <time.h> 42109998Smarkm#include <unistd.h> 43109998Smarkm 44109998Smarkm#include <sys/cdefs.h> 45109998Smarkm__FBSDID("$FreeBSD: stable/10/sbin/camcontrol/progress.c 287203 2015-08-27 13:17:05Z ken $"); 46109998Smarkm 47109998Smarkm#include "progress.h" 48109998Smarkm 49109998Smarkmstatic const char * const suffixes[] = { 50109998Smarkm "", /* 2^0 (byte) */ 51109998Smarkm "KiB", /* 2^10 Kibibyte */ 52109998Smarkm "MiB", /* 2^20 Mebibyte */ 53109998Smarkm "GiB", /* 2^30 Gibibyte */ 54109998Smarkm "TiB", /* 2^40 Tebibyte */ 55109998Smarkm "PiB", /* 2^50 Pebibyte */ 56109998Smarkm "EiB", /* 2^60 Exbibyte */ 57109998Smarkm}; 58109998Smarkm 59109998Smarkm#define NSUFFIXES (sizeof(suffixes) / sizeof(suffixes[0])) 60280304Sjkim#define SECSPERHOUR (60 * 60) 61280304Sjkim#define DEFAULT_TTYWIDTH 80 62280304Sjkim 63280304Sjkim/* initialise progress meter structure */ 64280304Sjkimint 65280304Sjkimprogress_init(progress_t *prog, const char *prefix, uint64_t total) 66280304Sjkim{ 67280304Sjkim struct winsize winsize; 68280304Sjkim int oerrno = errno; 69280304Sjkim 70109998Smarkm (void) memset(prog, 0x0, sizeof(*prog)); 71109998Smarkm prog->size = total; 72109998Smarkm prog->prefix = strdup(prefix); 73109998Smarkm prog->start = time(NULL); 74109998Smarkm if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &winsize) != -1 && 75280304Sjkim winsize.ws_col != 0) { 76160814Ssimon prog->ttywidth = winsize.ws_col; 77109998Smarkm } else { 78109998Smarkm prog->ttywidth = DEFAULT_TTYWIDTH; 79109998Smarkm } 80109998Smarkm errno = oerrno; 81238405Sjkim return 1; 82109998Smarkm} 83109998Smarkm 84109998Smarkm/* update the values in the progress meter */ 85280304Sjkimint 86280304Sjkimprogress_update(progress_t *prog, uint64_t done) 87280304Sjkim{ 88160814Ssimon prog->done = done; 89280304Sjkim prog->percent = (prog->done * 100) / prog->size; 90109998Smarkm prog->now = time(NULL); 91109998Smarkm prog->elapsed = prog->now - prog->start; 92109998Smarkm if (done == 0 || prog->elapsed == 0 || prog->done / prog->elapsed == 0) { 93109998Smarkm prog->eta = 0; 94109998Smarkm } else { 95109998Smarkm prog->eta = prog->size / (prog->done / prog->elapsed) - prog->elapsed; 96280304Sjkim } 97280304Sjkim return 1; 98109998Smarkm} 99109998Smarkm 100109998Smarkm/* update the values in the progress meter */ 101109998Smarkmint 102109998Smarkmprogress_reset_size(progress_t *prog, uint64_t size) 103109998Smarkm{ 104109998Smarkm prog->size = size; 105109998Smarkm return 1; 106280304Sjkim} 107280304Sjkim 108280304Sjkim/* make it look pretty at the end - display done bytes (usually total) */ 109280304Sjkimint 110280304Sjkimprogress_complete(progress_t *prog, uint64_t done) 111109998Smarkm{ 112280304Sjkim progress_update(prog, done); 113280304Sjkim progress_draw(prog); 114280304Sjkim printf("\n"); 115280304Sjkim return 1; 116280304Sjkim} 117280304Sjkim 118280304Sjkim/* draw the progress meter */ 119280304Sjkimint 120280304Sjkimprogress_draw(progress_t *prog) 121280304Sjkim{ 122280304Sjkim#define BAROVERHEAD 45 /* non `*' portion of progress bar */ 123280304Sjkim /* 124280304Sjkim * stars should contain at least 125109998Smarkm * sizeof(buf) - BAROVERHEAD entries 126280304Sjkim */ 127280304Sjkim#define MIN_BAR_LEN 10 128280304Sjkim static const char stars[] = 129280304Sjkim"*****************************************************************************" 130280304Sjkim"*****************************************************************************" 131280304Sjkim"*****************************************************************************"; 132280304Sjkim unsigned bytesabbrev; 133109998Smarkm unsigned bpsabbrev; 134280304Sjkim int64_t secs; 135280304Sjkim uint64_t bytespersec; 136280304Sjkim uint64_t abbrevsize; 137280304Sjkim int64_t secsleft; 138109998Smarkm ssize_t barlength; 139280304Sjkim size_t starc; 140280304Sjkim char hours[12]; 141280304Sjkim char buf[256]; 142280304Sjkim int len; 143109998Smarkm int prefix_len; 144280304Sjkim 145280304Sjkim prefix_len = strlen(prog->prefix); 146280304Sjkim barlength = MIN(sizeof(buf) - 1, (unsigned)prog->ttywidth) - 147280304Sjkim BAROVERHEAD - prefix_len; 148109998Smarkm if (barlength < MIN_BAR_LEN) { 149280304Sjkim int tmp_prefix_len; 150280304Sjkim /* 151280304Sjkim * In this case the TTY width is too small or the prefix is 152280304Sjkim * too large for a progress bar. We'll try decreasing the 153109998Smarkm * prefix length. 154280304Sjkim */ 155280304Sjkim barlength = MIN_BAR_LEN; 156280304Sjkim tmp_prefix_len = MIN(sizeof(buf) - 1,(unsigned)prog->ttywidth) - 157280304Sjkim BAROVERHEAD - MIN_BAR_LEN; 158280304Sjkim if (tmp_prefix_len > 0) 159280304Sjkim prefix_len = tmp_prefix_len; 160109998Smarkm else 161109998Smarkm prefix_len = 0; 162109998Smarkm } 163280304Sjkim starc = (barlength * prog->percent) / 100; 164109998Smarkm abbrevsize = prog->done; 165280304Sjkim for (bytesabbrev = 0; abbrevsize >= 100000 && bytesabbrev < NSUFFIXES; bytesabbrev++) { 166280304Sjkim abbrevsize >>= 10; 167109998Smarkm } 168280304Sjkim if (bytesabbrev == NSUFFIXES) { 169109998Smarkm bytesabbrev--; 170280304Sjkim } 171280304Sjkim bytespersec = 0; 172109998Smarkm if (prog->done > 0) { 173109998Smarkm bytespersec = prog->done; 174109998Smarkm if (prog->elapsed > 0) { 175109998Smarkm bytespersec /= prog->elapsed; 176280304Sjkim } 177109998Smarkm } 178280304Sjkim for (bpsabbrev = 1; bytespersec >= 1024000 && bpsabbrev < NSUFFIXES; bpsabbrev++) { 179280304Sjkim bytespersec >>= 10; 180109998Smarkm } 181109998Smarkm if (prog->done == 0 || prog->elapsed <= 0 || prog->done > prog->size) { 182280304Sjkim secsleft = 0; 183109998Smarkm } else { 184280304Sjkim secsleft = prog->eta; 185280304Sjkim } 186280304Sjkim if ((secs = secsleft / SECSPERHOUR) > 0) { 187109998Smarkm (void) snprintf(hours, sizeof(hours), "%2lld:", (long long)secs); 188109998Smarkm } else { 189109998Smarkm (void) snprintf(hours, sizeof(hours), " "); 190280304Sjkim } 191280304Sjkim secs = secsleft % SECSPERHOUR; 192280304Sjkim len = snprintf(buf, sizeof(buf), 193109998Smarkm "\r%.*s %3lld%% |%.*s%*s| %5lld %-3s %3lld.%02d %.2sB/s %s%02d:%02d ETA", 194109998Smarkm prefix_len, (prog->prefix) ? prog->prefix : "", 195280304Sjkim (long long)prog->percent, 196280304Sjkim (int)starc, stars, (int)(barlength - starc), "", 197109998Smarkm (long long)abbrevsize, 198280304Sjkim suffixes[bytesabbrev], 199280304Sjkim (long long)(bytespersec / 1024), 200280304Sjkim (int)((bytespersec % 1024) * 100 / 1024), 201280304Sjkim suffixes[bpsabbrev], 202109998Smarkm hours, 203109998Smarkm (int)secs / 60, (int)secs % 60); 204280304Sjkim return (int)write(STDOUT_FILENO, buf, len); 205109998Smarkm} 206109998Smarkm