benchmark.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_SYSTEM_TIMER_H
# include <BALL/SYSTEM/timer.h>
#endif

#include <string>

#define START_SECTION(name, weight) \
  BENCHMARK::section_time = BENCHMARK::timer.getCPUTime();\
  BENCHMARK::section_name = #name;\
  BENCHMARK::section_weight = weight;


#define END_SECTION \
  BENCHMARK::timer.stop();\
  BENCHMARK::section_time = BENCHMARK::timer.getCPUTime() - BENCHMARK::section_time;\
  if (BENCHMARK::verbose > 0)\
  {\
    std::cout << BENCHMARK::section_name << ": " \
      << BENCHMARK::section_time << " s"\
      << " (weight = " << BENCHMARK::section_weight << ")" << std::endl;\
  }\
  BENCHMARK::total_time += BENCHMARK::section_time * BENCHMARK::section_weight;\


#define STATUS(a) \
  if (BENCHMARK::verbose > 0)\
  {\
    std::cout << "  status: " << a << std::endl;\
  }


#define START_TIMER \
  BENCHMARK::timer.start();\


#define STOP_TIMER \
  BENCHMARK::timer.stop();

#define START_BENCHMARK(class_name, overall_weight, version)\
/* define a special namespace for all internal variables */\
/* to avoid potential collisions                         */\
namespace BENCHMARK {\
  int           verbose = 0;\
  bool          all_tests = true;\
  int           exception = 0;\
  string        exception_name = "";\
  const char*   version_string = version;\
  string        section_name = "";\
  float         section_weight = 1.0;\
  float         weight = overall_weight;\
  float         total_time;\
  float         section_time;\
  BALL::Timer   timer;\
}\
\
\
int main(int argc, char **argv)\
{\
\
  if (argc == 2) {\
    if (!strcmp(argv[1], "-v"))\
      BENCHMARK::verbose = 1;\
  };\
\
  if ((argc > 2) || ((argc == 2) && (BENCHMARK::verbose == 0))) {\
    std::cerr << "Execute a benchmark for the " #class_name " class." << std::endl;\
    std::cerr << "Overall weight of the test: " << BENCHMARK::weight << std::endl;\
\
    std::cerr << "On successful operation, the total CPU time (in seconds)," << std::endl;\
    std::cerr << "is printed." << std::endl;\
    std::cerr << "If called with an argument of -v, " << argv[0] << " detailed" << std::endl;\
    std::cerr << "information about individual benchmarks is printed." << std::endl;\
    return 1;\
  }\
\
  if (BENCHMARK::verbose > 0)\
    std::cout << "Version: " << BENCHMARK::version_string << std::endl;\
\
  try {\


#define END_BENCHMARK \
  /* global try block */\
  }\
  /* catch FileNotFound exceptions to print out the file name */\
  catch (BALL::Exception::FileNotFound& e)\
  {\
    BENCHMARK::all_tests = false;\
    if (BENCHMARK::verbose > 1)\
    {\
      if (BENCHMARK::exception == 1) /* dummy to avoid compiler warnings */\
        BENCHMARK::exception++;\
      std::cout << std::endl << "    (caught exception of type ";\
      std::cout << e.getName();\
      if ((e.getLine() > 0) && (!(e.getFile() == "")))\
        std::cout << " outside a benchmark block, which was thrown in line " << e.getLine() << " of file " << e.getFile();\
      std::cout << " while looking for file " << e.getFilename();\
      std::cout << " - unexpected!) " << std::endl;\
    }\
  }\
  /* catch BALL exceptions to retrieve additional information */\
  catch (BALL::Exception::GeneralException& e)\
  {\
    BENCHMARK::all_tests = false;\
    if (BENCHMARK::verbose > 1)\
    {\
      if (BENCHMARK::exception == 1) /* dummy to avoid compiler warnings */\
        BENCHMARK::exception++;\
      std::cout << std::endl << "    (caught exception of type ";\
      std::cout << e.getName();\
      if ((e.getLine() > 0) && (!(e.getFile() == "")))\
        std::cout << " outside a benchmark block, which was thrown in line " << e.getLine() << " of file " << e.getFile();\
      std::cout << " - unexpected!) " << std::endl;\
    }\
  }\
  /* catch all non-BALL exceptions */\
  catch (...)\
  {\
    BENCHMARK::all_tests = false;\
    if (BENCHMARK::verbose > 1)\
    {\
      std::cout << std::endl << "    (caught unidentified and unexpected exception outside a benchmark block!) " << std::endl;\
    }\
  }\
\
  /* check for exit code */\
  if (!BENCHMARK::all_tests)\
  {\
    std::cout << "(" << BENCHMARK::weight * BENCHMARK::total_time << ")" << std::endl;\
    return 1;\
  } else {\
    std::cout << BENCHMARK::weight * BENCHMARK::total_time << std::endl;\
    return 0;\
  }\
}\