Skip to contentSkip to conversation

eal: added new api to only enqueue a packet in tx buffer

PATCH In review Nilanjan Sarkar 5 participants 5 messages Aug 8, 2019 – Nov 12, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 eal: added new api to only enqueue a packet in tx buffer

This api is similar like api rte_eth_tx_buffer except it does not attempt to flush the buffer in case buffer is full. The advantage is that, this api does not need port id and queue id. In case port id and queue id are shared within threads then application can not buffer a packet until it gets access to port and queue. So this function segregate buffering job from flushing job and thus removes dependency on port and queue.

---
 lib/librte_ethdev/rte_ethdev.h | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
lib/librte_ethdev/rte_ethdev.h +29 -0
index dc6596bc9..bd8b8fee4 100644
@@ -4569,6 +4569,35 @@ rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
 	return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
 }
 
+/**
+ * Buffer a single packet for future transmission on Tx buffer. This buffer
+ * can be sent to a port and queue of a NIC using rte_eth_tx_buffer_flush ()
+ * call.
+ *
+ * This function enqueues a packet to Tx buffer. In case there is no space
+ * in Tx buffer, this function fails.
+ * Tx buffer will be flushed using rte_eth_tx_buffer_flush () call. It is
+ * application's responsibility to flush the Tx buffer in regular interval.
+ *
+ * @param buffer
+ *  Buffer used to collect packets to be sent.
+ * @param tx_pkt
+ *  Pointer to the packet mbuf to be sent.
+ * @return
+ *  0 = packet has been buffered for later transmission
+ *  -1 = Packet can not be buffered since it reached limit
+ */
+static __rte_always_inline int
+rte_eth_tx_enqueue(struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
+{
+	if (buffer->length < buffer->size) {
+		buffer->pkts[buffer->length++] = tx_pkt;
+		return 0;
+	}
+
+	return -1;
+}
+
 #ifdef __cplusplus
 }
 #endif
Signature · 5 lines
2.22.0


Disclaimer:
This communication (including any attachments) is intended for the use of the intended recipient(s) only and may contain information that is considered confidential, proprietary, sensitive and/or otherwise legally protected. Any unauthorized use or dissemination of this communication is strictly prohibited. If you have received this communication in error, please immediately notify the sender by return e-mail message and delete all copies of the original communication. Thank you for your cooperation.
#1 lore raw
Quoted 7 lines · Nilanjan Sarkar

This api is similar like api rte_eth_tx_buffer except it does not attempt to flush the buffer in case buffer is full. The advantage is that, this api does not need port id and queue id. In case port id and queue id are shared within threads then application can not buffer a packet until it gets access to port and queue. So this function segregate buffering job from flushing job and thus removes dependency on port and queue.

Hi Nilanjan,

Sorry, the patch seems missed because of the misleading module info in the patch title, this is not an 'eal' patch but a 'ethdev' patch ...

Related to the API, it looks like target is to reduce the critical section which looks reasonable to me.

A concern is related to the making this function inline, we are discussing moving existing inline functions to regular functions, this may have performance affect but if the drop is acceptable what about making this an ethdev API?

Thanks,
ferruh

Quoted 47 lines
---
 lib/librte_ethdev/rte_ethdev.h | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
lib/librte_ethdev/rte_ethdev.h +29 -0
index dc6596bc9..bd8b8fee4 100644
@@ -4569,6 +4569,35 @@ rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
 	return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
 }
 
+/**
+ * Buffer a single packet for future transmission on Tx buffer. This buffer
+ * can be sent to a port and queue of a NIC using rte_eth_tx_buffer_flush ()
+ * call.
+ *
+ * This function enqueues a packet to Tx buffer. In case there is no space
+ * in Tx buffer, this function fails.
+ * Tx buffer will be flushed using rte_eth_tx_buffer_flush () call. It is
+ * application's responsibility to flush the Tx buffer in regular interval.
+ *
+ * @param buffer
+ *  Buffer used to collect packets to be sent.
+ * @param tx_pkt
+ *  Pointer to the packet mbuf to be sent.
+ * @return
+ *  0 = packet has been buffered for later transmission
+ *  -1 = Packet can not be buffered since it reached limit
+ */
+static __rte_always_inline int
+rte_eth_tx_enqueue(struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
+{
+	if (buffer->length < buffer->size) {
+		buffer->pkts[buffer->length++] = tx_pkt;
+		return 0;
+	}
+
+	return -1;
+}
+
 #ifdef __cplusplus
 }
 #endif
#2 lore raw
Quoted 14 lines · Ferruh
Quoted 7 lines · Nilanjan Sarkar

This api is similar like api rte_eth_tx_buffer except it does not attempt to flush the buffer in case buffer is full. The advantage is that, this api does not need port id and queue id. In case port id and queue id are shared within threads then application can not buffer a packet until it gets access to port and queue. So this function segregate buffering job from flushing job and thus removes dependency on port and queue.

Hi Nilanjan,

Sorry, the patch seems missed because of the misleading module info in the patch title, this is not an 'eal' patch but a 'ethdev' patch ...

Quoted 7 lines

Related to the API, it looks like target is to reduce the critical section which looks reasonable to me.

A concern is related to the making this function inline, we are discussing moving existing inline functions to regular functions, this may have performance affect but if the drop is acceptable what about making this an ethdev API?

There was no response on making the new proposed API a proper function.

@Thomas, @Andrew, et al,

What do you think about a new static inline ethdev API?

Quoted 49 lines
Quoted 48 lines
---
 lib/librte_ethdev/rte_ethdev.h | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
lib/librte_ethdev/rte_ethdev.h +29 -0
index dc6596bc9..bd8b8fee4 100644
@@ -4569,6 +4569,35 @@ rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id,
 	return rte_eth_tx_buffer_flush(port_id, queue_id, buffer);
 }
 
+/**
+ * Buffer a single packet for future transmission on Tx buffer. This buffer
+ * can be sent to a port and queue of a NIC using rte_eth_tx_buffer_flush ()
+ * call.
+ *
+ * This function enqueues a packet to Tx buffer. In case there is no space
+ * in Tx buffer, this function fails.
+ * Tx buffer will be flushed using rte_eth_tx_buffer_flush () call. It is
+ * application's responsibility to flush the Tx buffer in regular interval.
+ *
+ * @param buffer
+ *  Buffer used to collect packets to be sent.
+ * @param tx_pkt
+ *  Pointer to the packet mbuf to be sent.
+ * @return
+ *  0 = packet has been buffered for later transmission
+ *  -1 = Packet can not be buffered since it reached limit
+ */
+static __rte_always_inline int
+rte_eth_tx_enqueue(struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
+{
+	if (buffer->length < buffer->size) {
+		buffer->pkts[buffer->length++] = tx_pkt;
+		return 0;
+	}
+
+	return -1;
+}
+
 #ifdef __cplusplus
 }
 #endif
#3 lore raw

11/11/2019 17:56, Ferruh Yigit:

Quoted 29 lines · Ferruh
Quoted 14 lines · Nilanjan Sarkar
Quoted 7 lines

This api is similar like api rte_eth_tx_buffer except it does not attempt to flush the buffer in case buffer is full. The advantage is that, this api does not need port id and queue id. In case port id and queue id are shared within threads then application can not buffer a packet until it gets access to port and queue. So this function segregate buffering job from flushing job and thus removes dependency on port and queue.

Hi Nilanjan,

Sorry, the patch seems missed because of the misleading module info in the patch title, this is not an 'eal' patch but a 'ethdev' patch ...

Quoted 7 lines

Related to the API, it looks like target is to reduce the critical section which looks reasonable to me.

A concern is related to the making this function inline, we are discussing moving existing inline functions to regular functions, this may have performance affect but if the drop is acceptable what about making this an ethdev API?

There was no response on making the new proposed API a proper function.

@Thomas, @Andrew, et al,

What do you think about a new static inline ethdev API?

Quoted 10 lines
Quoted 10 lines

lib/librte_ethdev/rte_ethdev.h rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id, · line 4599

Quoted 10 lines
lib/librte_ethdev/rte_ethdev.h +10 -0
+static __rte_always_inline int
+rte_eth_tx_enqueue(struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
+{
+	if (buffer->length < buffer->size) {
+		buffer->pkts[buffer->length++] = tx_pkt;
+		return 0;
+	}
+
+	return -1;
+}

It looks reasonnable.
But the function name should include _buffer_
What about rte_eth_tx_buffer_enqueue?

#4 lore raw
Quoted 30 lines · Thomas Monjalon

11/11/2019 17:56, Ferruh Yigit:

Quoted 29 lines · Ferruh
Quoted 14 lines · Nilanjan Sarkar
Quoted 7 lines

This api is similar like api rte_eth_tx_buffer except it does not attempt to flush the buffer in case buffer is full. The advantage is that, this api does not need port id and queue id. In case port id and queue id are shared within threads then application can not buffer a packet until it gets access to port and queue. So this function segregate buffering job from flushing job and thus removes dependency on port and queue.

Hi Nilanjan,

Sorry, the patch seems missed because of the misleading module info in the patch title, this is not an 'eal' patch but a 'ethdev' patch ...

Quoted 7 lines

Related to the API, it looks like target is to reduce the critical section which looks reasonable to me.

A concern is related to the making this function inline, we are discussing moving existing inline functions to regular functions, this may have performance affect but if the drop is acceptable what about making this an ethdev API?

There was no response on making the new proposed API a proper function.

@Thomas, @Andrew, et al,

What do you think about a new static inline ethdev API?

Quoted 14 lines
Quoted 10 lines
Quoted 10 lines

lib/librte_ethdev/rte_ethdev.h rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id, · line 4599

Quoted 10 lines
lib/librte_ethdev/rte_ethdev.h +10 -0
+static __rte_always_inline int
+rte_eth_tx_enqueue(struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
+{
+	if (buffer->length < buffer->size) {
+		buffer->pkts[buffer->length++] = tx_pkt;
+		return 0;
+	}
+
+	return -1;
+}

It looks reasonnable.
But the function name should include _buffer_
What about rte_eth_tx_buffer_enqueue?

+1