Changeset 8e24ef

Timestamp:

Apr 2, 2011, 12:20:10 AM (15 years ago)

Author:

Frederik Heber <heber@…>

Children:

bbd746

Parents:

93abe8

git-author:

Frederik Heber <heber@…> (03/15/11 09:53:34)

git-committer:

Frederik Heber <heber@…> (04/02/11 00:20:10)

Message:

Chronos is so far fully working.

• Library version is now 7:0:0, API version is 1.1.0.
• using either time.h or sys/times.h if present to measure timing.

Files:

• configure.ac (modified) (3 diffs)
• src/Helpers/Chronos.cpp (modified) (4 diffs)
• src/Helpers/Chronos.hpp (modified) (4 diffs)
• src/Helpers/Info.cpp (modified) (2 diffs)
• src/unittests/ChronosUnitTest.cpp (modified) (3 diffs)

configure.ac

@@ -3 +3 @@
 
 AC_PREREQ([2.65])
-AC_INIT([CodePatterns], [1.0.13], [heber@ins.uni-bonn.de], [codepatterns], [http://trac.ins.uni-bonn.de/projects/CodePatterns/])
+AC_INIT([CodePatterns], [1.1.0], [heber@ins.uni-bonn.de], [codepatterns], [http://trac.ins.uni-bonn.de/projects/CodePatterns/])
 AC_CONFIG_AUX_DIR(config)
 AC_CONFIG_SRCDIR([src/Patterns/Singleton_impl.hpp])
@@ -25 +25 @@
 # refer to the libtool manual, section "Updating library version information":
 # http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html
-AC_SUBST([CODEPATTERNS_SO_VERSION], [6:0:1])
-AC_SUBST([CODEPATTERNS_API_VERSION], [1.0.13])
+AC_SUBST([CODEPATTERNS_SO_VERSION], [7:0:0])
+AC_SUBST([CODEPATTERNS_API_VERSION], [1.1.0])
 
 # Checks for libraries.
@@ -41 +41 @@
 AC_C_INLINE
 AC_TYPE_SIZE_T
+AC_CHECK_HEADERS([sys/times.h])
 
 # Checks for library functions.

src/Helpers/Chronos.cpp

@@ -22 +22 @@
 #include <iostream>
 
+#ifdef HAVE_SYS_TIMES_H
+# include <sys/times.h>
+#else
+# include <time.h>
+#endif
+
 #include "Chronos.hpp"
 
@@ -32 +38 @@
 {}
 
-int Chronos::getTime(const std::string _name) const
+double Chronos::getTime(const std::string _name) const
 {
   // only those functions have a time that have run already
-  if (IsTimeRunning.count(_name)) {
+  if (TimeRunning.count(_name)) {
     // return -1 if function is currently running
-    if (!IsTimeRunning.count(_name))
+    if (TimeRunning.count(_name) != 0.)
       return AccountedTime.at(_name);
     else
-      return -1;
+      return -1.;
   }
-  return 0;
+  return 0.;
 }
 
 void Chronos::resetTime(const std::string _name)
 {
-  if (IsTimeRunning.count(_name)) {
-    AccountedTime[_name] = 0;
+  if (TimeRunning.count(_name)) {
+    AccountedTime[_name] = 0.;
   }
 }
@@ -55 +61 @@
 {
   // start time keeping
-  IsTimeRunning[_name] = true;
+  TimeRunning[_name] = getCurrentTime();
+}
+
+double Chronos::getCurrentTime() const
+{
+#ifdef HAVE_SYS_TIMES_H
+  struct tms *buffer = new tms;
+  double currenttime;
+  if (times(buffer) != (clock_t)(-1))
+    currenttime = ((double)buffer->tms_utime/(double)CLOCKS_PER_SEC);
+  else
+    currenttime = 0.;
+  delete buffer;
+#else
+  const double currenttime = (clock()/(double)CLOCKS_PER_SEC);
+#endif
+  //std::cout << "Current time is " << currenttime << std::endl;
+  return currenttime;
 }
 
 void Chronos::endTiming(const std::string _name)
 {
-  // finish time keeping if present
-  ASSERT(IsTimeRunning.count(_name), "Chronos::endTiming() - no timer under "+_name+" running.");
-  IsTimeRunning[_name] = false;
+  const double endtime = getCurrentTime();
+  const double starttime = TimeRunning[_name];
+
+  // if present
+  ASSERT(TimeRunning.count(_name), "Chronos::endTiming() - no timer under "+_name+" running.");
+  // finish time keeping
+  const double RunTime = ((double)endtime - starttime);
+  TimekeepingMap::iterator iter = AccountedTime.find(_name);
+  if (iter != AccountedTime.end())
+    AccountedTime[_name] += RunTime;
+  else
+    AccountedTime[_name] = RunTime;
+
+  // and zero for next run
+  TimeRunning[_name] = 0.;
 }
 
-int Chronos::SumUpTotalTime() const
+double Chronos::SumUpTotalTime() const
 {
-  int sum = 0;
+  double sum = 0.;
   for (TimekeepingMap::const_iterator iter = AccountedTime.begin();
       iter != AccountedTime.end();
@@ -78 +113 @@
 size_t Chronos::SumUpTotalFunctions() const
 {
-  return IsTimeRunning.size();
+  return TimeRunning.size();
 }
 
 std::ostream& operator<<(std::ostream &ost, const Chronos &_time)
 {
-  int sum = _time.SumUpTotalTime();
-  ost << "Total time passed: " << sum << std::endl;
+  ost << "List of functions present:" << std::endl;
+  for (Chronos::TimekeepingMap::const_iterator iter = _time.AccountedTime.begin();
+      iter != _time.AccountedTime.end();
+      ++iter)
+    ost << "\t" << iter->first << "\t" << iter->second << "s" << std::endl;
+  ost << "Total time passed: " << _time.SumUpTotalTime() << std::endl;
   ost << "Total functions: " << _time.SumUpTotalFunctions() << std::endl;
-
   return ost;
 }
 
+// construct the remainder of the singleton
+CONSTRUCT_SINGLETON(Chronos)
 
-CONSTRUCT_SINGLETON(Chronos)
+// catch if someone wants to use Info objects in here
+#ifdef INFO_HPP_
+BOOST_PP_ASSERT_MSG(1,\
+  ERROR: This is a safety measure to generate a compiler warning\n \
+  if you really try to use info.hpp in __FILE__.)
+#endif
+

src/Helpers/Chronos.hpp

@@ -26 +26 @@
   //!> unit tests needs access to private members
   friend class ChronosTest;
+  //!> operator needs to access some internals
+  friend std::ostream& operator<<(std::ostream &ost, const Chronos &_time);
 public :
 
@@ -33 +35 @@
    * @return current amount of time passed for this function, 0 if unknown, -1 if currently running
    */
-  int getTime(const std::string _name) const;
+  double getTime(const std::string _name) const;
 
   /** Resets time counter for this function \a _name to zero.
@@ -55 +57 @@
   /** Sums up total time accounted for.
    *
-   * @return total time
+   * @return total time in seconds
    */
-  int SumUpTotalTime() const;
+  double SumUpTotalTime() const;
 
   /** Sums up all functions accounted.
@@ -72 +74 @@
 
 private:
+  /** Returns the current timer in seconds.
+   *
+   * This function is present to allow for changing of time measurements
+   * without the other functions noticing.
+   *
+   * \note We convert clock() by CLOCKS_PER_SEC.
+   *
+   * @return current time in unit of seconds
+   */
+  double getCurrentTime() const;
 
-  typedef std::map<const std::string, int> TimekeepingMap;
-  typedef std::map<const std::string, bool> TimerStatusMap;
+
+  typedef std::map<const std::string, double> TimekeepingMap;
+  typedef std::map<const std::string, double> TimerStatusMap;
 
   TimekeepingMap AccountedTime;
-  TimerStatusMap IsTimeRunning;
+  TimerStatusMap TimeRunning;
 };
 

src/Helpers/Info.cpp

@@ -39 +39 @@
 {
   verbosity++;
-  DoLog(0) && (Log() << Verbose(0) << "Begin of " << FunctionName << endl);
+  LOG(0, "INFO: Begin of "+FunctionName);
 
   // one more info object
@@ -62 +62 @@
 
   // verbosity stuff
-  DoLog(0) && (Log() << Verbose(0) << "End of " << FunctionName << endl);
+  LOG(0, "INFO: End of "+FunctionName);
   verbosity--;
 

src/unittests/ChronosUnitTest.cpp

@@ -40 +40 @@
 {
   Info FunctionInfo(__func__);
+  for (int i=0;i<10000000;++i)
+    std::cout << "";
 }
 
@@ -45 +47 @@
 {
   Info FunctionInfo(__func__);
+  for (int i=0;i<1000000;++i)
+    std::cout << "";
 }
 
@@ -80 +84 @@
 void ChronosTest::dummyTest()
 {
+  double timings[4];
   // first dummy
   dummy();
-  CPPUNIT_ASSERT( Chronos::getInstance().IsTimeRunning.find(std::string("dummy"))
-      != Chronos::getInstance().IsTimeRunning.end() );
+  CPPUNIT_ASSERT( Chronos::getInstance().TimeRunning.find(std::string("dummy"))
+      != Chronos::getInstance().TimeRunning.end() );
   CPPUNIT_ASSERT_EQUAL( (size_t) 1, Chronos::getInstance().SumUpTotalFunctions() );
+  timings[0] = Chronos::getInstance().AccountedTime[std::string("dummy")];
+  std::cout << "Timing[0]: " << timings[0] << std::endl;
+  CPPUNIT_ASSERT(timings[0] > 0.);
   dummy();
   // second call goes to same entry
   CPPUNIT_ASSERT_EQUAL( (size_t) 1, Chronos::getInstance().SumUpTotalFunctions() );
+  timings[1] = Chronos::getInstance().AccountedTime[std::string("dummy")] - timings[0];
+  std::cout << "Timing[1]: " << timings[1] << std::endl;
+  CPPUNIT_ASSERT(timings[1] > 0.);
+
 
   // second dummy
   dummy_two();
-  CPPUNIT_ASSERT( Chronos::getInstance().IsTimeRunning.find(std::string("dummy_two"))
-      != Chronos::getInstance().IsTimeRunning.end() );
+  CPPUNIT_ASSERT( Chronos::getInstance().TimeRunning.find(std::string("dummy_two"))
+      != Chronos::getInstance().TimeRunning.end() );
   CPPUNIT_ASSERT_EQUAL( (size_t) 2, Chronos::getInstance().SumUpTotalFunctions() );
+  timings[2] = Chronos::getInstance().AccountedTime[std::string("dummy_two")];
+  std::cout << "Timing[2]: " << timings[2] << std::endl;
+  CPPUNIT_ASSERT(timings[2] > 0.);
+
+  // "inline" dummy
+  {
+    Info DummyInfo("dummy_three");
+    for (int i=0;i<1000000;++i)
+      std::cout << "";
+  }
+  CPPUNIT_ASSERT( Chronos::getInstance().TimeRunning.find(std::string("dummy_three"))
+      != Chronos::getInstance().TimeRunning.end() );
+  CPPUNIT_ASSERT_EQUAL( (size_t) 3, Chronos::getInstance().SumUpTotalFunctions() );
+  timings[3] = Chronos::getInstance().AccountedTime[std::string("dummy_three")];
+  std::cout << "Timing[3]: " << timings[3] << std::endl;
+  CPPUNIT_ASSERT(timings[3] > 0.);
+
+  // check summing of times
+  CPPUNIT_ASSERT_EQUAL( timings[0] + timings[1] + timings[2] + timings[3], Chronos::getInstance().SumUpTotalTime());
+
+  std::cout << Chronos::getInstance() << std::endl;
 }