Add ATLAS_DEBUG_SYNC macros with a timeout to catch deadlocks#385
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new, robust, and synchronized debugging and logging mechanism for MPI-parallel applications in Atlas. It replaces the older
ATLAS_DEBUG_PARALLELmacros with newATLAS_DEBUG_SYNCmacros, which ensure output is properly synchronized across MPI ranks, handle timeouts, and provide flexible configuration for debugging complex parallel scenarios. It also adds comprehensive tests to validate the new debugging features.The most important changes are:
Synchronized Debugging and Logging Functionality
ATLAS_DEBUG_SYNCandATLAS_DEBUG_SYNC_VARmacros inLog.hto replace the oldATLAS_DEBUG_PARALLELmacros, providing synchronized logging across MPI ranks with flexible argument handling and improved usability.debug_syncfunctions inLog.ccthat handle MPI barriers with configurable timeouts and actions (abort, throw, continue), as well as synchronized flushing of output streams and detailed backtraces for debugging.Timeout and Error Handling for MPI Barriers
ATLAS_MPI_BARRIER_TIMEOUT_ACTIONenvironment variable and reporting of ranks that timed out.Code Modernization and Refactoring
debug_parallel_hereanddebug_parallel_whatfunctions, fully replacing them with the newdebug_syncinfrastructure. [1] [2]Testing
test_debug_logging.cc) and corresponding CMake test targets to validate the new debugging macros and timeout behaviors in both serial and MPI-parallel contexts. [1] [2]Dependency and Include Updates
Log.ccto support new features, such as threading, chrono, and data synchronization, and to ensure compatibility across platforms.These changes collectively improve the reliability, configurability, and usability of debugging and logging in parallel Atlas applications.
💣💥☠️ Static Analyzer Report ☠️💥💣
https://sites.ecmwf.int/docs/atlas/static-analyzer/PR-385