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/Common/GroupQueryResult.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"
36 using fhicl::ParameterSet;
62 void beginJob()
override;
64 void endJob()
override;
66 void write(EventPrincipal&)
override;
68 void writeRun(RunPrincipal&)
override {};
69 void writeSubRun(SubRunPrincipal&)
override {};
71 void initialize_FILE_();
73 void deinitialize_FILE_();
75 bool readParameterSet_(fhicl::ParameterSet
const& pset);
78 std::string name_ =
"BinaryFileOutput";
79 std::string file_name_ =
"/tmp/artdaqdemo.binary";
80 bool do_direct_ =
false;
82 std::unique_ptr<std::ofstream> file_ptr_ = {
nullptr};
83 art::FileStatsCollector fstats_;
87 TLOG(TLVL_DEBUG) <<
"Begin: BinaryFileOutput::BinaryFileOutput(ParameterSet const& ps)\n";
88 readParameterSet_(ps);
89 TLOG(TLVL_DEBUG) <<
"End: BinaryFileOutput::BinaryFileOutput(ParameterSet const& ps)\n";
94 void art::BinaryFileOutput::beginJob() {
95 TLOG(TLVL_DEBUG) <<
"Begin: BinaryFileOutput::beginJob()\n";
97 TLOG(TLVL_DEBUG) <<
"End: BinaryFileOutput::beginJob()\n";
100 void art::BinaryFileOutput::endJob() {
101 TLOG(TLVL_DEBUG) <<
"Begin: BinaryFileOutput::endJob()\n";
102 deinitialize_FILE_();
103 TLOG(TLVL_DEBUG) <<
"End: BinaryFileOutput::endJob()\n";
106 void art::BinaryFileOutput::initialize_FILE_() {
107 std::string file_name = PostCloseFileRenamer{ fstats_ }.applySubstitutions(file_name_);
109 fd_ = open(file_name.c_str(), O_WRONLY | O_CREAT | O_DIRECT, 0660);
110 TLOG(TLVL_TRACE) <<
"initialize_FILE_ fd_=" << fd_;
112 file_ptr_ = std::make_unique<std::ofstream>(file_name, std::ofstream::binary);
113 TLOG(TLVL_TRACE) <<
"BinaryFileOutput::initialize_FILE_ file_ptr_=" << (
void*)file_ptr_.get() <<
" errno=" << errno;
116 fstats_.recordFileOpen();
119 void art::BinaryFileOutput::deinitialize_FILE_() {
124 file_ptr_.reset(
nullptr);
125 fstats_.recordFileClose();
128 bool art::BinaryFileOutput::readParameterSet_(fhicl::ParameterSet
const& pset) {
129 TLOG(TLVL_DEBUG) << name_ <<
"BinaryFileOutput::readParameterSet_ method called with "
130 <<
"ParameterSet = \"" << pset.to_string() <<
"\".";
133 file_name_ = pset.get<std::string>(
"fileName");
135 TLOG(TLVL_ERROR) << name_ <<
"The fileName parameter was not specified "
136 <<
"in the BinaryFileOutput initialization PSet: \"" << pset.to_string() <<
"\".";
139 do_direct_ = pset.get<
bool>(
"directIO",
false);
144 #define USE_STATIC_BUFFER 0
145 #if USE_STATIC_BUFFER == 1
146 static unsigned char static_buffer[0xa00000];
149 void art::BinaryFileOutput::write(EventPrincipal& ep) {
150 using RawEvent = artdaq::Fragments;
151 using RawEvents = std::vector<RawEvent>;
152 using RawEventHandle = art::Handle<RawEvent>;
153 using RawEventHandles = std::vector<RawEventHandle>;
155 auto result_handles = std::vector<art::GroupQueryResult>();
156 auto const& wrapped = art::WrappedTypeID::make<RawEvent>();
157 #if ART_HEX_VERSION >= 0x30000
158 ModuleContext
const mc{moduleDescription()};
159 ProcessTag
const processTag{
"", mc.moduleDescription().processName()};
161 result_handles = ep.getMany(mc, wrapped, art::MatchAllSelector{}, processTag);
163 result_handles = ep.getMany(wrapped, art::MatchAllSelector{});
166 for (
auto const& result_handle : result_handles) {
167 auto const raw_event_handle = RawEventHandle(result_handle);
169 if (!raw_event_handle.isValid())
continue;
171 for (
auto const& fragment : *raw_event_handle) {
172 auto sequence_id = fragment.sequenceID();
173 auto fragid_id = fragment.fragmentID();
174 TLOG(TLVL_TRACE) <<
"BinaryFileOutput::write seq=" << sequence_id <<
" frag=" << fragid_id <<
" "
175 <<
reinterpret_cast<const void*
>(fragment.headerBeginBytes()) <<
" bytes=0x" << std::hex
176 << fragment.sizeBytes() <<
" start";
178 ssize_t sts = ::write(fd_, reinterpret_cast<const char*>(fragment.headerBeginBytes()), fragment.sizeBytes());
179 TLOG(5) <<
"BinaryFileOutput::write seq=" << sequence_id <<
" frag=" << fragid_id <<
" done sts=" << sts
180 <<
" errno=" << errno;
182 # if USE_STATIC_BUFFER == 1
183 file_ptr_->write((
char*)static_buffer, fragment.sizeBytes());
185 file_ptr_->write(reinterpret_cast<const char*>(fragment.headerBeginBytes()), fragment.sizeBytes());
187 TLOG(5) <<
"BinaryFileOutput::write seq=" << sequence_id <<
" frag=" << fragid_id <<
" done errno=" << errno;
191 #if ART_HEX_VERSION < 0x30000
192 fstats_.recordEvent(ep.id());
194 fstats_.recordEvent(ep.eventID());
virtual ~BinaryFileOutput()
BinaryFileOutput Destructor.
BinaryFileOutput(ParameterSet const &ps)
BinaryFileOutput Constructor.
The BinaryFileOutput module streams art Events to a binary file, bypassing ROOT.