Conda CI: Use sockets transport for testing SST (#1956)

* ADIOS2: Configure SST transports via environment variables

Add OPENPMD_ADIOS2_SST_DATA_TRANSPORT, OPENPMD_ADIOS2_SST_WAN_TRANSPORT and OPENPMD_ADIOS2_SST_CONTROL_TRANSPORT. Also route existing environment-based engine parameters through the shared setParameter helper.

* CI: Use WAN data transport for SST in conda job

Avoid the system-specific UCX data plane in the conda_ompi_all job by using the WAN/sockets transport for SST.

---------

Co-authored-by: opencode <noreply@opencode.ai>

Author: franzpoeschel

.github/workflows/linux.yml

@@ -353,7 +353,11 @@ jobs:
         channel-priority: true
     - name: Build
       shell: bash -eo pipefail -l {0}
-      env: {CXXFLAGS: -Werror}
+      env:
+        CXXFLAGS: -Werror
+        OPENPMD_ADIOS2_SST_DATA_TRANSPORT: WAN
+        OPENPMD_ADIOS2_SST_WAN_TRANSPORT: sockets
+        OPENPMD_ADIOS2_SST_CONTROL_TRANSPORT: tcp
       run: |
         share/openPMD/download_samples.sh build
         cmake -S . -B build                                \

docs/source/backends/adios2.rst

@@ -75,24 +75,27 @@ The ADIOS2 SST engine for streaming can be picked by specifying the ending ``.ss
 The following environment variables control ADIOS2 I/O behavior at runtime.
 Fine-tuning these is especially useful when running at large scale.
 
-======================================= ========== ================================================================================
-environment variable                    default    description
-======================================= ========== ================================================================================
-``OPENPMD_ADIOS2_HAVE_PROFILING``       ``1``      Turns on/off profiling information right after a run.
-``OPENPMD_ADIOS2_HAVE_METADATA_FILE``   ``1``      Online creation of the adios journal file (``1``: yes, ``0``: no).
-``OPENPMD_ADIOS2_NUM_SUBSTREAMS``       ``0``      Number of files to be created, 0 indicates maximum number possible.
-``OPENPMD_ADIOS2_ENGINE``               ``File``   `ADIOS2 engine <https://adios2.readthedocs.io/en/latest/engines/engines.html>`_
-``OPENPMD_ADIOS2_PRETEND_ENGINE``       *empty*    Pretend that an (unknown) ADIOS2 engine is in fact another one (also see the ``adios2.pretend_engine`` :ref:`parameter <backendconfig-adios2>`).
-``OPENPMD2_ADIOS2_USE_GROUP_TABLE``     ``0``      Use group table (see below)
-``OPENPMD_ADIOS2_STATS_LEVEL``          see below  Whether to generate statistics for variables in ADIOS2. (``1``: yes, ``0``: no)
-``OPENPMD_ADIOS2_ASYNC_WRITE``          ``0``      ADIOS2 BP5 engine: 1 means setting "AsyncWrite" in ADIOS2 to "on". Flushes will go to the buffer by default (see ``preferred_flush_target``).
-``OPENPMD_ADIOS2_BP5_BufferChunkMB``    ``0``      ADIOS2 BP5 engine: applies when using either EveryoneWrites or EveryoneWritesSerial aggregation
-``OPENPMD_ADIOS2_BP5_MaxShmMB``         ``0``      ADIOS2 BP5 engine: applies when using TwoLevelShm aggregation
-``OPENPMD_ADIOS2_BP5_NumSubFiles``      ``0``      ADIOS2 BP5 engine: num of subfiles
-``OPENPMD_ADIOS2_BP5_NumAgg``           ``0``      ADIOS2 BP5 engine: num of aggregators
-``OPENPMD_ADIOS2_BP5_TypeAgg``          *empty*    ADIOS2 BP5 engine: aggregation type. (EveryoneWrites, EveryoneWritesSerial, TwoLevelShm)
-``OPENPMD_BP5_GROUPENCODING_MAX_STEPS`` ``100``    ADIOS2 BP5 engine: max number of allowed output steps in group encoding.
-======================================= ========== ================================================================================
+======================================== ========== ================================================================================
+environment variable                     default    description
+======================================== ========== ================================================================================
+``OPENPMD_ADIOS2_HAVE_PROFILING``        ``1``      Turns on/off profiling information right after a run.
+``OPENPMD_ADIOS2_HAVE_METADATA_FILE``    ``1``      Online creation of the adios journal file (``1``: yes, ``0``: no).
+``OPENPMD_ADIOS2_NUM_SUBSTREAMS``        ``0``      Number of files to be created, 0 indicates maximum number possible.
+``OPENPMD_ADIOS2_ENGINE``                ``File``   `ADIOS2 engine <https://adios2.readthedocs.io/en/latest/engines/engines.html>`_
+``OPENPMD_ADIOS2_PRETEND_ENGINE``        *empty*    Pretend that an (unknown) ADIOS2 engine is in fact another one (also see the ``adios2.pretend_engine`` :ref:`parameter <backendconfig-adios2>`).
+``OPENPMD2_ADIOS2_USE_GROUP_TABLE``      ``0``      Use group table (see below)
+``OPENPMD_ADIOS2_STATS_LEVEL``           see below  Whether to generate statistics for variables in ADIOS2. (``1``: yes, ``0``: no)
+``OPENPMD_ADIOS2_ASYNC_WRITE``           ``0``      ADIOS2 BP5 engine: 1 means setting "AsyncWrite" in ADIOS2 to "on". Flushes will go to the buffer by default (see ``preferred_flush_target``).
+``OPENPMD_ADIOS2_SST_DATA_TRANSPORT``    varies     ADIOS2 SST engine: data transport (``UCX``, ``MPI``, ``RDMA``, ``WAN``).
+``OPENPMD_ADIOS2_SST_WAN_TRANSPORT``     sockets    ADIOS2 SST engine: EVPath transport when ``DataTransport`` is ``WAN``.
+``OPENPMD_ADIOS2_SST_CONTROL_TRANSPORT`` tcp        ADIOS2 SST engine: control transport (``tcp`` or ``scalable``).
+``OPENPMD_ADIOS2_BP5_BufferChunkMB``     ``0``      ADIOS2 BP5 engine: applies when using either EveryoneWrites or EveryoneWritesSerial aggregation
+``OPENPMD_ADIOS2_BP5_MaxShmMB``          ``0``      ADIOS2 BP5 engine: applies when using TwoLevelShm aggregation
+``OPENPMD_ADIOS2_BP5_NumSubFiles``       ``0``      ADIOS2 BP5 engine: num of subfiles
+``OPENPMD_ADIOS2_BP5_NumAgg``            ``0``      ADIOS2 BP5 engine: num of aggregators
+``OPENPMD_ADIOS2_BP5_TypeAgg``           *empty*    ADIOS2 BP5 engine: aggregation type. (EveryoneWrites, EveryoneWritesSerial, TwoLevelShm)
+``OPENPMD_BP5_GROUPENCODING_MAX_STEPS``  ``100``    ADIOS2 BP5 engine: max number of allowed output steps in group encoding.
+======================================== ========== ================================================================================
 
 Please refer to the `ADIOS2 documentation <https://adios2.readthedocs.io/en/latest/engines/engines.html>`_ for details on I/O tuning.
 

src/IO/ADIOS/ADIOS2File.cpp

@@ -641,54 +641,39 @@ void ADIOS2File::configure_IO()
         return it == alreadyConfigured.end();
     };
 
-    // read parameters from environment
-    if (notYetConfigured("CollectiveMetadata"))
-    {
-        if (1 == auxiliary::getEnvNum("OPENPMD_ADIOS2_HAVE_METADATA_FILE", 1))
-        {
-            m_IO.SetParameter("CollectiveMetadata", "On");
-        }
-        else
-        {
-            m_IO.SetParameter("CollectiveMetadata", "Off");
-        }
-    }
-    if (notYetConfigured("Profile"))
-    {
-        if (1 == auxiliary::getEnvNum("OPENPMD_ADIOS2_HAVE_PROFILING", 1) &&
-            notYetConfigured("Profile"))
+    auto setParameter = [&](std::string const &parameter, std::string value) {
+        if (notYetConfigured(parameter) && !value.empty())
         {
-            m_IO.SetParameter("Profile", "On");
+            m_IO.SetParameter(parameter, std::move(value));
         }
-        else
-        {
-            m_IO.SetParameter("Profile", "Off");
-        }
-    }
-    if (notYetConfigured("AsyncWrite"))
+    };
+
+    // read parameters from environment
+    setParameter(
+        "CollectiveMetadata",
+        1 == auxiliary::getEnvNum("OPENPMD_ADIOS2_HAVE_METADATA_FILE", 1)
+            ? "On"
+            : "Off");
+    setParameter(
+        "Profile",
+        1 == auxiliary::getEnvNum("OPENPMD_ADIOS2_HAVE_PROFILING", 1) ? "On"
+                                                                      : "Off");
+    bool asyncWrite =
+        1 == auxiliary::getEnvNum("OPENPMD_ADIOS2_ASYNC_WRITE", 0);
+    if (asyncWrite && notYetConfigured("AsyncWrite") &&
+        !wasTheFlushTargetSpecifiedViaJSON)
     {
-        if (1 == auxiliary::getEnvNum("OPENPMD_ADIOS2_ASYNC_WRITE", 0) &&
-            notYetConfigured("AsyncWrite"))
-        {
-            m_IO.SetParameter("AsyncWrite", "On");
-            if (!wasTheFlushTargetSpecifiedViaJSON)
-            {
-                m_impl->m_flushTarget = FlushTarget::Buffer;
-            }
-        }
-        else
-        {
-            m_IO.SetParameter("AsyncWrite", "Off");
-        }
+        m_impl->m_flushTarget = FlushTarget::Buffer;
     }
+    setParameter("AsyncWrite", asyncWrite ? "On" : "Off");
 
 #if openPMD_HAVE_MPI
     {
         auto num_substreams =
             auxiliary::getEnvNum("OPENPMD_ADIOS2_NUM_SUBSTREAMS", 0);
-        if (notYetConfigured("SubStreams") && 0 != num_substreams)
+        if (num_substreams != 0)
         {
-            m_IO.SetParameter("SubStreams", std::to_string(num_substreams));
+            setParameter("SubStreams", std::to_string(num_substreams));
         }
 
         // BP5 parameters
@@ -701,18 +686,17 @@ void ADIOS2File::configure_IO()
         auto BufferChunkMB =
             auxiliary::getEnvNum("OPENPMD_ADIOS2_BP5_BufferChunkMB", 0);
 
-        if (notYetConfigured("NumAggregators") && (numAgg > 0))
-            m_IO.SetParameter("NumAggregators", std::to_string(numAgg));
-        if (notYetConfigured("NumSubFiles") && (numSubFiles > 0))
-            m_IO.SetParameter("NumSubFiles", std::to_string(numSubFiles));
-        if (notYetConfigured("AggregationType") && (AggTypeStr.size() > 0))
-            m_IO.SetParameter("AggregationType", AggTypeStr);
-        if (notYetConfigured("BufferChunkSize") && (BufferChunkMB > 0))
-            m_IO.SetParameter(
+        if (numAgg > 0)
+            setParameter("NumAggregators", std::to_string(numAgg));
+        if (numSubFiles > 0)
+            setParameter("NumSubFiles", std::to_string(numSubFiles));
+        setParameter("AggregationType", AggTypeStr);
+        if (BufferChunkMB > 0)
+            setParameter(
                 "BufferChunkSize",
                 std::to_string((uint64_t)BufferChunkMB * (uint64_t)1048576));
-        if (notYetConfigured("MaxShmSize") && (MaxShmMB > 0))
-            m_IO.SetParameter(
+        if (MaxShmMB > 0)
+            setParameter(
                 "MaxShmSize",
                 std::to_string((uint64_t)MaxShmMB * (uint64_t)1048576));
     }
@@ -724,24 +708,35 @@ void ADIOS2File::configure_IO()
     constexpr int default_stats_level = 0;
 #endif
 
-    if (notYetConfigured("StatsLevel"))
+    /*
+     * Up until and including ADIOS2 v2.12.0:
+     *
+     * Switch those off by default since they are expensive to compute
+     * and to enable it, set the JSON option "StatsLevel" or the
+     * environment variable "OPENPMD_ADIOS2_STATS_LEVEL" be positive.
+     * The ADIOS2 default was "1" (on).
+     *
+     * Beginning ADIOS2 v2.12.1:
+     *
+     * Performance for Stats computation has been improved through
+     * vectorization, so we switch it on by default.
+     */
+    auto stats_level =
+        auxiliary::getEnvNum("OPENPMD_ADIOS2_STATS_LEVEL", default_stats_level);
+    setParameter("StatsLevel", std::to_string(stats_level));
+
+    if (m_impl->realEngineType() == "sst")
     {
-        /*
-         * Up until and including ADIOS2 v2.12.0:
-         *
-         * Switch those off by default since they are expensive to compute
-         * and to enable it, set the JSON option "StatsLevel" or the
-         * environment variable "OPENPMD_ADIOS2_STATS_LEVEL" be positive.
-         * The ADIOS2 default was "1" (on).
-         *
-         * Beginning ADIOS2 v2.12.1:
-         *
-         * Performance for Stats computation has been improved through
-         * vectorization, so we switch it on by default.
-         */
-        auto stats_level = auxiliary::getEnvNum(
-            "OPENPMD_ADIOS2_STATS_LEVEL", default_stats_level);
-        m_IO.SetParameter("StatsLevel", std::to_string(stats_level));
+        setParameter(
+            "DataTransport",
+            auxiliary::getEnvString("OPENPMD_ADIOS2_SST_DATA_TRANSPORT", ""));
+        setParameter(
+            "WANDataTransport",
+            auxiliary::getEnvString("OPENPMD_ADIOS2_SST_WAN_TRANSPORT", ""));
+        setParameter(
+            "ControlTransport",
+            auxiliary::getEnvString(
+                "OPENPMD_ADIOS2_SST_CONTROL_TRANSPORT", ""));
     }
     if (m_impl->realEngineType() == "sst" && notYetConfigured("QueueLimit"))
     {