Clock.hpp

Go to the documentation of this file.

/*
    Copyright (c) 2009-2010 Christopher A. Taylor.  All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name of LibCat nor the names of its contributors may be used
      to endorse or promote products derived from this software without
      specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef CAT_CLOCK_HPP
#define CAT_CLOCK_HPP

#include <cat/Platform.hpp>
#include <string>
#include <cat/threads/Mutex.hpp>

namespace cat {


class Clock
{
#ifdef CAT_OS_WINDOWS
    static Mutex init_lock;
    static u32 initialized; // Number of times initialized
    static u32 period; // timegettime() and Windows scheduler period
    static double inv_freq; // Performance counter frequency (does not change, so cache it)
#endif

public:
    static bool Initialize();
    static bool Shutdown();

    static u32 sec();     // timestamp in seconds
    static u32 msec_fast(); // timestamp in milliseconds, less accurate than msec() but faster
    static u32 msec();    // timestamp in milliseconds, must call Initialize() first
    static double usec(); // timestamp in microseconds, must call Initialize() first
    static u32 cycles();  // timestamp in cycles

    static std::string format(const char *format_string);

    static void sleep(u32 milliseconds);

    static bool SetHighPriority();
    static bool SetNormalPriority();

    static u32 MeasureClocks(int iterations, void (*FunctionPtr)());
};


} // namespace cat

#endif // CAT_CLOCK_HPP