cds/os/win/timer.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_OS_WIN_TIMER_H
  32 #define CDSLIB_OS_WIN_TIMER_H
  33
  34 #ifndef CDSLIB_OS_TIMER_H
  35 #   error "<cds/os/timer.h> must be included"
  36 #endif
  37
  38 #ifndef NOMINMAX
  39 #   define NOMINMAX
  40 #endif
  41 #include <windows.h>
  42
  43 //@cond none
  44 namespace cds { namespace OS {
  45     CDS_CXX11_INLINE_NAMESPACE namespace Win32 {
  46
  47         /// High resolution timer
  48         /**
  49             Implementation of high resolution timer for Windows platforms.
  50             The implementation build on QueryPerformanceCounter API.
  51         */
  52         class Timer {
  53         public:
  54             typedef LARGE_INTEGER    native_timer_type        ;    ///< Native timer type
  55             typedef long long        native_duration_type    ;    ///< Native duration type
  56
  57         private:
  58             native_timer_type    m_nFrequency;
  59             native_timer_type    m_nStart;
  60
  61         public:
  62             Timer()
  63             {
  64                 ::QueryPerformanceFrequency( &m_nFrequency );
  65                 current( m_nStart );
  66             }
  67
  68             /// Places into \p tmr the current time in native Windows format
  69             static void current( native_timer_type& tmr )
  70             {
  71                 ::QueryPerformanceCounter( &tmr );
  72             }
  73
  74             /// Returns current time in native Windows format
  75             static native_timer_type current()
  76             {
  77                 native_timer_type    tmr;
  78                 current(tmr);
  79                 return tmr;
  80             }
  81
  82             /// Sets internal start time to current time. Returns duration from prevoius start time to current.
  83             double reset()
  84             {
  85                 native_timer_type nCur;
  86                 current( nCur );
  87                 double dblRet = double(nCur.QuadPart - m_nStart.QuadPart) / m_nFrequency.QuadPart;
  88                 m_nStart.QuadPart = nCur.QuadPart;
  89                 return dblRet;
  90             }
  91
  92             /// Translates \p dur from native format to seconds
  93             double duration( native_duration_type dur )
  94             {
  95                 return double( dur ) / m_nFrequency.QuadPart;
  96             }
  97
  98             /// Returns duration (in seconds) from start time to current
  99             double duration()
 100             {
 101                 return duration( native_duration() );
 102             }
 103
 104             /// Returns duration (in native format) from start time to current
 105             native_duration_type    native_duration()
 106             {
 107                 native_timer_type ts;
 108                 current( ts );
 109                 return native_duration( m_nStart, ts );
 110             }
 111
 112             /// Calculates duration (in native format) between \p nEnd and \p nStart
 113             static native_duration_type    native_duration( const native_timer_type& nStart, const native_timer_type& nEnd )
 114             {
 115                 return nEnd.QuadPart - nStart.QuadPart;
 116             }
 117
 118             static unsigned long long random_seed()
 119             {
 120                 return current().QuadPart;
 121             }
 122         };
 123
 124
 125     }   // namespace Win32
 126
 127 #ifndef CDS_CXX11_INLINE_NAMESPACE_SUPPORT
 128     typedef Win32::Timer    Timer;
 129 #endif
 130
 131 }}  // namespae cds::OS
 132 //@endcond
 133
 134 #endif // #ifndef CDSLIB_OS_WIN_TIMER_H