doc/guides/linux_gsg/sys_reqs.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of Intel Corporation nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 System Requirements
  32 ===================
  33
  34 This chapter describes the packages required to compile the DPDK.
  35
  36 .. note::
  37
  38     If the DPDK is being used on an Intel® Communications Chipset 89xx Series platform,
  39     please consult the *Intel® Communications Chipset 89xx Series Software for Linux Getting Started Guide*.
  40
  41 BIOS Setting Prerequisite on x86
  42 --------------------------------
  43
  44 For the majority of platforms, no special BIOS settings are needed to use basic DPDK functionality.
  45 However, for additional HPET timer and power management functionality,
  46 and high performance of small packets, BIOS setting changes may be needed.
  47 Consult the section on :ref:`Enabling Additional Functionality <Enabling_Additional_Functionality>`
  48 for more information on the required changes.
  49
  50 .. note::
  51
  52    If UEFI secure boot is enabled, the Linux kernel may disallow the use of
  53    UIO on the system. Therefore, devices for use by DPDK should be bound to the
  54    ``vfio-pci`` kernel module rather than ``igb_uio`` or ``uio_pci_generic``.
  55    For more details see :ref:`linux_gsg_binding_kernel`.
  56
  57 Compilation of the DPDK
  58 -----------------------
  59
  60 **Required Tools and Libraries:**
  61
  62 .. note::
  63
  64     Testing has been performed using Fedora 18. The setup commands and installed packages needed on other systems may be different.
  65     For details on other Linux distributions and the versions tested, please consult the DPDK Release Notes.
  66
  67 *   GNU ``make``.
  68
  69 *   coreutils: ``cmp``, ``sed``, ``grep``, ``arch``, etc.
  70
  71 *   gcc: versions 4.9 or later is recommended for all platforms.
  72     On some distributions, some specific compiler flags and linker flags are enabled by
  73     default and affect performance (``-fstack-protector``, for example). Please refer to the documentation
  74     of your distribution and to ``gcc -dumpspecs``.
  75
  76 *   libc headers, often packaged as ``gcc-multilib`` (``glibc-devel.i686`` / ``libc6-dev-i386``;
  77     ``glibc-devel.x86_64`` / ``libc6-dev`` for 64-bit compilation on Intel architecture;
  78     ``glibc-devel.ppc64`` for 64 bit IBM Power architecture;)
  79
  80 *   Linux kernel headers or sources required to build kernel modules. (kernel - devel.x86_64;
  81     kernel - devel.ppc64)
  82
  83 *   Additional packages required for 32-bit compilation on 64-bit systems are:
  84
  85     * glibc.i686, libgcc.i686, libstdc++.i686 and glibc-devel.i686 for Intel i686/x86_64;
  86
  87     * glibc.ppc64, libgcc.ppc64, libstdc++.ppc64 and glibc-devel.ppc64 for IBM ppc_64;
  88
  89     .. note::
  90
  91        x86_x32 ABI is currently supported with distribution packages only on Ubuntu
  92        higher than 13.10 or recent Debian distribution. The only supported  compiler is gcc 4.9+.
  93
  94 *   Library for handling NUMA (Non Uniform Memory Access).
  95
  96     * numactl-devel in Red Hat/Fedora;
  97
  98     * libnuma-dev in Debian/Ubuntu;
  99
 100 *   Python, version 2.7+ or 3.2+, to use various helper scripts included in the DPDK package.
 101
 102
 103 **Optional Tools:**
 104
 105 *   Intel® C++ Compiler (icc). For installation, additional libraries may be required.
 106     See the icc Installation Guide found in the Documentation directory under the compiler installation.
 107
 108 *   IBM® Advance ToolChain for Powerlinux. This is a set of open source development tools and runtime libraries
 109     which allows users to take leading edge advantage of IBM's latest POWER hardware features on Linux. To install
 110     it, see the IBM official installation document.
 111
 112 *   libpcap headers and libraries (libpcap-devel) to compile and use the libpcap-based poll-mode driver.
 113     This driver is disabled by default and can be enabled by setting ``CONFIG_RTE_LIBRTE_PMD_PCAP=y`` in the build time config file.
 114
 115 *   libarchive headers and library are needed for some unit tests using tar to get their resources.
 116
 117
 118 Running DPDK Applications
 119 -------------------------
 120
 121 To run an DPDK application, some customization may be required on the target machine.
 122
 123 System Software
 124 ~~~~~~~~~~~~~~~
 125
 126 **Required:**
 127
 128 *   Kernel version >= 2.6.34
 129
 130     The kernel version in use can be checked using the command::
 131
 132         uname -r
 133
 134 *   glibc >= 2.7 (for features related to cpuset)
 135
 136     The version can be checked using the ``ldd --version`` command.
 137
 138 *   Kernel configuration
 139
 140     In the Fedora OS and other common distributions, such as Ubuntu, or Red Hat Enterprise Linux,
 141     the vendor supplied kernel configurations can be used to run most DPDK applications.
 142
 143     For other kernel builds, options which should be enabled for DPDK include:
 144
 145     *   HUGETLBFS
 146
 147     *   PROC_PAGE_MONITOR  support
 148
 149     *   HPET and HPET_MMAP configuration options should also be enabled if HPET  support is required.
 150         See the section on :ref:`High Precision Event Timer (HPET) Functionality <High_Precision_Event_Timer>` for more details.
 151
 152 .. _linux_gsg_hugepages:
 153
 154 Use of Hugepages in the Linux Environment
 155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 156
 157 Hugepage support is required for the large memory pool allocation used for packet buffers
 158 (the HUGETLBFS option must be enabled in the running kernel as indicated the previous section).
 159 By using hugepage allocations, performance is increased since fewer pages are needed,
 160 and therefore less Translation Lookaside Buffers (TLBs, high speed translation caches),
 161 which reduce the time it takes to translate a virtual page address to a physical page address.
 162 Without hugepages, high TLB miss rates would occur with the standard 4k page size, slowing performance.
 163
 164 Reserving Hugepages for DPDK Use
 165 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 166
 167 The allocation of hugepages should be done at boot time or as soon as possible after system boot
 168 to prevent memory from being fragmented in physical memory.
 169 To reserve hugepages at boot time, a parameter is passed to the Linux kernel on the kernel command line.
 170
 171 For 2 MB pages, just pass the hugepages option to the kernel. For example, to reserve 1024 pages of 2 MB, use::
 172
 173     hugepages=1024
 174
 175 For other hugepage sizes, for example 1G pages, the size must be specified explicitly and
 176 can also be optionally set as the default hugepage size for the system.
 177 For example, to reserve 4G of hugepage memory in the form of four 1G pages, the following options should be passed to the kernel::
 178
 179     default_hugepagesz=1G hugepagesz=1G hugepages=4
 180
 181 .. note::
 182
 183     The hugepage sizes that a CPU supports can be determined from the CPU flags on Intel architecture.
 184     If pse exists, 2M hugepages are supported; if pdpe1gb exists, 1G hugepages are supported.
 185     On IBM Power architecture, the supported hugepage sizes are 16MB and 16GB.
 186
 187 .. note::
 188
 189     For 64-bit applications, it is recommended to use 1 GB hugepages if the platform supports them.
 190
 191 In the case of a dual-socket NUMA system,
 192 the number of hugepages reserved at boot time is generally divided equally between the two sockets
 193 (on the assumption that sufficient memory is present on both sockets).
 194
 195 See the Documentation/kernel-parameters.txt file in your Linux source tree for further details of these and other kernel options.
 196
 197 **Alternative:**
 198
 199 For 2 MB pages, there is also the option of allocating hugepages after the system has booted.
 200 This is done by echoing the number of hugepages required to a nr_hugepages file in the ``/sys/devices/`` directory.
 201 For a single-node system, the command to use is as follows (assuming that 1024 pages are required)::
 202
 203     echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
 204
 205 On a NUMA machine, pages should be allocated explicitly on separate nodes::
 206
 207     echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
 208     echo 1024 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages
 209
 210 .. note::
 211
 212     For 1G pages, it is not possible to reserve the hugepage memory after the system has booted.
 213
 214     On IBM POWER system, the nr_overcommit_hugepages should be set to the same value as nr_hugepages.
 215     For example, if the required page number is 128, the following commands are used::
 216
 217         echo 128 > /sys/kernel/mm/hugepages/hugepages-16384kB/nr_hugepages
 218         echo 128 > /sys/kernel/mm/hugepages/hugepages-16384kB/nr_overcommit_hugepages
 219
 220 Using Hugepages with the DPDK
 221 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 222
 223 Once the hugepage memory is reserved, to make the memory available for DPDK use, perform the following steps::
 224
 225     mkdir /mnt/huge
 226     mount -t hugetlbfs nodev /mnt/huge
 227
 228 The mount point can be made permanent across reboots, by adding the following line to the ``/etc/fstab`` file::
 229
 230     nodev /mnt/huge hugetlbfs defaults 0 0
 231
 232 For 1GB pages, the page size must be specified as a mount option::
 233
 234     nodev /mnt/huge_1GB hugetlbfs pagesize=1GB 0 0