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 Adding Rx Queues to the Adapter Instance
  66 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  67
  68 Ethdev Rx queues are added to the instance using the
  69 ``rte_event_eth_rx_adapter_queue_add()`` function. Configuration for the Rx
  70 queue is passed in using a ``struct rte_event_eth_rx_adapter_queue_conf``
  71 parameter. Event information for packets from this Rx queue is encoded in the
  72 ``ev`` field of ``struct rte_event_eth_rx_adapter_queue_conf``. The
  73 servicing_weight member of the struct  rte_event_eth_rx_adapter_queue_conf
  74 is the relative polling frequency of the Rx queue and is applicable when the
  75 adapter uses a service core function.
  76
  77 .. code-block:: c
  78
  79         ev.queue_id = 0;
  80         ev.sched_type = RTE_SCHED_TYPE_ATOMIC;
  81         ev.priority = 0;
  82
  83         queue_config.rx_queue_flags = 0;
  84         queue_config.ev = ev;
  85         queue_config.servicing_weight = 1;
  86
  87         err = rte_event_eth_rx_adapter_queue_add(id,
  88                                                 eth_dev_id,
  89                                                 0, &queue_config);
  90
  91 Querying Adapter Capabilities
  92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  93
  94 The ``rte_event_eth_rx_adapter_caps_get()`` function allows
  95 the application to query the adapter capabilities for an eventdev and ethdev
  96 combination. For e.g, if the ``RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID``
  97 is set, the application can override the adapter generated flow ID in the event
  98 using ``rx_queue_flags`` field in ``struct rte_event_eth_rx_adapter_queue_conf``
  99 which is passed as a parameter to the ``rte_event_eth_rx_adapter_queue_add()``
 100 function.
 101
 102 .. code-block:: c
 103
 104         err = rte_event_eth_rx_adapter_caps_get(dev_id, eth_dev_id, &cap);
 105
 106         queue_config.rx_queue_flags = 0;
 107         if (cap & RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID) {
 108                 ev.flow_id = 1;
 109                 queue_config.rx_queue_flags =
 110                         RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID;
 111         }
 112
 113 Configuring the Service Function
 114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 115
 116 If the adapter uses a service function, the application is required to assign
 117 a service core to the service function as show below.
 118
 119 .. code-block:: c
 120
 121         uint32_t service_id;
 122
 123         if (rte_event_eth_rx_adapter_service_id_get(0, &service_id) == 0)
 124                 rte_service_map_lcore_set(service_id, RX_CORE_ID);
 125
 126 Starting the Adapter Instance
 127 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 128
 129 The application calls ``rte_event_eth_rx_adapter_start()`` to start the adapter.
 130 This function calls the start callbacks of the eventdev PMDs for hardware based
 131 eventdev-ethdev connections and ``rte_service_run_state_set()`` to enable the
 132 service function if one exists.
 133
 134 .. Note::
 135
 136          The eventdev to which the event_eth_rx_adapter is connected needs to
 137          be started before calling rte_event_eth_rx_adapter_start().
 138
 139 Getting Adapter Statistics
 140 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 141
 142 The  ``rte_event_eth_rx_adapter_stats_get()`` function reports counters defined
 143 in struct ``rte_event_eth_rx_adapter_stats``. The received packet and
 144 enqueued event counts are a sum of the counts from the eventdev PMD callbacks
 145 if the callback is supported, and the counts maintained by the service function,
 146 if one exists. The service function also maintains a count of cycles for which
 147 it was not able to enqueue to the event device.
 148
 149 Interrupt Based Rx Queues
 150 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 151
 152 The service core function is typically set up to poll ethernet Rx queues for
 153 packets. Certain queues may have low packet rates and it would be more
 154 efficient to enable the Rx queue interrupt and read packets after receiving
 155 the interrupt.
 156
 157 The servicing_weight member of struct rte_event_eth_rx_adapter_queue_conf
 158 is applicable when the adapter uses a service core function. The application
 159 has to enable Rx queue interrupts when configuring the ethernet device
 160 using the ``rte_eth_dev_configure()`` function and then use a servicing_weight
 161 of zero when adding the Rx queue to the adapter.
 162
 163 The adapter creates a thread blocked on the interrupt, on an interrupt this
 164 thread enqueues the port id and the queue id to a ring buffer. The adapter
 165 service function dequeues the port id and queue id from the ring buffer,
 166 invokes the ``rte_eth_rx_burst()`` to receive packets on the queue and
 167 converts the received packets to events in the same manner as packets
 168 received on a polled Rx queue. The interrupt thread is affinitized to the same
 169 CPUs as the lcores of the Rx adapter service function, if the Rx adapter
 170 service function has not been mapped to any lcores, the interrupt thread
 171 is mapped to the main lcore.
 172
 173 Rx Callback for SW Rx Adapter
 174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 175
 176 For SW based packet transfers, i.e., when the
 177 ``RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT`` is not set in the adapter's
 178 capabilities flags for a particular ethernet device, the service function
 179 temporarily enqueues mbufs to an event buffer before batch enqueuing these
 180 to the event device. If the buffer fills up, the service function stops
 181 dequeuing packets from the ethernet device. The application may want to
 182 monitor the buffer fill level and instruct the service function to selectively
 183 enqueue packets to the event device. The application may also use some other
 184 criteria to decide which packets should enter the event device even when
 185 the event buffer fill level is low. The
 186 ``rte_event_eth_rx_adapter_cb_register()`` function allow the application
 187 to register a callback that selects which packets to enqueue to the event
 188 device.
 189
 190 Rx event vectorization
 191 ~~~~~~~~~~~~~~~~~~~~~~
 192
 193 The event devices, ethernet device pairs which support the capability
 194 ``RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR`` can aggregate packets based on
 195 flow characteristics and generate a ``rte_event`` containing ``rte_event_vector``
 196 whose event type is either ``RTE_EVENT_TYPE_ETHDEV_VECTOR`` or
 197 ``RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR``.
 198 The aggregation size and timeout are configurable at a queue level and the
 199 maximum, minimum vector sizes and timeouts vary based on the device capability
 200 and can be queried using ``rte_event_eth_rx_adapter_vector_limits_get``.
 201 The Rx adapter additionally might include useful data such as ethernet device
 202 port and queue identifier in the ``rte_event_vector::port`` and
 203 ``rte_event_vector::queue`` and mark ``rte_event_vector::attr_valid`` as true.
 204
 205 A loop processing ``rte_event_vector`` containing mbufs is shown below.
 206
 207 .. code-block:: c
 208
 209         event = rte_event_dequeue_burst(event_dev, event_port, &event,
 210                                         1, 0);
 211         if (!event)
 212                 continue;
 213
 214         switch (ev.event_type) {
 215         case RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR:
 216         case RTE_EVENT_TYPE_ETHDEV_VECTOR:
 217                 struct rte_mbufs **mbufs;
 218
 219                 mbufs = (struct rte_mbufs **)ev[i].vec->mbufs;
 220                 for (i = 0; i < ev.vec->nb_elem; i++) {
 221                         /* Process each mbuf. */
 222                 }
 223         break;
 224         case ...
 225         ...
 226         }
 227
 228 Rx event vectorization for SW Rx adapter
 229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 230
 231 For SW based event vectorization, i.e., when the
 232 ``RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT`` is not set in the adapter's
 233 capabilities flags for a particular ethernet device, the service function
 234 creates a single event vector flow for all the mbufs arriving on the given
 235 Rx queue.
 236 The 20-bit event flow identifier is set to 12-bits of Rx queue identifier
 237 and 8-bits of ethernet device identifier.
 238 Flow identifier is formatted as follows:
 239
 240 .. code-block:: console
 241
 242     19      12,11            0
 243     +---------+--------------+
 244     | port_id |   queue_id   |
 245     +---------+--------------+