src/gallium/auxiliary/util/u_time.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * @file
  30  * OS independent time-manipulation functions.
  31  *
  32  * @author Jose Fonseca <jrfonseca@tungstengraphics.com>
  33  */
  34
  35 #ifndef U_TIME_H_
  36 #define U_TIME_H_
  37
  38
  39 #include "pipe/p_config.h"
  40
  41 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE)
  42 #include <time.h> /* timeval */
  43 #include <unistd.h> /* usleep */
  44 #endif
  45
  46 #if defined(PIPE_OS_HAIKU)
  47 #include <sys/time.h> /* timeval */
  48 #include <unistd.h>
  49 #endif
  50
  51 #include "pipe/p_compiler.h"
  52
  53
  54 #ifdef  __cplusplus
  55 extern "C" {
  56 #endif
  57
  58
  59 /**
  60  * Time abstraction.
  61  *
  62  * Do not access this structure directly. Use the provided function instead.
  63  */
  64 struct util_time
  65 {
  66 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU)
  67    struct timeval tv;
  68 #else
  69    int64_t counter;
  70 #endif
  71 };
  72
  73
  74 void
  75 util_time_get(struct util_time *t);
  76
  77 /**
  78  * Return t2 = t1 + usecs
  79  */
  80 void
  81 util_time_add(const struct util_time *t1,
  82               int64_t usecs,
  83               struct util_time *t2);
  84
  85 /**
  86  * Return current time in microseconds
  87  */
  88 uint64_t
  89 util_time_micros( void );
  90
  91 /**
  92  * Return difference between times, in microseconds
  93  */
  94 int64_t
  95 util_time_diff(const struct util_time *t1,
  96                const struct util_time *t2);
  97
  98 /**
  99  * Returns non-zero when the timeout expires.
 100  */
 101 boolean
 102 util_time_timeout(const struct util_time *start,
 103                   const struct util_time *end,
 104                   const struct util_time *curr);
 105
 106 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE) || defined(PIPE_OS_HAIKU)
 107 #define util_time_sleep usleep
 108 #else
 109 void
 110 util_time_sleep(unsigned usecs);
 111 #endif
 112
 113
 114 #ifdef  __cplusplus
 115 }
 116 #endif
 117
 118 #endif /* U_TIME_H_ */