3 #define TRACE_NAME "BinaryFileOutput"
5 #include "art/Framework/Core/ModuleMacros.h"
6 #include "art/Framework/Core/OutputModule.h"
7 #include "art/Framework/IO/FileStatsCollector.h"
8 #include "art/Framework/IO/PostCloseFileRenamer.h"
9 #include "art/Framework/Principal/EventPrincipal.h"
10 #include "art/Framework/Principal/Handle.h"
11 #include "art/Framework/Principal/RunPrincipal.h"
12 #include "art/Framework/Principal/SubRunPrincipal.h"
13 #include "art/Persistency/Provenance/ModuleContext.h"
14 #include "art/Persistency/Common/GroupQueryResult.h"
15 #include "canvas/Persistency/Common/Wrapper.h"
16 #include "canvas/Utilities/DebugMacros.h"
17 #include "canvas/Utilities/Exception.h"
18 #if ART_HEX_VERSION < 0x30901
19 #include "canvas/Utilities/WrappedTypeID.h"
21 #include "canvas/Persistency/Common/WrappedTypeID.h"
23 #include "fhiclcpp/ParameterSet.h"
25 #include "artdaq-core/Data/Fragment.hh"
26 #include "artdaq/DAQdata/Globals.hh"
43 using fhicl::ParameterSet;
70 void beginJob()
override;
72 void endJob()
override;
74 void write(EventPrincipal& )
override;
76 void writeRun(RunPrincipal& )
override{};
77 void writeSubRun(SubRunPrincipal& )
override{};
79 void initialize_FILE_();
81 void deinitialize_FILE_();
83 bool readParameterSet_(fhicl::ParameterSet
const& pset);
91 std::string name_ =
"BinaryFileOutput";
92 std::string file_name_ =
"/tmp/artdaqdemo.binary";
93 bool do_direct_ =
false;
95 std::unique_ptr<std::ofstream> file_ptr_ = {
nullptr};
96 art::FileStatsCollector fstats_;
100 : OutputModule(ps), fstats_{name_, processName()}
102 TLOG(TLVL_DEBUG) <<
"Begin: BinaryFileOutput::BinaryFileOutput(ParameterSet const& ps)\n";
103 readParameterSet_(ps);
104 TLOG(TLVL_DEBUG) <<
"End: BinaryFileOutput::BinaryFileOutput(ParameterSet const& ps)\n";
109 void art::BinaryFileOutput::beginJob()
111 TLOG(TLVL_DEBUG) <<
"Begin: BinaryFileOutput::beginJob()\n";
113 TLOG(TLVL_DEBUG) <<
"End: BinaryFileOutput::beginJob()\n";
116 void art::BinaryFileOutput::endJob()
118 TLOG(TLVL_DEBUG) <<
"Begin: BinaryFileOutput::endJob()\n";
119 deinitialize_FILE_();
120 TLOG(TLVL_DEBUG) <<
"End: BinaryFileOutput::endJob()\n";
123 void art::BinaryFileOutput::initialize_FILE_()
125 std::string file_name = PostCloseFileRenamer{fstats_}.applySubstitutions(file_name_);
128 fd_ = open(file_name.c_str(), O_WRONLY | O_CREAT | O_DIRECT, 0660);
129 TLOG(TLVL_TRACE) <<
"initialize_FILE_ fd_=" << fd_;
133 file_ptr_ = std::make_unique<std::ofstream>(file_name, std::ofstream::binary);
134 TLOG(TLVL_TRACE) <<
"BinaryFileOutput::initialize_FILE_ file_ptr_=" <<
static_cast<void*
>(file_ptr_.get()) <<
" errno=" << errno;
137 fstats_.recordFileOpen();
140 void art::BinaryFileOutput::deinitialize_FILE_()
149 file_ptr_.reset(
nullptr);
151 fstats_.recordFileClose();
154 bool art::BinaryFileOutput::readParameterSet_(fhicl::ParameterSet
const& pset)
156 TLOG(TLVL_DEBUG) << name_ <<
"BinaryFileOutput::readParameterSet_ method called with "
157 <<
"ParameterSet = \"" << pset.to_string() <<
"\".";
161 file_name_ = pset.get<std::string>(
"fileName");
165 TLOG(TLVL_ERROR) << name_ <<
"The fileName parameter was not specified "
166 <<
"in the BinaryFileOutput initialization PSet: \"" << pset.to_string() <<
"\".";
169 do_direct_ = pset.get<
bool>(
"directIO",
false);
174 #define USE_STATIC_BUFFER 0
175 #if USE_STATIC_BUFFER == 1
176 static unsigned char static_buffer[0xa00000];
179 void art::BinaryFileOutput::write(EventPrincipal& ep)
181 using RawEvent = artdaq::Fragments;
182 using RawEvents = std::vector<RawEvent>;
183 using RawEventHandle = art::Handle<RawEvent>;
184 using RawEventHandles = std::vector<RawEventHandle>;
186 auto result_handles = std::vector<art::GroupQueryResult>();
187 auto const& wrapped = art::WrappedTypeID::make<RawEvent>();
188 ModuleContext
const mc{moduleDescription()};
189 ProcessTag
const processTag{
"", mc.moduleDescription().processName()};
191 result_handles = ep.getMany(mc, wrapped, art::MatchAllSelector{}, processTag);
193 for (
auto const& result_handle : result_handles)
195 auto const raw_event_handle = RawEventHandle(result_handle);
197 if (!raw_event_handle.isValid())
202 for (
auto const& fragment : *raw_event_handle)
204 auto sequence_id = fragment.sequenceID();
205 auto fragid_id = fragment.fragmentID();
206 TLOG(TLVL_TRACE) <<
"BinaryFileOutput::write seq=" << sequence_id <<
" frag=" << fragid_id <<
" "
207 <<
reinterpret_cast<const void*
>(fragment.headerBeginBytes()) <<
" bytes=0x" << std::hex
208 << fragment.sizeBytes() <<
" start";
211 ssize_t sts = ::write(fd_, reinterpret_cast<const char*>(fragment.headerBeginBytes()), fragment.sizeBytes());
212 TLOG(TLVL_DEBUG + 2) <<
"BinaryFileOutput::write seq=" << sequence_id <<
" frag=" << fragid_id <<
" done sts=" << sts
213 <<
" errno=" << errno;
217 #if USE_STATIC_BUFFER == 1
218 file_ptr_->write((
char*)static_buffer, fragment.sizeBytes());
220 file_ptr_->write(reinterpret_cast<const char*>(fragment.headerBeginBytes()), fragment.sizeBytes());
222 TLOG(TLVL_DEBUG + 2) <<
"BinaryFileOutput::write seq=" << sequence_id <<
" frag=" << fragid_id <<
" done errno=" << errno;
226 fstats_.recordEvent(ep.eventID());
~BinaryFileOutput() override
BinaryFileOutput Destructor.
BinaryFileOutput(ParameterSet const &ps)
BinaryFileOutput Constructor.
The BinaryFileOutput module streams art Events to a binary file, bypassing ROOT.