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 <alex@awakenetworks.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
This commit is contained in:
Alex Wang 2016-05-21 00:58:36 -07:00 committed by Thomas Monjalon
parent 1afa3d7ca6
commit 4608601000

View File

@ -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