feature(docker): dockerize the CLI and sampling apps

Use travis for building docker images on tags and publish releases.

Closes #77

Author: mcolmant

.travis.yml

@@ -1,16 +1,34 @@
 sudo: required
 
+services:
+  - docker
+
+env:
+  global:
+    - secure: "BfP5e/OPM62e3ktm4RD2nuBJls2u8zdXg/YjNyght5dpD2vCjL6ZHWhgDM2mNFpzgYPiE3DPsSE7g2ZlsBUJCuK8a7lB5r+OiWFcWkilC1E9QX6OMcDTpEKb5A9InFGcpt0xbjY5+8qaIbaN8TJcdxaxeit0TZEvxeirQa5OOEY=" # COVERALLS_REPO_TOKEN
+    - secure: "ldIw526YR2Fe6FlfIPlbbOojEeg7etbO4dqiL4TLm00SBhVkKG+DuckhFixVAvAJx1Q1LuVyUPsXaR77OjqiTxSkaH+GbsmR5VIM4qA/kBheD4IiV4wTamg679d+AldRNWcGtLpefgwqlCJ53FcMzUT9TH/MJcbEaOJ5GKW9v+s=" # CODACY_PROJECT_TOKEN
+    - secure: "MLFJWju96LymkPNIsUeJelNN5J3BK55OV/RXVMONC5kDr4N7T4JyhT6KUa4k+FSJ0S1GTPQMWQQEkWDF1MlZXv5yGwW4h5rN3tt//vqyHk968SyqlhTdygqzx6tO6t3OsfQ2F1AqVWAWsHQckL+VmhEo53VqVXpsqLy9DyLYGjs=" # DOCKER_EMAIL
+    - secure: "FbLHLKNAtpj7ZVgSobOPgAgdLK3/P4sR6RcaOmpVRsgaqodTPx7VkzGpkf4rOqPwxKU3+96vr0TlIdPRYWAE39Y3gMb1dyZ34+CxsrJ3avJYc2+9NT3kmAuU33Iy1DCo3IEnR7pWVVEyR80ob0c1ASfPAW1JN8DhBRRERpkMyn4=" # DOCKER_USER
+    - secure: "VLK9NI4yE+hLV8rgjiB0hOfQn1uFO7cEHHL4sEDZKNu1TgvwfTrEWEzMMLvG8pwK/7eG78xfNB489m/Imj7Y52xK6sZuY7Y78Y06mkepZS8PisAJiW59kHWH1Ci84DYHZ0y07NAgvCOSLS9l0ncgLdlGvRboR9KBYDMEWycwEn8=" # DOCKER_PWD
+
 cache:
   directories:
-    - $HOME/.m2/repository
-    - $HOME/.sbt
-    - $HOME/.ivy2
+  - "$HOME/.m2/repository"
+  - "$HOME/.sbt"
+  - "$HOME/.ivy2"
 
 language: scala
 
 scala:
 - 2.11.7
 
+jdk:
+  - openjdk7
+
+# workaround for openjdk buffer overflow
+addons:
+   hostname: localhost
+
 script:
 - sbt compile test:compile
 - sbt 'set concurrentRestrictions in Global += Tags.limit(Tags.Test, 1)' "project powerapi-core" coverage test
@@ -20,10 +38,37 @@ before_install:
 - wget -O influxdb.deb https://s3.amazonaws.com/influxdb/influxdb_0.10.2-1_amd64.deb
 - sudo dpkg -i influxdb.deb
 - sudo service influxdb start
-- sleep 5; /usr/bin/influx --execute "CREATE USER powerapi WITH PASSWORD 'powerapi' WITH ALL PRIVILEGES"
-
+- sleep 5; /usr/bin/influx --execute "CREATE USER powerapi WITH PASSWORD 'powerapi'
+  WITH ALL PRIVILEGES"
 
 after_success:
 - sbt "project powerapi-core" coverageReport
 - sbt "project powerapi-core" codacyCoverage
 - sbt "project powerapi-core" coveralls
+
+before_deploy:
+  - sbt "project powerapi-sampling" universal:packageZipTarball
+  - sbt "project powerapi-cli" universal:packageZipTarball
+  - tar -C powerapi-sampling/target/universal -xvf powerapi-sampling/target/universal/powerapi-sampling.tgz
+  - tar -C powerapi-cli/target/universal -xvf powerapi-cli/target/universal/powerapi-cli.tgz
+
+deploy:
+  provider: releases
+  api_key:
+    secure: IEU1nWNWXW394yjC8/2Ch3naFM18mUmns9q11U0sCWMm9nz7ej4D5crKxCPtIHyHtFlONY1s0udBk6rv3aCVq0UikOysHFiVdPPeJTRCtGptxOb04/pZtq3vITcMzS9+CQc+yV8Y3A2vv15L/30ERMk1fgur+Nb+8vTFfXfzEik=
+  file:
+    - "powerapi-sampling/target/universal/powerapi-sampling.tgz"
+    - "powerapi-cli/target/universal/powerapi-cli.tgz"
+  skip_cleanup: true
+  on:
+    tags: true
+    repo: Spirals-Team/powerapi
+
+after_deploy:
+  - docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PWD
+  - docker build -f docker/sampling/Dockerfile-sampling -t spirals/powerapi-sampling:$TRAVIS_TAG .
+  - docker build -f docker/Dockerfile-cli -t spirals/powerapi-cli:$TRAVIS_TAG .
+  - docker tag spirals/powerapi-sampling:$TRAVIS_TAG spirals/powerapi-sampling:latest
+  - docker tag spirals/powerapi-cli:$TRAVIS_TAG spirals/powerapi-cli:latest
+  - docker push spirals/powerapi-sampling
+  - docker push spirals/powerapi-cli

docker/Dockerfile-cli

@@ -0,0 +1,23 @@
+FROM alpine:latest
+
+ENV POWERAPI_PACKAGE powerapi-cli
+ENV LIBPFM_PACKAGE libpfm-4.6.0
+
+ENV INSTALL_PACKAGES ca-certificates linux-headers libc-dev make gcc patch
+ENV RUNTIME_PACKAGES bluez bluez-dev openjdk7-jre bash procps
+
+COPY docker/libpfm/config.mk.patch /root/
+COPY ${POWERAPI_PACKAGE}/target/universal/${POWERAPI_PACKAGE}/ /root/${POWERAPI_PACKAGE}/
+
+VOLUME /conf
+
+RUN apk update && apk upgrade && apk add $INSTALL_PACKAGES $RUNTIME_PACKAGES && \
+  wget https://circle-artifacts.com/gh/andyshinn/alpine-pkg-glibc/6/artifacts/0/home/ubuntu/alpine-pkg-glibc/packages/x86_64/glibc-2.21-r2.apk && apk --allow-untrusted add glibc-2.21-r2.apk && rm -f glibc-2.21-r2.apk && \
+  wget http://downloads.sourceforge.net/project/perfmon2/libpfm4/${LIBPFM_PACKAGE}.tar.gz && tar -C /root -xzvf ${LIBPFM_PACKAGE}.tar.gz && patch -d /root/$LIBPFM_PACKAGE -p1 < /root/config.mk.patch && (cd /root/$LIBPFM_PACKAGE; make lib; make install) && rm -rf /root/config.mk.patch /root/$LIBPFM_PACKAGE ${LIBPFM_PACKAGE}.tar.gz && \
+  rm -rf /root/${POWERAPI_PACKAGE}/conf && ln -s /conf/ /root/${POWERAPI_PACKAGE}/conf && \
+  apk del glibc $INSTALL_PACKAGES && \
+  rm -rf /var/cache/apk/*
+
+WORKDIR /root/$POWERAPI_PACKAGE
+
+ENTRYPOINT ["./bin/powerapi"]

docker/README.md

@@ -0,0 +1,88 @@
+## Docker version of PowerAPI
+
+Lightweight docker images of PowerAPI packaged as docker images.
+
+You have first to create a [data volume](https://docs.docker.com/engine/userguide/containers/dockervolumes/#creating-and-mounting-a-data-volume-container) to store the configuration files (`conf` directory) for PowerAPI.
+It will include all parameters needed to PowerAPI for configuring its internal components.
+The different parameters to set up are described inside the [Wiki](https://github.com/Spirals-Team/powerapi/wiki).
+
+We assume that two data volumes `powerapi-cli-conf` and `powerapi-sampling-conf` are created on the host system.
+
+### PowerAPI: CLI
+
+This image is used to run automatically a various choices of software-defined power meters.
+
+#### Usage
+
+Show the help text:
+
+```
+docker run --rm --privileged --net=host --pid=host \
+--volumes-from powerapi-cli-conf \
+spirals/powerapi-cli
+```
+
+The `--privileged` option is used to get the root access to the host machine,
+the `--net=host` option is mandatory to be able to use the PowerSPY bluetooth power meter inside a container,
+and the `--pid=host` is required to be able to get an access to the running apps of the host machine.
+
+A classic example with the `ProcFS` module can be:
+
+powerapi.conf:
+
+```
+powerapi.cpu.tdp = 35
+```
+
+Associated docker command:
+
+```
+docker run --rm --privileged --net=host --pid=host \
+--volumes-from powerapi-cli-conf \
+spirals/powerapi-cli \
+modules procfs-cpu-simple monitor --frequency 1000 --all --console
+```
+
+### PowerAPI: Sampling
+
+This image is used to build a CPU power model.
+
+#### Usage
+
+Launch the sampling:
+
+```
+docker run --rm --privileged --net=host --pid=host \
+--volumes-from powerapi-sampling-conf \
+spirals/powerapi-sampling
+```
+
+Example of a sampling configuration file:
+
+sampling.conf:
+
+```
+powerspy.mac = "00:0B:CE:07:1E:9B"
+
+powerapi.cpu.topology = [
+  { core = 0, indexes = [0, 4] }
+  { core = 1, indexes = [1, 5] }
+  { core = 2, indexes = [2, 6] }
+  { core = 3, indexes = [3, 7] }
+]
+
+powerapi.sampling.dvfs = true
+powerapi.sampling.turbo = true
+
+powerapi.cycles-polynom-regression.cpu-base-frequency = 0.133
+powerapi.cycles-polynom-regression.cpu-max-frequency = 2.66
+powerapi.cycles-polynom-regression.unhalted-cycles-event = "CPU_CLK_UNHALTED:THREAD_P"
+powerapi.cycles-polynom-regression.ref-cycles-event = "CPU_CLK_UNHALTED:REF_P"
+
+interval = 1s
+powerapi.actors.timeout = 15s
+powerapi.sampling.interval = ${interval}
+powerspy.interval = ${interval}
+powerapi.sampling.steps = [100, 25]
+powerapi.sampling.step-duration = 10
+```

docker/libpfm/config.mk.patch

@@ -0,0 +1,11 @@
+--- a/config.mk
++++ b/config.mk
+@@ -194,7 +194,7 @@ endif
+ CC?=gcc
+ LIBS=
+ INSTALL=install
+-LDCONFIG=ldconfig
++LDCONFIG=/usr/glibc/usr/bin/ldconfig
+ LN?=ln -sf
+ PFMINCDIR=$(TOPDIR)/include
+ PFMLIBDIR=$(TOPDIR)/lib

docker/sampling/Dockerfile-sampling

@@ -0,0 +1,25 @@
+FROM alpine:latest
+
+ENV POWERAPI_PACKAGE powerapi-sampling
+ENV LIBPFM_PACKAGE libpfm-4.6.0
+
+ENV INSTALL_PACKAGES ca-certificates linux-headers libc-dev make gcc patch
+ENV RUNTIME_PACKAGES bluez bluez-dev openjdk7-jre bash util-linux cpulimit procps
+
+COPY docker/libpfm/config.mk.patch /root/
+COPY docker/sampling/run.sh /root/
+COPY ${POWERAPI_PACKAGE}/target/universal/${POWERAPI_PACKAGE}/ /root/${POWERAPI_PACKAGE}/
+
+VOLUME /conf
+
+RUN apk update && apk upgrade && apk add $INSTALL_PACKAGES $RUNTIME_PACKAGES && \
+  wget https://circle-artifacts.com/gh/andyshinn/alpine-pkg-glibc/6/artifacts/0/home/ubuntu/alpine-pkg-glibc/packages/x86_64/glibc-2.21-r2.apk && apk --allow-untrusted add glibc-2.21-r2.apk && rm -f glibc-2.21-r2.apk && \
+  wget http://downloads.sourceforge.net/project/perfmon2/libpfm4/${LIBPFM_PACKAGE}.tar.gz && tar -C /root -xzvf ${LIBPFM_PACKAGE}.tar.gz && patch -d /root/$LIBPFM_PACKAGE -p1 < /root/config.mk.patch && (cd /root/$LIBPFM_PACKAGE; make lib; make install) && rm -rf /root/config.mk.patch /root/$LIBPFM_PACKAGE ${LIBPFM_PACKAGE}.tar.gz && \
+  wget http://people.seas.harvard.edu/~apw/stress/stress-1.0.4.tar.gz && tar -C /root -xzvf stress-1.0.4.tar.gz && (cd /root/stress-1.0.4; ./configure; make; make install) && rm -rf /root/stress-1.0.4 && \
+  rm -rf /${POWERAPI_PACKAGE}/conf && ln -s /conf/ /root/${POWERAPI_PACKAGE}/conf && \
+  apk del glibc $INSTALL_PACKAGES && \
+  rm -rf /var/cache/apk/*
+
+WORKDIR /root
+
+ENTRYPOINT ["./run.sh"]

docker/sampling/run.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+cd powerapi-sampling && ./bin/sampling --all results/sampling results/processing results/computing
+
+echo ""
+echo "Here is your CPU power model to use with PowerAPI"
+echo ""
+cat results/computing/libpfm-formula.conf
+echo ""

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

@@ -35,6 +35,7 @@ import org.powerapi.core.ClockChannel.{startClock, stopClock, subscribeClockTick
 import org.powerapi.core.MonitorChannel.{MonitorAggregator, MonitorFrequency, MonitorStart, MonitorStop, MonitorStopAll, formatMonitorChildName, publishMonitorTick, setAggregator, setFrequency, stopMonitor, subscribeMonitorsChannel}
 import org.powerapi.core.power._
 import org.powerapi.core.target.Target
+import org.powerapi.core.TickChannel.{subscribeTick, unsubscribeTick}
 import org.powerapi.module.FormulaChannel.stopFormula
 import org.powerapi.module.PowerChannel.{AggregatePowerReport, RawPowerReport, render, subscribeAggPowerReport, subscribeRawPowerReport, unsubscribeRawPowerReport, unsubscribeAggPowerReport}
 import org.powerapi.module.SensorChannel.stopSensor
@@ -62,6 +63,11 @@ trait MonitorConfiguration extends Configuration {
   */
 class MonitorChild(eventBus: MessageBus, muid: UUID, targets: Set[Target]) extends ActorComponent {
 
+  override def preStart(): Unit = {
+    subscribeTick(muid)(eventBus)(self)
+    super.preStart()
+  }
+
   def receive: Actor.Receive = starting orElse default
 
   def starting: Actor.Receive = {
@@ -75,7 +81,7 @@ class MonitorChild(eventBus: MessageBus, muid: UUID, targets: Set[Target]) exten
     case tick: Tick => produceMessages(tick)
     case powerReport: RawPowerReport => aggregate(aggR, powerReport, aggregator)
     case msg: MonitorAggregator if msg.muid == muid => setAggregator(aggR, msg.aggregator)
-    case msg: MonitorFrequency if msg.muid == muid => setMonitorFrequency(aggR, aggregator, msg.frequency)
+    case msg: MonitorFrequency if msg.muid == muid => unsubscribeTick(msg.muid)(eventBus)(self); setMonitorFrequency(aggR, aggregator, msg.frequency)
     case msg: MonitorStop if msg.muid == muid => stop()
     case _: MonitorStopAll => stop()
   }

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

@@ -22,12 +22,16 @@
  */
 package org.powerapi.core
 
+import java.util.UUID
+
+import akka.actor.ActorRef
+
 /**
   * Base trait for Tick messages.
   *
   * @author <a href="mailto:maxime.colmant@gmail.com">Maxime Colmant</a>
   */
-trait Tick {
+trait Tick extends Message {
   /**
     * Subject used for routing the message.
     */
@@ -38,3 +42,38 @@ trait Tick {
     */
   def timestamp: Long
 }
+
+/**
+  * Tick channel.
+  *
+  * @author <a href="mailto:maxime.colmant@gmail.com">Maxime Colmant</a>
+  */
+object TickChannel extends Channel {
+
+  type M = Tick
+
+  /**
+    * Used to subscribe/unsubscribe to Tick on the right topic.
+    */
+  def subscribeTick(muid: UUID): MessageBus => ActorRef => Unit = {
+    subscribe(tickTopic(muid))
+  }
+
+  def unsubscribeTick(muid: UUID): MessageBus => ActorRef => Unit = {
+    unsubscribe(tickTopic(muid))
+  }
+
+  /**
+    * Used to format the topic used to interact with the MonitorChild actors.
+    */
+  def tickTopic(muid: UUID): String = {
+    s"tick:$muid"
+  }
+
+  /**
+    * Used to publish a Tick message built externally on the right topic.
+    */
+  def publishTick(tick: Tick): MessageBus => Unit = {
+    publish(tick)
+  }
+}