diff options
Diffstat (limited to 'host/include/uhd/rfnoc/chdr/chdr_packet.hpp')
| -rw-r--r-- | host/include/uhd/rfnoc/chdr/chdr_packet.hpp | 294 |
1 files changed, 0 insertions, 294 deletions
diff --git a/host/include/uhd/rfnoc/chdr/chdr_packet.hpp b/host/include/uhd/rfnoc/chdr/chdr_packet.hpp deleted file mode 100644 index 0a2ae68f3..000000000 --- a/host/include/uhd/rfnoc/chdr/chdr_packet.hpp +++ /dev/null @@ -1,294 +0,0 @@ -// -// Copyright 2019 Ettus Research, a National Instruments Brand -// -// SPDX-License-Identifier: GPL-3.0-or-later -// - -#ifndef INCLUDED_RFNOC_CHDR_DATA_PACKET_HPP -#define INCLUDED_RFNOC_CHDR_DATA_PACKET_HPP - -#include <uhd/rfnoc/chdr/chdr_header.hpp> -#include <uhd/exception.hpp> -#include <cassert> -#include <memory> - -namespace uhd { namespace rfnoc { namespace chdr { - -class chdr_packet_iface -{ -public: - typedef std::unique_ptr<chdr_packet_iface> uptr; - static uptr make(void* pkt_buff); - static uptr make(size_t chdr_w, endianness_t endianness, void* pkt_buff); - static uptr make( - size_t chdr_w, endianness_t endianness, uint64_t header_val, void* pkt_buff); - virtual uint64_t get_header_val() const = 0; - virtual void set_header_val(uint64_t header_val) = 0; - virtual uint64_t get_timestamp() const = 0; - virtual void set_timestamp(uint64_t timestamp) = 0; - virtual uint64_t* metadata_ptr_of_type_uint64_t() const = 0; - virtual uint32_t* metadata_ptr_of_type_uint32_t() const = 0; - virtual uint64_t* payload_ptr_of_type_uint64_t() const = 0; - virtual uint32_t* payload_ptr_of_type_uint32_t() const = 0; - virtual uint16_t* payload_ptr_of_type_uint16_t() const = 0; -}; - -/*! CHDR Packet Abstraction Class - * - * This class wraps a pointer to a buffer containing a CHDR packet. It also - * provides access to the packet header in native byte ordering. The byte - * ordering of the metadata and payload needs to be handled elsewhere, but it - * needs to be also passed into this class as a template argument \p endianness. - * The byte ordering refers to the byte order on the transport. - * - * No size checking is performed in this class. The size of the buffer needs to - * be tracked separately in order to avoid buffer overflows. - * - * NOTE: This assumes the host is little-endian. - */ -template <size_t chdr_w, endianness_t endianness> -class chdr_packet : public chdr_packet_iface -{ -public: - typedef chdr_header<chdr_w> header_t; - - ~chdr_packet() = default; - - /*! This constructor is used to parse an incoming CHDR packet. - * - * Note: If the header declares the size of the packet to be larger than the - * valid memory readable at \p pkt_buff, then there is the possibility of a - * buffer overflow ocurring. - * - * \param pkt_buff a pointer to the packet buffer. Its byte ordering has to be - * provided as the template argument \p endianness - */ - chdr_packet(void* pkt_buff) - { - assert(pkt_buff != NULL); - _pkt_buff = static_cast<uint64_t*>(pkt_buff); - if (endianness == endianness_t::ENDIANNESS_BIG) { - _header = header_t(ntohx<uint64_t>(*_pkt_buff)); - } else { - _header = header_t(*_pkt_buff); - } - } - - /*! This constructor is used to construct an outgoing CHDR packet with given header. - * - * \param header CHDR header (in host-native byte ordering) - * \param pkt_buff a pointer to packet buffer. Its byte ordering has to be provided - * as the template argument \p endianness - */ - chdr_packet(header_t header, void* pkt_buff) : _header(header) - { - assert(pkt_buff != NULL); - _pkt_buff = static_cast<uint64_t*>(pkt_buff); - if (endianness == endianness_t::ENDIANNESS_BIG) { - *_pkt_buff = htonx<uint64_t>(header.get()); - } else { - *_pkt_buff = header.get(); - } - } - - /*! Get a copy of the header data (the first 64-bit of the CHDR packet) - * - * This copy will be in native byte order. - */ - inline header_t get_header() const - { - return _header; - } - - /*! Get a copy of the 64-bit value of the packet header (the first 64-bit - * of the CHDR packet) - * - * This copy will be in native byte order. - */ - inline uint64_t get_header_val() const - { - return _header.get(); - } - - /*! Set 64-bit value of the packet header (the first 64-bit of the CHDR - * packet) - * - * This set 64_bit value will swap byte to native byte order. - */ - inline void set_header_val(uint64_t header_val) - { - if (endianness == endianness_t::ENDIANNESS_BIG) { - _header = header_t(ntohx<uint64_t>(header_val)); - } else { - _header = header_t(header_val); - } - } - - /*! Return the pointer to the first byte of metadata of this CHDR packet - * - * Note: This class does no bounds checking. It is up to the user to only - * to the metadata portion of the the CHDR buffer. - * - * ~~~{.cpp} - * // Assume chdrpkt is of type chdr_packet: - * uint8_t* metadata_ptr = chdrpkt.metadata_ptr_of_type<uint8_t>(); - * const size_t metadata_size = chdrpkt.get_header().get_num_bytes_metadata(); - * // The following expression is fine if metadata_size > 0: - * metadata_ptr[0] = 0xF0; - * // The following expression is never fine, but the code will not throw an - * // exception (most likely, it won't segfault either, unless the payload - * // size is zero): - * metadata_ptr[metadata_size] = 0xF0; - * ~~~ - */ - template <typename data_t> - inline data_t* metadata_ptr_of_type() const - { - return reinterpret_cast<data_t*>( - reinterpret_cast<char*>(_pkt_buff) + _header.get_metadata_offset()); - } - - /*! Get 64-bit timestamp of this CHDR packet in native byte order - * - * This will byteswap if necessary. - * - */ - inline uint64_t get_timestamp() const - { - assert(_header.get_pkt_type() == packet_type_t::PACKET_TYPE_DATA_WITH_TS); - return endianness_t::ENDIANNESS_BIG ? ntohx<uint64_t>(*(_pkt_buff + 1)) - : *(_pkt_buff + 1); - } - - /*! Set 64-bit timestamp of this CHDR packet. - * - * If this packet is not a data packet with timestamp, this operation will - * overwrite the metadata or payload memory. - * - * \param timestamp 64-bit value of timestamp of this CHDR packet - */ - inline void set_timestamp(uint64_t timestamp) - { - assert(_header.get_pkt_type() == packet_type_t::PACKET_TYPE_DATA_WITH_TS); - *(_pkt_buff + 1) = endianness_t::ENDIANNESS_BIG ? htonx<uint64_t>(timestamp) - : timestamp; - } - - /*! Return the pointer to the first payload byte of this CHDR packet - * - * Note: This class does no bounds checking. It is up to the user to only - * to the metadata portion of the the CHDR buffer. - * - * ~~~{.cpp} - * // Assume chdrpkt is of type chdr_packet: - * uint8_t* payload_ptr = chdrpkt.metadata_ptr_of_type<uint8_t>(); - * const size_t payload_size = chdrpkt.get_header().get_num_bytes_payload(); - * // The following expression is fine if payload_size > 0: - * payload_ptr[0] = 0xF0; - * // The following expression is never fine, but the code will not throw an - * // exception. Instead, it could even segfault: - * payload_ptr[payload_size] = 0xF0; - * ~~~ - */ - template <typename payload_t> - inline payload_t* payload_ptr_of_type() const - { - return reinterpret_cast<payload_t*>( - reinterpret_cast<char*>(_pkt_buff) + _header.get_payload_offset()); - } - - inline uint64_t* payload_ptr_of_type_uint64_t() const - { - return reinterpret_cast<uint64_t*>( - reinterpret_cast<char*>(_pkt_buff) + _header.get_payload_offset()); - } - - inline uint32_t* payload_ptr_of_type_uint32_t() const - { - return reinterpret_cast<uint32_t*>( - reinterpret_cast<char*>(_pkt_buff) + _header.get_payload_offset()); - } - - inline uint16_t* payload_ptr_of_type_uint16_t() const - { - return reinterpret_cast<uint16_t*>( - reinterpret_cast<char*>(_pkt_buff) + _header.get_payload_offset()); - } - - inline uint64_t* metadata_ptr_of_type_uint64_t() const - { - return reinterpret_cast<uint64_t*>( - reinterpret_cast<char*>(_pkt_buff) + _header.get_metadata_offset()); - } - - inline uint32_t* metadata_ptr_of_type_uint32_t() const - { - return reinterpret_cast<uint32_t*>( - reinterpret_cast<char*>(_pkt_buff) + _header.get_metadata_offset()); - } - -private: - uint64_t* _pkt_buff; - header_t _header = header_t(0); -}; - -chdr_packet_iface::uptr chdr_packet_iface::make(void* pkt_buff) -{ - return uptr(new chdr_packet<64, ENDIANNESS_LITTLE>(pkt_buff)); -} - -chdr_packet_iface::uptr chdr_packet_iface::make( - size_t chdr_w, endianness_t endianness, void* pkt_buff) -{ - if (endianness == ENDIANNESS_BIG) { - switch (chdr_w) { - case 256: - return uptr(new chdr_packet<256, ENDIANNESS_BIG>(pkt_buff)); - case 64: - return uptr(new chdr_packet<64, ENDIANNESS_BIG>(pkt_buff)); - default: - UHD_THROW_INVALID_CODE_PATH(); - } - } else { - switch (chdr_w) { - case 256: - return uptr(new chdr_packet<256, ENDIANNESS_LITTLE>(pkt_buff)); - case 64: - return uptr(new chdr_packet<64, ENDIANNESS_LITTLE>(pkt_buff)); - default: - UHD_THROW_INVALID_CODE_PATH(); - } - } -} - -chdr_packet_iface::uptr chdr_packet_iface::make( - size_t chdr_w, endianness_t endianness, uint64_t header_val, void* pkt_buff) -{ - if (endianness == ENDIANNESS_BIG) { - switch (chdr_w) { - case 256: - return uptr(new chdr_packet<256, ENDIANNESS_BIG>( - chdr_header<256>(header_val), pkt_buff)); - case 64: - return uptr(new chdr_packet<64, ENDIANNESS_BIG>( - chdr_header<64>(header_val), pkt_buff)); - default: - UHD_THROW_INVALID_CODE_PATH(); - } - } else { - switch (chdr_w) { - case 256: - return uptr(new chdr_packet<256, ENDIANNESS_LITTLE>( - chdr_header<256>(header_val), pkt_buff)); - case 64: - return uptr(new chdr_packet<64, ENDIANNESS_LITTLE>( - chdr_header<64>(header_val), pkt_buff)); - default: - UHD_THROW_INVALID_CODE_PATH(); - } - } -} - -}}} // namespace uhd::rfnoc::chdr - -#endif /* INCLUDED_RFNOC_CHDR_DATA_PACKET_HPP */ |