os_time.h revision 16f0d70ffe6d42d22b9e6b927b297e75a199aa78 
1/**************************************************************************
2 *
3 * Copyright 2008-2010 VMware, Inc.
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 VMWARE 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 <jfonseca@vmware.com>
33 */
34
35#ifndef _OS_TIME_H_
36#define _OS_TIME_H_
37
38
39#include "pipe/p_config.h"
40
41#if defined(PIPE_OS_UNIX)
42#  include <unistd.h> /* usleep */
43#endif
44
45#include "pipe/p_compiler.h"
46
47
48#ifdef	__cplusplus
49extern "C" {
50#endif
51
52
53/*
54 * Get the current time in microseconds from an unknown base.
55 */
56int64_t
57os_time_get(void);
58
59
60/*
61 * Get the current time in nanoseconds from an unknown base.
62 */
63uint64_t
64os_time_get_nano(void);
65
66
67/*
68 * Sleep.
69 */
70#if defined(PIPE_OS_UNIX)
71#define os_time_sleep(_usecs) usleep(_usecs)
72#else
73void
74os_time_sleep(int64_t usecs);
75#endif
76
77
78/*
79 * Helper function for detecting time outs, taking in account overflow.
80 *
81 * Returns true if the current time has elapsed beyond the specified interval.
82 */
83static INLINE boolean
84os_time_timeout(int64_t start,
85                int64_t end,
86                int64_t curr)
87{
88   if(start <= end)
89      return !(start <= curr && curr < end);
90   else
91      return !((start <= curr) || (curr < end));
92}
93
94
95#ifdef	__cplusplus
96}
97#endif
98
99#endif /* _OS_TIME_H_ */
100