add header to timing data output by --osh-time[-percent] (#91)

- add header to timing data output by --osh-time[-percent]
- tests that exercise --osh-time[-percent] [--osh-time-chop ##]
- better help string for --osh-time-chop ##

src/CMakeLists.txt

@@ -436,6 +436,10 @@ if(BUILD_TESTING)
   osh_add_exe(osh_scale2d)
   set(TEST_EXES ${TEST_EXES} osh_scale2d)
   test_func(osh_scale2d 1 ./osh_scale2d ${CMAKE_SOURCE_DIR}/meshes/plate_6elem.osh 100 plate_100.osh)
+  set(scale2dArgs ${CMAKE_SOURCE_DIR}/meshes/plate_6elem.osh 100 plate_100.osh)
+  test_func(osh_scale2d_time 1 ./osh_scale2d --osh-time ${scale2dArgs})
+  test_func(osh_scale2d_timepercent 1 ./osh_scale2d --osh-time-percent ${scale2dArgs})
+  test_func(osh_scale2d_timechop 1 ./osh_scale2d --osh-time --osh-time-chop 10 ${scale2dArgs})
 
   test_basefunc(run_arrayops 1 ./arrayops_test)
   set(TEST_EXES ${TEST_EXES} reprosum_test)

src/Omega_h_library.cpp

@@ -101,7 +101,7 @@ void Library::initialize(char const* head_desc, int* argc, char*** argv
   cmdline.add_flag(
       "--osh-time-percent", "print amount of time spend in certain functions by percentage");
   auto& osh_time_chop_flag = cmdline.add_flag(
-      "--osh-time-chop", "only print functions whose percent time is greater than given value (e.g. --osh-time-chop=2)");
+      "--osh-time-chop", "only print functions whose percent time is greater than given value (e.g. --osh-time[-percent] --osh-time-chop 2)");
   osh_time_chop_flag.add_arg<double>("0.0");
   cmdline.add_flag("--osh-time-with-filename", "add file name to function name in profile output");
 

src/Omega_h_profile.cpp

@@ -201,13 +201,17 @@ void print_top_down_and_bottom_up(History const& h, double total_runtime) {
   if (h.do_percent) {
     std::cout << std::setprecision(2) << std::fixed;
   }
+  std::stringstream header;
+  header << "(function_name time("
+         << (h.do_percent ? "% total time" : "seconds")
+         << ") number_of_calls)";
   std::cout << "\n";
-  std::cout << "TOP-DOWN:\n";
+  std::cout << "TOP-DOWN " << header.str() << ":\n";
   std::cout << "=========\n";
   print_time_sorted(h, total_runtime);
   auto h_inv = invert(h);
   std::cout << "\n";
-  std::cout << "BOTTOM-UP:\n";
+  std::cout << "BOTTOM-UP " << header.str() << ":\n";
   std::cout << "==========\n";
   print_time_sorted(h_inv, total_runtime);
   std::cout.flags(coutflags);