refactor(LibpfmHelper): adds methods to detects the PMU, the number of generic counters and the events available on the targeted CPU

We are now able to detect automatically the PMU with their number of counters that we can open simultaneously.
This number is very useful to know exactly how many events that we can monitored at a the same time.

feature(Libpfm): creates a generic formula for Libpfm and builds modules upon this generic formula

This formula can be configured with a map of coefficients for each event which forms the formula.
It represents the entire processor's consumption with several events.

Author: mcolmant

README.md

@@ -50,6 +50,7 @@ We all stand on the shoulders of giants and get by with a little help from our f
 * [Apache log4j2](http://logging.apache.org/log4j/2.x) (version 2.3 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for logging outside actors.
 * [powerspy.scala](https://github.com/Spirals-Team/powerspy.scala) (version 1.2 under [AGPL license](http://www.gnu.org/licenses/agpl-3.0.html)), for using the [PowerSpy powermeter](http://www.alciom.com/en/products/powerspy2-en-gb-2.html).
 * [BridJ](https://code.google.com/p/bridj/) (version 0.7.0 under [3-clause BSD license](https://github.com/ochafik/nativelibs4java/blob/master/libraries/BridJ/LICENSE)), for system or C calls.
+* [JNA](https://github.com/twall/jna) (version 4.1.0 under [LGPL 2.1 license](https://github.com/twall/jna/blob/master/LGPL2.1)), for system or C calls.
 * [perfmon2](http://sourceforge.net/p/perfmon2/libpfm4/ci/master/tree) (version 4.6.0 under [MIT license](http://sourceforge.net/p/perfmon2/libpfm4/ci/master/tree/COPYING)), for accessing hardware performance counters.
 * [JFreeChart](http://www.jfree.org/jfreechart/) (version 1.0.19 under [LGPL license](https://www.gnu.org/licenses/lgpl.html)), for creation of interactive and animated charts.
 * [Scala IO](http://jesseeichar.github.io/scala-io-doc/0.4.3/index.html#!/overview) (version 0.4.3 under [3-clause BSD license](http://www.scala-lang.org/license.html)), for an extensions of IO.

powerapi-cli/src/main/scala/org/powerapi/app/PowerAPI.scala

@@ -30,7 +30,7 @@ import org.powerapi.{PowerMonitoring, PowerMeter}
 import org.powerapi.core.power._
 import org.powerapi.module.cpu.dvfs.CpuDvfsModule
 import org.powerapi.module.cpu.simple.{SigarCpuSimpleModule, ProcFSCpuSimpleModule}
-import org.powerapi.module.libpfm.{LibpfmHelper, LibpfmCoreProcessModule, LibpfmCoreModule}
+import org.powerapi.module.libpfm.{LibpfmModule, LibpfmHelper, LibpfmCoreProcessModule, LibpfmCoreModule, LibpfmProcessModule}
 import org.powerapi.module.powerspy.PowerSpyModule
 import scala.concurrent.duration.DurationInt
 import scala.sys
@@ -43,7 +43,7 @@ import scala.sys.process.stringSeqToProcess
  * @author <a href="mailto:l.huertas.pro@gmail.com">Loïc Huertas</a>
  */
 object PowerAPI extends App {
-  val modulesR = """(procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-process|powerspy|rapl)(,(procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-process|powerspy|rapl))*""".r
+  val modulesR = """(procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm|libpfm-process|libpfm-core|libpfm-core-process|powerspy|rapl)(,(procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm|libpfm-process|libpfm-core|libpfm-core-process|powerspy|rapl))*""".r
   val aggR = """max|min|geomean|logsum|mean|median|stdev|sum|variance""".r
   val durationR = """\d+""".r
   val pidR = """(\d+)""".r
@@ -113,7 +113,7 @@ object PowerAPI extends App {
         |You can use different settings per software-defined power meter for some modules by using the optional prefix option.
         |Please, refer to the documentation inside the GitHub wiki for further details.
         |
-        |usage: ./powerapi modules [procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm-core|libpfm-core-proces|powerspy|rapl,...] *--prefix [name]* \
+        |usage: ./powerapi modules [procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm|libpfm-process|libpfm-core|libpfm-core-proces|powerspy|rapl,...] *--prefix [name]* \
         |                          monitor --frequency [ms] --targets [pid, ..., app, ...|all] --agg [max|min|geomean|logsum|mean|median|stdev|sum|variance] --[console,file [filepath],chart] \
         |                  duration [s]
         |
@@ -176,6 +176,8 @@ object PowerAPI extends App {
           case "procfs-cpu-simple" => ProcFSCpuSimpleModule()
           case "sigar-cpu-simple" => SigarCpuSimpleModule()
           case "cpu-dvfs" => CpuDvfsModule()
+          case "libpfm" => LibpfmModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
+          case "libpfm-process" => LibpfmProcessModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
           case "libpfm-core" => LibpfmCoreModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
           case "libpfm-core-process" => LibpfmCoreProcessModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
           case "powerspy" => PowerSpyModule()

powerapi-core/build.sbt

@@ -21,7 +21,8 @@ libraryDependencies ++= Seq(
   "io.spray" %% "spray-client" % "1.3.3",
   "io.spray" %% "spray-routing" % "1.3.3",
   "io.spray" %% "spray-json" % "1.3.2",
-  "com.github.nscala-time" %% "nscala-time" % "2.0.0"
+  "com.github.nscala-time" %% "nscala-time" % "2.0.0",
+  "net.java.dev.jna" % "jna" % "4.1.0"
 )
 
 // Tests

powerapi-core/lib/libpfm.jar

@@ -31,13 +31,14 @@
 import perfmon2.libpfm.perf_event_attr;
 
 /**
- * This class is used for binding several functions available on the system or in C.
+ * This class is used for binding several functions available in C by using BridJ.
+ * There is a problem when trying to bind the syscall function with JNA.
  *
  * @author <a href="mailto:maxime.colmant@gmail.com">Maxime Colmant</a>
  */
 @Library("c")
 @Runtime(CRuntime.class)
-public class CUtils {
+public class CUtilsBridJ {
   static {
     BridJ.register();
   }
@@ -48,23 +49,6 @@ public class CUtils {
   public static int perf_event_open(int __nrPerfEventOpen, Pointer<perf_event_attr> __hw, int __pid, int __cpu, int __gr, @CLong long __flags) {
     return syscall(__nrPerfEventOpen, Pointer.getPeer(__hw), __pid, __cpu, __gr, __flags);
   }
-  private native static int syscall(int __code, Object... varArgs1);
-
-  /**
-   * Interact with a given file descriptor. In this case, we use it to enable, disable and reset a file descriptor (so, a counter).
-   */
-  public static native int ioctl(int __fd, @CLong long __request, Object... varArgs1);
 
-  /**
-   * Allow to read values from a file descriptor.
-   */
-  public static long read(int __fd, Pointer<? > __buf, @CLong long __nbytes) {
-    return read(__fd, Pointer.getPeer(__buf), __nbytes);
-  }
-  private native static long read(int __fd, @CLong long __buf, @CLong long __nbytes);
-
-  /**
-   * Close a file descriptor
-   */
-  public static native int close(int __fd);
-}
+  private native static int syscall(int __code, Object... varArgs1);
+}

…a/org/powerapi/module/libpfm/CUtils.java …/powerapi/module/libpfm/CUtilsBridJ.javapowerapi-core/src/main/java/org/powerapi/module/libpfm/CUtils.java renamed to powerapi-core/src/main/java/org/powerapi/module/libpfm/CUtilsBridJ.java powerapi-core/src/main/java/org/powerapi/module/libpfm/CUtils.java renamed to powerapi-core/src/main/java/org/powerapi/module/libpfm/CUtilsBridJ.java

@@ -0,0 +1,36 @@
+/*
+ * This software is licensed under the GNU Affero General Public License, quoted below.
+ *
+ * This file is a part of PowerAPI.
+ *
+ * Copyright (C) 2011-2015 Inria, University of Lille 1.
+ *
+ * PowerAPI is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * PowerAPI is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with PowerAPI.
+ *
+ * If not, please consult http://www.gnu.org/licenses/agpl-3.0.html.
+ */
+package org.powerapi.module.libpfm;
+
+import com.sun.jna.Library;
+
+/**
+ * This class is used for binding several functions available in C by using JNA.
+ *
+ * @author <a href="mailto:maxime.colmant@gmail.com">Maxime Colmant</a>
+ */
+public interface CUtilsJNA extends Library {
+  int ioctl(int fd, int request, Object... args);
+  long read(int fd, byte[] buf, long nbytes);
+  int close(int fd);
+}

powerapi-core/src/main/java/org/powerapi/module/libpfm/CUtilsJNA.java

@@ -31,8 +31,7 @@ import akka.util.Timeout
 import java.util.concurrent.TimeUnit
 import org.powerapi.PowerMeterMessages.StopAll
 import org.powerapi.core.{ActorComponent, Clocks, ConfigValue, Configuration, APIComponent, Monitor, Monitors, MessageBus}
-import org.powerapi.core.MonitorChannel.{ GetMonitoredProcesses, MonitorStart }
-import org.powerapi.core.MonitorChannel.stopMonitor
+import org.powerapi.core.MonitorChannel.{GetMonitoredProcesses, MonitorStart}
 import org.powerapi.core.target.Target
 import org.powerapi.core.power._
 import scala.concurrent.{ Await, Future }

powerapi-core/src/main/scala/org/powerapi/PowerMeter.scala

@@ -40,7 +40,7 @@ import org.powerapi.module.PowerChannel.{AggregatePowerReport, RawPowerReport, r
 import org.powerapi.module.SensorChannel.{monitorAllStopped, monitorStopped}
 import org.powerapi.reporter.ReporterComponent
 import scala.concurrent.duration.{ DurationLong, FiniteDuration }
-import scala.concurrent.{ Await, Future }
+import scala.concurrent.Future
 import scala.concurrent.ExecutionContext.Implicits.global
 import scala.util.{ Failure, Success }
 

powerapi-core/src/main/scala/org/powerapi/core/MonitorActors.scala

@@ -162,4 +162,3 @@ object MonitorChannel extends Channel {
     s"monitor-$muid"
   }
 }
-

powerapi-core/src/main/scala/org/powerapi/core/MonitorChannel.scala

@@ -37,11 +37,11 @@ class LibpfmCoreProcessModule(osHelper: OSHelper, libpfmHelper: LibpfmHelper, ti
 }
 
 object LibpfmCoreProcessModule {
-  def apply(configPrefix: Option[String] = None, libpfmHelper: LibpfmHelper): LibpfmCoreProcessModule = {
+  def apply(prefixConfig: Option[String] = None, libpfmHelper: LibpfmHelper): LibpfmCoreProcessModule = {
     val linuxHelper = new LinuxHelper
 
-    val coreProcessSensorConf = new LibpfmCoreProcessSensorConfiguration(configPrefix)
-    val coreCyclesFormulaConf = new LibpfmCoreCyclesFormulaConfiguration(configPrefix)
+    val coreProcessSensorConf = new LibpfmCoreProcessSensorConfiguration(prefixConfig)
+    val coreCyclesFormulaConf = new LibpfmCoreCyclesFormulaConfiguration(prefixConfig)
 
     new LibpfmCoreProcessModule(linuxHelper, libpfmHelper, coreProcessSensorConf.timeout, coreProcessSensorConf.topology, coreProcessSensorConf.configuration, coreProcessSensorConf.events,
       coreProcessSensorConf.inDepth, coreCyclesFormulaConf.cyclesThreadName, coreCyclesFormulaConf.cyclesRefName, coreCyclesFormulaConf.formulae, coreCyclesFormulaConf.samplingInterval)