docs/BUILD.dpdkstat.md

   1 # The dpdkstat plugin
   2
   3 **Data Plane Development Kit** (DPDK) is a set of drivers and libraries for fast
   4 packet processing.
   5
   6 ## Summary
   7
   8 The *dpdkstat plugin* has the following requirements:
   9
  10  * DPDK 16.04 or later
  11  * GCC 4.9 or later
  12
  13 You can also build with GCC 4.8 (e.g. Ubuntu 14.04) if you specify the SSSE3
  14 instruction set manually:
  15
  16     make -j CFLAGS+='-mssse3'
  17
  18 ## Building DPDK
  19
  20  *  Setup the build environment:
  21
  22     Ensure that you have GCC 4.9 or later. Ubuntu 14.04, for example, has GCC
  23     4.8 by default and requires an upgrade:
  24
  25         add-apt-repository ppa:ubuntu-toolchain-r/test
  26         apt-get update
  27         apt-get install gcc-4.9
  28
  29     If you know that the platform that you wish to run collectd on supports the
  30     SSSE3 instruction set, GCC 4.8 also works if you enable SSSE3 manually:
  31
  32         make -j CFLAGS+='-mssse3'
  33
  34  *  Clone DPDK:
  35
  36         git clone git://dpdk.org/dpdk
  37
  38  *  Checkout the [DPDK system
  39     requirements](http://dpdk.org/doc/guides/linux_gsg/sys_reqs.html) and make
  40     sure you have the required tools and hugepage setup as specified there.
  41
  42     **Note:** It's recommended to use the 1GB hugepage setup for best
  43     performance, please follow the instruction for "Reserving Hugepages for DPDK
  44     Use" in the link above.
  45
  46     However if you plan on configuring 2MB hugepages on the fly please ensure to
  47     add appropriate commands to reserve hugepages in a system startup script if
  48     collectd is booted at system startup time. These commands include:
  49
  50         mkdir -p /mnt/huge
  51         mount -t hugetlbfs nodev /mnt/huge
  52         echo 64 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
  53
  54  *  To configure the DPDK build for the combined shared library and enable autoload
  55     of pmd drivers modify `config/common_base` in your DPDK as follows
  56
  57         #
  58         # Compile to share library
  59         #
  60         -CONFIG_RTE_BUILD_SHARED_LIB=n
  61         +CONFIG_RTE_BUILD_SHARED_LIB=y
  62
  63         # Default driver path (or "" to disable)
  64         -CONFIG_RTE_EAL_PMD_PATH=""
  65         +CONFIG_RTE_EAL_PMD_PATH="/usr/lib/dpdk-pmd/"
  66
  67  *  Prepare the configuration for the appropriate target as specified at:
  68     http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html.
  69
  70     For example:
  71
  72         make config T=x86_64-native-linuxapp-gcc
  73
  74  *  Build the target:
  75
  76         make
  77
  78  *  Install DPDK to `/usr`
  79
  80         sudo make install prefix=/usr
  81
  82  *  Create dpdk-pmd folder
  83
  84         mkdir -p /usr/lib/dpdk-pmd
  85
  86  *  Create symlinks to pmd drivers
  87
  88         find /usr/lib -type f -name 'librte_pmd*' | while read path ; do ln -s $path /usr/lib/dpdk-pmd/`echo $path | grep -o 'librte_.*so'` ;  done
  89
  90     **Note 1:** You must run make install as the configuration of collectd with
  91     DPDK expects DPDK to be installed somewhere.
  92
  93     **Note 2:** If you don't specify a prefix then DPDK will be installed in
  94     `/usr/local/`.
  95
  96     **Note 3:** If you are not root then use sudo to make install DPDK to the
  97     appropriate location.
  98
  99     **Note 4:** You **MUST** create symlink to a NIC driver lib. This way collectd
 100     will be able to work with device bound to dpdk.
 101
 102  *  Check that the DPDK library has been installed in `/usr/lib` or `/lib`:
 103
 104         ls /usr/lib | grep dpdk
 105
 106  *  Bind the interfaces to use with dpdkstat to DPDK:
 107
 108     DPDK devices can be setup with either the VFIO (for DPDK 1.7+) or UIO
 109     modules.
 110
 111     **Note:** UIO requires inserting an out of tree driver `igb_uio.ko` that is
 112     available in DPDK.
 113
 114     **UIO Setup:**
 115
 116      *  Insert `uio.ko`:
 117
 118             sudo modprobe uio
 119
 120      *  Insert `igb_uio.ko`:
 121
 122             sudo insmod $DPDK_BUILD/kmod/igb_uio.ko
 123
 124      *  Bind network device to `igb_uio`:
 125
 126             sudo $DPDK_DIR/tools/dpdk_nic_bind.py --bind=igb_uio eth1
 127
 128     **VFIO Setup:**
 129
 130      *  VFIO needs to be supported in the kernel and the BIOS. More information
 131         can be found at: http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html.
 132      *  Insert the `vfio-pci.ko` module:
 133
 134             modprobe vfio-pci
 135
 136      *  Set the correct permissions for the VFIO device:
 137
 138             sudo /usr/bin/chmod a+x /dev/vfio
 139             sudo /usr/bin/chmod 0666 /dev/vfio/*
 140
 141      *  Bind the network device to `vfio-pci`:
 142
 143             sudo $DPDK_DIR/tools/dpdk_nic_bind.py --bind=vfio-pci eth1
 144
 145         **Note:** Please ensure to add appropriate commands to bind the network
 146         interfaces to DPDK in a system startup script if collectd is booted at
 147         system startup time.
 148
 149      *  Run `ldconfig` to update the shared library cache.
 150
 151 ## Build collectd with DPDK
 152
 153 **Note:** DPDK 16.04 is the minimum version and currently supported version of
 154 DPDK required for the dpdkstat plugin. This is to allow the plugin to take
 155 advantage of functions added to detect if the DPDK primary process is alive.
 156
 157
 158 **Note:** The *Address-Space Layout Randomization* (ASLR) security feature in
 159 Linux should be disabled, in order for the same hugepage memory mappings to be
 160 present in all DPDK multi-process applications. Note that this has security
 161 implications.
 162
 163  *  To disable ASLR:
 164
 165         echo 0 > /proc/sys/kernel/randomize_va_space
 166
 167  *  To fully enable ASLR:
 168
 169         echo 2 > /proc/sys/kernel/randomize_va_space
 170
 171 See also: http://dpdk.org/doc/guides/prog_guide/multi_proc_support.html
 172
 173  *  Generate the build script as specified below. (i.e. run `build.sh`).
 174  *  Configure collectd with the DPDK shared library. If DPDK is installed in
 175     custom installation path you can specify headers include path using
 176     LIBDPDK_CPPFLAGS variable and libraries path with LIBDPDK_LDFLAGS.
 177     Example:
 178
 179         ./configure
 180
 181         or for custom DPKD installation:
 182
 183         ./configure LIBDPDK_CPPFLAGS="-I/home/joe/include/dpdk" LIBDPDK_LDFLAGS="-L/home/joe/usr/lib"
 184
 185  *  Make sure that libdpdk and dpdkstat are enabled in the *configure* output.
 186
 187     Expected output:
 188
 189         Libraries:
 190         ...
 191         libdpdk  . . . . . . . . yes
 192
 193         Modules:
 194         ...
 195         dpdkstat . . . . . . .yes
 196
 197  *  Build collectd:
 198
 199     make -j && make -j install
 200
 201     **Note:** As mentioned above, if you are building on Ubuntu 14.04 with
 202     GCC <= 4.8.X, you need to use:
 203
 204         make -j CFLAGS+='-mssse3' && make -j install
 205
 206 ## Caveats
 207
 208  *  The same PCI device configuration should be passed to the primary process as
 209     the secondary process uses the same port indexes as the primary.
 210  *  A blacklist / whitelist of NICs isn't supported yet.
 211  *  Plugin initialization time depends on read interval. It requires 5 read
 212     cycles to set up internal buffers and states. During that time no statistics
 213     are submitted.
 214  *  If number of DPDK ports is increased while plugin is running, internal
 215     buffers are resized. That requires 3 read cycles and no port statistics
 216     are submitted in that time.
 217
 218 ## License
 219
 220 The *dpdkstat plugin* is copyright (c) 2016 *Intel Corporation* and licensed
 221 under the *MIT license*. Full licensing terms can be found in the file
 222 `COPYING`.