1 #define TRACE_NAME "shared_memory_reader_t"
3 #include "artdaq/ArtModules/detail/SharedMemoryReader.hh"
4 #include "artdaq/DAQrate/SharedMemoryEventManager.hh"
6 #include "art/Framework/Core/FileBlock.h"
8 #include "art/Framework/IO/Sources/SourceHelper.h"
9 #include "art/Framework/Principal/Event.h"
10 #include "art/Framework/Principal/EventPrincipal.h"
11 #include "art/Framework/Principal/Handle.h"
12 #include "art/Framework/Principal/RunPrincipal.h"
13 #include "art/Framework/Principal/SubRunPrincipal.h"
15 #include "art/Persistency/Provenance/MasterProductRegistry.h"
16 #include "art/Persistency/Provenance/ProductMetaData.h"
17 #include "canvas/Persistency/Provenance/EventID.h"
18 #include "canvas/Persistency/Provenance/FileFormatVersion.h"
19 #include "canvas/Persistency/Provenance/ModuleDescription.h"
20 #include "canvas/Persistency/Provenance/Parentage.h"
21 #include "canvas/Persistency/Provenance/ProcessConfiguration.h"
22 #include "canvas/Persistency/Provenance/RunID.h"
23 #include "canvas/Persistency/Provenance/SubRunID.h"
24 #include "canvas/Persistency/Provenance/Timestamp.h"
25 #include "canvas/Utilities/Exception.h"
26 #include "art/Version/GetReleaseVersion.h"
27 #include "artdaq-core/Data/Fragment.hh"
28 #include "artdaq-core/Utilities/configureMessageFacility.hh"
29 #include "fhiclcpp/make_ParameterSet.h"
31 #define BOOST_TEST_MODULE shared_memory_reader_t
32 #include <boost/test/auto_unit_test.hpp>
52 typedef std::map<std::string, art::BranchKey>
BKmap_t;
66 art::ProcessConfiguration*
68 std::string
const& processName,
69 fhicl::ParameterSet
const& moduleParams,
70 std::string
const& release = art::getReleaseVersion()
80 std::unique_ptr<art::BranchDescription>
82 std::string
const& processName,
83 std::string
const& productInstanceName = std::string());
97 , processConfigurations_()
116 art::ProcessConfiguration*
119 std::string
const& processName,
120 fhicl::ParameterSet
const& moduleParams,
121 std::string
const& release
124 fhicl::ParameterSet processParams;
125 processParams.put(processName, moduleParams);
126 processParams.put<std::string>(
"process_name",
130 std::make_unique<art::ProcessConfiguration>(processName, processParams.id(), release, pass));
131 return emplace_pair.first->second.get();
134 std::unique_ptr<art::BranchDescription>
137 std::string
const& processName,
138 std::string
const& productInstanceName)
140 std::string moduleLabel = processName +
"dummyMod";
141 std::string moduleClass(
"DummyModule");
142 fhicl::ParameterSet modParams;
143 modParams.put<std::string>(
"module_type", moduleClass);
144 modParams.put<std::string>(
"module_label", moduleLabel);
145 art::ProcessConfiguration* process =
147 art::ModuleDescription mod(modParams.id(),
151 art::TypeID dummyType(
typeid(
int));
152 art::BranchDescription* result =
153 new art::BranchDescription(
155 art::TypeLabel(dummyType,
156 productInstanceName),
160 branchKeys_.insert(std::make_pair(tag, art::BranchKey(*result)));
161 return std::unique_ptr<art::BranchDescription>(result);
174 static bool once(
true);
177 artdaq::configureMessageFacility(
"shared_memory_reader_t");
179 art::ModuleDescription md(fhicl::ParameterSet().
id(),
182 *
gf().processConfigurations_[
"daq"]);
185 helper().registerProducts(
gf().productRegistry_, md);
207 static art::ProductRegistryHelper s_helper;
217 static std::unique_ptr<art::SourceHelper>
219 if (!s_source_helper)
221 fhicl::ParameterSet sourceParams;
222 std::string moduleType{
"DummySource" };
223 std::string moduleLabel{
"daq" };
224 sourceParams.put<std::string>(
"module_type", moduleType);
225 sourceParams.put<std::string>(
"module_label", moduleLabel);
229 art::ModuleDescription md(sourceParams.id(),
233 s_source_helper = std::make_unique<art::SourceHelper>(md);
235 return *s_source_helper;
244 static uint32_t key =
static_cast<uint32_t
>(std::hash<std::string>()(
"shared_memory_reader_t"));
253 static uint32_t key =
static_cast<uint32_t
>(std::hash<std::string>()(
"shared_memory_reader_t BROADCAST"));
264 fhicl::ParameterSet pset;
265 pset.put(
"shared_memory_key",
getKey());
267 pset.put(
"max_event_size_bytes", 0x100000);
268 pset.put(
"buffer_count", 10);
273 gf().productRegistry_);
274 static bool reader_initialized =
false;
275 if (!reader_initialized)
278 helper().reconstitutes<artdaq::Fragments, art::InEvent>(
"daq",
"ABCDEF");
279 reader_initialized =
true;
290 fhicl::ParameterSet pset;
291 pset.put(
"shared_memory_key",
getKey());
293 pset.put(
"max_event_size_bytes", 0x100000);
294 pset.put(
"art_analyzer_count", 0);
295 pset.put(
"stale_buffer_timeout_usec", 100000);
296 pset.put(
"expected_fragments_per_event", 1);
297 pset.put(
"buffer_count", 10);
299 s_writer(pset, pset);
319 std::unique_ptr<art::RunPrincipal>&& run,
320 std::unique_ptr<art::SubRunPrincipal>&& subrun,
321 art::EventID
const& eventid)
323 BOOST_REQUIRE(run || subrun ==
nullptr);
324 std::vector<artdaq::Fragment::value_type> fakeData{ 1, 2, 3, 4 };
326 tmpFrag(artdaq::Fragment::dataFrag(eventid.event(),
330 tmpFrag->setUserType(1);
335 auto iter = tmpFrag->dataBegin();
336 std::ostringstream str;
338 while (iter != tmpFrag->dataEnd())
340 str << *iter <<
", ";
345 TLOG(TLVL_DEBUG) <<
"Fragment to art: " << str.str();
348 artdaq::FragmentPtr tempFrag;
349 auto sts = writer.AddFragment(std::move(tmpFrag), 1000000, tempFrag);
350 BOOST_REQUIRE_EQUAL(sts,
true);
358 art::EventPrincipal* newevent =
nullptr;
359 art::SubRunPrincipal* newsubrun =
nullptr;
360 art::RunPrincipal* newrun =
nullptr;
361 bool rc = reader.
readNext(run.get(), subrun.get(), newrun, newsubrun, newevent);
363 if (run.get() && run->run() == eventid.run())
365 BOOST_CHECK(newrun ==
nullptr);
370 BOOST_CHECK(newrun->id() == eventid.runID());
372 if (!newrun && subrun.get() && subrun->subRun() == eventid.subRun())
374 BOOST_CHECK(newsubrun ==
nullptr);
378 BOOST_CHECK(newsubrun);
379 BOOST_CHECK(newsubrun->id() == eventid.subRunID());
381 BOOST_CHECK(newevent);
382 BOOST_CHECK(newevent->id() == eventid);
383 art::Event e(*newevent, art::ModuleDescription());
384 art::Handle<std::vector<artdaq::Fragment>> h;
385 e.getByLabel(
"daq",
"ABCDEF", h);
386 BOOST_CHECK(h.isValid());
387 BOOST_CHECK(h->size() == 1);
389 auto iter2 = h->front().dataBegin();
390 std::ostringstream str2;
392 while (iter2 != h->front().dataEnd())
394 str2 << *iter2 <<
", ";
399 TLOG(TLVL_DEBUG) <<
"Fragment from art: " << str2.str();
401 BOOST_CHECK(std::equal(fakeData.begin(),
403 h->front().dataBegin()));
412 art::EventID eventid(2112, 1, 3);
414 basic_test(reader(), writer(),
415 std::unique_ptr<art::RunPrincipal>(source_helper().makeRunPrincipal(eventid.run(), now)),
416 std::unique_ptr<art::SubRunPrincipal>(source_helper().makeSubRunPrincipal(eventid.run(), eventid.subRun(), now)),
422 art::EventID eventid(2112, 1, 3);
424 basic_test(reader(), writer(),
432 art::EventID eventid(2112, 1, 3);
434 basic_test(reader(), writer(),
435 std::unique_ptr<art::RunPrincipal>(source_helper().makeRunPrincipal(eventid.run(), now)),
436 std::unique_ptr<art::SubRunPrincipal>(source_helper().makeSubRunPrincipal(eventid.run(), 0, now)),
442 art::EventID eventid(2112, 1, 3);
444 basic_test(reader(), writer(),
445 std::unique_ptr<art::RunPrincipal>(source_helper().makeRunPrincipal(eventid.run() - 1, now)),
446 std::unique_ptr<art::SubRunPrincipal>(source_helper().makeSubRunPrincipal(eventid.run() - 1,
457 std::string
const fakeFileName(
"no such file exists");
458 art::FileBlock* pFile =
nullptr;
459 reader().readFile(fakeFileName, pFile);
461 BOOST_CHECK(pFile->fileFormatVersion() == art::FileFormatVersion(1,
"RawEvent2011"));
462 BOOST_CHECK(pFile->tree() ==
nullptr);
464 BOOST_CHECK(!pFile->fastClonable());
468 art::RunID runid(2112);
469 art::SubRunID subrunid(2112, 1);
470 art::EventID eventid(2112, 1, 3);
472 std::unique_ptr<art::RunPrincipal> run(source_helper().makeRunPrincipal(runid.run(), now));
473 std::unique_ptr<art::SubRunPrincipal> subrun(source_helper().makeSubRunPrincipal(runid.run(), subrunid.subRun(), now));
474 std::unique_ptr<art::EventPrincipal> event(source_helper().makeEventPrincipal(runid.run(),
478 writer().endOfData();
479 art::EventPrincipal* newevent =
nullptr;
480 art::SubRunPrincipal* newsubrun =
nullptr;
481 art::RunPrincipal* newrun =
nullptr;
482 bool rc = reader().readNext(run.get(), subrun.get(), newrun, newsubrun, newevent);
484 BOOST_CHECK(newrun ==
nullptr);
485 BOOST_CHECK(newsubrun ==
nullptr);
486 BOOST_CHECK(newevent ==
nullptr);
489 BOOST_AUTO_TEST_SUITE_END()
SharedMemoryReader Test Fixture.
std::map< std::string, std::unique_ptr< art::ProcessConfiguration > > processConfigurations_
Configurations.
The SharedMemoryReader is a class which implements the methods needed by art::Source.
void finalize()
Finalizes the ProductRegistry.
size_t GetLockedBufferCount()
Returns the number of buffers currently owned by this manager.
The SharedMemoryEventManager is a SharedMemoryManger which tracks events as they are built...
ShmRTestFixture()
ShmRTestFixture Constructor.
artdaq::SharedMemoryEventManager & writer()
Get the instance of the SharedMemoryEventManager.
art::MasterProductRegistry productRegistry_
MasterProductRegistry instance.
uint32_t getBroadcastKey()
Gets the key for the broadcast shared memory segment.
void basic_test(artdaq::detail::SharedMemoryReader<> &reader, artdaq::SharedMemoryEventManager &writer, std::unique_ptr< art::RunPrincipal > &&run, std::unique_ptr< art::SubRunPrincipal > &&subrun, art::EventID const &eventid)
Run a basic checkout of the SharedMemoryReader.
std::unique_ptr< art::BranchDescription > fake_single_process_branch(std::string const &tag, std::string const &processName, std::string const &productInstanceName=std::string())
Create a BranchDescription for a process.
MasterProductRegistry Test Fixture.
uint32_t getKey()
Gets the key for the shared memory segment.
void sendMetrics()
Send metrics to the MetricManager, if one has been instantiated in the application.
std::map< std::string, art::BranchKey > BKmap_t
BKmap_t associates a string with a art::BranchKey.
MPRGlobalTestFixture()
MPRGlobalTestFixture Constructor.
artdaq::detail::SharedMemoryReader & reader()
Get an artdaq::detail::SharedMemoryReader object, creating a static instance if necessary.
bool readNext(art::RunPrincipal *const &inR, art::SubRunPrincipal *const &inSR, art::RunPrincipal *&outR, art::SubRunPrincipal *&outSR, art::EventPrincipal *&outE)
Dequeue a RawEvent and declare its Fragment contents to art, creating Run, SubRun, and EventPrincipal objects as necessary.
BKmap_t branchKeys_
Keys in this test fixture.
std::map< Fragment::type_t, std::string > fragment_type_map_
The Fragment type names that this SharedMemoryReader knows about.
MPRGlobalTestFixture & gf()
Get a MPRGlobalTestFixture, creating a static instance if necessary.
art::ProcessConfiguration * fake_single_module_process(std::string const &tag, std::string const &processName, fhicl::ParameterSet const &moduleParams, std::string const &release=art::getReleaseVersion())
Create the ProcessConfiguration for a single module art process.
art::SourceHelper & source_helper()
Get an art::SourceHelper object, creating a static instance if necessary.
art::ProductRegistryHelper & helper()
Get an art::ProductRegistryHelper, creating a static instance if necessary.
void startRun(run_id_t runID)
Start a Run.