|
1 | 1 | Readme |
2 | 2 | ======= |
3 | 3 |
|
| 4 | +[](https://github.com/Ergus/ExtraeWin/actions/workflows/cmake.yml) |
| 5 | +[](https://coveralls.io/github/Ergus/ExtraeWin?branch=master) |
| 6 | +[](https://www.gnu.org/licenses/gpl-3.0) |
| 7 | + |
4 | 8 | This is a very simple multi-platform Instrument based profiler |
5 | 9 | intended to work in multi-threaded systems (not intended for |
6 | 10 | distributed memory systems). For more advanced use cases consider |
@@ -32,15 +36,15 @@ function interception in a portable way. |
32 | 36 | The basic steps are: |
33 | 37 | -------------------- |
34 | 38 |
|
35 | | -1. Instrument the code like in the `main.cpp` example code. |
| 39 | +1. Instrument the code like in the `tests/tests_profiler.cpp` example code. |
36 | 40 |
|
37 | 41 | The example code includes all the different alternatives to instrument the code. |
38 | 42 |
|
39 | 43 | It is very important to define the `PROFILER_ENABLED` macro **BEFORE** including the |
40 | 44 | `Profiler.hpp` header. |
41 | 45 |
|
42 | 46 | - PROFILER_ENABLED = 0 (or not defined) don't trace anything |
43 | | - - PROFILER_ENABLED = 1 Emit user defined events (function instrumentation and thread init/stop) |
| 47 | + - PROFILER_ENABLED > 0 Emit user defined events (function instrumentation and thread init/stop) |
44 | 48 |
|
45 | 49 | 2. Execute your program. This will create a directory called `TRACEDIR_<timestamp>_<pid>` in the current execution path. |
46 | 50 |
|
@@ -198,7 +202,7 @@ Trace example |
198 | 202 | The profiler generates one binary trace file per thread. For more details |
199 | 203 | about the file format see `Parser.cpp`. |
200 | 204 |
|
201 | | -For the example provided in `main.cpp` the Paraver trace looks like: |
| 205 | +For the example provided in `tests/tests_profiler.cpp` the Paraver trace looks like: |
202 | 206 |
|
203 | 207 |  |
204 | 208 |
|
|
0 commit comments