Close Instrumentor properly when application calls h.quit()

neuronsimulator / nrn

NEURON Simulator

http://nrn.readthedocs.io

Other

381 stars 114 forks source link

Close Instrumentor properly when application calls h.quit() #2982

Closed pramodk closed 1 month ago

pramodk commented 1 month ago

Certain profiling tools, such as LIKWID, require calling finalization routines like LIKWID_MARKER_CLOSE before the application terminates.
When NEURON applications call h.quit(), this finalization call is missing, leading to errors such as:

$ likwid-perfctr -C 0 -m -g FLOPS_DP ./x86_64/special -python test.py
...
...
Marker API result file does not exist. This may happen if the
application has not called LIKWID_MARKER_CLOSE.

azure-pipelines[bot] commented 1 month ago

✔️ f6dfb7b6da3a0a35633f4e79b98f5f5ddd47b319 -> Azure artifacts URL

bbpbuildbot commented 1 month ago

Logfiles from GitLab pipeline #221707 (:white_check_mark:) have been uploaded here!

Status and direct links:

sonarcloud[bot] commented 1 month ago

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 67.28%. Comparing base (2ace814) to head (367a9a8).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #2982 +/- ## ========================================== - Coverage 67.29% 67.28% -0.01% ========================================== Files 572 572 Lines 104951 104950 -1 ========================================== - Hits 70626 70617 -9 - Misses 34325 34333 +8 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

bbpbuildbot commented 1 month ago

Logfiles from GitLab pipeline #221750 (:white_check_mark:) have been uploaded here!

Status and direct links:

azure-pipelines[bot] commented 1 month ago

✔️ 367a9a817be9d1968c7343ccea1d0eda379cd3ae -> Azure artifacts URL

1uc commented 1 month ago

@pramodk Is this the only place we need to add code like this? I would have expected to see other finalization code nearby, for example MPI_finalize.

pramodk commented 1 month ago

Our primary exit point is ivocmain_session() and that's where we already have the finalization: https://github.com/neuronsimulator/nrn/blob/df21c819d45ea2a9f4aabe33893dd2a4c359b731/src/ivoc/ivocmain.cpp#L765

But I had the same question and was wondering if there is another exit point I am not aware. But I believe these two cover most if not all.