Add ability for users to specify PAPI events in Dr Hook

src/fiat/drhook/drhook.c

@@ -2028,11 +2028,11 @@ signal_drhook_init(int enforce)
   char *env = getenv("DR_HOOK_SILENT");
   int silent = env ? atoi(env) : 0;
   int j;
-  dr_hook_procinfo_(&myproc, &nproc);
-  if (myproc < 1) myproc = 1; /* Just to enable output as if myproc was == 1 */
+  int mpi_init;
+  dr_hook_procinfo_(&myproc, &nproc, &mpi_init);
   /* Signals may not yet been set, since MPI not initialized
-     Only enforce-parameter can enforce to set these => no output on myproc=1 */
-  if (!enforce && (myproc < 1 || nproc < 0)) return;
+     Enforce parameter for setting signals regardless of MPI state */
+  if (!enforce && !mpi_init) return;
   if (signals_set) return; /* Extra safety */
   /* To present sumpini.F90 (f.ex.) initializing DrHook-signals in case of
      DR_HOOK was turned off (=0), then set also export DR_HOOK_INIT_SIGNALS=0 */
@@ -2759,6 +2759,10 @@ process_options()
           p++;
         }
         p = strtok(s,delim);
+        if (p && fp) {
+          fprintf(fp,"%s %s [%s@%s:%d]",pfx,TIMESTR(tid),FFL);
+          newline = 1;
+        }
         for (int i = 0; p && i < drhook_papi_max_num_counters();  p = strtok(NULL,delim), i++) {
           drhook_papi_add_counter_name(strdup_drhook(p));
           OPTPRINT(fp,"%s%s",comma,p); comma = ",";
@@ -2934,7 +2938,7 @@ getkey(int tid, const char *name, int name_len,
         }
 #if defined(DR_HOOK_HAVE_NVTX)
         // Helps filter out wrapper calls that may be noise
-        if (opt_nvtx && drhook_oml_get_thread_num() == 1){
+        if (opt_nvtx && tid == 1){
           if (keyptr->calls > opt_nvtx_SCC && keyptr->delta_wall_all < opt_nvtx_SWT) {
             if (!opt_silent)
               fprintf(stderr,"DRHOOK:NVTX: Skipping opening of region %s\n", keyptr->name);

src/fiat/drhook/extensions/papi/drhook_papi.h

@@ -18,6 +18,7 @@
 int drhook_papi_init(int rank);
 int drhook_papi_num_counters();
 int drhook_papi_max_num_counters();
+int drhook_papi_max_name_len();
 void drhook_papi_counter_name(int c, char* event_name);
 void drhook_papi_add_counter_name(const char* counter_name);
 long_long drhook_papi_read(int counterId);

src/fiat/drhook/internal/dr_hook_procinfo.F90

@@ -8,15 +8,15 @@
 ! nor does it submit to any jurisdiction.
 !
 
-SUBROUTINE DR_HOOK_PROCINFO(KMYPROC, KNPROC)
+SUBROUTINE DR_HOOK_PROCINFO(KMYPROC, KNPROC, LMPI_INITIALIZED)
 USE EC_PARKIND  ,ONLY : JPIM
 USE MPL_MPIF
 IMPLICIT NONE
-INTEGER(KIND=JPIM),INTENT(OUT) :: KMYPROC, KNPROC
-LOGICAL :: LMPI_INITIALIZED
+INTEGER(KIND=JPIM), INTENT(OUT) :: KMYPROC, KNPROC
+LOGICAL, INTENT(OUT) :: LMPI_INITIALIZED
 INTEGER(KIND=JPIM) :: IERROR
 
-KMYPROC=-1
+KMYPROC=1
 KNPROC=1
 CALL MPI_INITIALIZED(LMPI_INITIALIZED,IERROR)
 IF( LMPI_INITIALIZED ) THEN

src/fiat/include/fiat/drhook.h

@@ -187,7 +187,7 @@ dr_hook_prt_(const int *ftnunitno,
              , int s_len);
 
 extern void
-dr_hook_procinfo_(int *myproc, int *nproc);
+dr_hook_procinfo_(int *myproc, int *nproc, int *mpi_init);
 
 #ifdef __cplusplus
 } // extern "C"

tests/drhook/CMakeLists.txt

@@ -86,7 +86,7 @@ if (HAVE_DR_HOOK_NVTX)
   add_subdirectory(drhook_nvtx)
 endif ()
 
-  # PAPI
-  if (HAVE_DR_HOOK_PAPI)
-    add_subdirectory(drhook_papi)
-  endif ()
+# PAPI
+if (HAVE_DR_HOOK_PAPI)
+  add_subdirectory(drhook_papi)
+endif ()

tests/drhook/drhook_papi/CMakeLists.txt

@@ -64,9 +64,11 @@ ecbuild_add_test( TARGET fiat_test_drhook_papi_mpi_valid_csv
         ENVIRONMENT DR_HOOK=1 DR_HOOK_OPT=COUNTERS
         CONDITION HAVE_DR_HOOK_PAPI AND HAVE_MPI )
 
-set_tests_properties(fiat_test_drhook_papi_mpi_valid_csv
-        PROPERTIES DEPENDS fiat_test_drhook_papi_mpi
-        PASS_REGULAR_EXPRESSION "5" )
+if (HAVE_MPI)
+    set_tests_properties(fiat_test_drhook_papi_mpi_valid_csv
+            PROPERTIES DEPENDS fiat_test_drhook_papi_mpi
+            PASS_REGULAR_EXPRESSION "5" )
+endif()
 
 # Test user specified output file names
 
@@ -106,4 +108,24 @@ ecbuild_add_executable( TARGET drhook_papi_user_counters
 ecbuild_add_test( TARGET fiat_test_drhook_papi_user_counters
         COMMAND drhook_papi_user_counters
         ENVIRONMENT DR_HOOK=1 DR_HOOK_OPT=COUNTERS DR_HOOK_PAPI_COUNTERS=PAPI_TOT_INS DR_HOOK_PROFILE=fiat_test_drhook_papi_user_counters
-        CONDITION HAVE_DR_HOOK_PAPI )
+        CONDITION HAVE_DR_HOOK_PAPI )
+
+set_tests_properties(fiat_test_drhook_papi_user_counters
+        PROPERTIES PASS_REGULAR_EXPRESSION "PAPI_TOT_INS" )
+
+# Test user specified counters going over max allowed
+
+ecbuild_add_executable( TARGET drhook_papi_user_counters_more_than_max
+  SOURCES drhook_papi_user_counters_more_than_max.F90
+  LIBS fiat
+  LINKER_LANGUAGE Fortran
+  CONDITION HAVE_DR_HOOK_PAPI
+  NOINSTALL )
+
+ecbuild_add_test( TARGET fiat_test_drhook_papi_user_counters_more_than_max
+        COMMAND drhook_papi_user_counters_more_than_max
+        ENVIRONMENT DR_HOOK=1 DR_HOOK_OPT=COUNTERS DR_HOOK_PAPI_COUNTERS=PAPI_TOT_CYC,PAPI_FP_OPS,PAPI_L1_DCA,PAPI_L2_DCM,PAPI_TOT_INS DR_HOOK_PROFILE=drhook_papi_user_counters_more_than_max
+        CONDITION HAVE_DR_HOOK_PAPI )
+
+set_tests_properties(fiat_test_drhook_papi_user_counters_more_than_max
+        PROPERTIES FAIL_REGULAR_EXPRESSION "PAPI_TOT_INS" )

tests/drhook/drhook_papi/drhook_papi_user_counters_more_than_max.F90

@@ -0,0 +1,27 @@
+! (C) Copyright 2024- ECMWF.
+!
+! This software is licensed under the terms of the Apache Licence Version 2.0
+! which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+!
+! In applying this licence, ECMWF does not waive the privileges and immunities
+! granted to it by virtue of its status as an intergovernmental organisation
+! nor does it submit to any jurisdiction.
+
+program drhook_papi_user_counters_more_than_max
+
+  use yomhook, only : jphook, dr_hook
+
+  implicit none
+
+  real(jphook) :: zhook_handle
+  integer :: a
+
+  call dr_hook('drhook_papi_user_counters_more_than_max', 0, zhook_handle)
+
+  a = 1
+  a = a + a
+
+  call dr_hook('drhook_papi_user_counters_more_than_max', 1, zhook_handle)
+
+end program drhook_papi_user_counters_more_than_max
+