Resources.h

// Resources.h -- Interface to a class used to measure resource usage.

/*
 * Copyright (C) 1997, 1998, 2003 Tudor Hulubei <tudor@hulubei.net>.
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA,
 * 02111-1307, USA.
 */

/*
 * NOTE: This is an interal header file.
 * You should not attempt to use it directly.
 */

// $Id: Resources_8h-source.html,v 1.1 2005/05/25 12:37:18 tudor Exp $

#ifndef _CSP_KERNEL_Resources_H
#define _CSP_KERNEL_Resources_H


#ifndef _WIN32
#ifdef TIME_WITH_SYS_TIME
#include <sys/time.h>
#include <time.h>
#else
#ifdef CSP_HAVE_SYS_TIME_H
#include <sys/time.h>
#else
#include <time.h>
#endif
#endif
#endif // !_WIN32

#ifndef _WIN32
#include <sys/resource.h>
#endif // !_WIN32


#ifdef _MSC_VER
// Visual C++ doesn't provide rusage.  I copied it here from Linux.
struct rusage
{
    struct timeval ru_utime; /* user time used */
    struct timeval ru_stime; /* system time used */
    long ru_maxrss; /* maximum resident set size */
    long ru_ixrss; /* integral shared memory size */
    long ru_idrss; /* integral unshared data size */
    long ru_isrss; /* integral unshared stack size */
    long ru_minflt; /* page reclaims */
    long ru_majflt; /* page faults */
    long ru_nswap; /* swaps */
    long ru_inblock; /* block input operations */
    long ru_oublock; /* block output operations */
    long ru_msgsnd; /* messages sent */
    long ru_msgrcv; /* messages received */
    long ru_nsignals; /* signals received */
    long ru_nvcsw; /* voluntary context switches */
    long ru_nivcsw; /* involuntary context switches */
};
#endif // _MSC_VER


CSP_NAMESPACE_BEGIN(csp);


class CSP_API Resources
{
  public:
    Resources(bool max = false);

    /*
     * Start recording resource usage.  All previously collected
     * resource usages are deleted.
     */
    void start();

    void record();

    void stop();

    void resume(bool countBreakResources = false);

    const timeval userTime() const;

    const timeval systemTime() const;

    const timeval totalTime() const;

    const timeval realTime() const;

    long memory() const;
    long text() const;
    long data() const;
    long stack() const;
    long minorPageFaults() const;
    long majorPageFaults() const;
    long swaps() const;
    long inputBlocks() const;
    long outputBlocks() const;
    long messagesSent() const;
    long messagesReceived() const;
    long signalsReceived() const;
    long voluntaryContextSwitches() const;
    long involuntaryContextSwitches() const;

    static void add(
        const timeval& time1,
        const timeval& time2,
        timeval& result);

    static void substract(
        const timeval& final,
        const timeval& initial,
        timeval& result);

    static int compare(
        const timeval& t1,
        const timeval& t2);

    wostream& print(wostream& wos) const;

    friend CSP_API wostream& operator<<(
        wostream& wos, const Resources& resources)
    {
        return resources.print(wos);
    }

  protected:
    enum state_t { Started, Stopped };

    void read(timeval& timeStamp, rusage& resourceUsage, bool initialReading);

    static void move(
        timeval& initial,
        timeval& final,
        timeval& newFinal);

    static wostream& printTime(wostream& wos, const timeval& tv);

  private:
    rusage m_initialResourceUsage;

    rusage m_finalResourceUsage;

    timeval m_initialTimeStamp;

    timeval m_finalTimeStamp;

    state_t m_state;
};


CSP_NAMESPACE_END(csp);


#endif // _CSP_KERNEL_Resources_H

// Local Variables:
// mode: C++
// End:

---