3 #define TRACE_NAME "BinaryFileOutput"
5 #include "art/Framework/Core/ModuleMacros.h"
6 #include "art/Framework/Core/OutputModule.h"
7 #include "art/Framework/Principal/EventPrincipal.h"
8 #include "art/Framework/Principal/RunPrincipal.h"
9 #include "art/Framework/Principal/SubRunPrincipal.h"
10 #include "art/Framework/Principal/Handle.h"
11 #include "art/Persistency/Common/GroupQueryResult.h"
12 #include "art/Framework/IO/FileStatsCollector.h"
13 #include "art/Framework/IO/PostCloseFileRenamer.h"
14 #include "canvas/Utilities/DebugMacros.h"
15 #include "canvas/Utilities/Exception.h"
16 #include "fhiclcpp/ParameterSet.h"
18 #include "artdaq-core/Data/Fragment.hh"
19 #include "artdaq/DAQdata/Globals.hh"
37 using fhicl::ParameterSet;
64 void beginJob()
override;
66 void endJob()
override;
68 void write(EventPrincipal&)
override;
70 void writeRun(RunPrincipal&)
override {};
71 void writeSubRun(SubRunPrincipal&)
override {};
73 void initialize_FILE_();
75 void deinitialize_FILE_();
77 bool readParameterSet_(fhicl::ParameterSet
const& pset);
80 std::string name_ =
"BinaryFileOutput";
81 std::string file_name_ =
"/tmp/artdaqdemo.binary";
82 bool do_direct_ =
false;
84 std::unique_ptr<std::ofstream> file_ptr_ = {
nullptr};
85 art::FileStatsCollector fstats_;
91 , fstats_{ name_, processName() }
93 FDEBUG(1) <<
"Begin: BinaryFileOutput::BinaryFileOutput(ParameterSet const& ps)\n";
94 readParameterSet_(ps);
95 FDEBUG(1) <<
"End: BinaryFileOutput::BinaryFileOutput(ParameterSet const& ps)\n";
101 FDEBUG(1) <<
"Begin/End: BinaryFileOutput::~BinaryFileOutput()\n";
105 art::BinaryFileOutput::
108 FDEBUG(1) <<
"Begin: BinaryFileOutput::beginJob()\n";
110 FDEBUG(1) <<
"End: BinaryFileOutput::beginJob()\n";
114 art::BinaryFileOutput::
117 FDEBUG(1) <<
"Begin: BinaryFileOutput::endJob()\n";
118 deinitialize_FILE_();
119 FDEBUG(1) <<
"End: BinaryFileOutput::endJob()\n";
124 art::BinaryFileOutput::
127 std::string file_name = PostCloseFileRenamer{ fstats_ }.applySubstitutions(file_name_);
130 fd_ = open(file_name.c_str(), O_WRONLY | O_CREAT | O_DIRECT, 0660);
131 TLOG_ARB(4,
"BinaryFileOutput") <<
"initialize_FILE_ fd_=" << fd_ << TLOG_ENDL;
135 file_ptr_ = std::make_unique<std::ofstream>(file_name, std::ofstream::binary);
136 TRACE(4,
"BinaryFileOutput::initialize_FILE_ file_ptr_=%p errno=%d", (
void*)file_ptr_.get(), errno);
139 fstats_.recordFileOpen();
143 art::BinaryFileOutput::
152 file_ptr_.reset(
nullptr);
153 fstats_.recordFileClose();
157 art::BinaryFileOutput::
158 readParameterSet_(fhicl::ParameterSet
const& pset)
160 TLOG_DEBUG(name_) <<
"BinaryFileOutput::readParameterSet_ method called with "
161 <<
"ParameterSet = \"" << pset.to_string()
162 <<
"\"." << TLOG_ENDL;
166 file_name_ = pset.get<std::string>(
"fileName");
171 <<
"The fileName parameter was not specified "
172 <<
"in the BinaryFileOutput initialization PSet: \""
173 << pset.to_string() <<
"\"." << TLOG_ENDL;
176 do_direct_ = pset.get<
bool>(
"directIO",
false);
181 #define USE_STATIC_BUFFER 0
182 #if USE_STATIC_BUFFER == 1
183 static unsigned char static_buffer[0xa00000];
187 art::BinaryFileOutput::
188 write(EventPrincipal& ep)
190 using RawEvent = artdaq::Fragments;
191 using RawEvents = std::vector<RawEvent>;
192 using RawEventHandle = art::Handle<RawEvent>;
193 using RawEventHandles = std::vector<RawEventHandle>;
195 auto result_handles = std::vector<art::GroupQueryResult>();
196 #if ART_HEX_VERSION < 0x20906
197 ep.getManyByType(art::TypeID(
typeid(RawEvent)), result_handles);
199 auto const& wrapped = art::WrappedTypeID::make<RawEvent>();
200 result_handles = ep.getMany(wrapped, art::MatchAllSelector{});
203 for (
auto const& result_handle : result_handles)
205 auto const raw_event_handle = RawEventHandle(result_handle);
207 if (!raw_event_handle.isValid())
210 for (
auto const& fragment : *raw_event_handle)
212 auto sequence_id = fragment.sequenceID();
213 auto fragid_id = fragment.fragmentID();
214 TRACE(4,
"BinaryFileOutput::write seq=%lu frag=%i %p bytes=0x%lx start"
215 , sequence_id, fragid_id, fragment.headerBeginBytes(), fragment.sizeBytes());
218 ssize_t sts = ::write(fd_, reinterpret_cast<const char*>(fragment.headerBeginBytes()), fragment.sizeBytes());
219 TRACE(5,
"BinaryFileOutput::write seq=%lu frag=%i done sts=%ld errno=%d"
220 , sequence_id, fragid_id, sts, errno);
224 # if USE_STATIC_BUFFER == 1
225 file_ptr_->write((
char*)static_buffer, fragment.sizeBytes());
227 file_ptr_->write(reinterpret_cast<const char*>(fragment.headerBeginBytes()), fragment.sizeBytes());
229 TRACE(5,
"BinaryFileOutput::write seq=%lu frag=%i done errno=%d"
230 , sequence_id, fragid_id, errno);
234 fstats_.recordEvent(ep.id());
virtual ~BinaryFileOutput()
BinaryFileOutput Destructor.
BinaryFileOutput(ParameterSet const &ps)
BinaryFileOutput Constructor.
The BinaryFileOutput module streams art Events to a binary file, bypassing ROOT.