Project LEPL1503 : FEC

Made with the help of Botton Florentin, Accou Pierre, De Ro Corentin, Rixen Thomas, D'intino Salgado Lorenzo

Run the program

To run our program, you just have to launch the following commands in a prompt:

$ make
$ ./fec INPUT_DIRECTORY -f OUTPUT_FILE -n NUMBER_THREADS

with

• INPUT_DIRECTORY : path to a directory containing files to be processed to recover symbols
• OUTPUT_FILE : path to a file (can be a new file) which will contain the former content of the processed files
• NUMBER_THREADS : the number of threads we want to execute the program with

Run the tests and checks

To run our tests, you can run the following commands, while having CUnit installed in the $HOME/local directory:

export LD_LIBRARY_PATH=$HOME/local/lib:$LD_LIBRARY_PATH
export CFLAGS='-gdwarf-2 -gstrict-dwarf'    # comply to use older dwarf version
make
make tests

In order to use the check on files, you can use the following commands:

make
make check

Directories organisation

|
|-- binary_example                : contain exemples of binary files with lost datas
|-- expected                      : contains an exemple of expected result used by the tests
|-- headers                       : contain headers of C files
|-- src                           : contain all the C source code files   
|-- tests                         : contains all the CUnit tests
|-- utils                         : utility scripts
|    |
|    |-- auto.sh                  : script used to run the tests (export LD_LIBRARY_PATH automaticaly)
|    |-- executionSpeed.sh        : script to test the time taken to run our program
|    |-- graph.py                 : script used to generate our graphs to compare performances
|    |-- Rapport_src              : source code for our latex report
|
|-- main.c                        : main program calling the other files

Functions of source files

Each C file is responsible for a different task:

File	Function
block.c	Handle the recovering of lost blocks and the generation of linear system to recover them. Also implements methods to handle blocks (print, free).
message.c	Handling of opening files and extracting blocks and symbols from them. Also allow to write to the output file.
system.c	Solving of the linear system to recover the lost symbols, and operations on vectors and matrix
my_threads.c	Definition of the function used by threads and handling the consuming of the shared buffer
tinymt32.c	Generate random coefficients

Tests files

The files in ./tests are all run by the main test file testRun.c. They each implement a function called addSuiteNameTestFile which is then called by testRun.c to run these tests at once.

File	Function
test_block.c	Tests to check if block has lost symbols (with lost indexes) + check if symbol is lost
test_message.c	Tests to check if the output file contains the expected content
test_system.c	Tests for gaussian reduction + vector operations
test_tinymt32.c	Tests for random generation (already given at start of project)

Execution Speed test

The file executionSpeed.sh is used to mesure the time taken by our program fec to run. To be able to run it, install the bc extension for bash using the following command in terminal :

$ sudo apt install bc

You can then launch the execution time test by launching the following command in this directory :

$ ./utils/executionSpeed.sh NUMBER_TIMES NB_THREADS

For example, the average speed we mesured for our program to run was ~ 814.67 ms on a raspberry pi 3 with 200 files to process and 4 threads.

Known issues

Frequently, when we runned the scripts auto.sh or executionSpeed.sh, we encountered the following errors:

`$'make\r': command not found
`$'\r''

To fix these issues, try the following commands that worked for us (issues due to the encoding format of the scripts)

$ sudo apt install dos2unix
$ dos2unix ./utils/auto.sh
$ dos2unix ./utils/executionSpeed.sh

You should then be able to run these scripts without any problem