Use bit manipulation with the UniqueIDGenSvc

and add a check for the case where an ID is repeated.
key4hep · Oct 9, 2024 · 5c45f3c · 5c45f3c
1 parent 117bbce
commit 5c45f3c
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 20 deletions.
diff --git a/k4FWCore/components/UniqueIDGenSvc.cpp b/k4FWCore/components/UniqueIDGenSvc.cpp
@@ -18,27 +18,47 @@
  */
 #include "UniqueIDGenSvc.h"
 
+#include <cstdint>
+#include <string>
+
 DECLARE_COMPONENT(UniqueIDGenSvc)
 
 UniqueIDGenSvc::UniqueIDGenSvc(const std::string& name, ISvcLocator* svcLoc) : base_class(name, svcLoc) {}
 
-StatusCode UniqueIDGenSvc::initialize() {
-  StatusCode sc = Service::initialize();
-  return sc;
-}
-
-const size_t bits32    = std::numeric_limits<uint32_t>::digits;
-const size_t bits64    = std::numeric_limits<uint64_t>::digits;
-const size_t bitsSizeT = std::numeric_limits<size_t>::digits;
+constexpr size_t bits32    = std::numeric_limits<uint32_t>::digits;
+constexpr size_t bits64    = std::numeric_limits<uint64_t>::digits;
+constexpr size_t bitsSizeT = std::numeric_limits<size_t>::digits;
 
 size_t UniqueIDGenSvc::getUniqueID(uint32_t evt_num, uint32_t run_num, const std::string& name) const {
-  std::bitset<bits64>    seed_bits(this->m_seed);
+  std::bitset<bits64>    seed_bits = this->m_seed.value();
   std::bitset<bits32>    event_num_bits(evt_num), run_num_bits(run_num);
   size_t                 str_hash = std::hash<std::string>{}(name);
   std::bitset<bitsSizeT> name_bits(str_hash);
 
-  std::bitset<bits64 + bits32 + bits32 + bitsSizeT> combined_bits(seed_bits.to_string() + event_num_bits.to_string() +
-                                                                  run_num_bits.to_string() + name_bits.to_string());
+  std::bitset<bits64 + bits32 + bits32 + bitsSizeT> combined_bits;
+
+  for (size_t i = 0; i < bits64; i++) {
+    combined_bits[i + bits32 + bits32 + bitsSizeT] = seed_bits[i];
+  }
+  for (size_t i = 0; i < bits32; i++) {
+    combined_bits[i + bits32 + bitsSizeT] = event_num_bits[i];
+  }
+  for (size_t i = 0; i < bits32; i++) {
+    combined_bits[i + bitsSizeT] = run_num_bits[i];
+  }
+  for (size_t i = 0; i < bitsSizeT; i++) {
+    combined_bits[i] = name_bits[i];
+  }
+
+  auto hash = std::hash<std::bitset<bits64 + bits32 + bits32 + bitsSizeT>>{}(combined_bits);
+  std::lock_guard<std::mutex> lock(m_mutex);
+  if (m_uniqueIDs.contains(hash)) {
+    warning() << "Event number " << evt_num << ", run number " << run_num << " and algorithm name \"" << name
+              << "\" have already been used. Please check the uniqueness of the event number, run number and name."
+              << endmsg;
+  } else {
+    m_uniqueIDs.insert(hash);
+  }
 
-  return std::hash<std::bitset<bits64 + bits32 + bits32 + bitsSizeT>>{}(combined_bits);
+  return hash;
 }
diff --git a/k4FWCore/components/UniqueIDGenSvc.h b/k4FWCore/components/UniqueIDGenSvc.h
@@ -19,11 +19,13 @@
 #ifndef FWCORE_UNIQUEIDGENSVC_H
 #define FWCORE_UNIQUEIDGENSVC_H
 
+#include "GaudiKernel/Service.h"
+#include "k4Interface/IUniqueIDGenSvc.h"
+
 #include <cstdint>
+#include <functional>
 #include <string>
-
-#include <GaudiKernel/Service.h>
-#include "k4Interface/IUniqueIDGenSvc.h"
+#include <unordered_set>
 
 /** @class UniqueIDGenSvc
  *  Generate unique, reproducible numbers using
@@ -34,11 +36,12 @@
 class UniqueIDGenSvc : public extends<Service, IUniqueIDGenSvc> {
 public:
   UniqueIDGenSvc(const std::string& name, ISvcLocator* svcLoc);
-  StatusCode initialize() override;
   size_t     getUniqueID(uint32_t evt_num, uint32_t run_num, const std::string& name) const override;
 
 private:
-  Gaudi::Property<int64_t> m_seed{this, "Seed", {123456789}};
+  Gaudi::Property<uint64_t> m_seed{this, "Seed", {123456789}};
+  mutable std::unordered_set<size_t, std::identity> m_uniqueIDs;
+  mutable std::mutex m_mutex;
 };
 
 #endif
diff --git a/k4Interface/include/k4Interface/IUniqueIDGenSvc.h b/k4Interface/include/k4Interface/IUniqueIDGenSvc.h
@@ -19,10 +19,7 @@
 #ifndef FWCORE_IUNIQUEIDGENSVC_H
 #define FWCORE_IUNIQUEIDGENSVC_H
 
-#include <bitset>
 #include <cstdint>
-#include <functional>
-#include <limits>
 #include <string>
 
 #include <GaudiKernel/IInterface.h>

diff --git a/test/k4FWCoreTest/CMakeLists.txt b/test/k4FWCoreTest/CMakeLists.txt
@@ -126,6 +126,7 @@ add_test(NAME checkKeepDropSwitch
 set_test_env(checkKeepDropSwitch)
 set_property(TEST checkKeepDropSwitch APPEND PROPERTY DEPENDS ReadExampleEventData)
 add_test_with_env(TestUniqueIDGenSvc options/TestUniqueIDGenSvc.py)
+add_test_with_env(TestUniqueIDGenSvcRepeated options/TestUniqueIDGenSvc.py PROPERTIES PASS_REGULAR_EXPRESSION "WARNING *Event number 4, run number 3 and algorithm name \"Some algorithm name\" have already been used. Please check the uniqueness of the event number, run number and name.")
 add_test_with_env(TestEventHeaderFiller options/createEventHeader.py)
 add_test_with_env(EventHeaderCheck options/runEventHeaderCheck.py PROPERTIES DEPENDS TestEventHeaderFiller)
 add_test(NAME TestExec WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} COMMAND python options/TestExec.py)