00001 #define TRACE_NAME "MulticastTransfer"
00002
00003 #include "artdaq/TransferPlugins/TransferInterface.hh"
00004
00005 #include "artdaq-core/Data/Fragment.hh"
00006 #include "artdaq-core/Utilities/ExceptionHandler.hh"
00007
00008 #include "fhiclcpp/ParameterSet.h"
00009 #include "cetlib_except/exception.h"
00010
00011 #include <boost/asio.hpp>
00012 #include <boost/bind.hpp>
00013
00014 #include <iostream>
00015 #include <vector>
00016 #include <cassert>
00017 #include <string>
00018 #include <type_traits>
00019 #include <bitset>
00020
00021 #pragma GCC diagnostic push
00022 #pragma GCC diagnostic ignored "-Wunused-parameter"
00023
00024
00025 namespace artdaq
00026 {
00030 class MulticastTransfer : public TransferInterface
00031 {
00032 public:
00033
00034 using byte_t = artdaq::Fragment::byte_t;
00035
00039 virtual ~MulticastTransfer() = default;
00040
00058 MulticastTransfer(fhicl::ParameterSet const& ps, Role role);
00059
00066 int receiveFragment(artdaq::Fragment& fragment,
00067 size_t receiveTimeout) override;
00068
00075 int receiveFragmentHeader(detail::RawFragmentHeader& header, size_t receiveTimeout) override;
00076
00083 int receiveFragmentData(RawDataType* destination, size_t wordCount) override;
00084
00090 CopyStatus copyFragment(artdaq::Fragment& fragment, size_t send_timeout_usec) override;
00091
00097 CopyStatus moveFragment(artdaq::Fragment&& fragment) override;
00098
00099 private:
00100
00101 void fill_staging_memory(const artdaq::Fragment& frag);
00102
00103 template <typename T>
00104 void book_container_of_buffers(std::vector<T>& buffers,
00105 const size_t fragment_size,
00106 const size_t total_subfragments,
00107 const size_t first_subfragment_num,
00108 const size_t last_subfragment_num);
00109
00110 void get_fragment_quantities(const boost::asio::mutable_buffer& buf, size_t& payload_size, size_t& fragment_size,
00111 size_t& expected_subfragments);
00112
00113 void set_receive_buffer_size(size_t recv_buff_size);
00114
00115 class subfragment_identifier
00116 {
00117 public:
00118
00119 subfragment_identifier(size_t sequenceID, size_t fragmentID, size_t subfragment_number) :
00120 sequenceID_(sequenceID)
00121 , fragmentID_(fragmentID)
00122 , subfragment_number_(subfragment_number) { }
00123
00124 size_t sequenceID() const { return sequenceID_; }
00125 size_t fragmentID() const { return fragmentID_; }
00126 size_t subfragment_number() const { return subfragment_number_; }
00127
00128 private:
00129 size_t sequenceID_;
00130 size_t fragmentID_;
00131 size_t subfragment_number_;
00132 };
00133
00134 std::unique_ptr<boost::asio::io_service> io_service_;
00135
00136 std::unique_ptr<boost::asio::ip::udp::endpoint> local_endpoint_;
00137 std::unique_ptr<boost::asio::ip::udp::endpoint> multicast_endpoint_;
00138 std::unique_ptr<boost::asio::ip::udp::endpoint> opposite_endpoint_;
00139
00140 std::unique_ptr<boost::asio::ip::udp::socket> socket_;
00141
00142 size_t subfragment_size_;
00143 size_t subfragments_per_send_;
00144
00145 size_t pause_on_copy_usecs_;
00146 Fragment fragment_buffer_;
00147
00148 std::vector<byte_t> staging_memory_;
00149
00150 std::vector<boost::asio::mutable_buffer> receive_buffers_;
00151 };
00152 }
00153
00154 artdaq::MulticastTransfer::MulticastTransfer(fhicl::ParameterSet const& pset, Role role) :
00155 TransferInterface(pset, role)
00156 , io_service_(std::make_unique<std::remove_reference<decltype(*io_service_)>::type>())
00157 , local_endpoint_(nullptr)
00158 , multicast_endpoint_(nullptr)
00159 , opposite_endpoint_(std::make_unique<std::remove_reference<decltype(*opposite_endpoint_)>::type>())
00160 , socket_(nullptr)
00161 , subfragment_size_(pset.get<size_t>("subfragment_size"))
00162 , subfragments_per_send_(pset.get<size_t>("subfragments_per_send"))
00163 , pause_on_copy_usecs_(pset.get<size_t>("pause_on_copy_usecs", 0))
00164 {
00165 try
00166 {
00167 auto port = pset.get<unsigned short>("multicast_port");
00168 auto multicast_address = boost::asio::ip::address::from_string(pset.get<std::string>("multicast_address"));
00169 auto local_address = boost::asio::ip::address::from_string(pset.get<std::string>("local_address"));
00170
00171 TLOG(TLVL_DEBUG) << GetTraceName() << ": multicast address is set to " << multicast_address ;
00172 TLOG(TLVL_DEBUG) << GetTraceName() << ": local address is set to " << local_address ;
00173
00174 if (TransferInterface::role() == Role::kSend)
00175 {
00176 local_endpoint_ = std::make_unique<std::remove_reference<decltype(*local_endpoint_)>::type>(local_address, 0);
00177 multicast_endpoint_ = std::make_unique<std::remove_reference<decltype(*multicast_endpoint_)>::type>(multicast_address, port);
00178
00179 socket_ = std::make_unique<std::remove_reference<decltype(*socket_)>::type>(*io_service_,
00180 multicast_endpoint_->protocol());
00181 socket_->bind(*local_endpoint_);
00182 }
00183 else
00184 {
00185
00186
00187
00188 local_endpoint_ = std::make_unique<std::remove_reference<decltype(*local_endpoint_)>::type>(local_address, port);
00189 socket_ = std::make_unique<std::remove_reference<decltype(*socket_)>::type>(*io_service_,
00190 local_endpoint_->protocol());
00191
00192 boost::system::error_code ec;
00193
00194 socket_->set_option(boost::asio::ip::udp::socket::reuse_address(true), ec);
00195
00196 if (ec != 0)
00197 {
00198 std::cerr << "boost::system::error_code with value " << ec << " was found in setting reuse_address option" << std::endl;
00199 }
00200
00201 set_receive_buffer_size(pset.get<size_t>("receive_buffer_size", 0));
00202
00203 socket_->bind(boost::asio::ip::udp::endpoint(multicast_address, port));
00204
00205
00206
00207 socket_->set_option(boost::asio::ip::multicast::join_group(multicast_address), ec);
00208
00209 if (ec != 0)
00210 {
00211 std::cerr << "boost::system::error_code with value " << ec << " was found in attempt to join multicast group" << std::endl;
00212 }
00213 }
00214 }
00215 catch (...)
00216 {
00217 ExceptionHandler(ExceptionHandlerRethrow::yes, "Problem setting up the socket in MulticastTransfer");
00218 }
00219
00220 auto max_subfragments =
00221 static_cast<size_t>(std::ceil(max_fragment_size_words_ / static_cast<float>(subfragment_size_)));
00222
00223 staging_memory_.resize(max_subfragments * (sizeof(subfragment_identifier) + subfragment_size_));
00224
00225 if (TransferInterface::role() == Role::kReceive)
00226 {
00227 book_container_of_buffers(receive_buffers_, max_fragment_size_words_, max_subfragments, 0, max_subfragments - 1);
00228 }
00229
00230 TLOG(TLVL_DEBUG) << GetTraceName() << ": max_subfragments is " << max_subfragments ;
00231 TLOG(TLVL_DEBUG) << GetTraceName() << ": Staging buffer size is " << staging_memory_.size() ;
00232 }
00233
00234 #pragma GCC diagnostic push
00235 #pragma GCC diagnostic ignored "-Wunused-variable"
00236
00237 int artdaq::MulticastTransfer::receiveFragment(artdaq::Fragment& fragment,
00238 size_t receiveTimeout)
00239 {
00240 assert(TransferInterface::role() == Role::kReceive);
00241
00242 if (fragment.dataSizeBytes() > 0)
00243 {
00244 throw cet::exception("MulticastTransfer") << "Error in MulticastTransfer::receiveFragmentFrom: " <<
00245 "nonzero payload found in fragment passed as argument";
00246 }
00247
00248 static bool print_warning = true;
00249
00250 if (print_warning)
00251 {
00252 std::cerr << "Please note that MulticastTransfer::receiveFragmentFrom does not use its receiveTimeout argument" << std::endl;
00253 print_warning = false;
00254 }
00255
00256 fragment.resizeBytes(max_fragment_size_words_ - sizeof(artdaq::detail::RawFragmentHeader));
00257
00258 static auto current_sequenceID = std::numeric_limits<Fragment::sequence_id_t>::max();
00259 static auto current_fragmentID = std::numeric_limits<Fragment::fragment_id_t>::max();
00260
00261 size_t fragment_size = 0;
00262 size_t expected_subfragments = 0;
00263 size_t current_subfragments = 0;
00264 bool fragment_complete = false;
00265 bool last_fragment_truncated = false;
00266
00267 while (true)
00268 {
00269 auto bytes_received = socket_->receive_from(receive_buffers_, *opposite_endpoint_);
00270
00271 size_t bytes_processed = 0;
00272
00273 for (auto& buf : receive_buffers_)
00274 {
00275 auto buf_size = boost::asio::buffer_size(buf);
00276 auto size_t_ptr = boost::asio::buffer_cast<const size_t*>(buf);
00277 auto seqID = *size_t_ptr;
00278 auto fragID = *(size_t_ptr + 1);
00279 auto subfragID = *(size_t_ptr + 2);
00280
00281 if (seqID != current_sequenceID || fragID != current_fragmentID)
00282 {
00283
00284
00285
00286 assert(bytes_processed == 0);
00287
00288 if (current_subfragments < expected_subfragments)
00289 {
00290 last_fragment_truncated = true;
00291
00292 if (expected_subfragments != std::numeric_limits<size_t>::max())
00293 {
00294 std::cerr << "Warning: only received " << current_subfragments << " subfragments for fragment with seqID = " <<
00295 current_sequenceID << ", fragID = " << current_fragmentID << " (expected " << expected_subfragments << ")\n"
00296 << std::endl;
00297 }
00298 else
00299 {
00300 std::cerr << "Warning: only received " << current_subfragments <<
00301 " subfragments for fragment with seqID = " <<
00302 current_sequenceID << ", fragID = " << current_fragmentID <<
00303 ", # of expected subfragments is unknown as fragment header was not received)\n"
00304 << std::endl;
00305 }
00306 }
00307
00308 current_subfragments = 0;
00309 fragment_size = std::numeric_limits<size_t>::max();
00310 expected_subfragments = std::numeric_limits<size_t>::max();
00311 current_sequenceID = seqID;
00312 current_fragmentID = fragID;
00313 }
00314
00315 auto ptr_into_fragment = fragment.headerBeginBytes() + subfragID * subfragment_size_;
00316
00317 auto ptr_into_buffer = boost::asio::buffer_cast<const byte_t*>(buf) + sizeof(subfragment_identifier);
00318
00319 std::copy(ptr_into_buffer, ptr_into_buffer + buf_size - sizeof(subfragment_identifier), ptr_into_fragment);
00320
00321 if (subfragID == 0)
00322 {
00323 if (buf_size >= sizeof(subfragment_identifier) + sizeof(artdaq::detail::RawFragmentHeader))
00324 {
00325 auto payload_size = std::numeric_limits<size_t>::max();
00326 get_fragment_quantities(buf, payload_size, fragment_size, expected_subfragments);
00327
00328 fragment.resizeBytes(payload_size);
00329 }
00330 else
00331 {
00332 throw cet::exception("MulticastTransfer") << "Buffer size is too small to completely contain an artdaq::Fragment header; " <<
00333 "please increase the default size";
00334 }
00335 }
00336
00337 current_subfragments++;
00338
00339 if (current_subfragments == expected_subfragments)
00340 {
00341 fragment_complete = true;
00342 }
00343
00344 bytes_processed += buf_size;
00345
00346 if (bytes_processed >= bytes_received)
00347 {
00348 break;
00349 }
00350 }
00351
00352 if (last_fragment_truncated)
00353 {
00354
00355
00356
00357
00358
00359
00360
00361 assert(!fragment_complete);
00362 TLOG(TLVL_WARNING) << GetTraceName() << ": Got an incomplete fragment" ;
00363 return artdaq::TransferInterface::RECV_TIMEOUT;
00364 }
00365
00366 if (fragment_complete)
00367 {
00368 return source_rank();
00369 }
00370 }
00371
00372 return TransferInterface::RECV_TIMEOUT;
00373 }
00374
00375 #pragma GCC diagnostic pop
00376
00377 int artdaq::MulticastTransfer::receiveFragmentHeader(detail::RawFragmentHeader& header, size_t receiveTimeout)
00378 {
00379 auto ret = receiveFragment(fragment_buffer_, receiveTimeout);
00380 if (ret == source_rank())
00381 {
00382 header = *reinterpret_cast<detail::RawFragmentHeader*>(fragment_buffer_.headerAddress());
00383 return source_rank();
00384 }
00385 return ret;
00386 }
00387
00388 int artdaq::MulticastTransfer::receiveFragmentData(RawDataType* destination, size_t wordCount)
00389 {
00390 if (fragment_buffer_.size() > detail::RawFragmentHeader::num_words()) {
00391 auto dataSize = (fragment_buffer_.size() - detail::RawFragmentHeader::num_words()) * sizeof(RawDataType);
00392 memcpy(destination, fragment_buffer_.headerAddress() + detail::RawFragmentHeader::num_words(), dataSize);
00393 return source_rank();
00394 }
00395 return RECV_TIMEOUT;
00396 }
00397
00398
00399
00400 artdaq::TransferInterface::CopyStatus
00401 artdaq::MulticastTransfer::moveFragment(artdaq::Fragment&& f)
00402 {
00403 return copyFragment(f, 100000000);
00404 }
00405
00406 artdaq::TransferInterface::CopyStatus
00407 artdaq::MulticastTransfer::copyFragment(artdaq::Fragment& fragment,
00408 size_t send_timeout_usec)
00409 {
00410 assert(TransferInterface::role() == Role::kSend);
00411
00412 if (fragment.sizeBytes() > max_fragment_size_words_)
00413 {
00414 throw cet::exception("MulticastTransfer") << "Error in MulticastTransfer::copyFragmentTo: " <<
00415 fragment.sizeBytes() << " byte fragment exceeds max_fragment_size of " << max_fragment_size_words_;
00416 }
00417
00418 static size_t ncalls = 1;
00419 auto num_subfragments = static_cast<size_t>(std::ceil(fragment.sizeBytes() / static_cast<float>(subfragment_size_)));
00420
00421 ncalls++;
00422
00423 fill_staging_memory(fragment);
00424
00425 for (size_t batch_index = 0; ; batch_index++)
00426 {
00427 auto first_subfragment = batch_index * subfragments_per_send_;
00428 auto last_subfragment = (batch_index + 1) * subfragments_per_send_ >= num_subfragments ?
00429 num_subfragments - 1 :
00430 (batch_index + 1) * subfragments_per_send_ - 1;
00431
00432 std::vector<boost::asio::const_buffer> buffers;
00433
00434 book_container_of_buffers(buffers, fragment.sizeBytes(), num_subfragments, first_subfragment, last_subfragment);
00435
00436 socket_->send_to(buffers, *multicast_endpoint_);
00437
00438 usleep(pause_on_copy_usecs_);
00439
00440 if (last_subfragment == num_subfragments - 1)
00441 {
00442 break;
00443 }
00444 }
00445 return CopyStatus::kSuccess;
00446 }
00447
00448 #pragma GCC diagnostic push
00449 #pragma GCC diagnostic ignored "-Wsign-compare"
00450
00451 void artdaq::MulticastTransfer::fill_staging_memory(const artdaq::Fragment& fragment)
00452 {
00453 auto num_subfragments = static_cast<size_t>(std::ceil(fragment.sizeBytes() / static_cast<float>(subfragment_size_)));
00454 TLOG(TLVL_DEBUG) << GetTraceName() << ": # of subfragments to use is " << num_subfragments ;
00455
00456 for (auto i_s = 0; i_s < num_subfragments; ++i_s)
00457 {
00458 auto staging_memory_copyto = &staging_memory_.at(i_s * (sizeof(subfragment_identifier) + subfragment_size_));
00459
00460 subfragment_identifier sfi(fragment.sequenceID(), fragment.fragmentID(), i_s);
00461
00462 std::copy(reinterpret_cast<byte_t*>(&sfi),
00463 reinterpret_cast<byte_t*>(&sfi) + sizeof(subfragment_identifier),
00464 staging_memory_copyto);
00465
00466 auto low_ptr_into_fragment = fragment.headerBeginBytes() + subfragment_size_ * i_s;
00467
00468 auto high_ptr_into_fragment = (i_s == num_subfragments - 1) ?
00469 fragment.dataEndBytes() :
00470 fragment.headerBeginBytes() + subfragment_size_ * (i_s + 1);
00471
00472 std::copy(low_ptr_into_fragment,
00473 high_ptr_into_fragment,
00474 staging_memory_copyto + sizeof(subfragment_identifier));
00475 }
00476 }
00477
00478 #pragma GCC diagnostic pop
00479
00480
00481
00482
00483
00484
00485 template <typename T>
00486 void artdaq::MulticastTransfer::book_container_of_buffers(std::vector<T>& buffers,
00487 const size_t fragment_size,
00488 const size_t total_subfragments,
00489 const size_t first_subfragment_num,
00490 const size_t last_subfragment_num)
00491 {
00492 assert(staging_memory_.size() >= total_subfragments * (sizeof(subfragment_identifier) + subfragment_size_));
00493 assert(buffers.size() == 0);
00494 assert(last_subfragment_num < total_subfragments);
00495
00496 for (auto i_f = first_subfragment_num; i_f <= last_subfragment_num; ++i_f)
00497 {
00498 auto bytes_to_store = (i_f == total_subfragments - 1) ?
00499 sizeof(subfragment_identifier) + (fragment_size - (total_subfragments - 1) * subfragment_size_) :
00500 sizeof(subfragment_identifier) + subfragment_size_;
00501
00502 buffers.emplace_back(&staging_memory_.at(i_f * (sizeof(subfragment_identifier) + subfragment_size_)),
00503 bytes_to_store);
00504 }
00505 }
00506
00507
00508 #pragma GCC diagnostic push // Needed since profile builds will ignore the assert
00509 #pragma GCC diagnostic ignored "-Wunused-variable"
00510
00511 void artdaq::MulticastTransfer::get_fragment_quantities(const boost::asio::mutable_buffer& buf, size_t& payload_size,
00512 size_t& fragment_size,
00513 size_t& expected_subfragments)
00514 {
00515 byte_t* buffer_ptr = boost::asio::buffer_cast<byte_t*>(buf);
00516
00517 auto subfragment_num = *(reinterpret_cast<size_t*>(buffer_ptr) + 2);
00518
00519 assert(subfragment_num == 0);
00520
00521 artdaq::detail::RawFragmentHeader* header =
00522 reinterpret_cast<artdaq::detail::RawFragmentHeader*>(buffer_ptr + sizeof(subfragment_identifier));
00523
00524 fragment_size = header->word_count * sizeof(artdaq::RawDataType);
00525
00526 auto metadata_size = header->metadata_word_count * sizeof(artdaq::RawDataType);
00527 payload_size = fragment_size - metadata_size - artdaq::detail::RawFragmentHeader::num_words() *
00528 sizeof(artdaq::RawDataType);
00529
00530 assert(fragment_size ==
00531 artdaq::detail::RawFragmentHeader::num_words() * sizeof(artdaq::RawDataType) +
00532 metadata_size +
00533 payload_size);
00534
00535 expected_subfragments = static_cast<size_t>(std::ceil(fragment_size / static_cast<float>(subfragment_size_)));
00536 }
00537 #pragma GCC diagnostic pop
00538
00539 void artdaq::MulticastTransfer::set_receive_buffer_size(size_t recv_buff_size)
00540 {
00541 if (recv_buff_size == 0) return;
00542 boost::asio::socket_base::receive_buffer_size actual_recv_buff_size;
00543 socket_->get_option(actual_recv_buff_size);
00544
00545 TLOG(TLVL_DEBUG) << GetTraceName() << ": Receive buffer size is currently " << actual_recv_buff_size.value() <<
00546 " bytes, will try to change it to " << recv_buff_size ;
00547
00548 boost::asio::socket_base::receive_buffer_size recv_buff_option(recv_buff_size);
00549
00550 boost::system::error_code ec;
00551 socket_->set_option(recv_buff_option, ec);
00552
00553 if (ec != 0)
00554 {
00555 std::cerr << "boost::system::error_code with value " << ec <<
00556 " was found in attempt to change receive buffer" << std::endl;
00557 }
00558
00559 socket_->get_option(actual_recv_buff_size);
00560 TLOG(TLVL_DEBUG) << GetTraceName() << ": After attempted change, receive buffer size is now " << actual_recv_buff_size.value() ;
00561 }
00562
00563 #pragma GCC diagnostic pop
00564
00565 DEFINE_ARTDAQ_TRANSFER(artdaq::MulticastTransfer)