perfmon.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// 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.1 of the License, 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



#ifndef LIBMESH_PERFMON_H
#define LIBMESH_PERFMON_H


// Local includes
#include "libmesh/libmesh_common.h"

#ifdef HAVE_PAPI_H
namespace Papi {
#  include <papi.h>
}
#endif

// C++ includes
#include <cstddef>
#include <string>
#ifdef LIBMESH_HAVE_SYS_TIME_H
#include <sys/time.h> // gettimeofday() on Unix
#endif
#ifndef LIBMESH_HAVE_GETTIMEOFDAY
#include "libmesh/win_gettimeofday.h" // gettimeofday() on Windows
#endif

namespace libMesh
{



class PerfMon
{
public:
  PerfMon  (std::string id,
            const unsigned int v=1,
            const unsigned int pid=0);

  ~PerfMon ();
  void reset ();
  double print (std::string msg="NULL",
                std::ostream & my_out = libMesh::out);

private:

  const std::string id_string;

  struct timeval the_time_start;
  struct timeval the_time_stop;

  const unsigned int verbose;
  const unsigned int proc_id;

#ifdef HAVE_PAPI_H
  float rtime, ptime, mflops;
  long long int flpins;
#endif
};



inline
void
PerfMon::reset ()
{
  gettimeofday (&the_time_start, nullptr);

#ifdef HAVE_PAPI_H
  Papi::PAPI_flops (&rtime, & ptime, &flpins, &mflops);
#endif
}



inline
double
PerfMon::print (std::string msg, std::ostream & my_out)
{
  gettimeofday (&the_time_stop, nullptr);

#ifdef HAVE_PAPI_H
  Papi::PAPI_flops (&rtime, & ptime, &flpins, &mflops);
#endif

  const double elapsed_time = ((double) (the_time_stop.tv_sec - the_time_start.tv_sec)) +
    ((double) (the_time_stop.tv_usec - the_time_start.tv_usec))/1000000.;

  if (verbose)
    {

      if (proc_id == 0)
        {
          if (msg == "NULL")
            my_out << " " << id_string
                   << ": elapsed time: "
                   << elapsed_time << " (sec)"
                   << std::endl;
          else
            my_out << " " << msg
                   << ": elapsed time: "
                   << elapsed_time << " (sec)"
                   << std::endl;

#ifdef HAVE_PAPI_H
          if (msg == "NULL")
            my_out << " " << id_string
                   << ": mflops: "
                   << mflops
                   << std::endl;
          else
            my_out << " " << msg
                   << ": mflops: "
                   << mflops
                   << std::endl;
#endif

        }
    }

  return elapsed_time;
}


inline
PerfMon::PerfMon (std::string id,
                  const unsigned int v,
                  const unsigned int pid) :
  id_string(id),
  verbose(v),
  proc_id(pid)
{
  reset ();
}



inline
PerfMon::~PerfMon ()
{
  print ();
}




} // namespace libMesh


#endif // LIBMESH_PERFMON_H