stime.h

/*<std-header orig-src='shore' incl-file-exclusion='STIME_H'>

 $Id: stime.h,v 1.21 2010/05/26 01:20:22 nhall Exp $

SHORE -- Scalable Heterogeneous Object REpository

Copyright (c) 1994-99 Computer Sciences Department, University of
                      Wisconsin -- Madison
All Rights Reserved.

Permission to use, copy, modify and distribute this software and its
documentation is hereby granted, provided that both the copyright
notice and this permission notice appear in all copies of the
software, derivative works or modified versions, and any portions
thereof, and that both notices appear in supporting documentation.

THE AUTHORS AND THE COMPUTER SCIENCES DEPARTMENT OF THE UNIVERSITY
OF WISCONSIN - MADISON ALLOW FREE USE OF THIS SOFTWARE IN ITS
"AS IS" CONDITION, AND THEY DISCLAIM ANY LIABILITY OF ANY KIND
FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.

This software was developed with support by the Advanced Research
Project Agency, ARPA order number 018 (formerly 8230), monitored by
the U.S. Army Research Laboratory under contract DAAB07-91-C-Q518.
Further funding for this work was provided by DARPA through
Rome Research Laboratory Contract No. F30602-97-2-0247.

*/

#ifndef STIME_H
#define STIME_H

#include "w_defines.h"

/*  -- do not edit anything above this line --   </std-header>*/

/**\cond skip */
/* Skip documentation.
 * This isn't really for general consumption; it's used for
 * debugging and testing.
 * */

extern "C" {
#include <sys/time.h>
}

/**\brief General-purpose time interval class.
*
*  It's used as a
*  cast so that you can subtract two times and print the result as an
*  interval rather than an absolute date.
*
*  Stime_t is an class that lets you build an underlying implementation
*  which can utilize whatever the "best" time
*  information on a system is.  
*  
*  The current implementation, uses either BSD 'struct timeval' or
*  Posix 'struct timespec' to represent both intervals and timestamps.
*  Future implementors are encouraged to use something similar if other
*  high resolution timers are available.  The combination of a
*  "time-of-day" portion of time, and a "high resolution" between
*  time-of-day increments works well for both purposes.
*
*/

// USE_POSIX_TIME has protection from double-define so that
// you can override this in shore.def
#if     HAVE_CLOCK_GETTIME
#ifndef USE_POSIX_TIME
#define USE_POSIX_TIME 1
#endif
#elif   !HAVE_GETTIMEOFDAY
#error  No suitable get-time system call. Cannot build.
#endif

class stime_t {
protected:
#ifdef USE_POSIX_TIME
    struct    timespec    _time;
#else
    struct    timeval        _time;
#endif

    /* better method name, PLEASE */
    void    gettime();

    void signs();
    void _normalize();
    void normalize();

    /* only good INSIDE, since workings exposed if public */
    stime_t(time_t, long);        /* time-of-day, hr-secs */

public:
    stime_t() {
        _time.tv_sec = 0;
#ifdef USE_POSIX_TIME
        _time.tv_nsec = 0;
#else
        _time.tv_usec = 0;
#endif
    }

#ifdef USE_POSIX_TIME
    stime_t(const struct timespec &ts);
#endif
    stime_t(const struct timeval &tv);

    // an interval in seconds.
    stime_t(int);
    stime_t(long);

    // an interval in floating point seconds
    stime_t(double);

    /* comparison primitives */
    bool    operator==(const stime_t &) const;
    bool    operator<(const stime_t &) const;
    bool    operator<=(const stime_t &) const;
    /* derived compares */
    bool    operator!=(const stime_t &r) const { return !(*this == r); }
    bool    operator>(const stime_t &r) const { return !(*this <= r); }
    bool    operator>=(const stime_t &r) const { return !(*this < r); }

    // negate an interval
    stime_t    operator-() const;

    /* times can be added and subtracted */
    stime_t    operator+(const stime_t &r) const;
    stime_t    operator-(const stime_t &r) const;

    /* adjust an interval by a factor ... an experiment in progress */
    /* XXX should this be confined to sinterval_t ??? */ 
    stime_t operator*(const int factor) const;
    stime_t operator/(const int factor) const;
    stime_t operator*(const double factor) const;
    stime_t operator/(const double factor) const;

    // operatorX= variants
    stime_t &operator+=(const stime_t &r);
    stime_t &operator-=(const stime_t &r);

    /* XXX need a rounding operator?? */ 

    /* output conversions.  int/long is not available,
       because it doesn't have the dynamic range */
    operator double() const;
    operator float() const;
#ifdef USE_POSIX_TIME
    operator struct timespec() const;
#endif

    // for type conversion:
    operator struct timeval() const;
    
    /* XXX really belongs in sinterval_t */
    /* simple output conversions for integers to eliminate fp */
    long    secs() const;        /* seconds */
    long    msecs() const;        /* milli seconds */
    long    usecs() const;        /* micro seconds */
    long    nsecs() const;        /* nano seconds */

    /* input conversion operators for integral types */
    static    stime_t sec(int seconds); 
    static    stime_t    usec(int micro_seconds, int seconds = 0);
    static    stime_t    msec(int milli_seconds, int seconds = 0);
    static    stime_t    nsec(int nano_seconds, int seconds = 0);

    /* the Current time */
    static    stime_t now();

    ostream    &print(ostream &s) const;
    ostream &ctime(ostream &s) const;
};


/* Intervals are different, in some ways, from absolute
   times.  For now, they are to change print methods */

class sinterval_t : public stime_t {
public:
    /* XXX why do I duplicate the constructors ???  There
     is or was a reason for it. */

    sinterval_t() : stime_t() { }
#ifdef USE_POSIX_TIME
    sinterval_t(const struct timespec &ts) : stime_t(ts) { }
#endif
    sinterval_t(const struct timeval &tv) : stime_t(tv) { }

    sinterval_t(const stime_t &time) : stime_t(time) { }
    sinterval_t(int time) : stime_t(time) { }
    sinterval_t(long time) : stime_t(time) { }
    sinterval_t(double time) : stime_t(time) { }

    ostream    &print(ostream &s) const;
};


extern ostream &operator<<(ostream &s, const stime_t &t);
extern ostream &operator<<(ostream &s, const sinterval_t &t);

/**\endcond skip */

/*<std-footer incl-file-exclusion='STIME_H'>  -- do not edit anything below this line -- */

#endif          /*</std-footer>*/

---