DPDK  18.02.0
rte_eventdev.h
Go to the documentation of this file.
1 /*
2  * BSD LICENSE
3  *
4  * Copyright 2016 Cavium, Inc.
5  * Copyright 2016 Intel Corporation.
6  * Copyright 2016 NXP.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  * * Neither the name of Cavium, Inc nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef _RTE_EVENTDEV_H_
36 #define _RTE_EVENTDEV_H_
37 
237 #ifdef __cplusplus
238 extern "C" {
239 #endif
240 
241 #include <rte_common.h>
242 #include <rte_config.h>
243 #include <rte_memory.h>
244 #include <rte_errno.h>
245 
246 struct rte_mbuf; /* we just use mbuf pointers; no need to include rte_mbuf.h */
247 
248 /* Event device capability bitmap flags */
249 #define RTE_EVENT_DEV_CAP_QUEUE_QOS (1ULL << 0)
250 
255 #define RTE_EVENT_DEV_CAP_EVENT_QOS (1ULL << 1)
256 
262 #define RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED (1ULL << 2)
263 
271 #define RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES (1ULL << 3)
272 
278 #define RTE_EVENT_DEV_CAP_BURST_MODE (1ULL << 4)
279 
286 #define RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE (1ULL << 5)
287 
297 #define RTE_EVENT_DEV_CAP_NONSEQ_MODE (1ULL << 6)
298 
307 #define RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK (1ULL << 7)
308 
313 #define RTE_EVENT_DEV_CAP_MULTIPLE_QUEUE_PORT (1ULL << 8)
314 
319 /* Event device priority levels */
320 #define RTE_EVENT_DEV_PRIORITY_HIGHEST 0
321 
325 #define RTE_EVENT_DEV_PRIORITY_NORMAL 128
326 
330 #define RTE_EVENT_DEV_PRIORITY_LOWEST 255
331 
343 uint8_t
344 rte_event_dev_count(void);
345 
356 int
357 rte_event_dev_get_dev_id(const char *name);
358 
369 int
370 rte_event_dev_socket_id(uint8_t dev_id);
371 
376  const char *driver_name;
377  struct rte_device *dev;
408  int32_t max_num_events;
413  uint32_t event_dev_cap;
415 };
416 
432 int
433 rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info);
434 
438 #define RTE_EVENT_DEV_ATTR_PORT_COUNT 0
439 
442 #define RTE_EVENT_DEV_ATTR_QUEUE_COUNT 1
443 
446 #define RTE_EVENT_DEV_ATTR_STARTED 2
447 
460 int
461 rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id,
462  uint32_t *attr_value);
463 
464 
465 /* Event device configuration bitmap flags */
466 #define RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT (1ULL << 0)
467 
494  uint8_t nb_event_ports;
520  uint32_t event_dev_cfg;
522 };
523 
543 int
544 rte_event_dev_configure(uint8_t dev_id,
545  const struct rte_event_dev_config *dev_conf);
546 
547 
548 /* Event queue specific APIs */
549 
550 /* Event queue configuration bitmap flags */
551 #define RTE_EVENT_QUEUE_CFG_ALL_TYPES (1ULL << 0)
552 
557 #define RTE_EVENT_QUEUE_CFG_SINGLE_LINK (1ULL << 1)
558 
565  uint32_t nb_atomic_flows;
587  uint32_t event_queue_cfg;
589  uint8_t schedule_type;
594  uint8_t priority;
602 };
603 
626 int
627 rte_event_queue_default_conf_get(uint8_t dev_id, uint8_t queue_id,
628  struct rte_event_queue_conf *queue_conf);
629 
648 int
649 rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id,
650  const struct rte_event_queue_conf *queue_conf);
651 
655 #define RTE_EVENT_QUEUE_ATTR_PRIORITY 0
656 
659 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_FLOWS 1
660 
663 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_ORDER_SEQUENCES 2
664 
667 #define RTE_EVENT_QUEUE_ATTR_EVENT_QUEUE_CFG 3
668 
671 #define RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE 4
672 
693 int
694 rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id,
695  uint32_t *attr_value);
696 
697 /* Event port specific APIs */
698 
714  uint16_t dequeue_depth;
720  uint16_t enqueue_depth;
733 };
734 
757 int
758 rte_event_port_default_conf_get(uint8_t dev_id, uint8_t port_id,
759  struct rte_event_port_conf *port_conf);
760 
781 int
782 rte_event_port_setup(uint8_t dev_id, uint8_t port_id,
783  const struct rte_event_port_conf *port_conf);
784 
788 #define RTE_EVENT_PORT_ATTR_ENQ_DEPTH 0
789 
792 #define RTE_EVENT_PORT_ATTR_DEQ_DEPTH 1
793 
796 #define RTE_EVENT_PORT_ATTR_NEW_EVENT_THRESHOLD 2
797 
814 int
815 rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id,
816  uint32_t *attr_value);
817 
834 int
835 rte_event_dev_start(uint8_t dev_id);
836 
844 void
845 rte_event_dev_stop(uint8_t dev_id);
846 
858 int
859 rte_event_dev_close(uint8_t dev_id);
860 
861 /* Scheduler type definitions */
862 #define RTE_SCHED_TYPE_ORDERED 0
863 
889 #define RTE_SCHED_TYPE_ATOMIC 1
890 
908 #define RTE_SCHED_TYPE_PARALLEL 2
909 
921 /* Event types to classify the event source */
922 #define RTE_EVENT_TYPE_ETHDEV 0x0
923 
924 #define RTE_EVENT_TYPE_CRYPTODEV 0x1
925 
926 #define RTE_EVENT_TYPE_TIMERDEV 0x2
927 
928 #define RTE_EVENT_TYPE_CPU 0x3
929 
932 #define RTE_EVENT_TYPE_ETH_RX_ADAPTER 0x4
933 
934 #define RTE_EVENT_TYPE_MAX 0x10
935 
937 /* Event enqueue operations */
938 #define RTE_EVENT_OP_NEW 0
939 
942 #define RTE_EVENT_OP_FORWARD 1
943 
950 #define RTE_EVENT_OP_RELEASE 2
951 
988 struct rte_event {
990  union {
991  uint64_t event;
993  struct {
994  uint32_t flow_id:20;
1001  uint32_t sub_event_type:8;
1005  uint32_t event_type:4;
1009  uint8_t op:2;
1015  uint8_t rsvd:4;
1017  uint8_t sched_type:2;
1022  uint8_t queue_id;
1029  uint8_t priority;
1039  uint8_t impl_opaque;
1046  };
1047  };
1049  union {
1050  uint64_t u64;
1052  void *event_ptr;
1054  struct rte_mbuf *mbuf;
1056  };
1057 };
1058 
1059 /* Ethdev Rx adapter capability bitmap flags */
1060 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT 0x1
1061 
1064 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ 0x2
1065 
1068 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID 0x4
1069 
1095 int
1096 rte_event_eth_rx_adapter_caps_get(uint8_t dev_id, uint8_t eth_port_id,
1097  uint32_t *caps);
1098 
1099 struct rte_eventdev_driver;
1100 struct rte_eventdev_ops;
1101 struct rte_eventdev;
1102 
1103 typedef uint16_t (*event_enqueue_t)(void *port, const struct rte_event *ev);
1106 typedef uint16_t (*event_enqueue_burst_t)(void *port,
1107  const struct rte_event ev[], uint16_t nb_events);
1110 typedef uint16_t (*event_dequeue_t)(void *port, struct rte_event *ev,
1111  uint64_t timeout_ticks);
1114 typedef uint16_t (*event_dequeue_burst_t)(void *port, struct rte_event ev[],
1115  uint16_t nb_events, uint64_t timeout_ticks);
1118 #define RTE_EVENTDEV_NAME_MAX_LEN (64)
1119 
1128 struct rte_eventdev_data {
1129  int socket_id;
1131  uint8_t dev_id;
1133  uint8_t nb_queues;
1135  uint8_t nb_ports;
1137  void **ports;
1139  struct rte_event_port_conf *ports_cfg;
1141  struct rte_event_queue_conf *queues_cfg;
1143  uint16_t *links_map;
1145  void *dev_private;
1147  uint32_t event_dev_cap;
1149  struct rte_event_dev_config dev_conf;
1151  uint8_t service_inited;
1152  /* Service initialization state */
1153  uint32_t service_id;
1154  /* Service ID*/
1155 
1156  RTE_STD_C11
1157  uint8_t dev_started : 1;
1160  char name[RTE_EVENTDEV_NAME_MAX_LEN];
1163 
1165 struct rte_eventdev {
1166  event_enqueue_t enqueue;
1168  event_enqueue_burst_t enqueue_burst;
1170  event_enqueue_burst_t enqueue_new_burst;
1172  event_enqueue_burst_t enqueue_forward_burst;
1174  event_dequeue_t dequeue;
1176  event_dequeue_burst_t dequeue_burst;
1179  struct rte_eventdev_data *data;
1181  const struct rte_eventdev_ops *dev_ops;
1183  struct rte_device *dev;
1186  RTE_STD_C11
1187  uint8_t attached : 1;
1190 
1191 extern struct rte_eventdev *rte_eventdevs;
1194 static __rte_always_inline uint16_t
1195 __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
1196  const struct rte_event ev[], uint16_t nb_events,
1197  const event_enqueue_burst_t fn)
1198 {
1199  const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1200 
1201 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
1202  if (dev_id >= RTE_EVENT_MAX_DEVS || !rte_eventdevs[dev_id].attached) {
1203  rte_errno = -EINVAL;
1204  return 0;
1205  }
1206 
1207  if (port_id >= dev->data->nb_ports) {
1208  rte_errno = -EINVAL;
1209  return 0;
1210  }
1211 #endif
1212  /*
1213  * Allow zero cost non burst mode routine invocation if application
1214  * requests nb_events as const one
1215  */
1216  if (nb_events == 1)
1217  return (*dev->enqueue)(dev->data->ports[port_id], ev);
1218  else
1219  return fn(dev->data->ports[port_id], ev, nb_events);
1220 }
1221 
1264 static inline uint16_t
1265 rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
1266  const struct rte_event ev[], uint16_t nb_events)
1267 {
1268  const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1269 
1270  return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1271  dev->enqueue_burst);
1272 }
1273 
1313 static inline uint16_t
1314 rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id,
1315  const struct rte_event ev[], uint16_t nb_events)
1316 {
1317  const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1318 
1319  return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1320  dev->enqueue_new_burst);
1321 }
1322 
1362 static inline uint16_t
1363 rte_event_enqueue_forward_burst(uint8_t dev_id, uint8_t port_id,
1364  const struct rte_event ev[], uint16_t nb_events)
1365 {
1366  const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1367 
1368  return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1369  dev->enqueue_forward_burst);
1370 }
1371 
1397 int
1398 rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns,
1399  uint64_t *timeout_ticks);
1400 
1467 static inline uint16_t
1468 rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[],
1469  uint16_t nb_events, uint64_t timeout_ticks)
1470 {
1471  struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1472 
1473 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
1474  if (dev_id >= RTE_EVENT_MAX_DEVS || !rte_eventdevs[dev_id].attached) {
1475  rte_errno = -EINVAL;
1476  return 0;
1477  }
1478 
1479  if (port_id >= dev->data->nb_ports) {
1480  rte_errno = -EINVAL;
1481  return 0;
1482  }
1483 #endif
1484 
1485  /*
1486  * Allow zero cost non burst mode routine invocation if application
1487  * requests nb_events as const one
1488  */
1489  if (nb_events == 1)
1490  return (*dev->dequeue)(
1491  dev->data->ports[port_id], ev, timeout_ticks);
1492  else
1493  return (*dev->dequeue_burst)(
1494  dev->data->ports[port_id], ev, nb_events,
1495  timeout_ticks);
1496 }
1497 
1558 int
1559 rte_event_port_link(uint8_t dev_id, uint8_t port_id,
1560  const uint8_t queues[], const uint8_t priorities[],
1561  uint16_t nb_links);
1562 
1602 int
1603 rte_event_port_unlink(uint8_t dev_id, uint8_t port_id,
1604  uint8_t queues[], uint16_t nb_unlinks);
1605 
1633 int
1634 rte_event_port_links_get(uint8_t dev_id, uint8_t port_id,
1635  uint8_t queues[], uint8_t priorities[]);
1636 
1652 int
1653 rte_event_dev_service_id_get(uint8_t dev_id, uint32_t *service_id);
1654 
1668 int
1669 rte_event_dev_dump(uint8_t dev_id, FILE *f);
1670 
1672 #define RTE_EVENT_DEV_XSTATS_NAME_SIZE 64
1673 
1678  RTE_EVENT_DEV_XSTATS_DEVICE,
1679  RTE_EVENT_DEV_XSTATS_PORT,
1680  RTE_EVENT_DEV_XSTATS_QUEUE,
1681 };
1682 
1690  char name[RTE_EVENT_DEV_XSTATS_NAME_SIZE];
1691 };
1692 
1725 int
1726 rte_event_dev_xstats_names_get(uint8_t dev_id,
1727  enum rte_event_dev_xstats_mode mode,
1728  uint8_t queue_port_id,
1729  struct rte_event_dev_xstats_name *xstats_names,
1730  unsigned int *ids,
1731  unsigned int size);
1732 
1759 int
1760 rte_event_dev_xstats_get(uint8_t dev_id,
1761  enum rte_event_dev_xstats_mode mode,
1762  uint8_t queue_port_id,
1763  const unsigned int ids[],
1764  uint64_t values[], unsigned int n);
1765 
1782 uint64_t
1783 rte_event_dev_xstats_by_name_get(uint8_t dev_id, const char *name,
1784  unsigned int *id);
1785 
1806 int
1807 rte_event_dev_xstats_reset(uint8_t dev_id,
1808  enum rte_event_dev_xstats_mode mode,
1809  int16_t queue_port_id,
1810  const uint32_t ids[],
1811  uint32_t nb_ids);
1812 
1823 int rte_event_dev_selftest(uint8_t dev_id);
1824 
1825 #ifdef __cplusplus
1826 }
1827 #endif
1828 
1829 #endif /* _RTE_EVENTDEV_H_ */
void rte_event_dev_stop(uint8_t dev_id)
uint32_t min_dequeue_timeout_ns
Definition: rte_eventdev.h:378
int rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns, uint64_t *timeout_ticks)
static uint16_t rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id, const struct rte_event ev[], uint16_t nb_events)
#define __rte_always_inline
Definition: rte_common.h:110
#define RTE_EVENT_DEV_XSTATS_NAME_SIZE
int rte_event_eth_rx_adapter_caps_get(uint8_t dev_id, uint8_t eth_port_id, uint32_t *caps)
struct rte_eventdev * rte_eventdevs
uint64_t u64
int rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, uint32_t *attr_value)
uint32_t flow_id
Definition: rte_eventdev.h:994
uint8_t priority
struct rte_device * dev
Definition: rte_eventdev.h:377
int rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id, const struct rte_event_queue_conf *queue_conf)
int rte_event_queue_default_conf_get(uint8_t dev_id, uint8_t queue_id, struct rte_event_queue_conf *queue_conf)
int rte_event_port_default_conf_get(uint8_t dev_id, uint8_t port_id, struct rte_event_port_conf *port_conf)
uint32_t dequeue_timeout_ns
Definition: rte_eventdev.h:382
#define rte_errno
Definition: rte_errno.h:29
uint32_t event_type
uint32_t event_dev_cap
Definition: rte_eventdev.h:413
int rte_event_dev_socket_id(uint8_t dev_id)
uint32_t max_event_port_enqueue_depth
Definition: rte_eventdev.h:403
struct rte_mbuf __rte_cache_aligned
uint64_t rte_event_dev_xstats_by_name_get(uint8_t dev_id, const char *name, unsigned int *id)
int rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info)
uint32_t nb_atomic_order_sequences
Definition: rte_eventdev.h:573
uint32_t nb_event_port_dequeue_depth
Definition: rte_eventdev.h:504
void * event_ptr
int rte_event_port_link(uint8_t dev_id, uint8_t port_id, const uint8_t queues[], const uint8_t priorities[], uint16_t nb_links)
int rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id, uint32_t *attr_value)
uint8_t disable_implicit_release
Definition: rte_eventdev.h:726
rte_event_dev_xstats_mode
int rte_event_port_links_get(uint8_t dev_id, uint8_t port_id, uint8_t queues[], uint8_t priorities[])
int rte_event_dev_selftest(uint8_t dev_id)
static uint16_t rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id, const struct rte_event ev[], uint16_t nb_events)
int rte_event_dev_start(uint8_t dev_id)
int rte_event_port_setup(uint8_t dev_id, uint8_t port_id, const struct rte_event_port_conf *port_conf)
uint8_t max_event_port_dequeue_depth
Definition: rte_eventdev.h:398
int rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id, uint32_t *attr_value)
uint32_t nb_event_port_enqueue_depth
Definition: rte_eventdev.h:512
const char * driver_name
Definition: rte_eventdev.h:376
uint8_t impl_opaque
uint8_t queue_id
static uint16_t rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[], uint16_t nb_events, uint64_t timeout_ticks)
int rte_event_dev_get_dev_id(const char *name)
uint8_t rte_event_dev_count(void)
int rte_event_dev_close(uint8_t dev_id)
int rte_event_dev_xstats_get(uint8_t dev_id, enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id, const unsigned int ids[], uint64_t values[], unsigned int n)
int rte_event_dev_xstats_reset(uint8_t dev_id, enum rte_event_dev_xstats_mode mode, int16_t queue_port_id, const uint32_t ids[], uint32_t nb_ids)
#define RTE_STD_C11
Definition: rte_common.h:37
uint32_t dequeue_timeout_ns
Definition: rte_eventdev.h:473
int rte_event_dev_service_id_get(uint8_t dev_id, uint32_t *service_id)
static uint16_t rte_event_enqueue_forward_burst(uint8_t dev_id, uint8_t port_id, const struct rte_event ev[], uint16_t nb_events)
int rte_event_dev_dump(uint8_t dev_id, FILE *f)
uint8_t rsvd
uint8_t op
int32_t new_event_threshold
Definition: rte_eventdev.h:701
uint8_t max_event_priority_levels
Definition: rte_eventdev.h:392
struct rte_mbuf * mbuf
uint32_t max_dequeue_timeout_ns
Definition: rte_eventdev.h:380
uint32_t max_event_queue_flows
Definition: rte_eventdev.h:386
int rte_event_dev_configure(uint8_t dev_id, const struct rte_event_dev_config *dev_conf)
uint32_t sub_event_type
uint8_t sched_type
uint8_t max_event_queues
Definition: rte_eventdev.h:384
uint8_t max_event_queue_priority_levels
Definition: rte_eventdev.h:388
int rte_event_port_unlink(uint8_t dev_id, uint8_t port_id, uint8_t queues[], uint16_t nb_unlinks)
int rte_event_dev_xstats_names_get(uint8_t dev_id, enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id, struct rte_event_dev_xstats_name *xstats_names, unsigned int *ids, unsigned int size)
uint32_t nb_event_queue_flows
Definition: rte_eventdev.h:499