From 53dca32469c8af1f3267d84703a97c787352a3a6 Mon Sep 17 00:00:00 2001
From: Rodrigo Arias Mallo <rodrigo.arias@bsc.es>
Date: Fri, 9 Oct 2020 17:19:00 +0200
Subject: [PATCH] Simplify experiment

---
 garlic/exp/nbody/extrae.xml | 210 ------------------------------------
 garlic/exp/nbody/test.nix   |  28 ++---
 garlic/stdexp.nix           |  19 +++-
 3 files changed, 25 insertions(+), 232 deletions(-)
 delete mode 100644 garlic/exp/nbody/extrae.xml

diff --git a/garlic/exp/nbody/extrae.xml b/garlic/exp/nbody/extrae.xml
deleted file mode 100644
index 45a7574..0000000
--- a/garlic/exp/nbody/extrae.xml
+++ /dev/null
@@ -1,210 +0,0 @@
-<?xml version='1.0'?>
-
-<!-- Here comes the Extrae configuration.
-     As a general rule, "enabled" means that the feature is enabled :)  If
-     it's not enabled, then the value can be set to some default.
--->
-
-<!-- Must we activate the tracing? Which is the tracing mode? (detail/bursts) Where is it located? Which kind of trace? Version of the XML parser?-->
-<trace enabled="yes"
- initial-mode="detail"
- type="paraver"
->
-
-  <!-- Configuration of some MPI dependant values -->
-  <mpi enabled="yes">
-    <!-- Gather counters in the MPI routines? -->
-    <counters enabled="yes" />
-  </mpi>
-
-  <!-- Emit information of the callstack -->
-  <callers enabled="yes">
-    <!-- At MPI calls, select depth level -->
-    <mpi enabled="yes">1-3</mpi>
-    <!-- At sampling points, select depth level -->
-		<sampling enabled="yes">1-5</sampling>
-		<!-- At dynamic memory system calls -->
-		<dynamic-memory enabled="no">1-3</dynamic-memory>
-		<!-- At I/O system calls -->
-		<input-output enabled="no">1-3</input-output>
-		<!-- At other system calls -->
-	  <syscall enabled="no">1-3</syscall>
-  </callers>
-
-  <!-- Configuration of some OpenMP dependant values -->
-  <openmp enabled="no" ompt="no">
-    <!-- If the library instruments OpenMP, shall we gather info about locks?
-         Obtaining such information can make the final trace quite large.
-    -->
-		<locks enabled="no" />
-		<!-- Gather info about taskloops? -->
-		<taskloop enabled="no" />
-    <!-- Gather counters in the OpenMP routines? -->
-    <counters enabled="yes" />
-  </openmp>
-
-  <!-- Configuration of some pthread dependant values -->
-  <pthread enabled="no">
-    <!-- If the library instruments pthread, shall we gather info about locks,
-	       mutexs and conds?
-         Obtaining such information can make the final trace quite large.
-    -->
-    <locks enabled="no" />
-    <!-- Gather counters in the pthread routines? -->
-    <counters enabled="yes" />
-  </pthread>
-
-  <!-- Configuration of User Functions -->
-  <user-functions enabled="no" list="/home/bsc41/bsc41273/user-functions.dat" exclude-automatic-functions="no">
-    <!-- Gather counters on the UF routines? -->
-    <counters enabled="yes" />
-  </user-functions>
-
-  <!-- Configure which software/hardware counters must be collected -->
-  <counters enabled="yes">
-    <!-- Configure the CPU hardware counters. You can define here as many sets
-         as you want. You can also define if MPI/OpenMP calls must report such
-         counters.
-         Starting-set property defines which set is chosen from every task.
-         Possible values are:
-           - cyclic : The sets are distributed in a cyclic fashion among all
-           tasks. So Task 0 takes set 1, Task 1 takes set 2,...
-           - block  : The sets are distributed in block fashion among all tasks.
-           Task [0..i-1] takes set 1, Task [i..2*i-1] takes set 2, ...
-           - Number : All the tasks will start with the given set 
-           (from 1..N).
-    -->
-    <cpu enabled="yes" starting-set-distribution="1">
-      <!-- In this example, we configure two sets of counters. The first will 
-           be changed into the second after 5 calls to some collective
-           operation on MPI_COMM_WORLD. Once the second is activated, it will
-           turn to the first after 5seconds (aprox. depending on the MPI calls
-           granularity)
-           If you want that any set be counting forever, just don't set
-           changeat-globalops, or, changeat-time.
-
-           Each set has it's own properties.
-           domain -> in which domain must PAPI obtain the information (see
-                       PAPI info)
-           changeat-globalops=num -> choose the next set after num
-                       MPI_COMM_WORLD operations
-           changeat-time=numTime -> choose the next set after num Time
-                       (for example 5s, 15m (for ms), 10M (for minutes),..)
-      -->
-      <set enabled="yes" domain="all">
-        PAPI_TOT_INS,PAPI_TOT_CYC
-      </set>
-    </cpu>
-
-    <!-- Do we want to gather information of the network counters?
-         Nowadays we can gather information about MX/GM cards.
-     -->
-    <network enabled="no" />
-
-    <!-- Obtain resource usage information -->
-    <resource-usage enabled="no" />
-
-    <!-- Obtain malloc statistics -->
-    <memory-usage enabled="no" />
-  </counters>
-
-  <!-- Define the characteristics of the tracing storage. If not defined,
-       or set, the tracing will send the traces to the current directory
-       with a default output name.
-  -->
-  <storage enabled="no">
-    <!-- The intermediate files will take the name of the application -->
-    <trace-prefix enabled="yes">TRACE</trace-prefix>
-    <!-- Stop the tracing when the intermediate file reaches this amount of MBs -->
-    <size enabled="no">5</size>
-    <!-- Where must we store the MPIT files while the app runs? -->
-    <temporal-directory enabled="yes">/scratch</temporal-directory>
-    <!-- Where must we store the MPIT files once the app ends? -->
-    <final-directory enabled="yes">/gpfs/scratch/bsc41/bsc41273</final-directory>
-  </storage>
-
-  <!-- Buffer configuration -->
-  <buffer enabled="yes">
-    <!-- How many events can we handle before any flush -->
-    <size enabled="yes">5000000</size>
-    <!-- Use the event buffer in a circular manner? You can use this option to
-         trace the last set of events. Needs MPI global routines operating on
-         MPI_COMM_WORLD communicator to be merged
-    -->
-    <circular enabled="no" />
-  </buffer>
-
-  <!-- Control tracing -->
-  <trace-control enabled="no">
-    <!-- We can start the application with a "latent tracing" and wake it up
-         once a control file is created. Use the property 'frequency' to
-         choose at which frequency this check must be done. If not supplied,
-         it will be checked every 100 global operations on MPI_COMM_WORLD.
-    -->
-    <file enabled="no" frequency="5M">/gpfs/scratch/bsc41/bsc41273/control</file>
-    <!-- 
-    -->
-    <global-ops enabled="no"></global-ops>
-  </trace-control>
-
-  <others enabled="yes">
-    <!-- Want to force a minimum amount of time of tracing? Here we force 10
-         minutes -->
-    <minimum-time enabled="no">10M</minimum-time>
-	<!-- Capture the following signals to finish cleanly -->
-    <finalize-on-signal enabled="yes" 
-      SIGUSR1="no" SIGUSR2="no" SIGINT="yes"
-      SIGQUIT="yes" SIGTERM="yes" SIGXCPU="yes"
-      SIGFPE="yes" SIGSEGV="yes" SIGABRT="yes"
-    />
-	<!-- Use instrumentation poitns to flush sampling buffer -->
-    <flush-sampling-buffer-at-instrumentation-point enabled="yes" />
-  </others>
-
-
-  <!-- Bursts library enabled? This requires an special library! -->
-  <bursts enabled="no">
-    <!-- Specify the threshold. This is mandatory! In this example, the
-         threshold is limitted to 500 microseconds
-     -->
-    <threshold enabled="yes">500u</threshold>
-    <!-- Report MPI statistics? -->
-    <mpi-statistics enabled="yes" />
-  </bursts>
-
-  <!-- Enable sampling capabilities using system clock.
-       Type may refer to: default, real, prof and virtual.
-       Period stands for the sampling period (50ms here)
-       plus a variability of 10ms, which means periods from 
-       45 to 55ms.
-  -->
-  <sampling enabled="no" type="default" period="50m" variability="10m" />
-
-  <!-- Enable dynamic memory instrumentation (experimental) -->
-  <dynamic-memory enabled="no" />
-
-  <!-- Enable I/O (read, write) instrumentation (experimental) -->
-  <input-output enabled="no" internals="no"/>
-
-	<!-- Enable system calls instrumentation (experimental) -->
-  <syscall enabled="no" />
-
-  <!-- Do merge the intermediate tracefiles into the final tracefile?
-       Named according to the binary name
-       options: 
-       synchronization = { default, task, node, no } (default is node)
-       max-memory = Number (in Mbytes) max memory used in merge step
-       joint-states = { yes, no } generate joint states?
-       keep-mpits = { yes, no } keep mpit files after merge?
-  -->
-  <merge enabled="yes" 
-    synchronization="default"
-    tree-fan-out="16"
-    max-memory="512"
-    joint-states="yes"
-    keep-mpits="yes"
-    sort-addresses="yes"
-    overwrite="yes"
-  />
-
-</trace>
diff --git a/garlic/exp/nbody/test.nix b/garlic/exp/nbody/test.nix
index 41768bc..8c0d5a3 100644
--- a/garlic/exp/nbody/test.nix
+++ b/garlic/exp/nbody/test.nix
@@ -32,41 +32,27 @@ let
     cpuBind = "sockets,verbose";
   };
 
-  confMachine = targetMachine.config;
-
   # Compute the array of configurations
   configs = stdexp.buildConfigs {
     var = confUnit;
-    fixed = confMachine // confExperiment;
+    fixed = targetMachine.config // confExperiment;
   };
 
   exec = {nextStage, conf, ...}: with conf; stages.exec {
     inherit nextStage;
     argv = [ "-t" timesteps "-p" particles ];
-    env = "";
   };
 
-  # We may be able to use overlays by invoking the fix function directly, but we
-  # have to get the definition of the bsc packages and the garlic ones as
-  # overlays.
   program = {nextStage, conf, ...}: with conf;
   let
-    # We set the mpi implementation to the one specified in the conf, so all
-    # packages in bsc will use that one.
-    customPkgs = stdexp.genPkgs (self: super: {
-      bsc = super.bsc // { mpi = conf.mpi; };
-    });
+    customPkgs = stdexp.replaceMpi conf.mpi;
   in
-  customPkgs.apps.nbody.override {
-    inherit cc blocksize mpi gitBranch;
-  };
+    customPkgs.apps.nbody.override {
+      inherit cc blocksize mpi gitBranch;
+    };
 
-  # Generate the experimental units
-  units = map (c: stages.unit {
-    conf = c;
-    stages = stdexp.stdStages ++ [ exec program ];
-  }) configs;
+  pipeline = stdexp.stdStages ++ [ exec program ];
 
 in
  
-  stdexp.buildExperiment units
+  stdexp.genExperiment { inherit configs pipeline; }
diff --git a/garlic/stdexp.nix b/garlic/stdexp.nix
index 2209d00..974151e 100644
--- a/garlic/stdexp.nix
+++ b/garlic/stdexp.nix
@@ -15,7 +15,7 @@ in
 rec {
   /* Takes a list of units and builds an experiment, after executing the
   trebuchet and the isolate stages. Returns the trebuchet stage. */
-  buildExperiment = units: stages.trebuchet {
+  buildTrebuchet = units: stages.trebuchet {
     inherit (machineConf) nixPrefix;
     nextStage = stages.isolate {
       inherit (machineConf) nixPrefix;
@@ -81,4 +81,21 @@ rec {
       newOverlay
     ];
   };
+
+  replaceMpi = mpi: genPkgs (self: super: {
+    bsc = super.bsc // { inherit mpi; };
+  });
+
+  # Generate the experimental units
+  genUnits = {configs, pipeline}: map (c: stages.unit {
+    conf = c;
+    stages = pipeline;
+  }) configs;
+
+  # Generate the complete experiment
+  genExperiment = {configs, pipeline}: 
+  let
+    units = genUnits { inherit configs pipeline; };
+  in
+    buildTrebuchet units;
 }