Skip to content

Commit

Permalink
fix: correct some errors on the doc file
Browse files Browse the repository at this point in the history
  • Loading branch information
a-hamitouche committed Feb 7, 2024
1 parent ba277f1 commit b170b17
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ To do so, run via your command line on Linux or your powershell on Windows:

```shell
cd [PENE repository]
git sumdoule update --init
git sumodule foreach 'git checkout main'
cmake .
cmake --build -DUSE_FMA_INTRINSIC=1 .
git submodule update --init
git submodule foreach 'git checkout main'
cmake -DUSE_FMA_INTRINSIC=1 .
cmake --build .
ctest -C Debug
```
On Linux, you can create a folder, then generate and build the project inside it.
Expand All @@ -49,7 +49,7 @@ Without specifying any options, this command will execute your code under PENE w

# How to instrument your code with PENE?

PENE offers two ways to instrument code. A cross-plateforme based on backend [Verrou](https://github.com/edf-hpc/verrou) named **fp-replace** and one based one [Interflop](https://github.com/interflop), available on Linux only.
PENE offers two ways to instrument code. A cross-plateforme based on backend [Verrou](https://github.com/edf-hpc/verrou) named **fp-replace** and on based one [Interflop](https://github.com/interflop), available on Linux only.

## **FP-REPLACE** mode
To instrument your code, you can use the **fp-replace** option:
Expand Down Expand Up @@ -77,7 +77,7 @@ where:

## **INTERFLOP** mode (Linux only)

The interflop mode allows to dynamicaly load from 1 to 16 backends and make them work separately. Available backends are :
The interflop mode allows to dynamicaly load up to 16 backends and make them work separately. Available backends are :

| Backend | Description |
|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -102,14 +102,16 @@ Exemple of usage with Verrou :
VFC_BACKENDS="libinterflop_verrou.so --rounding-mode=upward" path/to/pin -t path/to/pene.so/or/pene.so -interflop -- path/to/executable

#Vector mode

VFC_BACKENDS="libinterflop_verrou.so --rounding-mode=downward" path/to/pin -t path/to/pene.so/or/pene.so -interflop -vector-mode -- path/to/executable

#Multiple backends

VFC_BACKENDS="libinterflop_verrou.so --rounding-mode=upward; libinterflop_vprec.so --mode=full --precision-binary32=23 --debug" path/to/pin -t path/to/pene.so/or/pene.so -interflop -- path/to/executable
```

/!\ Note :
- Proposed backends fully work only in scalar mode
- For backend Verrou, only nearest, upward and downward modes are available on vector mode

## How to exclude parts of the code from instrumentation?

You can filter which parts of the code your want to instrument using the option `-exclude` along with an exclusion file containing a list of the functions you want to exclude.
Expand Down

0 comments on commit b170b17

Please sign in to comment.