This is an archive of the discontinued LLVM Phabricator instance.

[OpenMP][Docs] Add documentation for device RTL debugging
ClosedPublic

Authored by jhuber6 on Oct 18 2021, 9:04 AM.

Details

Summary

Add documentation for the debugging features in the OpenMP device
runtime library.

Diff Detail

Event Timeline

jhuber6 created this revision.Oct 18 2021, 9:04 AM
jhuber6 requested review of this revision.Oct 18 2021, 9:04 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 18 2021, 9:04 AM
This revision is now accepted and ready to land.Oct 18 2021, 5:01 PM

Unrelated: We should provide two sets of functions so that users can benefit from the same compile-time + runtime selection logic.

  1. enter/exit functions, like above. In C++ we can even have a RAII
  2. a generic "llvm_omp_is_debug_enabled(bit)" function that evaluates at compile time if the command line flag was not set.
openmp/docs/design/Runtimes.rst
432

Make it explicit that both options (compile time and env var) need to be set. So only the bits set in both will actually be enabled.

435

We still need to find a way such that the number goes first, I always miss it online.

jhuber6 updated this revision to Diff 383439.Oct 29 2021, 11:22 AM

Making the zero overhead aspect of debugging more explicit.

This revision was automatically updated to reflect the committed changes.