lib/librte_eventdev/rte_event_eth_rx_adapter.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation.
   3  * All rights reserved.
   4  */
   5
   6 #ifndef _RTE_EVENT_ETH_RX_ADAPTER_
   7 #define _RTE_EVENT_ETH_RX_ADAPTER_
   8
   9 /**
  10  * @file
  11  *
  12  * RTE Event Ethernet Rx Adapter
  13  *
  14  * An eventdev-based packet processing application enqueues/dequeues mbufs
  15  * to/from the event device. Packet flow from the ethernet device to the event
  16  * device can be accomplished using either HW or SW mechanisms depending on the
  17  * platform and the particular combination of ethernet and event devices. The
  18  * event ethernet Rx adapter provides common APIs to configure the packet flow
  19  * from the ethernet devices to event devices across both these transfer
  20  * mechanisms.
  21  *
  22  * The adapter uses a EAL service core function for SW based packet transfer
  23  * and uses the eventdev PMD functions to configure HW based packet transfer
  24  * between the ethernet device and the event device. For SW based packet
  25  * transfer, if the mbuf does not have a timestamp set, the adapter adds a
  26  * timestamp to the mbuf using rte_get_tsc_cycles(), this provides a more
  27  * accurate timestamp as compared to if the application were to set the time
  28  * stamp since it avoids event device schedule latency.
  29  *
  30  * The ethernet Rx event adapter's functions are:
  31  *  - rte_event_eth_rx_adapter_create_ext()
  32  *  - rte_event_eth_rx_adapter_create()
  33  *  - rte_event_eth_rx_adapter_free()
  34  *  - rte_event_eth_rx_adapter_queue_add()
  35  *  - rte_event_eth_rx_adapter_queue_del()
  36  *  - rte_event_eth_rx_adapter_start()
  37  *  - rte_event_eth_rx_adapter_stop()
  38  *  - rte_event_eth_rx_adapter_stats_get()
  39  *  - rte_event_eth_rx_adapter_stats_reset()
  40  *
  41  * The application creates an ethernet to event adapter using
  42  * rte_event_eth_rx_adapter_create_ext() or rte_event_eth_rx_adapter_create()
  43  * functions.
  44  * The adapter needs to know which ethernet rx queues to poll for mbufs as well
  45  * as event device parameters such as the event queue identifier, event
  46  * priority and scheduling type that the adapter should use when constructing
  47  * events. The rte_event_eth_rx_adapter_queue_add() function is provided for
  48  * this purpose.
  49  * The servicing weight parameter in the rte_event_eth_rx_adapter_queue_conf
  50  * is applicable when the Rx adapter uses a service core function and is
  51  * intended to provide application control of the frequency of polling ethernet
  52  * device receive queues, for example, the application may want to poll higher
  53  * priority queues with a higher frequency but at the same time not starve
  54  * lower priority queues completely. If this parameter is zero and the receive
  55  * interrupt is enabled when configuring the device, the receive queue is
  56  * interrupt driven; else, the queue is assigned a servicing weight of one.
  57  *
  58  * The application can start/stop the adapter using the
  59  * rte_event_eth_rx_adapter_start() and the rte_event_eth_rx_adapter_stop()
  60  * functions. If the adapter uses a rte_service function, then the application
  61  * is also required to assign a core to the service function and control the
  62  * service core using the rte_service APIs. The
  63  * rte_event_eth_rx_adapter_service_id_get() function can be used to retrieve
  64  * the service function ID of the adapter in this case.
  65  *
  66  * For SW based packet transfers, i.e., when the
  67  * RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT is not set in the adapter's
  68  * capabilities flags for a particular ethernet device, the service function
  69  * temporarily enqueues mbufs to an event buffer before batch enqueueing these
  70  * to the event device. If the buffer fills up, the service function stops
  71  * dequeueing packets from the ethernet device. The application may want to
  72  * monitor the buffer fill level and instruct the service function to
  73  * selectively buffer packets. The application may also use some other
  74  * criteria to decide which packets should enter the event device even when
  75  * the event buffer fill level is low. The
  76  * rte_event_eth_rx_adapter_cb_register() function allows the
  77  * application to register a callback that selects which packets to enqueue
  78  * to the event device.
  79  */
  80
  81 #ifdef __cplusplus
  82 extern "C" {
  83 #endif
  84
  85 #include <stdint.h>
  86
  87 #include <rte_service.h>
  88
  89 #include "rte_eventdev.h"
  90
  91 #define RTE_EVENT_ETH_RX_ADAPTER_MAX_INSTANCE 32
  92
  93 /* struct rte_event_eth_rx_adapter_queue_conf flags definitions */
  94 #define RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID    0x1
  95 /**< This flag indicates the flow identifier is valid
  96  * @see rte_event_eth_rx_adapter_queue_conf::rx_queue_flags
  97  */
  98
  99 /**
 100  * Adapter configuration structure that the adapter configuration callback
 101  * function is expected to fill out
 102  * @see rte_event_eth_rx_adapter_conf_cb
 103  */
 104 struct rte_event_eth_rx_adapter_conf {
 105         uint8_t event_port_id;
 106         /**< Event port identifier, the adapter enqueues mbuf events to this
 107          * port.
 108          */
 109         uint32_t max_nb_rx;
 110         /**< The adapter can return early if it has processed at least
 111          * max_nb_rx mbufs. This isn't treated as a requirement; batching may
 112          * cause the adapter to process more than max_nb_rx mbufs.
 113          */
 114 };
 115
 116 /**
 117  * Function type used for adapter configuration callback. The callback is
 118  * used to fill in members of the struct rte_event_eth_rx_adapter_conf, this
 119  * callback is invoked when creating a SW service for packet transfer from
 120  * ethdev queues to the event device. The SW service is created within the
 121  * rte_event_eth_rx_adapter_queue_add() function if SW based packet transfers
 122  * from ethdev queues to the event device are required.
 123  *
 124  * @param id
 125  *  Adapter identifier.
 126  *
 127  * @param dev_id
 128  *  Event device identifier.
 129  *
 130  * @param [out] conf
 131  *  Structure that needs to be populated by this callback.
 132  *
 133  * @param arg
 134  *  Argument to the callback. This is the same as the conf_arg passed to the
 135  *  rte_event_eth_rx_adapter_create_ext().
 136  */
 137 typedef int (*rte_event_eth_rx_adapter_conf_cb) (uint8_t id, uint8_t dev_id,
 138                         struct rte_event_eth_rx_adapter_conf *conf,
 139                         void *arg);
 140
 141 /**
 142  * Rx queue configuration structure
 143  */
 144 struct rte_event_eth_rx_adapter_queue_conf {
 145         uint32_t rx_queue_flags;
 146          /**< Flags for handling received packets
 147           * @see RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID
 148           */
 149         uint16_t servicing_weight;
 150         /**< Relative polling frequency of ethernet receive queue when the
 151          * adapter uses a service core function for ethernet to event device
 152          * transfers. If it is set to zero, the Rx queue is interrupt driven
 153          * (unless rx queue interrupts are not enabled for the ethernet
 154          * device).
 155          */
 156         struct rte_event ev;
 157         /**<
 158          *  The values from the following event fields will be used when
 159          *  queuing mbuf events:
 160          *   - event_queue_id: Targeted event queue ID for received packets.
 161          *   - event_priority: Event priority of packets from this Rx queue in
 162          *                     the event queue relative to other events.
 163          *   - sched_type: Scheduling type for packets from this Rx queue.
 164          *   - flow_id: If the RTE_ETH_RX_EVENT_ADAPTER_QUEUE_FLOW_ID_VALID bit
 165          *              is set in rx_queue_flags, this flow_id is used for all
 166          *              packets received from this queue. Otherwise the flow ID
 167          *              is set to the RSS hash of the src and dst IPv4/6
 168          *              addresses.
 169          *
 170          * The event adapter sets ev.event_type to RTE_EVENT_TYPE_ETHDEV in the
 171          * enqueued event.
 172          */
 173 };
 174
 175 /**
 176  * A structure used to retrieve statistics for an eth rx adapter instance.
 177  */
 178 struct rte_event_eth_rx_adapter_stats {
 179         uint64_t rx_poll_count;
 180         /**< Receive queue poll count */
 181         uint64_t rx_packets;
 182         /**< Received packet count */
 183         uint64_t rx_enq_count;
 184         /**< Eventdev enqueue count */
 185         uint64_t rx_enq_retry;
 186         /**< Eventdev enqueue retry count */
 187         uint64_t rx_enq_start_ts;
 188         /**< Rx enqueue start timestamp */
 189         uint64_t rx_enq_block_cycles;
 190         /**< Cycles for which the service is blocked by the event device,
 191          * i.e, the service fails to enqueue to the event device.
 192          */
 193         uint64_t rx_enq_end_ts;
 194         /**< Latest timestamp at which the service is unblocked
 195          * by the event device. The start, end timestamps and
 196          * block cycles can be used to compute the percentage of
 197          * cycles the service is blocked by the event device.
 198          */
 199         uint64_t rx_intr_packets;
 200         /**< Received packet count for interrupt mode Rx queues */
 201 };
 202
 203 /**
 204  * Callback function invoked by the SW adapter before it continues
 205  * to process packets. The callback is passed the size of the enqueue
 206  * buffer in the SW adapter and the occupancy of the buffer. The
 207  * callback can use these values to decide which mbufs should be
 208  * enqueued to the event device. If the return value of the callback
 209  * is less than nb_mbuf then the SW adapter uses the return value to
 210  * enqueue enq_mbuf[] to the event device.
 211  *
 212  * @param eth_dev_id
 213  *  Port identifier of the Ethernet device.
 214  * @param queue_id
 215  *  Receive queue index.
 216  * @param enqueue_buf_size
 217  *  Total enqueue buffer size.
 218  * @param enqueue_buf_count
 219  *  mbuf count in enqueue buffer.
 220  * @param mbuf
 221  *  mbuf array.
 222  * @param nb_mbuf
 223  *  mbuf count.
 224  * @param cb_arg
 225  *  Callback argument.
 226  * @param[out] enq_mbuf
 227  *  The adapter enqueues enq_mbuf[] if the return value of the
 228  *  callback is less than nb_mbuf
 229  * @return
 230  *  Returns the number of mbufs should be enqueued to eventdev
 231  */
 232 typedef uint16_t (*rte_event_eth_rx_adapter_cb_fn)(uint16_t eth_dev_id,
 233                                                 uint16_t queue_id,
 234                                                 uint32_t enqueue_buf_size,
 235                                                 uint32_t enqueue_buf_count,
 236                                                 struct rte_mbuf **mbuf,
 237                                                 uint16_t nb_mbuf,
 238                                                 void *cb_arg,
 239                                                 struct rte_mbuf **enq_buf);
 240
 241 /**
 242  * Create a new ethernet Rx event adapter with the specified identifier.
 243  *
 244  * @param id
 245  *  The identifier of the ethernet Rx event adapter.
 246  *
 247  * @param dev_id
 248  *  The identifier of the device to configure.
 249  *
 250  * @param conf_cb
 251  *  Callback function that fills in members of a
 252  *  struct rte_event_eth_rx_adapter_conf struct passed into
 253  *  it.
 254  *
 255  * @param conf_arg
 256  *  Argument that is passed to the conf_cb function.
 257  *
 258  * @return
 259  *   - 0: Success
 260  *   - <0: Error code on failure
 261  */
 262 int rte_event_eth_rx_adapter_create_ext(uint8_t id, uint8_t dev_id,
 263                                 rte_event_eth_rx_adapter_conf_cb conf_cb,
 264                                 void *conf_arg);
 265
 266 /**
 267  * Create a new ethernet Rx event adapter with the specified identifier.
 268  * This function uses an internal configuration function that creates an event
 269  * port. This default function reconfigures the event device with an
 270  * additional event port and setups up the event port using the port_config
 271  * parameter passed into this function. In case the application needs more
 272  * control in configuration of the service, it should use the
 273  * rte_event_eth_rx_adapter_create_ext() version.
 274  *
 275  * @param id
 276  *  The identifier of the ethernet Rx event adapter.
 277  *
 278  * @param dev_id
 279  *  The identifier of the device to configure.
 280  *
 281  * @param port_config
 282  *  Argument of type *rte_event_port_conf* that is passed to the conf_cb
 283  *  function.
 284  *
 285  * @return
 286  *   - 0: Success
 287  *   - <0: Error code on failure
 288  */
 289 int rte_event_eth_rx_adapter_create(uint8_t id, uint8_t dev_id,
 290                                 struct rte_event_port_conf *port_config);
 291
 292 /**
 293  * Free an event adapter
 294  *
 295  * @param id
 296  *  Adapter identifier.
 297  *
 298  * @return
 299  *   - 0: Success
 300  *   - <0: Error code on failure, If the adapter still has Rx queues
 301  *      added to it, the function returns -EBUSY.
 302  */
 303 int rte_event_eth_rx_adapter_free(uint8_t id);
 304
 305 /**
 306  * Add receive queue to an event adapter. After a queue has been
 307  * added to the event adapter, the result of the application calling
 308  * rte_eth_rx_burst(eth_dev_id, rx_queue_id, ..) is undefined.
 309  *
 310  * @param id
 311  *  Adapter identifier.
 312  *
 313  * @param eth_dev_id
 314  *  Port identifier of Ethernet device.
 315  *
 316  * @param rx_queue_id
 317  *  Ethernet device receive queue index.
 318  *  If rx_queue_id is -1, then all Rx queues configured for
 319  *  the device are added. If the ethdev Rx queues can only be
 320  *  connected to a single event queue then rx_queue_id is
 321  *  required to be -1.
 322  * @see RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ
 323  *
 324  * @param conf
 325  *  Additional configuration structure of type *rte_event_eth_rx_adapter_conf*
 326  *
 327  * @return
 328  *  - 0: Success, Receive queue added correctly.
 329  *  - <0: Error code on failure.
 330  *  - (-EIO) device reconfiguration and restart error. The adapter reconfigures
 331  *  the event device with an additional port if it is required to use a service
 332  *  function for packet transfer from the ethernet device to the event device.
 333  *  If the device had been started before this call, this error code indicates
 334  *  an error in restart following an error in reconfiguration, i.e., a
 335  *  combination of the two error codes.
 336  */
 337 int rte_event_eth_rx_adapter_queue_add(uint8_t id,
 338                         uint16_t eth_dev_id,
 339                         int32_t rx_queue_id,
 340                         const struct rte_event_eth_rx_adapter_queue_conf *conf);
 341
 342 /**
 343  * Delete receive queue from an event adapter.
 344  *
 345  * @param id
 346  *  Adapter identifier.
 347  *
 348  * @param eth_dev_id
 349  *  Port identifier of Ethernet device.
 350  *
 351  * @param rx_queue_id
 352  *  Ethernet device receive queue index.
 353  *  If rx_queue_id is -1, then all Rx queues configured for
 354  *  the device are deleted. If the ethdev Rx queues can only be
 355  *  connected to a single event queue then rx_queue_id is
 356  *  required to be -1.
 357  * @see RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ
 358  *
 359  * @return
 360  *  - 0: Success, Receive queue deleted correctly.
 361  *  - <0: Error code on failure.
 362  */
 363 int rte_event_eth_rx_adapter_queue_del(uint8_t id, uint16_t eth_dev_id,
 364                                        int32_t rx_queue_id);
 365
 366 /**
 367  * Start ethernet Rx event adapter
 368  *
 369  * @param id
 370  *  Adapter identifier.
 371  *
 372  * @return
 373  *  - 0: Success, Adapter started correctly.
 374  *  - <0: Error code on failure.
 375  *
 376  * @note
 377  *  The eventdev to which the event_eth_rx_adapter is connected needs to
 378  *  be started before calling rte_event_eth_rx_adapter_start().
 379  */
 380 int rte_event_eth_rx_adapter_start(uint8_t id);
 381
 382 /**
 383  * Stop  ethernet Rx event adapter
 384  *
 385  * @param id
 386  *  Adapter identifier.
 387  *
 388  * @return
 389  *  - 0: Success, Adapter started correctly.
 390  *  - <0: Error code on failure.
 391  */
 392 int rte_event_eth_rx_adapter_stop(uint8_t id);
 393
 394 /**
 395  * Retrieve statistics for an adapter
 396  *
 397  * @param id
 398  *  Adapter identifier.
 399  *
 400  * @param [out] stats
 401  *  A pointer to structure used to retrieve statistics for an adapter.
 402  *
 403  * @return
 404  *  - 0: Success, retrieved successfully.
 405  *  - <0: Error code on failure.
 406  */
 407 int rte_event_eth_rx_adapter_stats_get(uint8_t id,
 408                                 struct rte_event_eth_rx_adapter_stats *stats);
 409
 410 /**
 411  * Reset statistics for an adapter.
 412  *
 413  * @param id
 414  *  Adapter identifier.
 415  *
 416  * @return
 417  *  - 0: Success, statistics reset successfully.
 418  *  - <0: Error code on failure.
 419  */
 420 int rte_event_eth_rx_adapter_stats_reset(uint8_t id);
 421
 422 /**
 423  * Retrieve the service ID of an adapter. If the adapter doesn't use
 424  * a rte_service function, this function returns -ESRCH.
 425  *
 426  * @param id
 427  *  Adapter identifier.
 428  *
 429  * @param [out] service_id
 430  *  A pointer to a uint32_t, to be filled in with the service id.
 431  *
 432  * @return
 433  *  - 0: Success
 434  *  - <0: Error code on failure, if the adapter doesn't use a rte_service
 435  * function, this function returns -ESRCH.
 436  */
 437 int rte_event_eth_rx_adapter_service_id_get(uint8_t id, uint32_t *service_id);
 438
 439 /**
 440  * Register callback to process Rx packets, this is supported for
 441  * SW based packet transfers.
 442  * @see rte_event_eth_rx_cb_fn
 443  *
 444  * @param id
 445  *  Adapter identifier.
 446  * @param eth_dev_id
 447  *  Port identifier of Ethernet device.
 448  * @param cb_fn
 449  *  Callback function.
 450  * @param cb_arg
 451  *  Callback arg.
 452  * @return
 453  *  - 0: Success
 454  *  - <0: Error code on failure.
 455  */
 456 int
 457 rte_event_eth_rx_adapter_cb_register(uint8_t id,
 458                                 uint16_t eth_dev_id,
 459                                 rte_event_eth_rx_adapter_cb_fn cb_fn,
 460                                 void *cb_arg);
 461
 462 #ifdef __cplusplus
 463 }
 464 #endif
 465 #endif  /* _RTE_EVENT_ETH_RX_ADAPTER_ */