RhodeCode

/* -*- mode: C++; indent-tabs-mode: nil; -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library.

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#ifndef LEMON_TIME_MEASURE_H

#define LEMON_TIME_MEASURE_H

///\ingroup timecount

///\file

///\brief Tools for measuring cpu usage

#ifdef WIN32

#define WIN32_LEAN_AND_MEAN

#define NOMINMAX

#include <windows.h>

#include <cmath>

#else

#include <sys/times.h>

#include <sys/time.h>

#endif

#include <string>

#include <fstream>

#include <iostream>

namespace lemon {

  /// \addtogroup timecount

  /// @{

  /// A class to store (cpu)time instances.

  /// This class stores five time values.

  /// - a real time

  /// - a user cpu time

  /// - a system cpu time

  /// - a user cpu time of children

  /// - a system cpu time of children

  ///

  /// TimeStamp's can be added to or substracted from each other and

  /// they can be pushed to a stream.

  ///

  /// In most cases, perhaps the \ref Timer or the \ref TimeReport

  /// class is what you want to use instead.

  class TimeStamp

  {

    double utime;

    double stime;

    double cutime;

    double cstime;

    double rtime;

    void _reset() {

      utime = stime = cutime = cstime = rtime = 0;

    }

  public:

    ///Read the current time values of the process

    void stamp()

    {

#ifndef WIN32

      timeval tv;

      gettimeofday(&tv, 0);

      rtime=tv.tv_sec+double(tv.tv_usec)/1e6;

      tms ts;

      double tck=sysconf(_SC_CLK_TCK);

      times(&ts);

      utime=ts.tms_utime/tck;

      stime=ts.tms_stime/tck;

      cutime=ts.tms_cutime/tck;

      cstime=ts.tms_cstime/tck;

#else

      static const double ch = 4294967296.0e-7;

      static const double cl = 1.0e-7;

      FILETIME system;

      GetSystemTimeAsFileTime(&system);

      rtime = ch * system.dwHighDateTime + cl * system.dwLowDateTime;

      FILETIME create, exit, kernel, user;

      if (GetProcessTimes(GetCurrentProcess(),&create, &exit, &kernel, &user)) {

        utime = ch * user.dwHighDateTime + cl * user.dwLowDateTime;

        stime = ch * kernel.dwHighDateTime + cl * kernel.dwLowDateTime;

        cutime = 0;

        cstime = 0;

      } else {

        rtime = 0;

        utime = 0;

        stime = 0;

        cutime = 0;

        cstime = 0;

      }

#endif

    }

    /// Constructor initializing with zero

    TimeStamp()

    { _reset(); }

    ///Constructor initializing with the current time values of the process

    TimeStamp(void *) { stamp();}

    ///Set every time value to zero

    TimeStamp &reset() {_reset();return *this;}

    ///\e

    TimeStamp &operator+=(const TimeStamp &b)

    {

      utime+=b.utime;

      stime+=b.stime;

      cutime+=b.cutime;

      cstime+=b.cstime;

      rtime+=b.rtime;

      return *this;

    }

    ///\e

    TimeStamp operator+(const TimeStamp &b) const

    {

      TimeStamp t(*this);

      return t+=b;

    }

    ///\e

    TimeStamp &operator-=(const TimeStamp &b)

    {

      utime-=b.utime;

      stime-=b.stime;

      cutime-=b.cutime;

      cstime-=b.cstime;

      rtime-=b.rtime;

      return *this;

    }

    ///\e

    TimeStamp operator-(const TimeStamp &b) const

    {

      TimeStamp t(*this);

      return t-=b;

    }

    ///\e

    TimeStamp &operator*=(double b)

    {

      utime*=b;

      stime*=b;

      cutime*=b;

      cstime*=b;

      rtime*=b;

      return *this;

    }

    ///\e

    TimeStamp operator*(double b) const

    {

      TimeStamp t(*this);

      return t*=b;

    }

    friend TimeStamp operator*(double b,const TimeStamp &t);

    ///\e

    TimeStamp &operator/=(double b)

    {

      utime/=b;

      stime/=b;

      cutime/=b;

      cstime/=b;

      rtime/=b;

      return *this;

    }

    ///\e

    TimeStamp operator/(double b) const

    {

      TimeStamp t(*this);

      return t/=b;

    }

    ///The time ellapsed since the last call of stamp()

    TimeStamp ellapsed() const

    {

      TimeStamp t(NULL);

      return t-*this;

    }

    friend std::ostream& operator<<(std::ostream& os,const TimeStamp &t);

    ///Gives back the user time of the process

    double userTime() const

    {

      return utime;

    }

    ///Gives back the system time of the process

    double systemTime() const

    {

      return stime;

    }

    ///Gives back the user time of the process' children

    ///\note On <tt>WIN32</tt> platform this value is not calculated.

    ///

    double cUserTime() const

    {

      return cutime;

    }

    ///Gives back the user time of the process' children

    ///\note On <tt>WIN32</tt> platform this value is not calculated.

    ///

    double cSystemTime() const

    {

      return cstime;

    }

    ///Gives back the real time

    double realTime() const {return rtime;}