Merge pull request #278 from JeffersonLab/nbrei_timeslices

Add support for timeslices

CMakeLists.txt

@@ -108,12 +108,12 @@ if (${USE_XERCES})
 endif()
 
 if (${USE_ASAN})
-    add_compile_options(-fsanitize=address -g -O2)
+    add_compile_options(-fsanitize=address)
     add_link_options(-fsanitize=address)
 endif()
 
 if (${USE_TSAN})
-    add_compile_options(-fsanitize=thread -g -O2)
+    add_compile_options(-fsanitize=thread)
     add_link_options(-fsanitize=thread)
 endif()
 

src/examples/CMakeLists.txt

@@ -8,4 +8,5 @@ add_subdirectory(BlockExample)
 add_subdirectory(SubeventExample)
 add_subdirectory(SubeventCUDAExample)
 add_subdirectory(UnitTestingExample)
-add_subdirectory(PodioExample)
+add_subdirectory(PodioExample)
+add_subdirectory(TimesliceExample)

src/examples/StreamingExample/ZmqMain.cc

@@ -58,8 +58,6 @@ void InitPlugin(JApplication *app) {
     app->Add(new AHitAnomalyDetector(app, 5000));
     app->Add(new JFactoryGeneratorT<AHitParser>());
 
-    // So we don't have to put this on the cmd line every time
-    app->SetParameterValue("jana:legacy_mode", 0);
     app->SetParameterValue("jana:extended_report", 0);
 
     new std::thread(dummy_publisher_loop);

src/examples/SubeventExample/CMakeLists.txt

@@ -7,7 +7,7 @@ set (SubeventExample_SOURCES
 add_executable(SubeventExample ${SubeventExample_SOURCES})
 
 target_link_libraries(SubeventExample jana2)
-set_target_properties(SubeventExample PROPERTIES PREFIX "" OUTPUT_NAME "SubeventExample" SUFFIX ".so")
-install(TARGETS SubeventExample DESTINATION plugins)
+set_target_properties(SubeventExample PROPERTIES PREFIX "" OUTPUT_NAME "SubeventExample")
+install(TARGETS SubeventExample DESTINATION programs)
 
 

src/examples/TimesliceExample/CMakeLists.txt

@@ -0,0 +1,16 @@
+
+
+if (USE_PODIO)
+    set (TimesliceExample_SOURCES
+            TimesliceExample.cc
+        )
+
+    add_library(TimesliceExample SHARED ${TimesliceExample_SOURCES})
+    target_link_libraries(TimesliceExample jana2 podio::podio PodioExampleDatamodel PodioExampleDatamodelDict podio::podioRootIO)
+    set_target_properties(TimesliceExample PROPERTIES PREFIX "" SUFFIX ".so" OUTPUT_NAME "TimesliceExample")
+    install(TARGETS TimesliceExample DESTINATION programs)
+
+else()
+    message(STATUS "Skipping examples/TimesliceExample because USE_PODIO=Off")
+endif()
+

src/examples/TimesliceExample/MyDataModel.h

@@ -0,0 +1,18 @@
+// Copyright 2024, Jefferson Science Associates, LLC.
+// Subject to the terms in the LICENSE file found in the top-level directory.
+
+#pragma once
+
+#include <JANA/JObject.h>
+
+struct MyHit : public JObject {
+    int hit_id;
+    int energy, x, y;
+};
+
+struct MyCluster : public JObject {
+    int cluster_id;
+    int energy, x, y;
+    std::vector<int> hits;
+};
+

src/examples/TimesliceExample/MyEventFactory.h

@@ -0,0 +1,39 @@
+
+
+
+// Copyright 2024, Jefferson Science Associates, LLC.
+// Subject to the terms in the LICENSE file found in the top-level directory.
+
+#pragma once
+#include "MyDataModel.h"
+#include <JANA/JFactoryT.h>
+#include <JANA/Omni/JOmniFactory.h>
+
+
+struct MyClusterFactory : public JFactoryT<MyCluster> {
+
+    int init_call_count = 0;
+    int change_run_call_count = 0;
+    int process_call_count = 0;
+
+    MyClusterFactory() {
+        SetLevel(JEventLevel::Event);
+    }
+
+    void Init() override {
+        ++init_call_count;
+    }
+
+    void ChangeRun(const std::shared_ptr<const JEvent>&) override {
+        ++change_run_call_count;
+    }
+
+    void Process(const std::shared_ptr<const JEvent>& event) override {
+        ++process_call_count;
+
+        auto protos = event->Get<MyCluster>("protos");
+        // TODO: Output something sensible
+    }
+};
+
+

src/examples/TimesliceExample/MyEventProcessor.h

@@ -0,0 +1,35 @@
+
+// Copyright 2024, Jefferson Science Associates, LLC.
+// Subject to the terms in the LICENSE file found in the top-level directory.
+
+#pragma once
+#include "MyDataModel.h"
+#include <JANA/JEventProcessor.h>
+
+struct ExampleEventProcessor : public JEventProcessor {
+
+    std::mutex m_mutex;
+
+    ExampleTimesliceProcessor() {
+        SetEventLevel(JEvent::Level::Event);
+    }
+
+    void Process(const std::shared_ptr<const JEvent>& event) {
+
+        std::lock_guard<std::mutex> guard(m_mutex);
+
+        auto outputs = event->Get<MyOutput>();
+        // assert(outputs.size() == 4);
+        // assert(outputs[0]->z == 25.6f);
+        // assert(outputs[1]->z == 26.5f);
+        // assert(outputs[2]->z == 27.4f);
+        // assert(outputs[3]->z == 28.3f);
+        LOG << " Contents of event " << event->GetEventNumber() << LOG_END;
+        for (auto output : outputs) {
+            LOG << " " << output->evt << ":" << output->sub << " " << output->z << LOG_END;
+        }
+        LOG << " DONE with contents of event " << event->GetEventNumber() << LOG_END;
+    }
+};
+
+

src/examples/TimesliceExample/MyTimesliceFactory.h

@@ -0,0 +1,37 @@
+// Copyright 2024, Jefferson Science Associates, LLC.
+// Subject to the terms in the LICENSE file found in the top-level directory.
+
+#pragma once
+#include "MyDataModel.h"
+
+#include <JANA/Omni/JOmniFactory.h>
+#include <JANA/JFactoryT.h>
+
+
+struct MyProtoClusterFactory : public JFactoryT<MyCluster> {
+
+    int init_call_count = 0;
+    int change_run_call_count = 0;
+    int process_call_count = 0;
+
+    MyProtoClusterFactory() {
+        SetLevel(JEventLevel::Timeslice);
+    }
+
+    void Init() override {
+        ++init_call_count;
+    }
+
+    void ChangeRun(const std::shared_ptr<const JEvent>&) override {
+        ++change_run_call_count;
+    }
+
+    void Process(const std::shared_ptr<const JEvent>& event) override {
+        ++process_call_count;
+
+        auto protos = event->Get<MyCluster>("protos");
+        // TODO: Output something sensible
+    }
+};
+
+

src/examples/TimesliceExample/MyTimesliceSource.h

@@ -0,0 +1,40 @@
+// Copyright 2024, Jefferson Science Associates, LLC.
+// Subject to the terms in the LICENSE file found in the top-level directory.
+
+#pragma once
+#include "MyDataModel.h"
+#include <JANA/JEventSource.h>
+
+
+struct MyTimesliceSource : public JEventSource {
+
+    MyTimesliceSource(std::string source_name, JApplication *app) : JEventSource(source_name, app) { 
+        SetLevel(JEventLevel::Timeslice);
+    }
+
+    static std::string GetDescription() { return "MyTimesliceSource"; }
+
+    std::string GetType(void) const override { return JTypeInfo::demangle<decltype(*this)>(); }
+
+    void Open() override { }
+
+    void GetEvent(std::shared_ptr<JEvent> event) override {
+
+        auto evt = event->GetEventNumber();
+        std::vector<MyInput*> inputs;
+        inputs.push_back(new MyInput(22,3.6,evt,0));
+        inputs.push_back(new MyInput(23,3.5,evt,1));
+        inputs.push_back(new MyInput(24,3.4,evt,2));
+        inputs.push_back(new MyInput(25,3.3,evt,3));
+        inputs.push_back(new MyInput(26,3.2,evt,4));
+        event->Insert(inputs);
+
+        auto hits = std::make_unique<ExampleHitCollection>();
+        hits.push_back(ExampleHit(22));
+        hits.push_back(ExampleHit(23));
+        hits.push_back(ExampleHit(24));
+        event->InsertCollection(hits);
+
+        jout << "MyTimesliceSource: Emitting " << event->GetEventNumber() << jendl;
+    }
+};

src/examples/TimesliceExample/MyTimesliceUnfolder.h

@@ -0,0 +1,43 @@
+// Copyright 2024, Jefferson Science Associates, LLC.
+// Subject to the terms in the LICENSE file found in the top-level directory.
+
+#pragma once
+#include "MyDataModel.h"
+#include <JANA/JEventUnfolder.h>
+
+struct ExampleTimesliceUnfolder : public JEventUnfolder {
+
+    MyTimesliceUnfolder() {
+        SetParentLevel(JEventLevel::Timeslice);
+        SetChildLevel(JEventLevel::Event);
+    }
+
+    void Preprocess(const JEvent& parent) const override {
+        parent->Get<MyCluster>("protos");
+    }
+
+    Result Unfold(const JEvent& parent, JEvent& child, int item) override {
+        auto protos = parent->Get<MyCluster>("protos");
+
+        child.SetEventNumber(parent.GetEventNumber()*10 + item);
+        LOG << "Unfolding parent=" << parent.GetEventNumber() << ", child=" << child.GetEventNumber() << ", item=" << item << LOG_END;
+
+        std::vector<MyCluster*> child_protos;
+        for (auto proto: protos) {
+            if (true) {
+                // TODO: condition
+                child_protos.push_back(proto);
+            }
+        }
+        child->Insert(child_protos, "event_protos")->SetFactoryFlag(JFactoryFlag::NOT_OBJECT_OWNER);
+
+        if (item == 3) {
+            jout << "Unfold found item 3, finishing join" << jendl;
+            return Result::Finished;
+        }
+        return Result::KeepGoing;
+    }
+}
+
+
+

src/examples/TimesliceExample/TimesliceExample.cc

@@ -0,0 +1,30 @@
+// Copyright 2024, Jefferson Science Associates, LLC.
+// Subject to the terms in the LICENSE file found in the top-level directory.
+
+
+#include "MyTimesliceSource.h"
+#include "MyTimesliceUnfolder.h"
+#include "MyEventProcessor.h"
+#include "MyTimesliceFactory.h"
+#include "MyEventFactory.h"
+
+#include <JANA/JApplication.h>
+
+
+extern "C"{
+void InitPlugin(JApplication *app) {
+
+    InitJANAPlugin(app);
+
+    app->Add(new MyTimesliceSource("Dummy"));
+    app->Add(new MyTimesliceUnfolder);
+    app->Add(new MyEventProcessor);
+
+    app->Add(new JFactoryGeneratorT<MyTimesliceFactory>());
+    app->Add(new JFactoryGeneratorT<MyEventFactory>());
+
+    app->SetParameterValue("jana:extended_report", 0);
+}
+} // "C"
+
+

src/libraries/JANA/CMakeLists.txt

@@ -41,6 +41,8 @@ set(JANA2_SOURCES
     Engine/JEventSourceArrow.h
     Engine/JBlockSourceArrow.h
     Engine/JBlockDisentanglerArrow.h
+    Engine/JEventMapArrow.h
+    Engine/JEventMapArrow.cc
     Engine/JPool.h
 
     Engine/JMailbox.h
@@ -244,6 +246,7 @@ file(GLOB jana_calibs_headers "Calibrations/*.h*")
 file(GLOB jana_cli_headers "CLI/*.h*")
 file(GLOB jana_compat_headers "Compatibility/*.h*")
 file(GLOB jana_podio_headers "Podio/*.h*")
+file(GLOB jana_omni_headers "Omni/*.h*")
 
 install(FILES ${jana_headers} DESTINATION include/JANA)
 install(FILES ${jana_engine_headers} DESTINATION include/JANA/Engine)
@@ -254,6 +257,7 @@ install(FILES ${jana_utils_headers} DESTINATION include/JANA/Utils)
 install(FILES ${jana_calibs_headers} DESTINATION include/JANA/Calibrations)
 install(FILES ${jana_cli_headers} DESTINATION include/JANA/CLI)
 install(FILES ${jana_compat_headers} DESTINATION include/JANA/Compatibility)
+install(FILES ${jana_omni_headers} DESTINATION include/JANA/Omni)
 
 if (${USE_PODIO})
     install(FILES ${jana_podio_headers} DESTINATION include/JANA/Podio)

src/libraries/JANA/Engine/JArrow.h

@@ -29,7 +29,7 @@ class JArrow {
     const std::string m_name;     // Used for human understanding
     const bool m_is_parallel;     // Whether or not it is safe to parallelize
     const bool m_is_source;       // Whether or not this arrow should activate/drain the topology
-    const bool m_is_sink;         // Whether or not tnis arrow contributes to the final event count
+    bool m_is_sink;         // Whether or not tnis arrow contributes to the final event count
     JArrowMetrics m_metrics;      // Performance information accumulated over all workers
 
     mutable std::mutex m_arrow_mutex;  // Protects access to arrow properties
@@ -39,6 +39,7 @@ class JArrow {
 
     friend class JScheduler;
     std::vector<JArrow *> m_listeners;    // Downstream Arrows
+    friend class JTopologyBuilder;
     std::vector<PlaceRefBase*> m_places;  // Will eventually supplant m_listeners, m_chunksize
 
 protected:
@@ -57,6 +58,10 @@ class JArrow {
         m_logger = logger;
     }
 
+    void set_is_sink(bool is_sink) {
+        m_is_sink = is_sink;
+    }
+
     // TODO: Get rid of me
     void set_chunksize(size_t chunksize) {
         std::lock_guard<std::mutex> lock(m_arrow_mutex);

src/libraries/JANA/Engine/JArrowTopology.h

@@ -28,7 +28,7 @@ struct JArrowTopology {
     // Ensure that ComponentManager stays alive at least as long as JArrowTopology does
     // Otherwise there is a potential use-after-free when JArrowTopology or JArrowProcessingController access components
 
-    std::shared_ptr<JEventPool> event_pool; // TODO: Move into pools eventually
+    JEventPool* event_pool; // TODO: Move into pools eventually
     JPerfMetrics metrics;
 
     std::vector<JArrow*> arrows;

src/libraries/JANA/Engine/JBlockDisentanglerArrow.h

@@ -14,7 +14,7 @@ class JBlockDisentanglerArrow : public JArrow {
 	JBlockedEventSource<T>* m_source;  // non-owning
 	JMailbox<T*>* m_block_queue; // non-owning
 	JMailbox<std::shared_ptr<JEvent>*>* m_event_queue; // non-owning
-	std::shared_ptr<JEventPool> m_pool;
+	JEventPool* m_pool;
 
 	size_t m_max_events_per_block = 40;
 
@@ -23,13 +23,13 @@ class JBlockDisentanglerArrow : public JArrow {
 							JBlockedEventSource<T>* source,
 							JMailbox<T*>* block_queue,
 							JMailbox<std::shared_ptr<JEvent>*>* event_queue,
-							std::shared_ptr<JEventPool> pool
+							JEventPool* pool
 							)
 							: JArrow(std::move(name), true, false, false, 1)
 							, m_source(source)
 							, m_block_queue(block_queue)
 							, m_event_queue(event_queue)
-							, m_pool(std::move(pool))
+							, m_pool(pool)
 							{}
 
 	~JBlockDisentanglerArrow() {