progress.c

/*
 * progress.c
 * $Id: progress.c,v 1.11 2006/09/01 17:21:05 bobi Exp $
 *
 * Copyright 2004 Bobi B., w1zard0f07@yahoo.com
 *
 * This file is part of hdl_dump.
 *
 * hdl_dump is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * hdl_dump is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with hdl_dump; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <stdio.h>
#include <string.h>
#include "progress.h"
#include "osal.h"


/* high-resolution time support */
#if defined(_BUILD_WIN32) && !defined(_BUILD_WINE)
void highres_time(highres_time_t *cl)
{
    QueryPerformanceCounter(cl);
}

u_int64_t
highres_time_val(const highres_time_t *cl)
{
    static int init = 0;
    static LARGE_INTEGER freq;
    if (!init) {
        QueryPerformanceFrequency(&freq);
        init = 1;
    }
    if (freq.QuadPart >= HIGHRES_TO_SEC)
        return ((u_int64_t)(cl->QuadPart /
                            ((double)freq.QuadPart / HIGHRES_TO_SEC)));
    else
        return ((u_int64_t)(cl->QuadPart *
                            ((double)HIGHRES_TO_SEC / freq.QuadPart)));
}
#endif

#if defined(_BUILD_UNIX) || defined(_BUILD_WINE)
void highres_time(highres_time_t *cl)
{
    (void)gettimeofday(cl, NULL /* ignore time zone */);
}

u_int64_t
highres_time_val(const highres_time_t *cl)
{
    return ((u_int64_t)cl->tv_sec * 1000000 + cl->tv_usec);
}
#endif


/**************************************************************/
progress_t *
pgs_alloc(progress_cb_t progress_cb,
          /*@dependent@*/ void *data)
{
    progress_t *pgs = osal_alloc(sizeof(progress_t));
    if (pgs != NULL) {
        memset(pgs, 0, sizeof(progress_t));
        pgs->progress_cb_ = progress_cb;
        pgs->progress_data_ = data;
    }
    return (pgs);
}


/**************************************************************/
void pgs_free(progress_t *pgs)
{
    if (pgs != NULL)
        osal_free(pgs);
}


/**************************************************************/
void pgs_prepare(progress_t *pgs,
                 u_int64_t total)
{
    if (pgs != NULL) {
        highres_time_t now;
        progress_cb_t progress_cb = pgs->progress_cb_;
        memset(pgs, 0, sizeof(progress_t));

        highres_time(&now);
        pgs->start_ = highres_time_val(&now);

        pgs->total = total;

        pgs->estimated = -1;
        pgs->remaining = -1;
        pgs->progress_cb_ = progress_cb;

        if (pgs->progress_cb_ != NULL)
            (void)pgs->progress_cb_(pgs, pgs->progress_data_);
    }
}


/**************************************************************/
void pgs_chunk_complete(progress_t *pgs)
{
    if (pgs != NULL)
        pgs->offset_ = pgs->curr;
}


/**************************************************************/
char *
fmt_time(/*@returned@*/ char *buffer,
         int seconds)
{
    if (seconds >= 60) {
        if ((seconds % 60) != 0)
            /* minutes + seconds */
            sprintf(buffer, "%d min, %d sec", seconds / 60, seconds % 60);
        else /* minutes only */
            sprintf(buffer, "%d min", seconds / 60);
    } else if (seconds > 0)
        /* seconds only */
        sprintf(buffer, "%d sec", seconds);
    else /* seconds <= 0 */
        strcpy(buffer, "0 sec");
    return (buffer);
}


/**************************************************************/
int pgs_update(progress_t *pgs,
               u_int64_t curr)
{ /* TODO: pgs_update: check math for overflows! */
    if (pgs != NULL && pgs->total > 0) {
        highres_time_t tmp;
        u_int64_t now;
        struct hist_t *hist = pgs->history_ + pgs->hist_pos_;
        u_int64_t prev = pgs->curr;

        highres_time(&tmp);
        now = highres_time_val(&tmp);

        pgs->curr = pgs->offset_ + curr;

        pgs->pc_completed = (int)(pgs->curr * 100 / pgs->total);

        /* calculate current speed */
        if (hist->when > 0)
            pgs->curr_bps = (u_int32_t)((pgs->hist_sum_ * HIGHRES_TO_SEC) /
                                        (now - hist->when + 1));
        else
            pgs->curr_bps = (u_int32_t)((pgs->hist_sum_ * HIGHRES_TO_SEC) /
                                        (now - pgs->start_ + 1));
        pgs->hist_sum_ += (pgs->curr - prev) - hist->how_much;
        hist->how_much = (u_int32_t)(pgs->curr - prev);
        hist->when = now;
        pgs->hist_pos_ = (pgs->hist_pos_ + 1) % PG_HIST_SIZE;

        /* elapsed/estimated time */
        pgs->elapsed_ = now - pgs->start_;
        if (pgs->elapsed_ > 0) {
            pgs->avg_bps = (long)(pgs->curr * HIGHRES_TO_SEC / pgs->elapsed_);
            pgs->elapsed = (u_int32_t)(pgs->elapsed_ / HIGHRES_TO_SEC);
            (void)fmt_time(pgs->elapsed_text, pgs->elapsed);

            if (((pgs->elapsed > 10 && pgs->pc_completed > 0) ||
                 pgs->pc_completed > 10) &&
                pgs->elapsed > pgs->last_elapsed_) { /* calculate estimated and remaining, format texts */
                pgs->estimated = (int)(((pgs->elapsed_ * pgs->total) /
                                        pgs->curr) /
                                       HIGHRES_TO_SEC);
                pgs->remaining = pgs->estimated - pgs->elapsed + 1;
                pgs->last_elapsed_ = pgs->elapsed;
                (void)fmt_time(pgs->estimated_text, pgs->estimated);
                (void)fmt_time(pgs->remaining_text, pgs->remaining);
            }
        }

        if (pgs->progress_cb_ != NULL) { /* skip unnecessary updates */
            if (pgs->call_pc_completed_ != pgs->pc_completed ||
                pgs->call_elapsed_ != pgs->elapsed ||
                pgs->call_estimated_ != pgs->estimated ||
                pgs->call_remaining_ != pgs->remaining) {
                pgs->call_pc_completed_ = pgs->pc_completed;
                pgs->call_elapsed_ = pgs->elapsed;
                pgs->call_estimated_ = pgs->estimated;
                pgs->call_remaining_ = pgs->remaining;
                /* let callback decide whether to continue */
                return (pgs->progress_cb_(pgs, pgs->progress_data_));
            } else
                return (0); /* continue */
        } else
            return (0); /* continue */
    } else
        return (0); /* continue */
}