Clock: Move the clock and related functions to ClockedObject
[gem5.git] / src / base / time.hh
index 24e8a8a53e58b9c7ab89115482b5dbdfd3423e76..734a86fa91f9238e3dad27d230d65f14fb74d01c 100644 (file)
  *          Nathan Binkert
  */
 
-#ifndef __SIM_TIME_HH__
-#define __SIM_TIME_HH__
+#ifndef __BASE_TIME_HH__
+#define __BASE_TIME_HH__
 
 #include <sys/time.h>
+#include <inttypes.h>
 
+#include <cmath>
+#include <cstring>
+#include <ctime>
 #include <iosfwd>
+#include <iostream>
 #include <string>
 
-struct _timeval;
+#include "base/types.hh"
+
+class Checkpoint;
 
 class Time
 {
   protected:
-    mutable _timeval *time;
+    timespec _time;
+
+    /**
+     * Internal time set function
+     */
+    void _set(bool monotonic);
+
+  public:
+    static const long NSEC_PER_SEC  = 1000 * 1000 * 1000;
+    static const long NSEC_PER_MSEC = 1000 * 1000;
+    static const long NSEC_PER_USEC = 1000;
 
   public:
-    explicit Time(bool set_now = false);
-    Time(const timeval &val);
-    Time(const Time &val);
-    ~Time();
+    explicit Time() { clear(); }
+    explicit Time(double sec) { operator=(sec); }
+    Time(const Time &val) : _time(val._time) { }
+    Time(uint64_t sec, uint64_t nsec) { set(sec, nsec); }
+    Time(const timeval &tv) { operator=(tv); }
+    Time(const timespec &ts) { operator=(ts); }
 
-    void set();
-    const timeval &get() const;
-    void set(const timeval &val);
+    /**
+     * Accessors for getting and setting the current clock
+     */
+    time_t sec() const { return _time.tv_sec; }
+    long msec() const { return _time.tv_nsec / NSEC_PER_MSEC; }
+    long usec() const { return _time.tv_nsec / NSEC_PER_USEC; }
+    long nsec() const { return _time.tv_nsec; }
 
-    double operator()() const;
-    std::string date(std::string format = "") const;
+    void sec(time_t sec) { _time.tv_sec = sec; }
+    void msec(long msec) { _time.tv_nsec = msec * NSEC_PER_MSEC; }
+    void usec(long usec) { _time.tv_nsec = usec * NSEC_PER_USEC; }
+    void nsec(long nsec) { _time.tv_nsec = nsec; }
 
-  public:
-    static const Time start;
+    /**
+     * Clear the time
+     */
+    void clear() { memset(&_time, 0, sizeof(_time)); }
+
+    /**
+     * Use this to set time for the purposes of time measurement (use
+     * a monotonic clock if it is available
+     */
+    void setTimer() { _set(true); }
+
+    /**
+     * Use this to set the time to the actual current time
+     */
+    void setWallclock() { _set(false); }
+
+    /**
+     * Set the current time
+     */
+    void set(time_t _sec, long _nsec) { sec(_sec); nsec(_nsec); }
+
+    /**
+     * Set the current time from a value measured in Ticks
+     * @param ticks Number of ticks to convert into a time.
+     */
+    void setTick(Tick ticks);
+
+    /**
+     * Get the current time from a value measured in Ticks
+     * @return Time value measured in Ticks.
+     */
+    Tick getTick() const;
+
+    const Time &
+    operator=(const Time &other)
+    {
+        sec(other.sec());
+        nsec(other.nsec());
+        return *this;
+    }
+
+    const Time &
+    operator=(double new_time)
+    {
+        double seconds = floor(new_time);
+        sec((time_t)seconds);
+        nsec((long)((seconds - new_time) * 1e9));
+        return *this;
+    }
+
+    const Time &
+    operator=(const timeval &tv)
+    {
+        sec(tv.tv_sec);
+        nsec(tv.tv_usec * 1000);
+        return *this;
+    }
+
+    const Time &
+    operator=(const timespec &ts)
+    {
+        sec(ts.tv_sec);
+        nsec(ts.tv_nsec);
+        return *this;
+    }
+
+    /**
+     * Get the time in floating point seconds
+     */
+    operator double() const
+    {
+        return (double)sec() + ((double)nsec()) * 1e-9;
+    }
+
+    /**
+     * operators for time conversion
+     */
+    operator timespec() const { return _time; }
+    operator timeval() const
+    {
+        timeval tv;
+        tv.tv_sec = sec();
+        tv.tv_usec = usec();
+        return tv;
+    }
+
+    const Time &
+    operator+=(const Time &other)
+    {
+
+        _time.tv_sec += other.sec();
+        _time.tv_nsec += other.nsec();
+        if (_time.tv_nsec > NSEC_PER_SEC) {
+            _time.tv_sec++;
+            _time.tv_nsec -= NSEC_PER_SEC;
+        }
+
+        return *this;
+    }
+
+    const Time &
+    operator-=(const Time &other)
+    {
+        _time.tv_sec -= other.sec();
+        _time.tv_nsec -= other.nsec();
+        if (_time.tv_nsec < 0) {
+            _time.tv_sec--;
+            _time.tv_nsec += NSEC_PER_SEC;
+        }
+
+        return *this;
+    }
+
+    std::string date(const std::string &format = "") const;
+    std::string time() const;
+
+    void serialize(const std::string &base, std::ostream &os);
+    void unserialize(const std::string &base, Checkpoint *cp,
+                     const std::string &section);
 };
 
-Time operator-(const Time &l, const Time &r);
+void sleep(const Time &time);
+
+inline bool
+operator==(const Time &l, const Time &r)
+{
+    return l.sec() == r.sec() && l.nsec() == r.nsec();
+}
+
+inline bool
+operator!=(const Time &l, const Time &r)
+{
+    return l.sec() != r.sec() || l.nsec() != r.nsec();
+}
+
+inline bool
+operator<(const Time &l, const Time &r)
+{
+    return (l.sec() < r.sec()) ||
+        (l.sec() == r.sec() && l.nsec() < r.nsec());
+}
+
+inline bool
+operator<=(const Time &l, const Time &r)
+{
+    return (l.sec() < r.sec()) ||
+        (l.sec() == r.sec() && l.nsec() <= r.nsec());
+}
+
+inline bool
+operator>(const Time &l, const Time &r)
+{
+    return (l.sec() > r.sec()) ||
+        (l.sec() == r.sec() && l.nsec() > r.nsec());
+}
+
+inline bool
+operator>=(const Time &l, const Time &r)
+{
+    return (l.sec() > r.sec()) ||
+        (l.sec() == r.sec() && l.nsec() >= r.nsec());
+}
+
+inline Time
+operator+(const Time &l, const Time &r)
+{
+    Time time(l);
+    time += r;
+    return time;
+}
+
+inline Time
+operator-(const Time &l, const Time &r)
+{
+    Time time(l);
+    time -= r;
+    return time;
+}
+
+inline std::ostream &
+operator<<(std::ostream &out, const Time &time)
+{
+    out << time.date();
+    return out;
+}
 
-std::ostream &operator<<(std::ostream &out, const Time &time);
+time_t mkutctime(struct tm *time);
 
-#endif // __SIM_TIME_HH__
+#endif // __BASE_TIME_HH__