12ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca/************************************************************************** 22ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * 32ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * Copyright 2008-2010 VMware, Inc. 42ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * All Rights Reserved. 52ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * 62ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * Permission is hereby granted, free of charge, to any person obtaining a 72ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * copy of this software and associated documentation files (the 82ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * "Software"), to deal in the Software without restriction, including 92ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * without limitation the rights to use, copy, modify, merge, publish, 102ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * distribute, sub license, and/or sell copies of the Software, and to 112ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * permit persons to whom the Software is furnished to do so, subject to 122ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * the following conditions: 132ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * 142ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * The above copyright notice and this permission notice (including the 152ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * next paragraph) shall be included in all copies or substantial portions 162ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * of the Software. 172ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * 182ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 192ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 202ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 212ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR 222ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 232ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 242ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 252ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * 262ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca **************************************************************************/ 272ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 282ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca/** 292ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * @file 302ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * OS independent time-manipulation functions. 312ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * 322ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * @author Jose Fonseca <jfonseca@vmware.com> 332ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca */ 342ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 352ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#ifndef _OS_TIME_H_ 362ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#define _OS_TIME_H_ 372ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 382ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 392ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#include "pipe/p_config.h" 402ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 412ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#if defined(PIPE_OS_UNIX) 422ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca# include <unistd.h> /* usleep */ 432ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#endif 442ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 452ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#include "pipe/p_compiler.h" 462ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 472ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 48f025aec906fce0f2918b6f4acb15548dc957ba67Brian Paul#ifdef __cplusplus 492ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonsecaextern "C" { 502ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#endif 512ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 522ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 532ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca/* 54d296326e065ed9685bd27d62a3ba20d8a8996e6fJosé Fonseca * Get the current time in nanoseconds from an unknown base. 552ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca */ 562ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonsecaint64_t 57d296326e065ed9685bd27d62a3ba20d8a8996e6fJosé Fonsecaos_time_get_nano(void); 582ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 592ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 602ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca/* 61d296326e065ed9685bd27d62a3ba20d8a8996e6fJosé Fonseca * Get the current time in microseconds from an unknown base. 6216f0d70ffe6d42d22b9e6b927b297e75a199aa78James Benton */ 63a2a1a5805fd617e7f3cc8be44dd79b50da07ebb9Ilia Mirkinstatic inline int64_t 64f025aec906fce0f2918b6f4acb15548dc957ba67Brian Paulos_time_get(void) 65f025aec906fce0f2918b6f4acb15548dc957ba67Brian Paul{ 66f025aec906fce0f2918b6f4acb15548dc957ba67Brian Paul return os_time_get_nano() / 1000; 67d296326e065ed9685bd27d62a3ba20d8a8996e6fJosé Fonseca} 6816f0d70ffe6d42d22b9e6b927b297e75a199aa78James Benton 6916f0d70ffe6d42d22b9e6b927b297e75a199aa78James Benton 7016f0d70ffe6d42d22b9e6b927b297e75a199aa78James Benton/* 712ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * Sleep. 722ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca */ 732ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonsecavoid 742ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonsecaos_time_sleep(int64_t usecs); 752ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 762ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 772ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca/* 782ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * Helper function for detecting time outs, taking in account overflow. 792ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca * 80fab1f07d6ad01463897ae792f4b33738afb07369Jeff Smith * Returns true if the current time has elapsed beyond the specified interval. 812ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca */ 82a2a1a5805fd617e7f3cc8be44dd79b50da07ebb9Ilia Mirkinstatic inline boolean 832ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonsecaos_time_timeout(int64_t start, 842ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca int64_t end, 852ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca int64_t curr) 862ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca{ 87f025aec906fce0f2918b6f4acb15548dc957ba67Brian Paul if (start <= end) 882ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca return !(start <= curr && curr < end); 892ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca else 902ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca return !((start <= curr) || (curr < end)); 912ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca} 922ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 932ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 943836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák/** 957316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * Convert a relative timeout in nanoseconds into an absolute timeout, 967316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * in other words, it returns current time + timeout. 977316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * os_time_get_nano() must be monotonic. 987316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * PIPE_TIMEOUT_INFINITE is passed through unchanged. If the calculation 997316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * overflows, PIPE_TIMEOUT_INFINITE is returned. 1007316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák */ 1017316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšákint64_t 1027316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšákos_time_get_absolute_timeout(uint64_t timeout); 1037316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák 1047316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák 1057316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák/** 1063836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák * Wait until the variable at the given memory location is zero. 1073836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák * 1083836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák * \param var variable 1093836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák * \param timeout timeout in ns, can be anything from 0 (no wait) to 1103836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák * PIPE_TIME_INFINITE (wait forever) 1113836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák * \return true if the variable is zero 1123836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák */ 1133836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšákbool 1143836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšákos_wait_until_zero(volatile int *var, uint64_t timeout); 1153836857a777a248dd212ce7a1d7307d2984fda7dMarek Olšák 1167316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák 1177316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák/** 1187316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * Wait until the variable at the given memory location is zero. 1197316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * The timeout is the absolute time when the waiting should stop. If it is 1207316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * less than or equal to the current time, it only returns the status and 1217316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * doesn't wait. PIPE_TIME_INFINITE waits forever. This requires that 1227316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * os_time_get_nano is monotonic. 1237316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * 1247316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * \param var variable 1257316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * \param timeout the time in ns when the waiting should stop 1267316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák * \return true if the variable is zero 1277316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák */ 1287316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšákbool 1297316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšákos_wait_until_zero_abs_timeout(volatile int *var, int64_t timeout); 1307316cc92f3810c9e53a22c35343190d8fb7980beMarek Olšák 131f025aec906fce0f2918b6f4acb15548dc957ba67Brian Paul#ifdef __cplusplus 1322ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca} 1332ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#endif 1342ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca 1352ef6d311b7cba30deb3d7e38eec14cef89e7e579José Fonseca#endif /* _OS_TIME_H_ */ 136