zircon/system/ulib/zx/include/lib/zx/time.h

// Copyright 2016 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef LIB_ZX_TIME_H_
#define LIB_ZX_TIME_H_

#include <stdint.h>
#include <zircon/compiler.h>
#include <zircon/syscalls.h>
#include <zircon/time.h>

namespace zx {

class duration final {
public:
    constexpr duration() = default;

    explicit constexpr duration(zx_duration_t value)
        : value_(value) {}

    static constexpr duration infinite() { return duration(ZX_TIME_INFINITE); }

    static constexpr duration infinite_past() { return duration(ZX_TIME_INFINITE_PAST); }

    constexpr zx_duration_t get() const { return value_; }

    constexpr duration operator+(duration other) const {
        return duration(zx_duration_add_duration(value_, other.value_));
    }

    constexpr duration operator-(duration other) const {
        return duration(zx_duration_sub_duration(value_, other.value_));
    }

    constexpr duration operator*(int64_t multiplier) const {
        return duration(zx_duration_mul_int64(value_, multiplier));
    }

    constexpr duration operator/(int64_t divisor) const {
        return duration(value_ / divisor);
    }

    constexpr int64_t operator/(duration other) const {
        return value_ / other.value_;
    }

    constexpr duration operator%(int64_t divisor) const {
        return duration(value_ % divisor);
    }

    constexpr int64_t operator%(duration other) const {
        return value_ % other.value_;
    }

    constexpr duration& operator+=(duration other) {
        value_ = zx_duration_add_duration(value_, other.value_);
        return *this;
    }

    constexpr duration& operator-=(duration other) {
        value_ = zx_duration_sub_duration(value_, other.value_);
        return *this;
    }

    constexpr duration& operator*=(int64_t multiplier) {
        value_ = zx_duration_mul_int64(value_, multiplier);
        return *this;
    }

    constexpr duration& operator/=(int64_t divisor) {
        value_ /= divisor;
        return *this;
    }

    constexpr duration& operator%=(int64_t divisor) {
        value_ %= divisor;
        return *this;
    }

    constexpr bool operator==(duration other) const { return value_ == other.value_; }
    constexpr bool operator!=(duration other) const { return value_ != other.value_; }
    constexpr bool operator<(duration other) const { return value_ < other.value_; }
    constexpr bool operator<=(duration other) const { return value_ <= other.value_; }
    constexpr bool operator>(duration other) const { return value_ > other.value_; }
    constexpr bool operator>=(duration other) const { return value_ >= other.value_; }

    constexpr int64_t to_nsecs() const { return value_; }

    constexpr int64_t to_usecs() const { return value_ / ZX_USEC(1); }

    constexpr int64_t to_msecs() const { return value_ / ZX_MSEC(1); }

    constexpr int64_t to_secs() const { return value_ / ZX_SEC(1); }

    constexpr int64_t to_mins() const { return value_ / ZX_MIN(1); }

    constexpr int64_t to_hours() const { return value_ / ZX_HOUR(1); }

private:
    zx_duration_t value_ = 0;
};

class ticks final {
public:
    constexpr ticks() = default;

    explicit constexpr ticks(zx_ticks_t value)
        : value_(value) {}

    // Constructs a tick object for the current tick counter in the system.
    static ticks now() { return ticks(zx_ticks_get()); }

    // Returns the number of ticks contained within one second.
    static ticks per_second() { return ticks(zx_ticks_per_second()); }

    // Acquires the number of ticks contained within this object.
    constexpr zx_ticks_t get() const { return value_; }

    constexpr ticks operator+(ticks other) const {
        return ticks(value_ + other.value_);
    }

    constexpr ticks operator-(ticks other) const {
        return ticks(value_ - other.value_);
    }

    constexpr ticks operator*(uint64_t multiplier) const {
        return ticks(value_ * multiplier);
    }

    constexpr ticks operator/(uint64_t divisor) const {
        return ticks(value_ / divisor);
    }

    constexpr uint64_t operator/(ticks other) const {
        return value_ / other.value_;
    }

    constexpr ticks operator%(uint64_t divisor) const {
        return ticks(value_ % divisor);
    }

    constexpr uint64_t operator%(ticks other) const {
        return value_ % other.value_;
    }

    constexpr ticks& operator+=(ticks other) {
        value_ += other.value_;
        return *this;
    }

    constexpr ticks& operator-=(ticks other) {
        value_ -= other.value_;
        return *this;
    }

    constexpr ticks& operator*=(uint64_t multiplier) {
        value_ *= multiplier;
        return *this;
    }

    constexpr ticks& operator/=(uint64_t divisor) {
        value_ /= divisor;
        return *this;
    }

    constexpr ticks& operator%=(uint64_t divisor) {
        value_ %= divisor;
        return *this;
    }

    constexpr bool operator==(ticks other) const { return value_ == other.value_; }
    constexpr bool operator!=(ticks other) const { return value_ != other.value_; }
    constexpr bool operator<(ticks other) const { return value_ < other.value_; }
    constexpr bool operator<=(ticks other) const { return value_ <= other.value_; }
    constexpr bool operator>(ticks other) const { return value_ > other.value_; }
    constexpr bool operator>=(ticks other) const { return value_ >= other.value_; }

private:
    zx_ticks_t value_ = 0;
};

template <zx_clock_t kClockId>
class basic_time final {
public:
    constexpr basic_time() = default;

    explicit constexpr basic_time(zx_time_t value)
        : value_(value) {}

    static constexpr basic_time<kClockId> infinite() {
        return basic_time<kClockId>(ZX_TIME_INFINITE);
    }

    static constexpr basic_time<kClockId> infinite_past() {
        return basic_time<kClockId>(ZX_TIME_INFINITE_PAST);
    }

    constexpr zx_time_t get() const { return value_; }

    zx_time_t* get_address() { return &value_; }

    constexpr duration operator-(basic_time<kClockId> other) const {
        return duration(zx_time_sub_time(value_, other.value_));
    }

    constexpr basic_time<kClockId> operator+(duration delta) const {
        return basic_time<kClockId>(zx_time_add_duration(value_, delta.get()));
    }

    constexpr basic_time<kClockId> operator-(duration delta) const {
        return basic_time<kClockId>(zx_time_sub_duration(value_, delta.get()));
    }

    constexpr basic_time<kClockId>& operator+=(duration delta) {
        value_ = zx_time_add_duration(value_, delta.get());
        return *this;
    }

    constexpr basic_time<kClockId>& operator-=(duration delta) {
        value_ = zx_time_sub_duration(value_, delta.get());
        return *this;
    }

    constexpr bool operator==(basic_time<kClockId> other) const { return value_ == other.value_; }
    constexpr bool operator!=(basic_time<kClockId> other) const { return value_ != other.value_; }
    constexpr bool operator<(basic_time<kClockId> other) const { return value_ < other.value_; }
    constexpr bool operator<=(basic_time<kClockId> other) const { return value_ <= other.value_; }
    constexpr bool operator>(basic_time<kClockId> other) const { return value_ > other.value_; }
    constexpr bool operator>=(basic_time<kClockId> other) const { return value_ >= other.value_; }

private:
    zx_time_t value_ = 0;
};

template <zx_clock_t kClockId>
constexpr basic_time<kClockId> operator+(duration delta, basic_time<kClockId> time) {
    return time + delta;
}

using time = basic_time<ZX_CLOCK_MONOTONIC>;
using time_utc = basic_time<ZX_CLOCK_UTC>;
using time_thread = basic_time<ZX_CLOCK_THREAD>;

class clock final {
public:
    clock() = delete;

    template <zx_clock_t kClockId>
    static zx_status_t get(basic_time<kClockId>* result) {
        return zx_clock_get_new(kClockId, result->get_address());
    }

    static time get_monotonic() {
        return time(zx_clock_get_monotonic());
    }
};

constexpr inline duration nsec(int64_t n) {
    return duration(ZX_NSEC(n));
}

constexpr inline duration usec(int64_t n) {
    return duration(ZX_USEC(n));
}

constexpr inline duration msec(int64_t n) {
    return duration(ZX_MSEC(n));
}

constexpr inline duration sec(int64_t n) {
    return duration(ZX_SEC(n));
}

constexpr inline duration min(int64_t n) {
    return duration(ZX_MIN(n));
}

constexpr inline duration hour(int64_t n) {
    return duration(ZX_HOUR(n));
}

inline zx_status_t nanosleep(zx::time deadline) {
    return zx_nanosleep(deadline.get());
}

inline time deadline_after(zx::duration nanoseconds) {
    return time(zx_deadline_after(nanoseconds.get()));
}

} // namespace zx

#endif // LIB_ZX_TIME_H_