time.hpp

Go to the documentation of this file.

//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2012- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
 
#pragma once
 
#include <chrono>
#include <cstdint> // for std::uint32_t, uint64_t
#include <limits>
 
#include <openvpn/common/platform.hpp>
#include <openvpn/common/exception.hpp>
#include <openvpn/common/olong.hpp>
#include <openvpn/common/to_string.hpp>
#include <openvpn/common/numeric_cast.hpp>
 
 
#ifdef OPENVPN_PLATFORM_WIN
#include <time.h>    // for ::time() on Windows
#include <windows.h> // for GetTickCount64
#else
#include <sys/time.h> // for ::time() and ::gettimeofday()
#endif
 
namespace openvpn {
OPENVPN_SIMPLE_EXCEPTION(get_time_error);
 
template <typename T>
class TimeType
{
  public:
    enum
    {
        prec = 1024
    };
    typedef ::time_t base_type;
    typedef T type;
 
    class Duration
    {
        friend class TimeType;
 
      public:
        static Duration seconds(const T v)
        {
            return Duration(v * prec);
        }
        static Duration binary_ms(const T v)
        {
            return Duration(v);
        }
        static Duration infinite()
        {
            return Duration(std::numeric_limits<T>::max());
        }
 
        static Duration milliseconds(const T v)
        {
            // NOTE: assumes that prec == 1024
            // Also note that this might wrap if v is larger than 1/3 of max size of T
            return Duration(v + (v * T(3) / T(128)));
        }
 
        static Duration milliseconds(std::chrono::milliseconds ms)
        {
            /* Windows on 32 bit platforms warns about loss of precision otherwise */
            return milliseconds(openvpn::numeric_util::numeric_cast<T>(ms.count()));
        }
 
        Duration() noexcept
            : duration_(T(0))
        {
        }
 
        bool defined() const
        {
            return duration_ != T(0);
        }
        bool operator!() const
        {
            return duration_ == T(0);
        }
        bool is_infinite() const
        {
            return duration_ == std::numeric_limits<T>::max();
        }
        bool enabled() const
        {
            return defined() && !is_infinite();
        }
        void set_infinite()
        {
            duration_ = std::numeric_limits<T>::max();
        }
        void set_zero()
        {
            duration_ = T(0);
        }
 
        Duration operator+(const Duration &d) const
        {
            if (is_infinite() || d.is_infinite())
                return infinite();
            else
                return Duration(duration_ + d.duration_);
        }
 
        Duration operator+(const int delta) const
        {
            if (is_infinite())
                return infinite();
            T duration = duration_;
            if (delta >= 0)
                duration += delta;
            else
            {
                const unsigned int ndelta = -delta;
                if (duration_ >= ndelta)
                    duration -= ndelta;
                else
                    duration = 0;
            }
            return Duration(duration);
        }
 
        Duration operator*(const unsigned int mult) const
        {
            return Duration(duration_ * mult);
        }
 
        Duration &operator+=(const Duration &d)
        {
            if (is_infinite() || d.is_infinite())
                set_infinite();
            else
                duration_ += d.duration_;
            return *this;
        }
 
        void min(const Duration &d)
        {
            if (d.duration_ < duration_)
                duration_ = d.duration_;
        }
 
        void max(const Duration &d)
        {
            if (d.duration_ > duration_)
                duration_ = d.duration_;
        }
 
        Duration operator-(const Duration &d) const
        {
            if (d.duration_ >= duration_)
                return Duration(0);
            else if (is_infinite())
                return Duration::infinite();
            else
                return Duration(duration_ - d.duration_);
        }
 
        Duration &operator-=(const Duration &d)
        {
            if (d.duration_ >= duration_)
                set_zero();
            else if (!is_infinite())
                duration_ -= d.duration_;
            return *this;
        }
 
        T to_seconds() const
        {
            return duration_ / prec;
        }
        T to_binary_ms() const
        {
            return duration_;
        }
 
        T to_milliseconds() const
        {
            // NOTE: assumes that prec == 1024
            // Also note that this might wrap if duration_ is larger than 1/3 of max size of T
            return duration_ - (duration_ * T(3) / T(128));
        }
 
        double to_double() const
        {
            return double(duration_) / double(prec);
        }
 
        T raw() const
        {
            return duration_;
        }
 
#define OPENVPN_DURATION_REL(OP)              \
    bool operator OP(const Duration &d) const \
    {                                         \
        return duration_ OP d.duration_;      \
    }
        OPENVPN_DURATION_REL(==)
        OPENVPN_DURATION_REL(!=)
        OPENVPN_DURATION_REL(>)
        OPENVPN_DURATION_REL(<)
        OPENVPN_DURATION_REL(>=)
        OPENVPN_DURATION_REL(<=)
#undef OPENVPN_DURATION_REL
 
      private:
        explicit Duration(const T duration)
            : duration_(duration)
        {
        }
 
        T duration_;
    };
 
    TimeType() noexcept
        : time_(T(0))
    {
    }
 
    static TimeType zero()
    {
        return TimeType(T(0));
    }
    static TimeType infinite()
    {
        return TimeType(std::numeric_limits<T>::max());
    }
 
    static TimeType from_seconds_since_epoch(const time_t t)
    {
        if (t <= base_)
            return TimeType(T(1));
        else
            return TimeType(T((t - base_) * prec));
    }
 
    bool is_infinite() const
    {
        return time_ == std::numeric_limits<T>::max();
    }
 
    void reset()
    {
        time_ = 0;
    }
    void set_infinite()
    {
        time_ = std::numeric_limits<T>::max();
    }
 
    bool defined() const
    {
        return time_ != 0;
    }
    bool operator!() const
    {
        return time_ == 0;
    }
 
    base_type seconds_since_epoch() const
    {
        return base_ + time_ / prec;
    }
    std::uint64_t nanoseconds_since_epoch() const
    {
        return base_ * 1000000000ull + time_ * (1000000000ull / prec);
    }
    T fractional_binary_ms() const
    {
        return time_ % prec;
    }
 
    static TimeType now()
    {
        return TimeType(now_());
    }
 
    void update()
    {
        time_ = now_();
    }
 
    TimeType operator+(const Duration &d) const
    {
        if (is_infinite() || d.is_infinite())
            return infinite();
        else
            return TimeType(time_ + d.duration_);
    }
 
    TimeType &operator+=(const Duration &d)
    {
        if (is_infinite() || d.is_infinite())
            set_infinite();
        else
            time_ += d.duration_;
        return *this;
    }
 
    Duration operator-(const TimeType &t) const
    {
        if (t.time_ >= time_)
            return Duration(0);
        else if (is_infinite())
            return Duration::infinite();
        else
            return Duration(time_ - t.time_);
    }
 
    void min(const TimeType &t)
    {
        if (t.time_ < time_)
            time_ = t.time_;
    }
 
    void max(const TimeType &t)
    {
        if (t.time_ > time_)
            time_ = t.time_;
    }
 
    long delta_prec(const TimeType &t) const
    {
        return long(time_) - long(t.time_);
    }
 
    long delta(const TimeType &t) const
    {
        return delta_prec(t) / long(prec);
    }
 
    double delta_float(const TimeType &t) const
    {
        return (double(time_) - double(t.time_)) / double(prec);
    }
 
    std::string delta_str(const TimeType &t) const
    {
        if (!defined())
            return "UNDEF-TIME";
        if (is_infinite())
            return "+INF";
        const double df = delta_float(t);
        std::string ret;
        if (df >= 0.0)
            ret += '+';
        const int idf = int(df);
        if (df == static_cast<double>(idf))
            ret += openvpn::to_string(idf);
        else
            ret += openvpn::to_string(df);
        return ret;
    }
 
#define OPENVPN_TIME_REL(OP)                  \
    bool operator OP(const TimeType &t) const \
    {                                         \
        return time_ OP t.time_;              \
    }
    OPENVPN_TIME_REL(==)
    OPENVPN_TIME_REL(!=)
    OPENVPN_TIME_REL(>)
    OPENVPN_TIME_REL(<)
    OPENVPN_TIME_REL(>=)
    OPENVPN_TIME_REL(<=)
#undef OPENVPN_TIME_REL
 
    template <typename HASH>
    void hash(HASH &h) const
    {
        h(time_);
    }
 
    T raw() const
    {
        return time_;
    }
 
    static void reset_base_conditional()
    {
        // on 32-bit systems, reset time base after 30 days
        if (sizeof(T) == 4)
        {
            const base_type newbase = ::time(NULL);
            if (newbase - base_ >= (60 * 60 * 24 * 30))
                reset_base();
        }
    }
 
    static void reset_base()
    {
#ifdef OPENVPN_TIME_NO_BASE
        static_assert(sizeof(base_type) >= 8, "OPENVPN_TIME_NO_BASE requires time_t to be 64 bits");
#else
        base_ = ::time(NULL);
#ifdef OPENVPN_PLATFORM_WIN
        win_recalibrate(::GetTickCount64());
#endif
#endif
    }
 
    static uint64_t win_time()
    {
        // NOTE: assumes that prec == 1024
        return ((11644473600ULL * uint64_t(prec)) + (uint64_t(base_) * uint64_t(prec)) + uint64_t(now_())) * 78125ULL / 8ULL;
    }
 
  private:
    explicit TimeType(const T time)
        : time_(time)
    {
    }
 
#ifdef OPENVPN_PLATFORM_WIN
 
    static void win_recalibrate(const ULONGLONG gtc)
    {
        gtc_last = gtc;
        gtc_base = ::time(NULL) - gtc_last / 1000;
    }
 
    static T now_()
    {
        const ULONGLONG gtc = ::GetTickCount64();
        if (gtc < gtc_last)
            win_recalibrate(gtc);
        const time_t sec = gtc_base + gtc / 1000;
        const unsigned int msec = gtc % 1000;
        return T((sec - base_) * prec + msec * prec / 1000);
    }
 
    static inline ULONGLONG gtc_last = 0;
    static inline time_t gtc_base = 0;
 
#else
 
    static T now_()
    {
        ::timeval tv;
        if (::gettimeofday(&tv, nullptr) != 0)
            throw get_time_error();
        return T((tv.tv_sec - base_) * prec + tv.tv_usec * prec / 1000000);
    }
 
#endif
 
#ifdef OPENVPN_TIME_NO_BASE
    static constexpr base_type base_ = 0;
#else
    static inline base_type base_ = 0;
#endif
 
    T time_;
};
 
typedef TimeType<oulong> Time;
 
typedef Time *TimePtr;
 
} // namespace openvpn