Time.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef TIME_H
#define TIME_H
#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/processor/types.h"
 
#include <config.h>
 
namespace Time {
typedef uint64_t Timestamp;
 
struct CpuTimeSample {
  Timestamp timestamp;
  // Processor::index() identifies the clock domain for migration checks.
  size_t processor;
};
 
namespace Multiplier {
const Timestamp Nanosecond = 1U;
const Timestamp Microsecond = 1000U;
const Timestamp Millisecond = 1000000U;
const Timestamp Second = Millisecond * 1000U;
const Timestamp Minute = Second * 60U;
const Timestamp Hour = Minute * 60U;
const Timestamp Day = Hour * 24U;
 
// slightly sanity check the above multiplications
static_assert(Microsecond == 1000,
              "Microsecond conversion multiplier to nanoseconds is incorrect.");
static_assert(Millisecond == 1000000,
              "Millisecond conversion multiplier to nanoseconds is incorrect.");
static_assert(Second == 1000000000, "Seconds conversion multiplier to nanoseconds is incorrect.");
}  // namespace Multiplier
 
const Timestamp Infinity = 0xFFFFFFFFFFFFFFFFULL;
 
EXPORTED_PUBLIC bool delay(Timestamp nanoseconds);
 
EXPORTED_PUBLIC void* addAlarm(Timestamp nanoseconds);
 
EXPORTED_PUBLIC void removeAlarm(void* handle);
 
#if HOSTED && PEDIGREE_HOSTED_SMOKE_TESTS
EXPORTED_PUBLIC size_t getHostedAlarmCreateCount();
EXPORTED_PUBLIC size_t getHostedAlarmDestroyCount();
#endif
 
EXPORTED_PUBLIC Timestamp getTime(bool sync = false);
 
EXPORTED_PUBLIC Timestamp getTimeNanoseconds(bool sync = false);
 
EXPORTED_PUBLIC bool setTimeNanoseconds(Timestamp value);
 
EXPORTED_PUBLIC bool anchorRealtime(Timestamp value);
 
EXPORTED_PUBLIC Timestamp getTicks();
 
EXPORTED_PUBLIC Timestamp getTicksFast();
 
EXPORTED_PUBLIC CpuTimeSample sampleCpuTime();
 
namespace Conversion {
EXPORTED_PUBLIC Timestamp toUnix(size_t second, size_t minute, size_t hour, size_t dom,
                                 size_t month, size_t year);
 
}  // namespace Conversion
 
}  // namespace Time
 
#endif