optionally store min-max raw TF range beyond random percentage

add SubTimeFrameFileSink options --data-sink-stf-min-id <int (def=-1)> --data-sink-stf-max-id <int (def=-1)> to force storage of TFs with ID matching this limits (on top of eventual random storage)
AliceO2Group · Nov 15, 2024 · 4ff6e16 · 4ff6e16
1 parent 0b7b83b
commit 4ff6e16
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/src/common/SubTimeFrameFileSink.cxx b/src/common/SubTimeFrameFileSink.cxx
@@ -88,6 +88,12 @@ bpo::options_description SubTimeFrameFileSink::getProgramOptions()
     OptionKeyStfSinkStfPercent,
     bpo::value<double>()->default_value(100.0),
     "Specifies probabilistic acceptance percentage for saving of each (Sub)TimeFrames, between 0.0 and 100. Default: 100.0")(
+    OptionKeyStfSinkMinTFIDForceToStore,
+    bpo::value<std::uint64_t>()->default_value(std::int64_t(0)),
+    "Specifies min TF ID forced to store regardless of requested mean fraction")(
+    OptionKeyStfSinkMaxTFIDForceToStore,
+    bpo::value<std::uint64_t>()->default_value(std::int64_t(0)),
+    "Specifies max TF ID forced to store regardless of requested mean fraction")(
     OptionKeyStfSinkFileSize,
     bpo::value<std::uint64_t>()->default_value(std::uint64_t(4) << 10), /* 4GiB */
     "Specifies target size for (Sub)TimeFrame files in MiB.")(
@@ -127,6 +133,8 @@ bool SubTimeFrameFileSink::loadVerifyConfig(const fair::mq::ProgOptions& pFMQPro
   mStfsPerFile = pFMQProgOpt.GetValue<std::uint64_t>(OptionKeyStfSinkStfsPerFile);
   mFileSize = std::max(std::uint64_t(1), pFMQProgOpt.GetValue<std::uint64_t>(OptionKeyStfSinkFileSize));
   mPercentageToSave = std::clamp(pFMQProgOpt.GetValue<double>(OptionKeyStfSinkStfPercent), 0.0, 100.0);
+  mMinTFIDForceToStore = pFMQProgOpt.GetValue<std::uint64_t>(OptionKeyStfSinkMinTFIDForceToStore);
+  mMaxTFIDForceToStore = pFMQProgOpt.GetValue<std::uint64_t>(OptionKeyStfSinkMaxTFIDForceToStore);
   mFileSize <<= 20; /* in MiB */
   mSidecar = pFMQProgOpt.GetValue<bool>(OptionKeyStfSinkSidecar);
   mEosMetaDir = pFMQProgOpt.GetValue<std::string>(OptionKeyStfSinkEpn2EosMetaDir);
@@ -197,6 +205,8 @@ bool SubTimeFrameFileSink::loadVerifyConfig(const fair::mq::ProgOptions& pFMQPro
   IDDLOG("(Sub)TimeFrame Sink :: root dir         = {}", mRootDir);
   IDDLOG("(Sub)TimeFrame Sink :: file pattern     = {}", mFileNamePattern);
   IDDLOG("(Sub)TimeFrame Sink :: stfs per file    = {}", (mStfsPerFile > 0 ? std::to_string(mStfsPerFile) : "unlimited" ));
+  IDDLOG("(Sub)TimeFrame Sink :: force min TFID   = {}", (mMinTFIDForceToStore > 0 && mMinTFIDForceToStore <= mMaxTFIDForceToStore ? std::to_string(mMinTFIDForceToStore) : "none"));
+  IDDLOG("(Sub)TimeFrame Sink :: force max TFID   = {}", (mMinTFIDForceToStore > 0 && mMinTFIDForceToStore <= mMaxTFIDForceToStore ? std::to_string(mMaxTFIDForceToStore) : "none"));
   IDDLOG("(Sub)TimeFrame Sink :: stfs percentage  = {:.4}", (mPercentageToSave));
   IDDLOG("(Sub)TimeFrame Sink :: max file size    = {}", mFileSize);
   IDDLOG("(Sub)TimeFrame Sink :: sidecar files    = {}", (mSidecar ? "yes" : "no"));
@@ -323,7 +333,7 @@ void SubTimeFrameFileSink::DataHandlerThread(const unsigned pIdx)
     }
 
     // apply rejection rules
-    bool lStfAccepted = (lUniformDist(lGen) <= mPercentageToSave) ? true : false;
+    bool lStfAccepted = (lUniformDist(lGen) <= mPercentageToSave) || (lStf->id() <= mMaxTFIDForceToStore && lStf->id() >= mMinTFIDForceToStore) ? true : false;
 
     if (mEnabled && mReady && lStfAccepted) {
       do {

diff --git a/src/common/SubTimeFrameFileSink.h b/src/common/SubTimeFrameFileSink.h
@@ -49,6 +49,8 @@ class SubTimeFrameFileSink
   static constexpr const char* OptionKeyStfSinkFileName = "data-sink-file-name";
   static constexpr const char* OptionKeyStfSinkStfsPerFile = "data-sink-max-stfs-per-file";
   static constexpr const char* OptionKeyStfSinkStfPercent = "data-sink-stf-percentage";
+  static constexpr const char* OptionKeyStfSinkMinTFIDForceToStore = "data-sink-stf-min-id";
+  static constexpr const char* OptionKeyStfSinkMaxTFIDForceToStore = "data-sink-stf-max-id";
   static constexpr const char* OptionKeyStfSinkFileSize = "data-sink-max-file-size";
   static constexpr const char* OptionKeyStfSinkSidecar = "data-sink-sidecar";
   static constexpr const char* OptionKeyStfSinkEpn2EosMetaDir = "data-sink-epn2eos-meta-dir";
@@ -101,6 +103,8 @@ class SubTimeFrameFileSink
   std::string mCurrentDir;
   std::string mFileNamePattern;
   std::uint64_t mStfsPerFile;
+  std::uint64_t mMinTFIDForceToStore = 0;
+  std::uint64_t mMaxTFIDForceToStore = 0;
   double mPercentageToSave = 100.0;
   std::uint64_t mFileSize;
   bool mSidecar = false;