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