Blame tmv.h

Packit 9c3e7e
/**
Packit 9c3e7e
 * @file tmv.h
Packit 9c3e7e
 * @brief Implements an abstract time value type.
Packit 9c3e7e
 * @note Copyright (C) 2011 Richard Cochran <richardcochran@gmail.com>
Packit 9c3e7e
 *
Packit 9c3e7e
 * This program is free software; you can redistribute it and/or modify
Packit 9c3e7e
 * it under the terms of the GNU General Public License as published by
Packit 9c3e7e
 * the Free Software Foundation; either version 2 of the License, or
Packit 9c3e7e
 * (at your option) any later version.
Packit 9c3e7e
 *
Packit 9c3e7e
 * This program is distributed in the hope that it will be useful,
Packit 9c3e7e
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 9c3e7e
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit 9c3e7e
 * GNU General Public License for more details.
Packit 9c3e7e
 *
Packit 9c3e7e
 * You should have received a copy of the GNU General Public License along
Packit 9c3e7e
 * with this program; if not, write to the Free Software Foundation, Inc.,
Packit 9c3e7e
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Packit 9c3e7e
 */
Packit 9c3e7e
#ifndef HAVE_TMV_H
Packit 9c3e7e
#define HAVE_TMV_H
Packit 9c3e7e
Packit 9c3e7e
#include <time.h>
Packit 9c3e7e
Packit 9c3e7e
#include "ddt.h"
Packit 9c3e7e
#include "pdt.h"
Packit 9c3e7e
Packit 9c3e7e
#define NS_PER_SEC 1000000000LL
Packit 9c3e7e
Packit 9c3e7e
/**
Packit 9c3e7e
 * We implement the time value as a 64 bit signed integer containing
Packit 9c3e7e
 * nanoseconds. Using this representation, we could really spare the
Packit 9c3e7e
 * arithmetic functions such as @ref tmv_add() and the like, and just
Packit 9c3e7e
 * use plain old math operators in the code.
Packit 9c3e7e
 *
Packit 9c3e7e
 * However, we are going to be a bit pedantic here and enforce the
Packit 9c3e7e
 * use of the these functions, so that we can easily upgrade the code
Packit 9c3e7e
 * to a finer representation later on. In that way, we can make use of
Packit 9c3e7e
 * the fractional nanosecond parts of the correction fields, if and
Packit 9c3e7e
 * when people start asking for them.
Packit 9c3e7e
 */
Packit 9c3e7e
typedef struct {
Packit 9c3e7e
	int64_t ns;
Packit 9c3e7e
} tmv_t;
Packit 9c3e7e
Packit 9c3e7e
static inline tmv_t tmv_add(tmv_t a, tmv_t b)
Packit 9c3e7e
{
Packit 9c3e7e
	tmv_t t;
Packit 9c3e7e
	t.ns = a.ns + b.ns;
Packit 9c3e7e
	return t;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline tmv_t tmv_div(tmv_t a, int divisor)
Packit 9c3e7e
{
Packit 9c3e7e
	tmv_t t;
Packit 9c3e7e
	t.ns = a.ns / divisor;
Packit 9c3e7e
	return t;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline int tmv_cmp(tmv_t a, tmv_t b)
Packit 9c3e7e
{
Packit 9c3e7e
	return a.ns == b.ns ? 0 : a.ns > b.ns ? +1 : -1;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline int tmv_sign(tmv_t x)
Packit 9c3e7e
{
Packit 9c3e7e
	return x.ns == 0 ? 0 : x.ns > 0 ? +1 : -1;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline int tmv_is_zero(tmv_t x)
Packit 9c3e7e
{
Packit 9c3e7e
	return x.ns == 0 ? 1 : 0;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline tmv_t tmv_sub(tmv_t a, tmv_t b)
Packit 9c3e7e
{
Packit 9c3e7e
	tmv_t t;
Packit 9c3e7e
	t.ns = a.ns - b.ns;
Packit 9c3e7e
	return t;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline tmv_t tmv_zero(void)
Packit 9c3e7e
{
Packit 9c3e7e
	tmv_t t = { 0 };
Packit 9c3e7e
	return t;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline tmv_t correction_to_tmv(Integer64 c)
Packit 9c3e7e
{
Packit 9c3e7e
	tmv_t t;
Packit 9c3e7e
	t.ns = (c >> 16);
Packit 9c3e7e
	return t;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline double tmv_dbl(tmv_t x)
Packit 9c3e7e
{
Packit 9c3e7e
	return (double) x.ns;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline tmv_t dbl_tmv(double x)
Packit 9c3e7e
{
Packit 9c3e7e
	tmv_t t;
Packit 9c3e7e
	t.ns = x;
Packit 9c3e7e
	return t;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline int64_t tmv_to_nanoseconds(tmv_t x)
Packit 9c3e7e
{
Packit 9c3e7e
	return x.ns;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline TimeInterval tmv_to_TimeInterval(tmv_t x)
Packit 9c3e7e
{
Packit 9c3e7e
	return x.ns << 16;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline struct Timestamp tmv_to_Timestamp(tmv_t x)
Packit 9c3e7e
{
Packit 9c3e7e
	struct Timestamp result;
Packit 9c3e7e
	uint64_t sec, nsec;
Packit 9c3e7e
Packit 9c3e7e
	sec  = x.ns / 1000000000ULL;
Packit 9c3e7e
	nsec = x.ns % 1000000000ULL;
Packit 9c3e7e
Packit 9c3e7e
	result.seconds_lsb = sec & 0xFFFFFFFF;
Packit 9c3e7e
	result.seconds_msb = (sec >> 32) & 0xFFFF;
Packit 9c3e7e
	result.nanoseconds = nsec;
Packit 9c3e7e
Packit 9c3e7e
	return result;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline tmv_t timespec_to_tmv(struct timespec ts)
Packit 9c3e7e
{
Packit 9c3e7e
	tmv_t t;
Packit 9c3e7e
	t.ns = ts.tv_sec * NS_PER_SEC + ts.tv_nsec;
Packit 9c3e7e
	return t;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
static inline tmv_t timestamp_to_tmv(struct timestamp ts)
Packit 9c3e7e
{
Packit 9c3e7e
	tmv_t t;
Packit 9c3e7e
	t.ns = ts.sec * NS_PER_SEC + ts.nsec;
Packit 9c3e7e
	return t;
Packit 9c3e7e
}
Packit 9c3e7e
Packit 9c3e7e
#endif