fernivy/fernivy

A uniform interface for tools for measuring power consumption of software

FernIvy

This repository contains the source code for FernIvy, a power-measurement tool meant to provide a uniform command-line interface across multiple platforms. It was originally developed for the Sustainable Software Engineering course at the TU Delft.

For documentation and installation, please see the docs page. It currently has support for:

• perf (Linux)
• PowerLog (MacOS)

It has the following syntax and options:

syntax:
    fernivy [-h] [-l]
            [-s seconds_to_run | -c command_to_run]
            [-r number_of_runs] [-b seconds_between_runs]
            [-e] [-p] [-t]
            [-o output_file_name] [-f output_file_folder]
options:
b     Set the number of second to pause between runs.
c     Run for specified command.
      Put the entire command in quotation marks if it is longer than one word.
e     Print total energy consumption.
f     Set the folder in which to save the output file.
      If it does not exist, it will be created.
h     Print this Help.
l     Run in logging mode.
o     Set output file.
      The path to the file has to exist.
      It cannot start with "temp".
p     Print average power.
r     Set the number of times to run.
s     Run for specified number of seconds.
t     Print total execution time.

If you find any bugs or have a feature request, feel free to create an issue or (even better) contribute!

fernivy's Issues

Generate `debian/changelog` for Perf with actual changes extracted from CHANGELOG.md

Currently, we just add the link to the repository CHANGELOG in the generation of the debian/changelog. It should be possible to parse the CHANGELOG file and add only the things relevant to the new version to the generated file.

Fix the folder+file concatenation

Right now, the folder+file concatenation is very naive (OUTPUT=$FLDR"/"$OUTPUT) and will break when e.g. the folder ends in a /. This needs to be fixed.

Add Zen Mode settings / instructions

Before measurement, don't forget to:

• charge the laptop to 100% and keep it plugged in throughout the experiment to ensure equal battery capacity for all runs,
• quit all active applications,
• turn off the auto-dim of an inactive screen,
• turn off AirDrop (macOS),
• set the screen saver to only appear after one hour,
• turn off the automatic adjustion of brightness,
• turn off keyboard lighting.

Make the `yaml` reader recursive

Currently, the Config class in generate.py only allows for reading yaml files which are not recursive. It also does not take quotation marks (") into account. This needs to be fixed for potential future expansion.

This will work:

logo_path: path/logo.png

But this will not:

logo:
    path: "path"
    filename: "logo.png"

Also, update this in the CONTRIBUTING.md.

Make a CI for Releases

This should include:

• Packaging the perf package to a .deb and adding it as a binary to the release
• Zipping the powerlog/package and adding it to the release (such that users who don't wish to install it through brew can still do so)
• Automatically update the fernivy-homebrew repo with the new release? This might be an issues for that repository.

Make a CI for push and pull requests

The question here is, what do we put in there and how do we make sure it actually upholds some semblance of working on all of the OSs and architecture types.

Add laptop warm-up

Usually the computer should be warmed up before running an experiment to make sure the results are as accurate as possible. This could be added to the start of the script.

Unify "prototype" script

Right now, the flags for checking whether variables are set or unset differ in the script for Perf and in the script for PowerLog. There should be (hopefully) a way to unify this.

Put together dependencies

Up to now:

• Perf

• PowerLog

• Python

• csv

Extract timestamp from PowerLog

Right now, the output file for PowerLog doesn't have the timestamp :(

Add argument for path to PowerLog

Currently, this is set to the default installation path. We should allow users to specify where PowerLog is.