From b0cb065111dc3f40b89bdda76e9bd98f3e70b72e Mon Sep 17 00:00:00 2001 From: Samuel O'Brien Date: Fri, 26 Jun 2020 08:26:25 -0500 Subject: rfnoc: Rename chdr_packet to chdr_packet_writer It would be confusing to have two classes named chdr_packet. As it makes more sense to name the new public chdr parser class chdr_packet, the internal uhd::rfnoc::chdr::chdr_packet class is being renamed to chdr_packet_writer to better represent its functionality. Signed-off-by: Samuel O'Brien --- host/lib/rfnoc/CMakeLists.txt | 2 +- host/lib/rfnoc/chdr_ctrl_endpoint.cpp | 2 +- host/lib/rfnoc/chdr_packet.cpp | 222 ---------------------------------- host/lib/rfnoc/chdr_packet_writer.cpp | 222 ++++++++++++++++++++++++++++++++++ host/lib/rfnoc/chdr_rx_data_xport.cpp | 2 +- host/lib/rfnoc/chdr_tx_data_xport.cpp | 4 +- host/lib/rfnoc/ctrlport_endpoint.cpp | 20 ++- host/lib/rfnoc/mgmt_portal.cpp | 2 +- 8 files changed, 236 insertions(+), 240 deletions(-) delete mode 100644 host/lib/rfnoc/chdr_packet.cpp create mode 100644 host/lib/rfnoc/chdr_packet_writer.cpp (limited to 'host/lib/rfnoc') diff --git a/host/lib/rfnoc/CMakeLists.txt b/host/lib/rfnoc/CMakeLists.txt index 7c54a71f6..7d1334e04 100644 --- a/host/lib/rfnoc/CMakeLists.txt +++ b/host/lib/rfnoc/CMakeLists.txt @@ -16,7 +16,7 @@ LIBUHD_APPEND_SOURCES( ${CMAKE_CURRENT_SOURCE_DIR}/block_container.cpp ${CMAKE_CURRENT_SOURCE_DIR}/block_id.cpp ${CMAKE_CURRENT_SOURCE_DIR}/chdr_types.cpp - ${CMAKE_CURRENT_SOURCE_DIR}/chdr_packet.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/chdr_packet_writer.cpp ${CMAKE_CURRENT_SOURCE_DIR}/chdr_ctrl_xport.cpp ${CMAKE_CURRENT_SOURCE_DIR}/chdr_rx_data_xport.cpp ${CMAKE_CURRENT_SOURCE_DIR}/chdr_tx_data_xport.cpp diff --git a/host/lib/rfnoc/chdr_ctrl_endpoint.cpp b/host/lib/rfnoc/chdr_ctrl_endpoint.cpp index bba972186..3b2865c73 100644 --- a/host/lib/rfnoc/chdr_ctrl_endpoint.cpp +++ b/host/lib/rfnoc/chdr_ctrl_endpoint.cpp @@ -9,7 +9,7 @@ #include #include #include -#include +#include #include #include #include diff --git a/host/lib/rfnoc/chdr_packet.cpp b/host/lib/rfnoc/chdr_packet.cpp deleted file mode 100644 index fc6c24838..000000000 --- a/host/lib/rfnoc/chdr_packet.cpp +++ /dev/null @@ -1,222 +0,0 @@ -// -// Copyright 2019 Ettus Research, a National Instruments Brand -// -// SPDX-License-Identifier: GPL-3.0-or-later -// - -#include -#include -#include -#include - -using namespace uhd; -using namespace uhd::rfnoc; -using namespace uhd::rfnoc::chdr; - -chdr_packet::~chdr_packet() = default; - -//------------------------------------------------------------ -// chdr_packet -//------------------------------------------------------------ -// endianness is the link endianness, not the host endianness -template -class chdr_packet_impl : public chdr_packet -{ -public: - chdr_packet_impl() = delete; - chdr_packet_impl(size_t mtu_bytes) : _mtu_bytes(mtu_bytes) {} - ~chdr_packet_impl() = default; - - virtual void refresh(const void* pkt_buff) const - { - assert(pkt_buff); - _pkt_buff = const_cast(reinterpret_cast(pkt_buff)); - _mdata_offset = _compute_mdata_offset(get_chdr_header()); - } - - virtual void refresh(void* pkt_buff, chdr_header& header, uint64_t timestamp = 0) - { - assert(pkt_buff); - _pkt_buff = reinterpret_cast(pkt_buff); - _pkt_buff[0] = u64_from_host(header); - if (_has_timestamp(header)) { - _pkt_buff[1] = u64_from_host(timestamp); - } - _mdata_offset = _compute_mdata_offset(get_chdr_header()); - } - - virtual void update_payload_size(size_t payload_size_bytes) - { - chdr_header header = get_chdr_header(); - header.set_length(((_mdata_offset + header.get_num_mdata()) * chdr_w_bytes) - + payload_size_bytes); - _pkt_buff[0] = u64_from_host(header); - } - - virtual endianness_t get_byte_order() const - { - return endianness; - } - - virtual size_t get_mtu_bytes() const - { - return _mtu_bytes; - } - - virtual chdr_header get_chdr_header() const - { - assert(_pkt_buff); - return std::move(chdr_header(u64_to_host(_pkt_buff[0]))); - } - - virtual boost::optional get_timestamp() const - { - if (_has_timestamp(get_chdr_header())) { - // In a unit64_t buffer, the timestamp is always immediately after the header - // regardless of chdr_w. - return u64_to_host(_pkt_buff[1]); - } else { - return boost::none; - } - } - - virtual size_t get_mdata_size() const - { - return get_chdr_header().get_num_mdata() * chdr_w_bytes; - } - - virtual const void* get_mdata_const_ptr() const - { - return const_cast( - const_cast*>(this)->get_mdata_ptr()); - } - - virtual void* get_mdata_ptr() - { - return reinterpret_cast(_pkt_buff + (chdr_w_stride * _mdata_offset)); - } - - virtual size_t get_payload_size() const - { - return get_chdr_header().get_length() - get_mdata_size() - - (chdr_w_bytes * _mdata_offset); - } - - virtual const void* get_payload_const_ptr() const - { - return const_cast( - const_cast*>(this)->get_payload_ptr()); - } - - virtual void* get_payload_ptr() - { - return reinterpret_cast( - _pkt_buff - + (chdr_w_stride * (_mdata_offset + get_chdr_header().get_num_mdata()))); - } - - virtual size_t calculate_payload_offset( - const packet_type_t pkt_type, const uint8_t num_mdata = 0) const - { - chdr_header header; - header.set_pkt_type(pkt_type); - return (_compute_mdata_offset(header) + num_mdata) * chdr_w_bytes; - } - -private: - inline bool _has_timestamp(const chdr_header& header) const - { - return (header.get_pkt_type() == PKT_TYPE_DATA_WITH_TS); - } - - inline size_t _compute_mdata_offset(const chdr_header& header) const - { - // The metadata offset depends on the chdr_w and whether we have a timestamp - if (chdr_w == 64) { - return _has_timestamp(header) ? 2 : 1; - } else { - return 1; - } - } - - inline static uint64_t u64_to_host(uint64_t word) - { - return (endianness == ENDIANNESS_BIG) ? uhd::ntohx(word) - : uhd::wtohx(word); - } - - inline static uint64_t u64_from_host(uint64_t word) - { - return (endianness == ENDIANNESS_BIG) ? uhd::htonx(word) - : uhd::htowx(word); - } - - static const size_t chdr_w_bytes = (chdr_w / 8); - static const size_t chdr_w_stride = (chdr_w / 64); - - // Packet state - const size_t _mtu_bytes = 0; - mutable uint64_t* _pkt_buff = nullptr; - mutable size_t _mdata_offset = 0; -}; - -chdr_packet_factory::chdr_packet_factory(chdr_w_t chdr_w, endianness_t endianness) - : _chdr_w(chdr_w), _endianness(endianness) -{ -} - -chdr_packet::uptr chdr_packet_factory::make_generic(size_t mtu_bytes) const -{ - if (_endianness == ENDIANNESS_BIG) { - switch (_chdr_w) { - case CHDR_W_512: - return std::make_unique>(mtu_bytes); - case CHDR_W_256: - return std::make_unique>(mtu_bytes); - case CHDR_W_128: - return std::make_unique>(mtu_bytes); - case CHDR_W_64: - return std::make_unique>(mtu_bytes); - default: - assert(0); - } - } else { - switch (_chdr_w) { - case CHDR_W_512: - return std::make_unique>( - mtu_bytes); - case CHDR_W_256: - return std::make_unique>( - mtu_bytes); - case CHDR_W_128: - return std::make_unique>( - mtu_bytes); - case CHDR_W_64: - return std::make_unique>( - mtu_bytes); - default: - assert(0); - } - } - return chdr_packet::uptr(); -} - -chdr_ctrl_packet::uptr chdr_packet_factory::make_ctrl(size_t mtu_bytes) const -{ - return std::make_unique(make_generic(mtu_bytes)); -} - -chdr_strs_packet::uptr chdr_packet_factory::make_strs(size_t mtu_bytes) const -{ - return std::make_unique(make_generic(mtu_bytes)); -} - -chdr_strc_packet::uptr chdr_packet_factory::make_strc(size_t mtu_bytes) const -{ - return std::make_unique(make_generic(mtu_bytes)); -} - -chdr_mgmt_packet::uptr chdr_packet_factory::make_mgmt(size_t mtu_bytes) const -{ - return std::make_unique(make_generic(mtu_bytes)); -} diff --git a/host/lib/rfnoc/chdr_packet_writer.cpp b/host/lib/rfnoc/chdr_packet_writer.cpp new file mode 100644 index 000000000..c58ffd932 --- /dev/null +++ b/host/lib/rfnoc/chdr_packet_writer.cpp @@ -0,0 +1,222 @@ +// +// Copyright 2019 Ettus Research, a National Instruments Brand +// +// SPDX-License-Identifier: GPL-3.0-or-later +// + +#include +#include +#include +#include + +using namespace uhd; +using namespace uhd::rfnoc; +using namespace uhd::rfnoc::chdr; + +chdr_packet_writer::~chdr_packet_writer() = default; + +//------------------------------------------------------------ +// chdr_packet +//------------------------------------------------------------ +// endianness is the link endianness, not the host endianness +template +class chdr_packet_impl : public chdr_packet_writer +{ +public: + chdr_packet_impl() = delete; + chdr_packet_impl(size_t mtu_bytes) : _mtu_bytes(mtu_bytes) {} + ~chdr_packet_impl() = default; + + virtual void refresh(const void* pkt_buff) const + { + assert(pkt_buff); + _pkt_buff = const_cast(reinterpret_cast(pkt_buff)); + _mdata_offset = _compute_mdata_offset(get_chdr_header()); + } + + virtual void refresh(void* pkt_buff, chdr_header& header, uint64_t timestamp = 0) + { + assert(pkt_buff); + _pkt_buff = reinterpret_cast(pkt_buff); + _pkt_buff[0] = u64_from_host(header); + if (_has_timestamp(header)) { + _pkt_buff[1] = u64_from_host(timestamp); + } + _mdata_offset = _compute_mdata_offset(get_chdr_header()); + } + + virtual void update_payload_size(size_t payload_size_bytes) + { + chdr_header header = get_chdr_header(); + header.set_length(((_mdata_offset + header.get_num_mdata()) * chdr_w_bytes) + + payload_size_bytes); + _pkt_buff[0] = u64_from_host(header); + } + + virtual endianness_t get_byte_order() const + { + return endianness; + } + + virtual size_t get_mtu_bytes() const + { + return _mtu_bytes; + } + + virtual chdr_header get_chdr_header() const + { + assert(_pkt_buff); + return std::move(chdr_header(u64_to_host(_pkt_buff[0]))); + } + + virtual boost::optional get_timestamp() const + { + if (_has_timestamp(get_chdr_header())) { + // In a unit64_t buffer, the timestamp is always immediately after the header + // regardless of chdr_w. + return u64_to_host(_pkt_buff[1]); + } else { + return boost::none; + } + } + + virtual size_t get_mdata_size() const + { + return get_chdr_header().get_num_mdata() * chdr_w_bytes; + } + + virtual const void* get_mdata_const_ptr() const + { + return const_cast( + const_cast*>(this)->get_mdata_ptr()); + } + + virtual void* get_mdata_ptr() + { + return reinterpret_cast(_pkt_buff + (chdr_w_stride * _mdata_offset)); + } + + virtual size_t get_payload_size() const + { + return get_chdr_header().get_length() - get_mdata_size() + - (chdr_w_bytes * _mdata_offset); + } + + virtual const void* get_payload_const_ptr() const + { + return const_cast( + const_cast*>(this)->get_payload_ptr()); + } + + virtual void* get_payload_ptr() + { + return reinterpret_cast( + _pkt_buff + + (chdr_w_stride * (_mdata_offset + get_chdr_header().get_num_mdata()))); + } + + virtual size_t calculate_payload_offset( + const packet_type_t pkt_type, const uint8_t num_mdata = 0) const + { + chdr_header header; + header.set_pkt_type(pkt_type); + return (_compute_mdata_offset(header) + num_mdata) * chdr_w_bytes; + } + +private: + inline bool _has_timestamp(const chdr_header& header) const + { + return (header.get_pkt_type() == PKT_TYPE_DATA_WITH_TS); + } + + inline size_t _compute_mdata_offset(const chdr_header& header) const + { + // The metadata offset depends on the chdr_w and whether we have a timestamp + if (chdr_w == 64) { + return _has_timestamp(header) ? 2 : 1; + } else { + return 1; + } + } + + inline static uint64_t u64_to_host(uint64_t word) + { + return (endianness == ENDIANNESS_BIG) ? uhd::ntohx(word) + : uhd::wtohx(word); + } + + inline static uint64_t u64_from_host(uint64_t word) + { + return (endianness == ENDIANNESS_BIG) ? uhd::htonx(word) + : uhd::htowx(word); + } + + static const size_t chdr_w_bytes = (chdr_w / 8); + static const size_t chdr_w_stride = (chdr_w / 64); + + // Packet state + const size_t _mtu_bytes = 0; + mutable uint64_t* _pkt_buff = nullptr; + mutable size_t _mdata_offset = 0; +}; + +chdr_packet_factory::chdr_packet_factory(chdr_w_t chdr_w, endianness_t endianness) + : _chdr_w(chdr_w), _endianness(endianness) +{ +} + +chdr_packet_writer::uptr chdr_packet_factory::make_generic(size_t mtu_bytes) const +{ + if (_endianness == ENDIANNESS_BIG) { + switch (_chdr_w) { + case CHDR_W_512: + return std::make_unique>(mtu_bytes); + case CHDR_W_256: + return std::make_unique>(mtu_bytes); + case CHDR_W_128: + return std::make_unique>(mtu_bytes); + case CHDR_W_64: + return std::make_unique>(mtu_bytes); + default: + assert(0); + } + } else { + switch (_chdr_w) { + case CHDR_W_512: + return std::make_unique>( + mtu_bytes); + case CHDR_W_256: + return std::make_unique>( + mtu_bytes); + case CHDR_W_128: + return std::make_unique>( + mtu_bytes); + case CHDR_W_64: + return std::make_unique>( + mtu_bytes); + default: + assert(0); + } + } + return chdr_packet_writer::uptr(); +} + +chdr_ctrl_packet::uptr chdr_packet_factory::make_ctrl(size_t mtu_bytes) const +{ + return std::make_unique(make_generic(mtu_bytes)); +} + +chdr_strs_packet::uptr chdr_packet_factory::make_strs(size_t mtu_bytes) const +{ + return std::make_unique(make_generic(mtu_bytes)); +} + +chdr_strc_packet::uptr chdr_packet_factory::make_strc(size_t mtu_bytes) const +{ + return std::make_unique(make_generic(mtu_bytes)); +} + +chdr_mgmt_packet::uptr chdr_packet_factory::make_mgmt(size_t mtu_bytes) const +{ + return std::make_unique(make_generic(mtu_bytes)); +} diff --git a/host/lib/rfnoc/chdr_rx_data_xport.cpp b/host/lib/rfnoc/chdr_rx_data_xport.cpp index df7162a73..ebfcda2b8 100644 --- a/host/lib/rfnoc/chdr_rx_data_xport.cpp +++ b/host/lib/rfnoc/chdr_rx_data_xport.cpp @@ -106,7 +106,7 @@ chdr_rx_data_xport::fc_params_t chdr_rx_data_xport::configure_sep(io_service::sp const sep_id_t local_epid = epids.second; rx_flow_ctrl_sender fc_sender(pkt_factory, epids); - chdr::chdr_packet::uptr pkt = pkt_factory.make_generic(); + chdr::chdr_packet_writer::uptr pkt = pkt_factory.make_generic(); fc_sender.set_capacity(recv_capacity); chdr::strc_payload strc; diff --git a/host/lib/rfnoc/chdr_tx_data_xport.cpp b/host/lib/rfnoc/chdr_tx_data_xport.cpp index 321b6ea85..a51835a07 100644 --- a/host/lib/rfnoc/chdr_tx_data_xport.cpp +++ b/host/lib/rfnoc/chdr_tx_data_xport.cpp @@ -96,8 +96,8 @@ static chdr_tx_data_xport::fc_params_t configure_flow_ctrl(io_service::sptr io_s const double fc_freq_ratio, const double fc_headroom_ratio) { - chdr::chdr_strc_packet::uptr strc_packet = pkt_factory.make_strc(); - chdr::chdr_packet::uptr recv_packet = pkt_factory.make_generic(); + chdr::chdr_strc_packet::uptr strc_packet = pkt_factory.make_strc(); + chdr::chdr_packet_writer::uptr recv_packet = pkt_factory.make_generic(); // No flow control at initialization, just release all send buffs auto send_cb = [](frame_buff::uptr buff, send_link_if* send_link) { diff --git a/host/lib/rfnoc/ctrlport_endpoint.cpp b/host/lib/rfnoc/ctrlport_endpoint.cpp index 5cff24443..5afb3919e 100644 --- a/host/lib/rfnoc/ctrlport_endpoint.cpp +++ b/host/lib/rfnoc/ctrlport_endpoint.cpp @@ -6,7 +6,7 @@ #include #include -#include +#include #include #include #include @@ -121,9 +121,8 @@ public: { // Compute transaction expiration time, use MASSIVE_TIMEOUT if a timed // command is in the queue - auto timeout_time = start_timeout( - check_timed_in_queue() ? MASSIVE_TIMEOUT : _policy.timeout - ); + auto timeout_time = + start_timeout(check_timed_in_queue() ? MASSIVE_TIMEOUT : _policy.timeout); // Send request auto request = @@ -174,9 +173,8 @@ public: // Compute transaction expiration time, use MASSIVE_TIMEOUT if a timed // command is in the queue - auto timeout_time = start_timeout( - check_timed_in_queue() ? MASSIVE_TIMEOUT : _policy.timeout - ); + auto timeout_time = + start_timeout(check_timed_in_queue() ? MASSIVE_TIMEOUT : _policy.timeout); // Send request auto request = send_request_packet(OP_POLL, @@ -192,12 +190,10 @@ public: virtual void sleep(uhd::time_spec_t duration, bool ack = false) { - // Compute transaction expiration time, use MASSIVE_TIMEOUT if a timed // command is in the queue - auto timeout_time = start_timeout( - check_timed_in_queue() ? MASSIVE_TIMEOUT : _policy.timeout - ); + auto timeout_time = + start_timeout(check_timed_in_queue() ? MASSIVE_TIMEOUT : _policy.timeout); // Send request auto request = send_request_packet(OP_SLEEP, @@ -421,7 +417,7 @@ private: // If we can fit the current request in the queue then we can proceed return (_buff_occupied + pyld_size) <= (_buff_capacity - - (ASYNC_MESSAGE_SIZE * _max_outstanding_async_msgs)); + - (ASYNC_MESSAGE_SIZE * _max_outstanding_async_msgs)); }; if (!buff_not_full()) { // If we're sending a timed command or if we have a timed command in the diff --git a/host/lib/rfnoc/mgmt_portal.cpp b/host/lib/rfnoc/mgmt_portal.cpp index 971c9837a..a54efaaf7 100644 --- a/host/lib/rfnoc/mgmt_portal.cpp +++ b/host/lib/rfnoc/mgmt_portal.cpp @@ -8,7 +8,7 @@ #include #include #include -#include +#include #include #include #include -- cgit v1.2.3