$treeview $search $mathjax $extrastylesheet
artdaq_core
v3_04_17
$projectbrief
|
$projectbrief
|
$searchbox |
00001 #ifndef artdaq_core_Data_ContainerFragment_hh 00002 #define artdaq_core_Data_ContainerFragment_hh 00003 00004 #include "artdaq-core/Data/Fragment.hh" 00005 #include "cetlib_except/exception.h" 00006 00007 //#include <ostream> 00008 //#include <vector> 00009 00010 // Implementation of "ContainerFragment", an artdaq::Fragment overlay class 00011 00012 namespace artdaq 00013 { 00014 class ContainerFragment; 00015 } 00016 00020 class artdaq::ContainerFragment 00021 { 00022 public: 00024 static constexpr uint8_t CURRENT_VERSION = 1; 00026 static constexpr size_t CONTAINER_MAGIC = 0x00BADDEED5B1BEE5; 00027 00031 struct MetadataV0 00032 { 00036 static constexpr int CONTAINER_FRAGMENT_COUNT_MAX = 100; 00037 00038 typedef uint8_t data_t; 00039 typedef uint64_t count_t; 00040 00041 count_t block_count : 55; 00042 count_t fragment_type : 8; 00043 count_t missing_data : 1; 00044 00046 size_t index[CONTAINER_FRAGMENT_COUNT_MAX]; 00047 00049 static size_t const size_words = 8ul + CONTAINER_FRAGMENT_COUNT_MAX * sizeof(size_t) / sizeof(data_t); // Units of Header::data_t 00050 }; 00051 static_assert (sizeof(MetadataV0) == MetadataV0::size_words * sizeof(MetadataV0::data_t), "ContainerFragment::MetadataV0 size changed"); 00052 00056 struct Metadata 00057 { 00058 typedef uint8_t data_t; 00059 typedef uint64_t count_t; 00060 00061 count_t block_count : 16; 00062 count_t fragment_type : 8; 00063 count_t version : 4; 00064 count_t missing_data : 1; 00065 count_t has_index : 1; 00066 count_t unused_flag1 : 1; 00067 count_t unused_flag2 : 1; 00068 count_t unused : 32; 00069 00070 uint64_t index_offset; 00071 00073 static size_t const size_words = 16ul; // Units of Header::data_t 00074 }; 00075 static_assert (sizeof(Metadata) == Metadata::size_words * sizeof(Metadata::data_t), "ContainerFragment::Metadata size changed"); 00076 00082 Metadata const* UpgradeMetadata(MetadataV0 const* in) const 00083 { 00084 TLOG(TLVL_DEBUG, "ContainerFragment") << "Upgrading ContainerFragment::MetadataV0 into new ContainerFragment::Metadata"; 00085 assert(in->block_count < std::numeric_limits<Metadata::count_t>::max()); 00086 metadata_alloc_ = true; 00087 Metadata md; 00088 md.block_count = in->block_count; 00089 md.fragment_type = in->fragment_type; 00090 md.has_index = 0; 00091 md.missing_data = in->missing_data; 00092 md.version = 0; 00093 index_ptr_ = in->index; 00094 metadata_ = new Metadata(md); 00095 return metadata_; 00096 } 00097 00104 explicit ContainerFragment(Fragment const& f) : artdaq_Fragment_(f), index_ptr_(nullptr), index_alloc_(false),metadata_(nullptr), metadata_alloc_(false) { } 00105 00106 virtual ~ContainerFragment() 00107 { 00108 if (index_alloc_) 00109 { 00110 delete[] index_ptr_; 00111 } 00112 if (metadata_alloc_) 00113 { 00114 delete metadata_; 00115 } 00116 } 00117 00122 Metadata const* metadata() const 00123 { 00124 if (metadata_alloc_) return metadata_; 00125 00126 if (artdaq_Fragment_.sizeBytes() - artdaq_Fragment_.dataSizeBytes() - sizeof(detail::RawFragmentHeader) == sizeof(MetadataV0)) 00127 { 00128 return UpgradeMetadata(artdaq_Fragment_.metadata<MetadataV0>()); 00129 } 00130 00131 return artdaq_Fragment_.metadata<Metadata>(); 00132 } 00133 00138 Metadata::count_t block_count() const { return metadata()->block_count; } 00143 Fragment::type_t fragment_type() const { return static_cast<Fragment::type_t>(metadata()->fragment_type); } 00148 bool missing_data() const { return static_cast<bool>(metadata()->missing_data); } 00149 00154 void const* dataBegin() const 00155 { 00156 return reinterpret_cast<void const *>(&*artdaq_Fragment_.dataBegin()); 00157 } 00158 00163 void const* dataEnd() const 00164 { 00165 return reinterpret_cast<void const *>(reinterpret_cast<uint8_t const *>(dataBegin()) + lastFragmentIndex()); 00166 } 00167 00174 FragmentPtr at(size_t index) const 00175 { 00176 if (index >= block_count() || block_count() == 0) 00177 { 00178 throw cet::exception("ArgumentOutOfRange") << "Buffer overrun detected! ContainerFragment::at was asked for a non-existent Fragment!"; 00179 } 00180 FragmentPtr frag(new Fragment(fragSize(index) / sizeof(RawDataType) - detail::RawFragmentHeader::num_words())); 00181 memcpy(frag->headerAddress(), reinterpret_cast<uint8_t const *>(dataBegin()) + fragmentIndex(index), fragSize(index)); 00182 return frag; 00183 } 00184 00191 size_t fragSize(size_t index) const 00192 { 00193 if (index >= block_count() || block_count() == 0) 00194 { 00195 throw cet::exception("ArgumentOutOfRange") << "Buffer overrun detected! ContainerFragment::fragSize was asked for a non-existent Fragment!"; 00196 } 00197 auto end = fragmentIndex(index + 1); 00198 if (index == 0) return end; 00199 return end - fragmentIndex(index); 00200 } 00201 00208 FragmentPtr operator[](size_t index) const 00209 { 00210 return this->at(index); 00211 } 00212 00219 size_t fragmentIndex(size_t index) const 00220 { 00221 if (index > block_count()) 00222 { 00223 throw cet::exception("ArgumentOutOfRange") << "Buffer overrun detected! ContainerFragment::fragmentIndex was asked for a non-existent Fragment!"; 00224 } 00225 if (index == 0) { return 0; } 00226 00227 auto index_ptr = get_index_(); 00228 00229 return index_ptr[index - 1]; 00230 } 00231 00236 size_t lastFragmentIndex() const 00237 { 00238 return fragmentIndex(block_count()); 00239 } 00240 00241 protected: 00242 00247 static constexpr size_t words_per_frag_word_() 00248 { 00249 return sizeof(Fragment::value_type) / sizeof(Metadata::data_t); 00250 } 00251 00256 const size_t* create_index_() const 00257 { 00258 TLOG(TLVL_TRACE, "ContainerFragment") << "Creating new index for ContainerFragment"; 00259 auto tmp = new size_t[metadata()->block_count + 1]; 00260 00261 auto current = reinterpret_cast<uint8_t const*>(artdaq_Fragment_.dataBegin()); 00262 size_t offset = 0; 00263 for (int ii = 0; ii < metadata()->block_count; ++ii) 00264 { 00265 auto this_size = reinterpret_cast<const detail::RawFragmentHeader*>(current)->word_count * sizeof(RawDataType); 00266 offset += this_size; 00267 tmp[ii] = offset; 00268 current += this_size; 00269 } 00270 tmp[metadata()->block_count] = CONTAINER_MAGIC; 00271 return tmp; 00272 } 00273 00278 void reset_index_ptr_() const 00279 { 00280 TLOG(TLVL_TRACE, "ContainerFragment") << "Request to reset index_ptr recieved. has_index=" << metadata()->has_index << ", Check word = " << std::hex 00281 << *(reinterpret_cast<size_t const*>(artdaq_Fragment_.dataBeginBytes() + metadata()->index_offset) + metadata()->block_count); 00282 if (metadata()->has_index && *(reinterpret_cast<size_t const*>(artdaq_Fragment_.dataBeginBytes() + metadata()->index_offset) + metadata()->block_count) == CONTAINER_MAGIC) 00283 { 00284 TLOG(TLVL_TRACE, "ContainerFragment") << "Setting index_ptr to found valid index"; 00285 index_ptr_ = reinterpret_cast<size_t const*>(artdaq_Fragment_.dataBeginBytes() + metadata()->index_offset); 00286 } 00287 else 00288 { 00289 TLOG(TLVL_TRACE, "ContainerFragment") << "Index invalid or not found, allocating new index"; 00290 if (index_alloc_) 00291 { 00292 delete[] index_ptr_; 00293 } 00294 00295 index_alloc_ = true; 00296 index_ptr_ = create_index_(); 00297 } 00298 } 00299 00304 const size_t* get_index_() const 00305 { 00306 if (index_ptr_ != nullptr) return index_ptr_; 00307 00308 reset_index_ptr_(); 00309 00310 return index_ptr_; 00311 } 00312 00313 private: 00314 Fragment const& artdaq_Fragment_; 00315 00316 mutable const size_t* index_ptr_; 00317 mutable bool index_alloc_; 00318 mutable const Metadata* metadata_; 00319 mutable bool metadata_alloc_; 00320 }; 00321 00322 #endif /* artdaq_core_Data_ContainerFragment_hh */