port: fix minor typo

[dpdk.git] / lib / librte_port / rte_port.h

diff --git a/lib/librte_port/rte_port.h b/lib/librte_port/rte_port.h
index 0934b00..c3c5348 100644 (file)
--- a/lib/librte_port/rte_port.h
+++ b/lib/librte_port/rte_port.h
@@ -42,7 +42,7 @@ extern "C" {
  * @file
  * RTE Port
  *
- * This tool is part of the Intel DPDK Packet Framework tool suite and provides
+ * This tool is part of the DPDK Packet Framework tool suite and provides
  * a standard interface to implement different types of packet ports.
  *
  ***/
@@ -50,6 +50,29 @@ extern "C" {
 #include <stdint.h>
 #include <rte_mbuf.h>
 
+/**@{
+ * Macros to allow accessing metadata stored in the mbuf headroom
+ * just beyond the end of the mbuf data structure returned by a port
+ */
+#define RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset)          \
+       (&((uint8_t *)(mbuf))[offset])
+#define RTE_MBUF_METADATA_UINT16_PTR(mbuf, offset)         \
+       ((uint16_t *) RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset))
+#define RTE_MBUF_METADATA_UINT32_PTR(mbuf, offset)         \
+       ((uint32_t *) RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset))
+#define RTE_MBUF_METADATA_UINT64_PTR(mbuf, offset)         \
+       ((uint64_t *) RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset))
+
+#define RTE_MBUF_METADATA_UINT8(mbuf, offset)              \
+       (*RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset))
+#define RTE_MBUF_METADATA_UINT16(mbuf, offset)             \
+       (*RTE_MBUF_METADATA_UINT16_PTR(mbuf, offset))
+#define RTE_MBUF_METADATA_UINT32(mbuf, offset)             \
+       (*RTE_MBUF_METADATA_UINT32_PTR(mbuf, offset))
+#define RTE_MBUF_METADATA_UINT64(mbuf, offset)             \
+       (*RTE_MBUF_METADATA_UINT64_PTR(mbuf, offset))
+/**@}*/
+
 /*
  * Port IN
  *
@@ -58,6 +81,12 @@ extern "C" {
 Cannot be changed. */
 #define RTE_PORT_IN_BURST_SIZE_MAX                         64
 
+/** Input port statistics */
+struct rte_port_in_stats {
+       uint64_t n_pkts_in;
+       uint64_t n_pkts_drop;
+};
+
 /**
  * Input port create
  *
@@ -97,17 +126,42 @@ typedef int (*rte_port_in_op_rx)(
        struct rte_mbuf **pkts,
        uint32_t n_pkts);
 
+/**
+ * Input port stats get
+ *
+ * @param port
+ *   Handle to output port instance
+ * @param stats
+ *   Handle to port_in stats struct to copy data
+ * @param clear
+ *   Flag indicating that stats should be cleared after read
+ *
+ * @return
+ *   Error code or 0 on success.
+ */
+typedef int (*rte_port_in_op_stats_read)(
+               void *port,
+               struct rte_port_in_stats *stats,
+               int clear);
+
 /** Input port interface defining the input port operation */
 struct rte_port_in_ops {
-       rte_port_in_op_create f_create; /**< Create */
-       rte_port_in_op_free f_free;     /**< Free */
-       rte_port_in_op_rx f_rx;         /**< Packet RX (packet burst) */
+       rte_port_in_op_create f_create;      /**< Create */
+       rte_port_in_op_free f_free;          /**< Free */
+       rte_port_in_op_rx f_rx;              /**< Packet RX (packet burst) */
+       rte_port_in_op_stats_read f_stats;   /**< Stats */
 };
 
 /*
  * Port OUT
  *
  */
+/** Output port statistics */
+struct rte_port_out_stats {
+       uint64_t n_pkts_in;
+       uint64_t n_pkts_drop;
+};
+
 /**
  * Output port create
  *
@@ -165,7 +219,7 @@ typedef int (*rte_port_out_op_tx_bulk)(
        uint64_t pkts_mask);
 
 /**
- * Output port free
+ * Output port flush
  *
  * @param port
  *   Handle to output port instance
@@ -174,13 +228,32 @@ typedef int (*rte_port_out_op_tx_bulk)(
  */
 typedef int (*rte_port_out_op_flush)(void *port);
 
+/**
+ * Output port stats read
+ *
+ * @param port
+ *   Handle to output port instance
+ * @param stats
+ *   Handle to port_out stats struct to copy data
+ * @param clear
+ *   Flag indicating that stats should be cleared after read
+ *
+ * @return
+ *   Error code or 0 on success.
+ */
+typedef int (*rte_port_out_op_stats_read)(
+               void *port,
+               struct rte_port_out_stats *stats,
+               int clear);
+
 /** Output port interface defining the output port operation */
 struct rte_port_out_ops {
-       rte_port_out_op_create f_create;   /**< Create */
-       rte_port_out_op_free f_free;       /**< Free */
-       rte_port_out_op_tx f_tx;           /**< Packet TX (single packet) */
-       rte_port_out_op_tx_bulk f_tx_bulk; /**< Packet TX (packet burst) */
-       rte_port_out_op_flush f_flush;     /**< Flush */
+       rte_port_out_op_create f_create;      /**< Create */
+       rte_port_out_op_free f_free;          /**< Free */
+       rte_port_out_op_tx f_tx;              /**< Packet TX (single packet) */
+       rte_port_out_op_tx_bulk f_tx_bulk;    /**< Packet TX (packet burst) */
+       rte_port_out_op_flush f_flush;        /**< Flush */
+       rte_port_out_op_stats_read f_stats;   /**< Stats */
 };
 
 #ifdef __cplusplus