Home | History | Annotate | Line # | Download | only in programs 
      1 /*
      2  * Copyright (c) Meta Platforms, Inc. and affiliates.
      3  * All rights reserved.
      4  *
      5  * This source code is licensed under both the BSD-style license (found in the
      6  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
      7  * in the COPYING file in the root directory of this source tree).
      8  * You may select, at your option, one of the above-listed licenses.
      9  */
     10 
     11 #ifndef TIME_FN_H_MODULE_287987
     12 #define TIME_FN_H_MODULE_287987
     13 
     14 /*-****************************************
     15 *  Types
     16 ******************************************/
     17 
     18 #if !defined (__VMS) && (defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) )
     19 # if defined(_AIX)
     20 #  include <inttypes.h>
     21 # else
     22 #  include <stdint.h> /* uint64_t */
     23 # endif
     24   typedef uint64_t           PTime;  /* Precise Time */
     25 #else
     26   typedef unsigned long long PTime;  /* does not support compilers without long long support */
     27 #endif
     28 
     29 /* UTIL_time_t contains a nanosecond time counter.
     30  * The absolute value is not meaningful.
     31  * It's only valid to compute the difference between 2 measurements. */
     32 typedef struct { PTime t; } UTIL_time_t;
     33 #define UTIL_TIME_INITIALIZER { 0 }
     34 
     35 
     36 /*-****************************************
     37 *  Time functions
     38 ******************************************/
     39 
     40 UTIL_time_t UTIL_getTime(void);
     41 
     42 /* Timer resolution can be low on some platforms.
     43  * To improve accuracy, it's recommended to wait for a new tick
     44  * before starting benchmark measurements */
     45 void UTIL_waitForNextTick(void);
     46 /* tells if timefn will return correct time measurements
     47  * in presence of multi-threaded workload.
     48  * note : this is not the case if only C90 clock_t measurements are available */
     49 int UTIL_support_MT_measurements(void);
     50 
     51 PTime UTIL_getSpanTimeNano(UTIL_time_t clockStart, UTIL_time_t clockEnd);
     52 PTime UTIL_clockSpanNano(UTIL_time_t clockStart);
     53 
     54 PTime UTIL_getSpanTimeMicro(UTIL_time_t clockStart, UTIL_time_t clockEnd);
     55 PTime UTIL_clockSpanMicro(UTIL_time_t clockStart);
     56 
     57 #define SEC_TO_MICRO ((PTime)1000000)  /* nb of microseconds in a second */
     58 
     59 #endif /* TIME_FN_H_MODULE_287987 */
     60