path: root/lib/librte_kni
diff options
authorAlex Wang <>2016-05-21 00:58:36 -0700
committerThomas Monjalon <>2016-06-14 17:15:01 +0200
commit460860100017a96117564c5b59c9f241083f7f8a (patch)
tree0b773a0a5bfeb3573aabdc827cf0980c837e1032 /lib/librte_kni
parent1afa3d7ca6cc5ab8f0f8a95187b66c2f735f0682 (diff)
kni: describe mempool capacity requirement
Function like 'rte_kni_rx_burst()' keeps allocating 'MAX_MBUF_BURST_NUM' mbufs to kni fifo queue unless the queue's capacity ('KNI_FIFO_COUNT_MAX') is reached. So, if the mempool is under-provisioned, user may run into "Out of Memory" logs from KNI code. This commit documents the need to provision mempool capacity of more than "2 x KNI_FIFO_COUNT_MAX" for each KNI interface. Signed-off-by: Alex Wang <> Acked-by: Ferruh Yigit <> Acked-by: John McNamara <>
Diffstat (limited to 'lib/librte_kni')
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/librte_kni/rte_kni.h b/lib/librte_kni/rte_kni.h
index b724fa2..7363e6c 100644
--- a/lib/librte_kni/rte_kni.h
+++ b/lib/librte_kni/rte_kni.h
@@ -113,6 +113,9 @@ void rte_kni_init(unsigned int max_kni_ifaces);
* The rte_kni_alloc shall not be called before rte_kni_init() has been
* called. rte_kni_alloc is thread safe.
+ * The mempool should have capacity of more than "2 x KNI_FIFO_COUNT_MAX"
+ * elements for each KNI interface allocated.
+ *
* @param pktmbuf_pool
* The mempool for allocting mbufs for packets.
* @param conf