Changeset 2704 for XIOS2/dev/hshepherd/reduce_output_log/src/client.cpp

Timestamp:

01/17/25 15:18:37 (3 weeks ago)

Author:

hshepherd

Message:

Port across changes from the patching - Not yet tested

File:

• XIOS2/dev/hshepherd/reduce_output_log/src/client.cpp (modified) (11 diffs)

XIOS2/dev/hshepherd/reduce_output_log/src/client.cpp

@@ -13 +13 @@
 #include "buffer_client.hpp"
 #include "string_tools.hpp"
+#include "timestats.hpp"
 
 namespace xios
@@ -261 +262 @@
     }
 
+        std::vector<double> CClient::collate_timings(std::string timing_param)
+    {
+      int myrank, comm_size;
+      MPI_Comm_rank(intraComm, &myrank);
+      MPI_Comm_size(intraComm, &comm_size);
+
+      std::vector<double> collated_results;
+      MPI_Barrier(intraComm);
+      if (myrank == 0) {
+        double recv_val = 0.;
+        collated_results.push_back(CTimer::get(timing_param).getCumulatedTime());
+        for (int i = 1; i < comm_size; i++) {
+          MPI_Recv(&recv_val, 1, MPI_DOUBLE, i, 0, intraComm, MPI_STATUS_IGNORE);
+          collated_results.push_back(recv_val);
+        }
+      } else {
+        double snd_val = CTimer::get(timing_param).getCumulatedTime();
+        MPI_Send(&snd_val, 1, MPI_DOUBLE, 0, 0, intraComm);
+      }
+      MPI_Barrier(intraComm);
+      return collated_results;
+    }
+
+    void CClient::present_collated_timings(void)
+    {
+      std::vector<double> blocking_times = collate_timings("Blocking time");
+      // we need to suspend the XIOS init/finalize timer briefly to gather the measurements
+      CTimer::get("XIOS init/finalize").suspend();
+      std::vector<double> init_final_times = collate_timings("XIOS init/finalize");
+      CTimer::get("XIOS init/finalize").resume();
+      std::vector<double> ratio = percentage_ratio_vec_double(blocking_times, init_final_times);
+      if (rank_ == 0) {
+        int n_ranks;
+        MPI_Comm_size(intraComm, &n_ranks);
+        
+        report(0) << " Performance metrics across all client ranks" << endl;
+        report(0) << "     Collating from " << n_ranks << " ranks" << endl;
+        write_summary_timings(blocking_times, "Time spent waiting for free buffer");
+        write_summary_timings(ratio, "Waiting ratio (percentage)");
+      }
+    }
+
+    void CClient::write_summary_timings(std::vector<double>& collated_results,
+                                        std::string results_label)
+    {
+      report(0) << "  " << results_label << " average " << calc_mean_double(collated_results) << endl;
+      report(0) << "  " << results_label << " std dev " << calc_std_double(collated_results) << endl;
+      report(0) << "  " << results_label << " min " << calc_min_double(collated_results) << endl;
+      report(0) << "  " << results_label << " max " << calc_max_double(collated_results) << endl;
+    }
 
     void CClient::finalize(void)
@@ -266 +317 @@
       int rank ;
       int msg=0 ;
+
+      // Do our collated summary
+      present_collated_timings();
+      MPI_Barrier(intraComm);
 
       MPI_Comm_rank(intraComm,&rank) ;
@@ -294 +349 @@
       
       info(20) << "Client side context is finalized"<<endl ;
+
+      if (CXios::reduceLogFiles) report(0) << "Performance summary from the first rank in this intraComm." << endl;
+
       report(0) <<" Performance report : Whole time from XIOS init and finalize: "<< CTimer::get("XIOS init/finalize").getCumulatedTime()<<" s"<<endl ;
       report(0) <<" Performance report : total time spent for XIOS : "<< CTimer::get("XIOS").getCumulatedTime()<<" s"<<endl ;
@@ -354 +412 @@
 
     /*!
+    * \brief Check to see if we are on a rank for which we an output file
+    * If reduced output is selected we only write from a single client
+    * rank
+    */
+    bool CClient::writeLogFromRank()
+    {
+      bool do_write = false;
+      if (!CXios::reduceLogFiles)
+      {
+        return true;
+      }
+      if (rank_ == 0)
+      {
+        do_write = true;
+      }
+      return do_write;
+    }
+
+    /*!
     * \brief Open a file stream to write the info logs
     * Open a file stream with a specific file name suffix+rank
@@ -359 +436 @@
     * \param fileName [in] protype file name
     */
-    void CClient::openInfoStream(const StdString& fileName)
-    {
-      std::filebuf* fb = m_infoStream.rdbuf();
-      openStream(fileName, ".out", fb);
-
-      info.write2File(fb);
-      report.write2File(fb);
+        void CClient::openInfoStream(const StdString& fileName)
+    {
+      if (writeLogFromRank())
+      {
+        std::filebuf* fb = m_infoStream.rdbuf();
+        openStream(fileName, ".out", fb);
+
+        info.write2File(fb);
+        report.write2File(fb);
+      }
     }
 
@@ -371 +451 @@
     void CClient::openInfoStream()
     {
-      info.write2StdOut();
-      report.write2StdOut();
+      if (writeLogFromRank())
+      {
+        info.write2StdOut();
+        report.write2StdOut();
+      }
     }
 
@@ -378 +461 @@
     void CClient::closeInfoStream()
     {
-      if (m_infoStream.is_open()) m_infoStream.close();
-    }
+      if (writeLogFromRank())
+      {
+        if (m_infoStream.is_open()) m_infoStream.close();
+      }
+    }
+
 
     /*!
@@ -389 +476 @@
     void CClient::openErrorStream(const StdString& fileName)
     {
-      std::filebuf* fb = m_errorStream.rdbuf();
-      openStream(fileName, ".err", fb);
-
-      error.write2File(fb);
+      if (writeLogFromRank())
+      {
+        std::filebuf* fb = m_errorStream.rdbuf();
+        openStream(fileName, ".err", fb);
+
+        error.write2File(fb);
+      }
     }
 
@@ -398 +488 @@
     void CClient::openErrorStream()
     {
-      error.write2StdErr();
+      if (writeLogFromRank())
+      {
+        error.write2StdErr();
+      }
     }
 
@@ -404 +497 @@
     void CClient::closeErrorStream()
     {
-      if (m_errorStream.is_open()) m_errorStream.close();
+      if (writeLogFromRank())
+      {
+        if (m_errorStream.is_open()) m_errorStream.close();
+      }
     }
 }