uhd: add udp boost asio implementation of transport interface

2 files changed, 315 insertions, 0 deletions

diff --git a/host/lib/include/uhdlib/transport/udp_boost_asio_link.hpp b/host/lib/include/uhdlib/transport/udp_boost_asio_link.hpp
new file mode 100644
index 000000000..2e6f731c9
--- /dev/null
+++ b/host/lib/include/uhdlib/transport/udp_boost_asio_link.hpp
@@ -0,0 +1,115 @@
+//
+// Copyright 2019 Ettus Research, a National Instruments Brand
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
+//
+
+#ifndef INCLUDED_UHD_TRANSPORT_UDP_BOOST_ASIO_LINK_HPP
+#define INCLUDED_UHD_TRANSPORT_UDP_BOOST_ASIO_LINK_HPP
+
+#include <uhd/config.hpp>
+#include <uhd/transport/buffer_pool.hpp>
+#include <uhd/types/device_addr.hpp>
+#include <uhdlib/transport/link_base.hpp>
+#include <uhdlib/transport/links.hpp>
+#include <uhdlib/transport/udp_common.hpp>
+#include <boost/asio.hpp>
+#include <memory>
+#include <vector>
+
+namespace uhd { namespace transport {
+
+class udp_boost_asio_frame_buff : public frame_buff
+{
+public:
+    udp_boost_asio_frame_buff(void* mem)
+    {
+        _data = mem;
+    }
+};
+
+class udp_boost_asio_link : public recv_link_base<udp_boost_asio_link>,
+                            public send_link_base<udp_boost_asio_link>
+{
+public:
+    using sptr = std::shared_ptr<udp_boost_asio_link>;
+
+    /*!
+     * Make a new udp link.
+     *
+     * \param addr a string representing the destination address
+     * \param port a string representing the destination port
+     * \param params Values for frame sizes, num frames, and buffer sizes
+     * \param[out] recv_socket_buff_size Returns the recv socket buffer size
+     * \param[out] send_socket_buff_size Returns the send socket buffer size
+     */
+    static sptr make(const std::string& addr,
+        const std::string& port,
+        const link_params_t& params,
+        size_t& recv_socket_buff_size,
+        size_t& send_socket_buff_size);
+
+    /*! Return the local port of the UDP connection. Port is in host byte order.
+     *
+     * \returns Port number or 0 if port number couldn't be identified.
+     */
+    uint16_t get_local_port() const;
+
+    /*! Return the local IP address of the UDP connection as a dotted string.
+     *
+     * \returns IP address as a string or empty string if the IP address could
+     *          not be identified.
+     */
+    std::string get_local_addr() const;
+
+private:
+    using recv_link_base_t = recv_link_base<udp_boost_asio_link>;
+    using send_link_base_t = send_link_base<udp_boost_asio_link>;
+
+    // Friend declarations to allow base classes to call private methods
+    friend recv_link_base_t;
+    friend send_link_base_t;
+
+    udp_boost_asio_link(
+        const std::string& addr, const std::string& port, const link_params_t& params);
+
+    size_t resize_recv_socket_buffer(size_t num_bytes);
+    size_t resize_send_socket_buffer(size_t num_bytes);
+
+    // Methods called by recv_link_base
+    UHD_FORCE_INLINE size_t get_recv_buff_derived(frame_buff& buff, int32_t timeout_ms)
+    {
+        return recv_udp_packet(_sock_fd, buff.data(), get_recv_frame_size(), timeout_ms);
+    }
+
+    UHD_FORCE_INLINE void release_recv_buff_derived(frame_buff& /*buff*/)
+    {
+        // No-op
+    }
+
+    // Methods called by send_link_base
+    UHD_FORCE_INLINE bool get_send_buff_derived(
+        frame_buff& /*buff*/, int32_t /*timeout_ms*/)
+    {
+        return true;
+    }
+
+    UHD_FORCE_INLINE void release_send_buff_derived(frame_buff& buff)
+    {
+        send_udp_packet(_sock_fd, buff.data(), buff.packet_size());
+    }
+
+    buffer_pool::sptr _recv_memory_pool;
+    buffer_pool::sptr _send_memory_pool;
+
+    std::vector<udp_boost_asio_frame_buff> _recv_buffs;
+    std::vector<udp_boost_asio_frame_buff> _send_buffs;
+
+    boost::asio::io_service _io_service;
+    std::shared_ptr<boost::asio::ip::udp::socket> _socket;
+    int _sock_fd;
+};
+
+}} // namespace uhd::transport
+
+#endif /* INCLUDED_UHD_TRANSPORT_UDP_BOOST_ASIO_LINK_HPP */
diff --git a/host/lib/include/uhdlib/transport/udp_common.hpp b/host/lib/include/uhdlib/transport/udp_common.hpp
new file mode 100644
index 000000000..5f5a18c27
--- /dev/null
+++ b/host/lib/include/uhdlib/transport/udp_common.hpp
@@ -0,0 +1,200 @@
+//
+// Copyright 2011 Ettus Research LLC
+// Copyright 2018 Ettus Research, a National Instruments Company
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
+//
+
+#ifndef INCLUDED_TRANSPORT_UDP_COMMON_HPP
+#define INCLUDED_TRANSPORT_UDP_COMMON_HPP
+
+#include <uhd/config.hpp>
+#include <uhd/exception.hpp>
+#include <uhd/utils/log.hpp>
+#include <boost/asio.hpp>
+#include <boost/format.hpp>
+#include <thread>
+
+namespace uhd { namespace transport {
+
+// Jumbo frames can be up to 9600 bytes;
+constexpr size_t MAX_ETHERNET_MTU = 9600;
+
+constexpr size_t UDP_DEFAULT_NUM_FRAMES = 1;
+
+// Based on common 1500 byte MTU for 1GbE
+constexpr size_t UDP_DEFAULT_FRAME_SIZE = 1472;
+
+// 20ms of data for 1GbE link (in bytes)
+constexpr size_t UDP_DEFAULT_BUFF_SIZE = 2500000;
+
+
+#if defined(UHD_PLATFORM_MACOS) || defined(UHD_PLATFORM_BSD)
+// MacOS limits socket buffer size to 1 Mib
+static const size_t MAX_BUFF_SIZE_ETH_MACOS = 0x100000; // 1Mib
+#endif
+
+typedef std::shared_ptr<boost::asio::ip::udp::socket> socket_sptr;
+
+/*!
+ * Wait for the socket to become ready for a receive operation.
+ * \param sock_fd the open socket file descriptor
+ * \param timeout_ms the timeout duration in milliseconds
+ * \return true when the socket is ready for receive
+ */
+UHD_INLINE bool wait_for_recv_ready(int sock_fd, int32_t timeout_ms)
+{
+#ifdef UHD_PLATFORM_WIN32 // select is more portable than poll unfortunately
+    // setup timeval for timeout
+    timeval tv;
+    // If the tv_usec > 1 second on some platforms, select will
+    // error EINVAL: An invalid timeout interval was specified.
+    tv.tv_sec  = int(timeout_ms / 1000);
+    tv.tv_usec = int(timeout_ms * 1000) % 1000000;
+
+    // setup rset for timeout
+    fd_set rset;
+    FD_ZERO(&rset);
+    FD_SET(sock_fd, &rset);
+
+// http://www.gnu.org/s/hello/manual/libc/Interrupted-Primitives.html
+// This macro is provided with gcc to properly deal with EINTR.
+// If not provided, define an empty macro, assume that is OK
+#    ifndef TEMP_FAILURE_RETRY
+#        define TEMP_FAILURE_RETRY(x) (x)
+#    endif
+
+    // call select with timeout on receive socket
+    return TEMP_FAILURE_RETRY(::select(sock_fd + 1, &rset, NULL, NULL, &tv)) > 0;
+#else
+    pollfd pfd_read;
+    pfd_read.fd     = sock_fd;
+    pfd_read.events = POLLIN;
+
+    // call poll with timeout on receive socket
+    return ::poll(&pfd_read, 1, (int)timeout_ms) > 0;
+#endif
+}
+
+UHD_INLINE socket_sptr open_udp_socket(
+    const std::string& addr, const std::string& port, boost::asio::io_service& io_service)
+{
+    using udp = boost::asio::ip::udp;
+
+    // resolve the address
+    udp::resolver resolver(io_service);
+    udp::resolver::query query(udp::v4(), addr, port);
+    udp::endpoint receiver_endpoint = *resolver.resolve(query);
+
+    // create, open, and connect the socket
+    socket_sptr socket = socket_sptr(new udp::socket(io_service));
+    socket->open(udp::v4());
+    socket->connect(receiver_endpoint);
+
+    return socket;
+}
+
+UHD_INLINE size_t recv_udp_packet(
+    int sock_fd, void* mem, size_t frame_size, int32_t timeout_ms)
+{
+    ssize_t len;
+
+#ifdef MSG_DONTWAIT // try a non-blocking recv() if supported
+    len = ::recv(sock_fd, (char*)mem, frame_size, MSG_DONTWAIT);
+    if (len > 0) {
+        return len;
+    }
+#endif
+
+    if (wait_for_recv_ready(sock_fd, timeout_ms)) {
+        len = ::recv(sock_fd, (char*)mem, frame_size, 0);
+        if (len == 0) {
+            throw uhd::io_error("socket closed");
+        }
+        if (len < 0) {
+            throw uhd::io_error(
+                str(boost::format("recv error on socket: %s") % strerror(errno)));
+        }
+        return len;
+    }
+
+    return 0; // timeout
+}
+
+UHD_INLINE void send_udp_packet(int sock_fd, void* mem, size_t len)
+{
+    // Retry logic because send may fail with ENOBUFS.
+    // This is known to occur at least on some OSX systems.
+    // But it should be safe to always check for the error.
+    while (true) {
+        const ssize_t ret = ::send(sock_fd, (const char*)mem, len, 0);
+        if (ret == ssize_t(len))
+            break;
+        if (ret == -1 and errno == ENOBUFS) {
+            std::this_thread::sleep_for(std::chrono::microseconds(1));
+            continue; // try to send again
+        }
+        if (ret == -1) {
+            throw uhd::io_error(
+                str(boost::format("send error on socket: %s") % strerror(errno)));
+        }
+        UHD_ASSERT_THROW(ret == ssize_t(len));
+    }
+}
+
+template <typename Opt>
+size_t get_udp_socket_buffer_size(socket_sptr socket)
+{
+    Opt option;
+    socket->get_option(option);
+    return option.value();
+}
+
+template <typename Opt>
+size_t resize_udp_socket_buffer(socket_sptr socket, size_t num_bytes)
+{
+#if defined(UHD_PLATFORM_MACOS) || defined(UHD_PLATFORM_BSD)
+    // limit buffer resize on macos or it will error
+    num_bytes = std::min(num_bytes, MAX_BUFF_SIZE_ETH_MACOS);
+#endif
+    Opt option(num_bytes);
+    socket->set_option(option);
+    return get_udp_socket_buffer_size<Opt>(socket);
+}
+
+UHD_INLINE size_t resize_udp_socket_buffer_with_warning(
+    std::function<size_t(size_t)> resize_fn,
+    const size_t target_size,
+    const std::string& name)
+{
+    size_t actual_size = 0;
+    std::string help_message;
+#if defined(UHD_PLATFORM_LINUX)
+    help_message = str(boost::format("Please run: sudo sysctl -w net.core.%smem_max=%d")
+                       % ((name == "recv") ? "r" : "w") % target_size);
+#endif /*defined(UHD_PLATFORM_LINUX)*/
+
+    // resize the buffer if size was provided
+    if (target_size > 0) {
+        actual_size = resize_fn(target_size);
+
+        UHD_LOGGER_TRACE("UDP")
+            << boost::format("Target/actual %s sock buff size: %d/%d bytes") % name
+                   % target_size % actual_size;
+        if (actual_size < target_size)
+            UHD_LOGGER_WARNING("UDP")
+                << boost::format(
+                       "The %s buffer could not be resized sufficiently.\n"
+                       "Target sock buff size: %d bytes.\n"
+                       "Actual sock buff size: %d bytes.\n"
+                       "See the transport application notes on buffer resizing.\n%s")
+                       % name % target_size % actual_size % help_message;
+    }
+
+    return actual_size;
+}
+
+
+}} // namespace uhd::transport
+
+#endif /* INCLUDED_TRANSPORT_UDP_COMMON_HPP */