issue: 3886011 Removing UDP RX callback API

Removing the remainings of RX callback API that was kept for UDP sockets.

Signed-off-by: Alexander Grissik <[email protected]>

Author: AlexanderGrissik

src/core/sock/sock-extra.cpp

@@ -34,19 +34,6 @@
 // extended API functions
 //-----------------------------------------------------------------------------
 
-extern "C" int xlio_register_recv_callback(int __fd, xlio_recv_callback_t __callback,
-                                           void *__context)
-{
-    sockinfo *p_socket_object = nullptr;
-    p_socket_object = fd_collection_get_sockfd(__fd);
-    if (p_socket_object && p_socket_object->get_protocol() == PROTO_UDP) {
-        reinterpret_cast<sockinfo_udp *>(p_socket_object)->register_callback(__callback, __context);
-        return 0;
-    }
-    errno = EINVAL;
-    return -1;
-}
-
 extern "C" int xlio_add_conf_rule(const char *config_line)
 {
     int ret = __xlio_parse_config_line(config_line);
@@ -88,8 +75,6 @@ struct xlio_api_t *extra_api()
         memset(xlio_api, 0, sizeof(struct xlio_api_t));
         xlio_api->magic = XLIO_MAGIC_NUMBER;
         xlio_api->cap_mask = 0;
-        SET_EXTRA_API(register_recv_callback, xlio_register_recv_callback,
-                      XLIO_EXTRA_API_REGISTER_RECV_CALLBACK);
         SET_EXTRA_API(add_conf_rule, xlio_add_conf_rule, XLIO_EXTRA_API_ADD_CONF_RULE);
         SET_EXTRA_API(thread_offload, xlio_thread_offload, XLIO_EXTRA_API_THREAD_OFFLOAD);
         SET_EXTRA_API(dump_fd_stats, xlio_dump_fd_stats, XLIO_EXTRA_API_DUMP_FD_STATS);

src/core/sock/sockinfo_udp.cpp

@@ -347,12 +347,12 @@ sockinfo_udp::sockinfo_udp(int fd, int domain)
     , m_port_map_lock("sockinfo_udp::m_ports_map_lock")
     , m_port_map_index(0)
     , m_p_last_dst_entry(nullptr)
-    , m_tos(0)
     , m_n_sysvar_rx_poll_yield_loops(safe_mce_sys().rx_poll_yield_loops)
     , m_n_sysvar_rx_udp_poll_os_ratio(safe_mce_sys().rx_udp_poll_os_ratio)
     , m_n_sysvar_rx_ready_byte_min_limit(safe_mce_sys().rx_ready_byte_min_limit)
     , m_n_sysvar_rx_cq_drain_rate_nsec(safe_mce_sys().rx_cq_drain_rate_nsec)
     , m_n_sysvar_rx_delta_tsc_between_cq_polls(safe_mce_sys().rx_delta_tsc_between_cq_polls)
+    , m_tos(0)
     , m_sockopt_mapped(false)
     , m_is_connected(false)
     , m_multicast(false)
@@ -2264,72 +2264,27 @@ int sockinfo_udp::rx_verify_available_data()
     return ret;
 }
 
-void sockinfo_udp::register_callback(xlio_recv_callback_t callback, void *context)
-{
-    m_rx_callback = callback;
-    m_rx_callback_context = context;
-}
-
-/**
- *	Performs inspection by registered user callback
- *
- */
-inline xlio_recv_callback_retval_t sockinfo_udp::inspect_by_user_cb(mem_buf_desc_t *p_desc)
-{
-    xlio_info_t pkt_info;
-
-    pkt_info.struct_sz = sizeof(pkt_info);
-    pkt_info.packet_id = (void *)p_desc;
-    pkt_info.src = p_desc->rx.src.get_p_sa();
-    pkt_info.dst = p_desc->rx.dst.get_p_sa();
-    pkt_info.socket_ready_queue_pkt_count = m_n_rx_pkt_ready_list_count;
-    pkt_info.socket_ready_queue_byte_count = m_rx_ready_byte_count;
-
-    if (m_n_tsing_flags & SOF_TIMESTAMPING_RAW_HARDWARE) {
-        pkt_info.hw_timestamp = p_desc->rx.timestamps.hw;
-    }
-    if (p_desc->rx.timestamps.sw.tv_sec) {
-        pkt_info.sw_timestamp = p_desc->rx.timestamps.sw;
-    }
-
-    // fill io vector array with data buffer pointers
-    iovec iov[p_desc->rx.n_frags];
-    int nr_frags = 0;
-
-    for (mem_buf_desc_t *tmp = p_desc; tmp; tmp = tmp->p_next_desc) {
-        iov[nr_frags++] = tmp->rx.frag;
-    }
-
-    // call user callback
-    return m_rx_callback(m_fd, nr_frags, iov, &pkt_info, m_rx_callback_context);
-}
-
 /**
  *	Performs packet processing and store packet
  *	in ready queue.
  */
-inline void sockinfo_udp::update_ready(mem_buf_desc_t *p_desc, void *pv_fd_ready_array,
-                                       xlio_recv_callback_retval_t cb_ret)
+inline void sockinfo_udp::update_ready(mem_buf_desc_t *p_desc, void *pv_fd_ready_array)
 {
-    // In ZERO COPY case we let the user's application manage the ready queue
-    if (cb_ret != XLIO_PACKET_HOLD) {
-        m_lock_rcv.lock();
-        // Save rx packet info in our ready list
-        m_rx_pkt_ready_list.push_back(p_desc);
-        m_n_rx_pkt_ready_list_count++;
-        m_rx_ready_byte_count += p_desc->rx.sz_payload;
-        if (unlikely(m_p_socket_stats)) {
-            m_p_socket_stats->n_rx_ready_byte_count += p_desc->rx.sz_payload;
-            m_p_socket_stats->n_rx_ready_pkt_count++;
-            m_p_socket_stats->counters.n_rx_ready_pkt_max =
-                std::max((uint32_t)m_n_rx_pkt_ready_list_count,
-                         m_p_socket_stats->counters.n_rx_ready_pkt_max);
-            m_p_socket_stats->counters.n_rx_ready_byte_max = std::max(
-                (uint32_t)m_rx_ready_byte_count, m_p_socket_stats->counters.n_rx_ready_byte_max);
-        }
-        m_sock_wakeup_pipe.do_wakeup();
-        m_lock_rcv.unlock();
+    m_lock_rcv.lock();
+    // Save rx packet info in our ready list
+    m_rx_pkt_ready_list.push_back(p_desc);
+    m_n_rx_pkt_ready_list_count++;
+    m_rx_ready_byte_count += p_desc->rx.sz_payload;
+    if (unlikely(m_p_socket_stats)) {
+        m_p_socket_stats->n_rx_ready_byte_count += p_desc->rx.sz_payload;
+        m_p_socket_stats->n_rx_ready_pkt_count++;
+        m_p_socket_stats->counters.n_rx_ready_pkt_max = std::max(
+            (uint32_t)m_n_rx_pkt_ready_list_count, m_p_socket_stats->counters.n_rx_ready_pkt_max);
+        m_p_socket_stats->counters.n_rx_ready_byte_max = std::max(
+            (uint32_t)m_rx_ready_byte_count, m_p_socket_stats->counters.n_rx_ready_byte_max);
     }
+    m_sock_wakeup_pipe.do_wakeup();
+    m_lock_rcv.unlock();
 
     NOTIFY_ON_EVENTS(this, EPOLLIN);
 
@@ -2482,17 +2437,10 @@ bool sockinfo_udp::rx_input_cb(mem_buf_desc_t *p_desc, void *pv_fd_ready_array)
 
     process_timestamps(p_desc);
 
-    xlio_recv_callback_retval_t cb_ret = XLIO_PACKET_RECV;
-    if (m_rx_callback && ((cb_ret = inspect_by_user_cb(p_desc)) == XLIO_PACKET_DROP)) {
-        si_udp_logfunc("rx packet discarded - by user callback");
-        return false;
-    }
-    // Yes, we want to keep this packet!
-    // And we must increment ref_counter before pushing this packet into the ready queue
-    //  to prevent race condition with the 'if( (--ref_count) <= 0)' in ib_comm_mgr
+    // We must increment ref_counter before pushing this packet into the ready queue
     p_desc->inc_ref_count();
     save_strq_stats(p_desc->rx.strides_num);
-    update_ready(p_desc, pv_fd_ready_array, cb_ret);
+    update_ready(p_desc, pv_fd_ready_array);
     if (unlikely(m_p_socket_stats)) {
         m_p_socket_stats->counters.n_rx_bytes += p_desc->rx.sz_payload;
         m_p_socket_stats->counters.n_rx_data_pkts++;

src/core/sock/sockinfo_udp.h

@@ -159,7 +159,6 @@ class sockinfo_udp : public sockinfo {
 
     bool prepare_to_close(bool process_shutdown = false) override;
     void update_header_field(data_updater *updater) override;
-    void register_callback(xlio_recv_callback_t callback, void *context);
 
 #if defined(DEFINED_NGINX)
     void prepare_to_close_socket_pool(bool _push_pop) override;
@@ -241,9 +240,7 @@ class sockinfo_udp : public sockinfo {
         }
     }
 
-    inline xlio_recv_callback_retval_t inspect_by_user_cb(mem_buf_desc_t *p_desc);
-    inline void update_ready(mem_buf_desc_t *p_rx_wc_buf_desc, void *pv_fd_ready_array,
-                             xlio_recv_callback_retval_t cb_ret);
+    inline void update_ready(mem_buf_desc_t *p_rx_wc_buf_desc, void *pv_fd_ready_array);
 
     void post_dequeue() override;
     size_t handle_msg_trunc(size_t total_rx, size_t payload_size, int in_flags,
@@ -289,18 +286,13 @@ class sockinfo_udp : public sockinfo {
 
     chunk_list_t<mem_buf_desc_t *> m_rx_pkt_ready_list;
 
-    // Callback function pointer to support XLIO extra API (xlio_extra.h)
-    xlio_recv_callback_t m_rx_callback = nullptr;
-    void *m_rx_callback_context = nullptr; // user context
-
-    uint8_t m_tos;
-
     const uint32_t m_n_sysvar_rx_poll_yield_loops;
     const uint32_t m_n_sysvar_rx_udp_poll_os_ratio;
     const uint32_t m_n_sysvar_rx_ready_byte_min_limit;
     const uint32_t m_n_sysvar_rx_cq_drain_rate_nsec;
     const uint32_t m_n_sysvar_rx_delta_tsc_between_cq_polls;
 
+    uint8_t m_tos;
     bool m_sockopt_mapped; // setsockopt IPPROTO_UDP UDP_MAP_ADD
     bool m_is_connected; // to inspect for in_addr.src
     bool m_multicast; // true when socket set MC rule

src/core/xlio.h

@@ -163,18 +163,6 @@ int xlio_thread_offload(int offload, pthread_t tid);
  */
 int xlio_dump_fd_stats(int fd, int log_level);
 
-/*
- * Register a received packet notification callback.
- *
- * @param s Socket file descriptor.
- * @param callback Callback function.
- * @param context user contex for callback function.
- * @return 0 - success, -1 - error
- *
- * errno is set to: EINVAL - not offloaded socket
- */
-int xlio_register_recv_callback(int s, xlio_recv_callback_t callback, void *context);
-
 /**
  * @defgroup xlio_ultra_api XLIO Ultra API
  * @brief High-performance zero-copy networking interface

src/core/xlio_extra.h

@@ -33,7 +33,6 @@ struct ibv_pd;
  */
 
 enum {
-    XLIO_EXTRA_API_REGISTER_RECV_CALLBACK = (1 << 0),
     XLIO_EXTRA_API_ADD_CONF_RULE = (1 << 3),
     XLIO_EXTRA_API_THREAD_OFFLOAD = (1 << 4),
     XLIO_EXTRA_API_DUMP_FD_STATS = (1 << 11),
@@ -82,18 +81,6 @@ struct __attribute__((packed)) xlio_api_t {
      */
     int (*dump_fd_stats)(int fd, int log_level);
 
-    /*
-     * Register a received packet notification callback.
-     *
-     * @param s Socket file descriptor.
-     * @param callback Callback function.
-     * @param context user context for callback function.
-     * @return 0 - success, -1 - error
-     *
-     * errno is set to: EINVAL - not offloaded socket
-     */
-    int (*register_recv_callback)(int s, xlio_recv_callback_t callback, void *context);
-
     /*
      * XLIO Ultra API.
      */

src/core/xlio_types.h

@@ -28,48 +28,6 @@
 #define SO_XLIO_SHUTDOWN_RX      2821
 #define SO_XLIO_EXT_VLAN_TAG     2824
 
-/*
- * Return values for the receive packet notify callback function
- */
-typedef enum {
-    XLIO_PACKET_DROP, /* The library will drop the received packet and recycle
-                        the buffer if no other socket needs it */
-
-    XLIO_PACKET_RECV, /* The library will queue the received packet on this socket ready queue.
-                        The application will read it with the usual recv socket APIs */
-
-    XLIO_PACKET_HOLD /* Application will handle the queuing of the received packet. The application
-                       must return the descriptor to the library using the free packet function
-           But not in the context of XLIO's callback itself. */
-} xlio_recv_callback_retval_t;
-
-/*
- * Structure holding additional information on the packet and socket
- * Note: Check structure size value for future library changes
- */
-struct __attribute__((packed)) xlio_info_t {
-    size_t
-        struct_sz; /* Compare this value with sizeof(xlio_info_t) to check version compatability */
-    void *packet_id; /* Handle to received packet buffer to be return if zero copy logic is used */
-
-    /* Packet addressing information (in network byte order) */
-    const struct sockaddr *src;
-    const struct sockaddr *dst;
-
-    /* Packet information */
-    size_t payload_sz;
-
-    /* Socket's information */
-    uint32_t socket_ready_queue_pkt_count; /* Current count of packets waiting to be read from the
-                                              socket */
-    uint32_t socket_ready_queue_byte_count; /* Current count of bytes waiting to be read from the
-                                               socket */
-
-    /* Packet timestamping information */
-    struct timespec hw_timestamp;
-    struct timespec sw_timestamp;
-};
-
 struct xlio_rate_limit_t {
     uint32_t rate; /* rate limit in Kbps */
     uint32_t max_burst_sz; /* maximum burst size in bytes */
@@ -117,39 +75,6 @@ struct xlio_ring_alloc_logic_attr {
     uint32_t reserved : 30;
 };
 
-/*
- * Notification callback for incoming packet on socket
- * @param fd Socket's file descriptor which this packet refers to
- * @param iov iovector structure array point holding the packet
- *            received data buffer pointers and size of each buffer
- * @param iov_sz Size of iov array
- * @param xlio_info Additional information on the packet and socket
- * @param context User-defined value provided during callback
- *                registration for each socket
- *
- *   This callback function should be registered by the library calling
- * register_recv_callback() in the extended API. It can be unregistered by
- * setting a NULL function pointer. The library will call the callback to notify
- * of new incoming packets after the IP & UDP header processing and before
- * they are queued in the socket's receive queue.
- *   Context of the callback will always be from one of the user's application
- * threads when calling the following socket APIs: select, poll, epoll, recv,
- * recvfrom, recvmsg, read, readv.
- *
- * Notes:
- * - The application can call all of the Socket APIs control and send from
- *   within the callback context.
- * - Packet loss might occur depending on the applications behavior in the
- *   callback context.
- * - Parameters `iov' and `xlio_info' are only valid until callback context
- *   is returned to the library. User should copy these structures for later use
- *   if working with zero copy logic.
- */
-typedef xlio_recv_callback_retval_t (*xlio_recv_callback_t)(int fd, size_t sz_iov,
-                                                            struct iovec iov[],
-                                                            struct xlio_info_t *xlio_info,
-                                                            void *context);
-
 /**
  * @addtogroup xlio_ultra_api XLIO Ultra API
  * @{