doc/guides/prog_guide/event_ethernet_rx_adapter.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2017 Intel Corporation.
   3
   4 Event Ethernet Rx Adapter Library
   5 =================================
   6
   7 The DPDK Eventdev API allows the application to use an event driven programming
   8 model for packet processing. In this model, the application polls an event
   9 device port for receiving events that reference packets instead of polling Rx
  10 queues of ethdev ports. Packet transfer between ethdev and the event device can
  11 be supported in hardware or require a software thread to receive packets from
  12 the ethdev port using ethdev poll mode APIs and enqueue these as events to the
  13 event device using the eventdev API. Both transfer mechanisms may be present on
  14 the same platform depending on the particular combination of the ethdev and
  15 the event device.
  16
  17 The Event Ethernet Rx Adapter library is intended for the application code to
  18 configure both transfer mechanisms using a common API. A capability API allows
  19 the eventdev PMD to advertise features supported for a given ethdev and allows
  20 the application to perform configuration as per supported features.
  21
  22 API Walk-through
  23 ----------------
  24
  25 This section will introduce the reader to the adapter API. The
  26 application has to first instantiate an adapter which is associated with
  27 a single eventdev, next the adapter instance is configured with Rx queues
  28 that are either polled by a SW thread or linked using hardware support. Finally
  29 the adapter is started.
  30
  31 For SW based packet transfers from ethdev to eventdev, the adapter uses a
  32 DPDK service function and the application is also required to assign a core to
  33 the service function.
  34
  35 Creating an Adapter Instance
  36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  37
  38 An adapter instance is created using ``rte_event_eth_rx_adapter_create()``. This
  39 function is passed the event device to be associated with the adapter and port
  40 configuration for the adapter to setup an event port if the adapter needs to use
  41 a service function.
  42
  43 .. code-block:: c
  44
  45         int err;
  46         uint8_t dev_id;
  47         struct rte_event_dev_info dev_info;
  48         struct rte_event_port_conf rx_p_conf;
  49
  50         err = rte_event_dev_info_get(id, &dev_info);
  51
  52         rx_p_conf.new_event_threshold = dev_info.max_num_events;
  53         rx_p_conf.dequeue_depth = dev_info.max_event_port_dequeue_depth;
  54         rx_p_conf.enqueue_depth = dev_info.max_event_port_enqueue_depth;
  55         err = rte_event_eth_rx_adapter_create(id, dev_id, &rx_p_conf);
  56
  57 If the application desires to have finer control of eventdev port allocation
  58 and setup, it can use the ``rte_event_eth_rx_adapter_create_ext()`` function.
  59 The ``rte_event_eth_rx_adapter_create_ext()`` function is passed a callback
  60 function. The callback function is invoked if the adapter needs to use a
  61 service function and needs to create an event port for it. The callback is
  62 expected to fill the ``struct rte_event_eth_rx_adapter_conf structure``
  63 passed to it.
  64
  65 If the application desires to control the event buffer size, it can use the
  66 ``rte_event_eth_rx_adapter_create_with_params()`` api. The event buffer size is
  67 specified using ``struct rte_event_eth_rx_adapter_params::event_buf_size``.
  68 The function is passed the event device to be associated with the adapter
  69 and port configuration for the adapter to setup an event port if the
  70 adapter needs to use a service function.
  71
  72 Adding Rx Queues to the Adapter Instance
  73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  74
  75 Ethdev Rx queues are added to the instance using the
  76 ``rte_event_eth_rx_adapter_queue_add()`` function. Configuration for the Rx
  77 queue is passed in using a ``struct rte_event_eth_rx_adapter_queue_conf``
  78 parameter. Event information for packets from this Rx queue is encoded in the
  79 ``ev`` field of ``struct rte_event_eth_rx_adapter_queue_conf``. The
  80 servicing_weight member of the struct  rte_event_eth_rx_adapter_queue_conf
  81 is the relative polling frequency of the Rx queue and is applicable when the
  82 adapter uses a service core function.
  83
  84 .. code-block:: c
  85
  86         ev.queue_id = 0;
  87         ev.sched_type = RTE_SCHED_TYPE_ATOMIC;
  88         ev.priority = 0;
  89
  90         queue_config.rx_queue_flags = 0;
  91         queue_config.ev = ev;
  92         queue_config.servicing_weight = 1;
  93
  94         err = rte_event_eth_rx_adapter_queue_add(id,
  95                                                 eth_dev_id,
  96                                                 0, &queue_config);
  97
  98 Querying Adapter Capabilities
  99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 100
 101 The ``rte_event_eth_rx_adapter_caps_get()`` function allows
 102 the application to query the adapter capabilities for an eventdev and ethdev
 103 combination. For e.g, if the ``RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID``
 104 is set, the application can override the adapter generated flow ID in the event
 105 using ``rx_queue_flags`` field in ``struct rte_event_eth_rx_adapter_queue_conf``
 106 which is passed as a parameter to the ``rte_event_eth_rx_adapter_queue_add()``
 107 function.
 108
 109 .. code-block:: c
 110
 111         err = rte_event_eth_rx_adapter_caps_get(dev_id, eth_dev_id, &cap);
 112
 113         queue_config.rx_queue_flags = 0;
 114         if (cap & RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID) {
 115                 ev.flow_id = 1;
 116                 queue_config.rx_queue_flags =
 117                         RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID;
 118         }
 119
 120 Configuring the Service Function
 121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 122
 123 If the adapter uses a service function, the application is required to assign
 124 a service core to the service function as show below.
 125
 126 .. code-block:: c
 127
 128         uint32_t service_id;
 129
 130         if (rte_event_eth_rx_adapter_service_id_get(0, &service_id) == 0)
 131                 rte_service_map_lcore_set(service_id, RX_CORE_ID);
 132
 133 Starting the Adapter Instance
 134 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135
 136 The application calls ``rte_event_eth_rx_adapter_start()`` to start the adapter.
 137 This function calls the start callbacks of the eventdev PMDs for hardware based
 138 eventdev-ethdev connections and ``rte_service_run_state_set()`` to enable the
 139 service function if one exists.
 140
 141 .. Note::
 142
 143          The eventdev to which the event_eth_rx_adapter is connected needs to
 144          be started before calling rte_event_eth_rx_adapter_start().
 145
 146 Getting Adapter Statistics
 147 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 148
 149 The  ``rte_event_eth_rx_adapter_stats_get()`` function reports counters defined
 150 in struct ``rte_event_eth_rx_adapter_stats``. The received packet and
 151 enqueued event counts are a sum of the counts from the eventdev PMD callbacks
 152 if the callback is supported, and the counts maintained by the service function,
 153 if one exists. The service function also maintains a count of cycles for which
 154 it was not able to enqueue to the event device.
 155
 156 Getting Adapter queue config
 157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 158
 159 The  ``rte_event_eth_rx_adapter_queue_conf_get()`` function reports
 160 flags for handling received packets, event queue identifier, scheduler type,
 161 event priority, polling frequency of the receive queue and flow identifier
 162 in struct ``rte_event_eth_rx_adapter_queue_conf``.
 163
 164 Interrupt Based Rx Queues
 165 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 166
 167 The service core function is typically set up to poll ethernet Rx queues for
 168 packets. Certain queues may have low packet rates and it would be more
 169 efficient to enable the Rx queue interrupt and read packets after receiving
 170 the interrupt.
 171
 172 The servicing_weight member of struct rte_event_eth_rx_adapter_queue_conf
 173 is applicable when the adapter uses a service core function. The application
 174 has to enable Rx queue interrupts when configuring the ethernet device
 175 using the ``rte_eth_dev_configure()`` function and then use a servicing_weight
 176 of zero when adding the Rx queue to the adapter.
 177
 178 The adapter creates a thread blocked on the interrupt, on an interrupt this
 179 thread enqueues the port id and the queue id to a ring buffer. The adapter
 180 service function dequeues the port id and queue id from the ring buffer,
 181 invokes the ``rte_eth_rx_burst()`` to receive packets on the queue and
 182 converts the received packets to events in the same manner as packets
 183 received on a polled Rx queue. The interrupt thread is affinitized to the same
 184 CPUs as the lcores of the Rx adapter service function, if the Rx adapter
 185 service function has not been mapped to any lcores, the interrupt thread
 186 is mapped to the main lcore.
 187
 188 Rx Callback for SW Rx Adapter
 189 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 190
 191 For SW based packet transfers, i.e., when the
 192 ``RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT`` is not set in the adapter's
 193 capabilities flags for a particular ethernet device, the service function
 194 temporarily enqueues mbufs to an event buffer before batch enqueuing these
 195 to the event device. If the buffer fills up, the service function stops
 196 dequeuing packets from the ethernet device. The application may want to
 197 monitor the buffer fill level and instruct the service function to selectively
 198 enqueue packets to the event device. The application may also use some other
 199 criteria to decide which packets should enter the event device even when
 200 the event buffer fill level is low. The
 201 ``rte_event_eth_rx_adapter_cb_register()`` function allow the application
 202 to register a callback that selects which packets to enqueue to the event
 203 device.
 204
 205 Rx event vectorization
 206 ~~~~~~~~~~~~~~~~~~~~~~
 207
 208 The event devices, ethernet device pairs which support the capability
 209 ``RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR`` can aggregate packets based on
 210 flow characteristics and generate a ``rte_event`` containing ``rte_event_vector``
 211 whose event type is either ``RTE_EVENT_TYPE_ETHDEV_VECTOR`` or
 212 ``RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR``.
 213 The maximum, minimum vector sizes and timeouts vary based on the device
 214 capability and can be queried using
 215 ``rte_event_eth_rx_adapter_vector_limits_get``.
 216 The Rx adapter additionally might include useful data such as ethernet device
 217 port and queue identifier in the ``rte_event_vector::port`` and
 218 ``rte_event_vector::queue`` and mark ``rte_event_vector::attr_valid`` as true.
 219 The aggregation size and timeout are configurable at a queue level by setting
 220 ``rte_event_eth_rx_adapter_queue_conf::vector_sz``,
 221 ``rte_event_eth_rx_adapter_queue_conf::vector_timeout_ns`` and
 222 ``rte_event_eth_rx_adapter_queue_conf::vector_mp`` when adding queues using
 223 ``rte_event_eth_rx_adapter_queue_add``.
 224
 225 A loop processing ``rte_event_vector`` containing mbufs is shown below.
 226
 227 .. code-block:: c
 228
 229         event = rte_event_dequeue_burst(event_dev, event_port, &event,
 230                                         1, 0);
 231         if (!event)
 232                 continue;
 233
 234         switch (ev.event_type) {
 235         case RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR:
 236         case RTE_EVENT_TYPE_ETHDEV_VECTOR:
 237                 struct rte_mbufs **mbufs;
 238
 239                 mbufs = (struct rte_mbufs **)ev[i].vec->mbufs;
 240                 for (i = 0; i < ev.vec->nb_elem; i++) {
 241                         /* Process each mbuf. */
 242                 }
 243         break;
 244         case ...
 245         ...
 246         }
 247
 248 Rx event vectorization for SW Rx adapter
 249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 250
 251 For SW based event vectorization, i.e., when the
 252 ``RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT`` is not set in the adapter's
 253 capabilities flags for a particular ethernet device, the service function
 254 creates a single event vector flow for all the mbufs arriving on the given
 255 Rx queue.
 256 The 20-bit event flow identifier is set to 12-bits of Rx queue identifier
 257 and 8-bits of ethernet device identifier.
 258 Flow identifier is formatted as follows:
 259
 260 .. code-block:: console
 261
 262     19      12,11            0
 263     +---------+--------------+
 264     | port_id |   queue_id   |
 265     +---------+--------------+