Completed nvml and powerletrics plugins

+ made changing the logfile location a bit more dynamic.

Author: mhkarsten

examples/powerletrics-profiling/RunnerConfig.py

@@ -68,7 +68,6 @@ def before_experiment(self) -> None:
         """Perform any activity required before starting the experiment here
         Invoked only once during the lifetime of the program."""
 
-        PowerLetrics.source_name = ".env/bin/powerletrics"
         self.profiler = PowerLetrics(additional_args={
                             "--show-process-io": None, 
                             "--show-process-netstats": None})
@@ -115,6 +114,7 @@ def populate_run_data(self, context: RunnerContext) -> Optional[Dict[str, Any]]:
         # Powerletrics outputs stats for each process
         pl_log = self.profiler.parse_log(self.profiler.logfile)
 
+        # Parse the stats for the values you are interested in
         first_process = pl_log[0][0]
         return {"energy_footprint": first_process['Energy Footprint'],
                 "cpu_utilization": first_process["CPU Utilization (%)"], 

experiment-runner/Plugins/Profilers/DataSource.py

@@ -66,10 +66,13 @@ def __contains__(self, key):
 
         return False
 
+class ValueRef:
+    def __init__(self, value):
+        self.value = value
+
 class DataSource(ABC):
     def __init__(self):
         self._validate_platform()
-        self._logfile = None
 
     def _validate_platform(self):
         if platform.system() in self.supported_platforms:
@@ -110,21 +113,26 @@ def stop(self):
     def parse_log():
         pass
 
-class Logfile:
-    def __init__(self, file: str):
-        self.file = file
-
 class CLISource(DataSource):
     def __init__(self):
         self.process = None
         self.args = None
+        self._logfile = ValueRef(None)
 
         super().__init__()
 
     def __del__(self):
         if self.process:
             self.process.kill()
 
+    @property
+    def logfile(self):
+        return self._logfile.value
+    
+    @logfile.setter
+    def logfile(self, value):
+        self._logfile.value = value
+
     @property
     @abstractmethod
     def parameters(self) -> ParameterDict:
@@ -177,8 +185,8 @@ def _format_cmd(self):
         for p, v in self.args.items():
             if v == None:
                 cmd += f" {p}"
-            elif isinstance(v, Logfile):
-                cmd += f" {p} {v.file}"
+            elif isinstance(v, ValueRef):
+                cmd += f" {p} {v.value}"
             elif isinstance(v, Iterable) and not (isinstance(v, StrEnum) or isinstance(v, str)):
                 cmd += f" {p} {",".join(map(str, v))}"
             else:

experiment-runner/Plugins/Profilers/PowerJoular.py

@@ -1,13 +1,13 @@
 from __future__ import annotations
 from pathlib import Path
 import pandas as pd
-from Plugins.Profilers.DataSource import CLISource, ParameterDict
+from Plugins.Profilers.DataSource import CLISource, ParameterDict, ValueRef
 
 # Supported Paramters for the PowerJoular metrics plugin
 POWERJOULAR_PARAMETERS = {
     ("-p",): int,
     ("-a",): str,
-    ("-f",): Path,
+    ("-f",): ValueRef,
     ("-o",): Path,
     ("-t",): None,
     ("-l",): None,
@@ -31,7 +31,7 @@ def __init__(self,
         self.logfile = out_file
         self.args = {
             "-l": None,
-            "-f": Path(self.logfile),
+            "-f": self._logfile,
         }
 
         if target_pid:

experiment-runner/Plugins/Profilers/PowerLetrics.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from enum import StrEnum
 import weakref
-from Plugins.Profilers.DataSource import CLISource, ParameterDict, Logfile
+from Plugins.Profilers.DataSource import CLISource, ParameterDict, ValueRef
 
 # How to format the output
 class PLFormatTypes(StrEnum):
@@ -20,7 +20,7 @@ class PLOrderTypes(StrEnum):
 #    ("-h", "--help"): None,             # Dont support this
     ("-i", "--sample-rate"): int,
     ("-n", "--sample-count"): int,
-    ("-o", "--output-file"): Logfile,
+    ("-o", "--output-file"): ValueRef,
     ("-r", "--order"): PLOrderTypes,
     ("-A", "--show-all"): None,
     ("--show-process-io"): None,
@@ -48,14 +48,16 @@ class PowerLetrics(CLISource):
 
     def __init__(self,
                  sample_frequency:      int                 = 1000,
-                 out_file:              Path                = "pm_out.plist",
+                 out_file:              Path                = "pl_out.plist",
                  additional_args:       dict                = {},
                  order:                 PLOrderTypes        = PLOrderTypes.PL_ORDER_CPU):
 
         super().__init__()
+        
+        print(self._logfile)
 
         self.requires_admin = True
-        self._logfile = Logfile(out_file)
+        self.logfile = out_file
 
         self.args = {
             "--output-file": self._logfile,
@@ -67,14 +69,6 @@ def __init__(self,
         }
 
         self.update_parameters(add=additional_args)
-    
-    @property
-    def logfile(self):
-        return self._logfile.file
-    
-    @logfile.setter
-    def logfile(self, value):
-        self._logfile.file = value
 
     @staticmethod
     def parse_log(logfile: Path):

experiment-runner/Plugins/Profilers/PowerMetrics.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 import plistlib
 
-from Plugins.Profilers.DataSource import ParameterDict, CLISource
+from Plugins.Profilers.DataSource import ParameterDict, CLISource, ValueRef
 
 # How to format the output
 class PMFormatTypes(StrEnum):
@@ -41,7 +41,7 @@ class PMSampleTypes(StrEnum):
     ("--format",        "-f"): PMFormatTypes,
     ("--sample-rate",   "-i"): int,
     ("--sample-count",  "-n"): int,
-    ("--output-file",   "-o"): Path,
+    ("--output-file",   "-o"): ValueRef,
     ("--order",         "-r"): PMOrderTypes,
     ("--samplers",      "-s"): list[PMSampleTypes],
     ("--wakeup-cost",   "-t"): int,
@@ -86,7 +86,7 @@ def __init__(self,
         self.logfile = out_file
         # Grab all available power stats by default
         self.args = {
-            "--output-file": Path(self.logfile),
+            "--output-file": self._logfile,
             "--sample-rate": sample_frequency,
             "--format": PMFormatTypes.PM_FMT_PLIST,
             "--samplers": [PMSampleTypes.PM_SAMPLE_CPU_POWER,