xTasks Library

The xTasks Library provides a common interface to manage OmpSs tasks with a FPGA target regardless the platform and the communication/back-end used. Each platform has different supported back-ends that can be found inside the platform source folder (for example: src/zynq). Please, refer to the platform README file for build instructions.

Configuration File

xTasks Library reads the current FPGA configuration at each application launch from a formatted file. The library looks for this file in the following locations with the same preference order:

1. Path provided in the XTASKS_CONFIG_FILE environment variable.
2. /dev/ompss_fpga/bitinfo/xtasks (Only in Zynq boards).

File Format

The configuration file is expected to have the following format:

• First line contains the headers info.
• One line for each accelerator type with the following information separated by tabs.
  • Accelerator type identifier (integer number).
  • Number of instances of such type (positive integer number).
  • Description (string, max. 128 chars).
  • Working frequency in MHz (floating point number).

Programming style guide

The library follows the Google style which is verified using the clang-format tool (in Debian based systems can be installed with apt install clang-format). The tools folder contains a couple of scripts that can be used to setup a git pre-hook to check&fix the style of staged changes. To install the git hook you have to run ./tools/git-pre-commit-format install (to uninstall you can do the same but with the uninstall argument). The hook will run during the git commit and it will suggest style fixes if needed.

To apply style to a file, run ./tools/apply-format -i -f <file to format>. This will modify yout file. Run ./tools/apply-format --help for further info`