1/*
2 * Copyright (c) 2003-2005 The Regents of The University of Michigan
3 * 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 are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Steve Reinhardt
29 *          Nathan Binkert
30 */
31
32#ifndef __BASE_TIME_HH__
33#define __BASE_TIME_HH__
34
35#include <sys/time.h>
36#include <inttypes.h>
37
38#include <cmath>
39#include <cstring>
40#include <ctime>
41#include <iosfwd>
42#include <iostream>
43#include <string>
44
45#include "base/types.hh"
46#include "sim/serialize.hh"
47
48class Time
49{
50  protected:
51    timespec _time;
52
53    /**
54     * Internal time set function
55     */
56    void _set(bool monotonic);
57
58  public:
59    static const long NSEC_PER_SEC  = 1000 * 1000 * 1000;
60    static const long NSEC_PER_MSEC = 1000 * 1000;
61    static const long NSEC_PER_USEC = 1000;
62
63  public:
64    explicit Time() { clear(); }
65    explicit Time(double sec) { operator=(sec); }
66    Time(const Time &val) : _time(val._time) { }
67    Time(uint64_t sec, uint64_t nsec) { set(sec, nsec); }
68    Time(const timeval &tv) { operator=(tv); }
69    Time(const timespec &ts) { operator=(ts); }
70
71    /**
72     * Accessors for getting and setting the current clock
73     */
74    time_t sec() const { return _time.tv_sec; }
75    long msec() const { return _time.tv_nsec / NSEC_PER_MSEC; }
76    long usec() const { return _time.tv_nsec / NSEC_PER_USEC; }
77    long nsec() const { return _time.tv_nsec; }
78
79    void sec(time_t sec) { _time.tv_sec = sec; }
80    void msec(long msec) { _time.tv_nsec = msec * NSEC_PER_MSEC; }
81    void usec(long usec) { _time.tv_nsec = usec * NSEC_PER_USEC; }
82    void nsec(long nsec) { _time.tv_nsec = nsec; }
83
84    /**
85     * Clear the time
86     */
87    void clear() { memset(&_time, 0, sizeof(_time)); }
88
89    /**
90     * Use this to set time for the purposes of time measurement (use
91     * a monotonic clock if it is available
92     */
93    void setTimer() { _set(true); }
94
95    /**
96     * Use this to set the time to the actual current time
97     */
98    void setWallclock() { _set(false); }
99
100    /**
101     * Set the current time
102     */
103    void set(time_t _sec, long _nsec) { sec(_sec); nsec(_nsec); }
104
105    /**
106     * Set the current time from a value measured in Ticks
107     * @param ticks Number of ticks to convert into a time.
108     */
109    void setTick(Tick ticks);
110
111    /**
112     * Get the current time from a value measured in Ticks
113     * @return Time value measured in Ticks.
114     */
115    Tick getTick() const;
116
117    const Time &
118    operator=(const Time &other)
119    {
120        sec(other.sec());
121        nsec(other.nsec());
122        return *this;
123    }
124
125    const Time &
126    operator=(double new_time)
127    {
128        double seconds = floor(new_time);
129        sec((time_t)seconds);
130        nsec((long)((seconds - new_time) * 1e9));
131        return *this;
132    }
133
134    const Time &
135    operator=(const timeval &tv)
136    {
137        sec(tv.tv_sec);
138        nsec(tv.tv_usec * 1000);
139        return *this;
140    }
141
142    const Time &
143    operator=(const timespec &ts)
144    {
145        sec(ts.tv_sec);
146        nsec(ts.tv_nsec);
147        return *this;
148    }
149
150    /**
151     * Get the time in floating point seconds
152     */
153    operator double() const
154    {
155        return (double)sec() + ((double)nsec()) * 1e-9;
156    }
157
158    /**
159     * operators for time conversion
160     */
161    operator timespec() const { return _time; }
162    operator timeval() const
163    {
164        timeval tv;
165        tv.tv_sec = sec();
166        tv.tv_usec = usec();
167        return tv;
168    }
169
170    const Time &
171    operator+=(const Time &other)
172    {
173
174        _time.tv_sec += other.sec();
175        _time.tv_nsec += other.nsec();
176        if (_time.tv_nsec > NSEC_PER_SEC) {
177            _time.tv_sec++;
178            _time.tv_nsec -= NSEC_PER_SEC;
179        }
180
181        return *this;
182    }
183
184    const Time &
185    operator-=(const Time &other)
186    {
187        _time.tv_sec -= other.sec();
188        _time.tv_nsec -= other.nsec();
189        if (_time.tv_nsec < 0) {
190            _time.tv_sec--;
191            _time.tv_nsec += NSEC_PER_SEC;
192        }
193
194        return *this;
195    }
196
197    std::string date(const std::string &format = "") const;
198    std::string time() const;
199
200    void serialize(const std::string &base, CheckpointOut &cp) const;
201    void unserialize(const std::string &base, CheckpointIn &cp);
202};
203
204void sleep(const Time &time);
205
206inline bool
207operator==(const Time &l, const Time &r)
208{
209    return l.sec() == r.sec() && l.nsec() == r.nsec();
210}
211
212inline bool
213operator!=(const Time &l, const Time &r)
214{
215    return l.sec() != r.sec() || l.nsec() != r.nsec();
216}
217
218inline bool
219operator<(const Time &l, const Time &r)
220{
221    return (l.sec() < r.sec()) ||
222        (l.sec() == r.sec() && l.nsec() < r.nsec());
223}
224
225inline bool
226operator<=(const Time &l, const Time &r)
227{
228    return (l.sec() < r.sec()) ||
229        (l.sec() == r.sec() && l.nsec() <= r.nsec());
230}
231
232inline bool
233operator>(const Time &l, const Time &r)
234{
235    return (l.sec() > r.sec()) ||
236        (l.sec() == r.sec() && l.nsec() > r.nsec());
237}
238
239inline bool
240operator>=(const Time &l, const Time &r)
241{
242    return (l.sec() > r.sec()) ||
243        (l.sec() == r.sec() && l.nsec() >= r.nsec());
244}
245
246inline Time
247operator+(const Time &l, const Time &r)
248{
249    Time time(l);
250    time += r;
251    return time;
252}
253
254inline Time
255operator-(const Time &l, const Time &r)
256{
257    Time time(l);
258    time -= r;
259    return time;
260}
261
262inline std::ostream &
263operator<<(std::ostream &out, const Time &time)
264{
265    out << time.date();
266    return out;
267}
268
269time_t mkutctime(struct tm *time);
270
271#endif // __BASE_TIME_HH__
272