Enable MPI support to execute MPI specific unit/functional tests (#1996)

* Added MPI support to execute unit/functional tests Update node and process validation Updated node detection count and modified validation method Update validation logic to include max procs and nodes * Address review comments * Fix warnings * Added a new NET transport test and clean up * Added MPI test logging mechanism * Decoupled GTest framework * Added Net IB functional tests * Updated with resource guards * Added NET IB tests and refactored code * Update P2pWorkflow test * Update documentation * Add MPI_TESTS_ENABLED guard to the file * Fix Shm and NetIB tests * Applied refactoring and cleanup * Replaced BufferGuard with AutoGuard * Modified test debug logging * Use macro to reduce NcclTypeTraits code duplication - Replace repetitive template specializations with a single DEFINE_NCCL_TYPE_TRAIT macro - Use stringification operator (#) to auto-generate type name strings - Add #undef to keep macro from polluting namespace - Makes adding new type mappings trivial * Unify buffer initialization with generic pattern function - Remove initializeBufferWithCustomPattern - Make initializeBufferWithPattern generic with PatternFunc template param - Now single function handles all patterns via lambda injection - Updated all test files to use lambdas for pattern generation - Pattern logic now visible at call site (self-documenting) * Unify buffer verification with pluggable pattern function - Remove verifyBufferWithCustomCheck - Make verifyBufferData generic with PatternFunc template param - Single function handles all verification patterns via lambda injection - Updated all test files to use lambdas - Better defaults: num_samples=0 means verify all elements - Pattern logic now visible at call site (self-documenting) * Docs: Add DeviceBufferHelpers section to MPITestRunner.md - Document new refactored buffer initialization/verification API - Explain pluggable pattern functions with lambda examples - Show type mapping and automatic float/int comparison - Include migration guide from old API to new unified functions - Demonstrate best practices with real-world examples - Reference recent refactoring commits (macro-based type traits) * Docs: Update documentation and examples - Update on DeviceBufferHelpers - Update examples using DeviceBufferHelpers methods, e.g. data verification * Address review comment. - Replace manual pattern generation loop with initializeBufferWithPattern call - Use downloadBuffer to get host copy instead of manual hipMemcpy * Remove non-existent dependency * Remove duplicate testcase * Code cleanup in test files * Moved common constants to base class
2025-12-06 16:05:37 -06:00
parent 8ad446b271
commit 29e1567b95
22 changed files with 11512 additions and 2 deletions
@@ -0,0 +1,85 @@
+/*************************************************************************
+ * Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved.
+ *
+ * See LICENSE.txt for license information
+ ************************************************************************/
+
+/**
+ * @file main_mpi.cpp
+ * @brief Main entry point for Google Test-based MPI tests
+ *
+ * This file provides the main() function for running GTest-based MPI tests.
+ * For standalone tests (performance benchmarks, etc.), each test should have
+ * its own main() function and use MPIHelpers for common functionality.
+ */
+
+#include <cstdio>
+#include <cstdlib>
+#include <gtest/gtest.h>
+
+#ifdef MPI_TESTS_ENABLED
+
+    #include "MPIHelpers.hpp"
+    #include "MPITestBase.hpp"
+    #include "MPIEnvironment.hpp"
+
+int main(int argc, char* argv[])
+{
+    // Initialize MPI using shared helper
+    auto mpi_ctx = MPIHelpers::initializeMPI(&argc, &argv);
+
+    const auto world_rank = mpi_ctx.world_rank;
+    const auto world_size = mpi_ctx.world_size;
+
+    // Setup per-rank logging using shared helper
+    auto       rank_log_config          = MPIHelpers::setupRankLogging(world_rank);
+    const auto per_rank_logging_enabled = rank_log_config && rank_log_config->logging_enabled;
+
+    // Print initialization message
+    if(world_rank == 0 && !per_rank_logging_enabled)
+    {
+        TEST_INFO("MPI initialized - World size: %d, Thread support: %d",
+                  world_size,
+                  mpi_ctx.thread_support);
+    }
+
+    // Initialize Google Test
+    ::testing::InitGoogleTest(&argc, argv);
+
+    // Suppress GTest output for non-zero ranks (unless per-rank logging is enabled)
+    // This is done by deleting GTest listeners for non-zero ranks
+    // Note: stdout/stderr are already redirected for non-zero ranks by setupRankLogging
+    if(world_rank != 0 && !per_rank_logging_enabled)
+    {
+        auto& listeners = ::testing::UnitTest::GetInstance()->listeners();
+        delete listeners.Release(listeners.default_result_printer());
+        delete listeners.Release(listeners.default_xml_generator());
+    }
+
+    // Set up the RCCL MPI environment for all tests
+    ::testing::AddGlobalTestEnvironment(new MPIEnvironment());
+
+    // Run all tests
+    const auto ret_code = RUN_ALL_TESTS();
+
+    // Restore original output if per-rank logging was enabled
+    if(rank_log_config)
+    {
+        MPIHelpers::restoreRankLogging(*rank_log_config);
+    }
+
+    // MPI_Finalize called by MPIEnvironment destructor
+    return ret_code;
+}
+
+#else // MPI_TESTS_ENABLED not defined
+
+int main([[maybe_unused]] int argc, [[maybe_unused]] char* argv[])
+{
+    std::fprintf(stderr,
+                 "ERROR: MPI tests are not enabled. Please build with ENABLE_MPI_TESTS=ON\n");
+    std::fprintf(stderr, "Usage: cmake -DENABLE_MPI_TESTS=ON -DMPI_PATH=/path/to/mpi ..\n");
+    return 1;
+}
+
+#endif // MPI_TESTS_ENABLED