/simet-lmapd

SIMET lmap scheduler core (based on lmapd)

Primary LanguageC

lmapd

lmapd is the proof-of-concept daemon implementation for the Large-Scale Measurement Platforms (LMAP) information and data model developed by the LMAP working group of the IETF. The information model was published as RFC8193 and the data model as RFC8194.

simet-lmapd

simet-lmapd is a fork from the proof-of-concept lmapd implementation, adding features needed by the SIMET2 project for production use. We contribute those back to the reference lmapd implementation, and will resync to the upstream implementation should the features be accepted.

The "merge back" contribution branches are those in the "for-upstream/" branch namespace of the simetnicbr/simet-lmapd project.

License

The license of any changes and contributed code by NIC.br is the same as the upstream code.

Version

0.4.1+simet0.15.3 (simet-lmapd fork 0.15.5)

Dependencies

lmapd depends on a few open source libraries:

  • libevent - an event notification library
  • libxml2 - an XML library written in C
  • libjson-c - a JSON library written in C
  • libcheck - a unit testing framework for C

Installation

The build system is based on cmake.

$ sudo apt-get install cmake pkg-config libevent-dev libxml2-dev check
$ git clone https://github.com/schoenw/lmapd.git
$ cd lmapd
$ mkdir build
$ cd build
$ cmake ..
$ make
$ make test   # optional
$ make doc    # optional

The binary for the daemon is located at src/lmapd. The binary at src/lmapctl provides a little command line tool that can be used to validate configuration files and to interact with the daemon.

$ ./src/lmapd -h
usage: lmapd [-f] [-n] [-s] [-v] [-h] [-q queue] [-c config] [-s status]
       -f fork (daemonize)
       -n parse config and dump config and exit
       -s parse config and dump state and exit
       -q path to queue directory
       -c path to config directory or file
       -r path to run directory (pid file and status file)
       -v show version information and exit
       -h show brief usage information and exit
$ ./src/lmapctl help
  clean       clean the workspace (be careful!)
  config      validate and render lmap configuration
  help        show brief list of commands
  reload      reload the lmap configuration
  report      report data
  running     test if the lmap daemon is running
  shutdown    shutdown the lmap daemon
  status      show status information
  validate    validate lmap configuration
  version     show version information

An example config file is located at docs/lmapd-config.xml.

Development

Want to contribute? Great!

Check out the current issues and provide a fix for each of them. Fork your local lmapd repository and create a new branch. When the development is done create a pull request and we can get things upstream.

Coverage

Enable coverage definitions in the top-level CMakeLists.txt and build normally. In the build directory, you can now produce a nice report:

$ lcov --zerocounters --directory .
$ lcov --capture --initial --directory . --output-file app
$ make test
$ lcov --no-checksum --directory . --capture --output-file app.info
$ genhtml app.info

Todo's

  • Fix lmapctl timezone bug
  • Implement schedule/duration
  • Implement calendar/timezone-offset
  • Implement pipelined execution mode

Acknowledgments

The following people have helped with suggestions and ideas:

  • Vlad Ungureanu
  • Vaibhav Bajpai
  • Jürgen Schönwälder
  • Roxana Nadrag
  • Alexandru Barbarosie

Development of this code was kindly supported by the EU FP7 Leone and Flamingo research projects.

Upstream License

GPLv3 (believed to be SPDX-License-Identifier: GPL-3.0-or-later, waiting for upstream clarification)