Skip to content
Tom Barbette edited this page Aug 6, 2018 · 2 revisions

DPDKInfo Element Documentation

NAME

DPDKInfo — Click element; Set DPDK global parameters.

SYNOPSIS

DPDKInfo([keywords NB_MBUF, MBUF_SIZE, RX_PTHRESH, etc.])

Ports: none

DESCRIPTION

Set Intel's DPDK global parameters used by FromDPDKDevice and ToDPDKDevice elements. See DPDK documentation for details.

Keyword arguments:

  • NB_MBUF — Integer. Number of message buffers to allocate. Defaults to 65536.

  • MBUF_SIZE — Integer. Size of a message buffer in bytes. Defaults to 2048 + RTE_PKTMBUF_HEADROOM.

  • MBUF_CACHE_SIZE — Integer. Number of message buffer to keep in a per-core cache. It should be such that NB_MBUF modulo MBUF_CACHE_SIZE == 0. Defaults to 256.

  • RX_PTHRESH — Integer. RX prefetch threshold. Defaults to 8.

  • RX_HTHRESH — Integer. RX host threshold. Defaults to 8.

  • RX_WTHRESH — Integer. RX write-back threshold. Defaults to 4.

  • TX_PTHRESH — Integer. TX prefetch threshold. Defaults to 36.

  • TX_HTHRESH — Integer. TX host threshold. Defaults to 0.

  • TX_WTHRESH — Integer. TX write-back threshold. Defaults to 0.

  • MEMPOOL_PREFIX — String. Prefix for the mempool name. Use this to get a predictable

    mempool name and attach secondary processes.
    
  • DEF_RING_NDESC — Integer. Number of frame descriptors in the ring buffer. Used for interprocess communication. Defaults to 1024.

  • DEF_BURST_SIZE — Integer. Number of frames to read/write from/to a DPDK device. Defaults to 32.

  • RING_FLAGS — Integer. Parameters to pass to a ring-based DPDK process communication. Defaults to 0.

  • RING_SIZE — Integer. The size of the ring used for DPDK inter-process communication. Defaults to 64.

  • RING_POOL_CACHE_SIZE — Integer. The size of the message buffer for DPDK inter-process communication. Defaults to 32.

  • RING_PRIV_DATA_SIZE — Integer. The size of the private memory area for a pair of interconnected DPDK process. Defaults to 0 as there is no need to share something privately.

This element is only available at user level, when compiled with DPDK support.

EXAMPLES

  DPDKInfo(NB_MBUF 1048576, MBUF_SIZE 4096, MBUF_CACHE_SIZE 512)

SEE ALSO

FromDPDKDevice, ToDPDKDevice, FromDPDKRing, ToDPDKRing

Generated by click-elem2man from ../elements/userlevel/dpdkinfo.hh:9 on 2018/08/06.

Clone this wiki locally