/**************************************************************************
 *
 * Copyright 2008 VMware, Inc.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/

/**
 * @file
 * OS independent time-manipulation functions.
 * 
 * @author Jose Fonseca <jfonseca@vmware.com>
 */

#ifndef U_TIME_H_
#define U_TIME_H_


#include "pipe/p_config.h"

#include "util/os_time.h"

#include "pipe/p_compiler.h"


#ifdef	__cplusplus
extern "C" {
#endif


/**
 * Time abstraction.
 * 
 * Do not access this structure directly. Use the provided function instead.
 */
struct util_time 
{
   int64_t counter;
};
   

PIPE_DEPRECATED
static inline void
util_time_get(struct util_time *t)
{
   t->counter = os_time_get();
}


/**
 * Return t2 = t1 + usecs
 */
PIPE_DEPRECATED
static inline void
util_time_add(const struct util_time *t1,
              int64_t usecs,
              struct util_time *t2)
{
   t2->counter = t1->counter + usecs;
}


/**
 * Return difference between times, in microseconds
 */
PIPE_DEPRECATED
static inline int64_t
util_time_diff(const struct util_time *t1, 
               const struct util_time *t2)
{
   return t2->counter - t1->counter;
}


/**
 * Compare two time values.
 *
 * Not publicly available because it does not take in account wrap-arounds.
 * Use util_time_timeout instead.
 */
static inline int
_util_time_compare(const struct util_time *t1,
                   const struct util_time *t2)
{
   if (t1->counter < t2->counter)
      return -1;
   else if(t1->counter > t2->counter)
      return 1;
   else
      return 0;
}


/**
 * Returns non-zero when the timeout expires.
 */
PIPE_DEPRECATED
static inline boolean
util_time_timeout(const struct util_time *start, 
                  const struct util_time *end,
                  const struct util_time *curr)
{
   return os_time_timeout(start->counter, end->counter, curr->counter);
}


/**
 * Return current time in microseconds
 */
PIPE_DEPRECATED
static inline int64_t
util_time_micros(void)
{
   return os_time_get();
}


PIPE_DEPRECATED
static inline void
util_time_sleep(int64_t usecs)
{
   os_time_sleep(usecs);
}


#ifdef	__cplusplus
}
#endif

#endif /* U_TIME_H_ */