76d82e6eef75d245d4ae6fa5bf20d1d9f8a44d11
[dpdk.git] / 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 on 40G NIC, 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 Compilation of the DPDK
51 -----------------------
52
53 **Required Tools:**
54
55 .. note::
56
57     Testing has been performed using Fedora 18. The setup commands and installed packages needed on other systems may be different.
58     For details on other Linux distributions and the versions tested, please consult the DPDK Release Notes.
59
60 *   GNU ``make``.
61
62 *   coreutils: ``cmp``, ``sed``, ``grep``, ``arch``, etc.
63
64 *   gcc: versions 4.9 or later is recommended for all platforms.
65     On some distributions, some specific compiler flags and linker flags are enabled by
66     default and affect performance (``-fstack-protector``, for example). Please refer to the documentation
67     of your distribution and to ``gcc -dumpspecs``.
68
69 *   libc headers, often packaged as ``gcc-multilib`` (``glibc-devel.i686`` / ``libc6-dev-i386``;
70     ``glibc-devel.x86_64`` / ``libc6-dev`` for 64-bit compilation on Intel architecture;
71     ``glibc-devel.ppc64`` for 64 bit IBM Power architecture;)
72
73 *   Linux kernel headers or sources required to build kernel modules. (kernel - devel.x86_64;
74     kernel - devel.ppc64)
75
76 *   Additional packages required for 32-bit compilation on 64-bit systems are:
77
78     * glibc.i686, libgcc.i686, libstdc++.i686 and glibc-devel.i686 for Intel i686/x86_64;
79
80     * glibc.ppc64, libgcc.ppc64, libstdc++.ppc64 and glibc-devel.ppc64 for IBM ppc_64;
81
82     .. note::
83
84        x86_x32 ABI is currently supported with distribution packages only on Ubuntu
85        higher than 13.10 or recent Debian distribution. The only supported  compiler is gcc 4.9+.
86
87 *   Python, version 2.6 or 2.7, to use various helper scripts included in the DPDK package.
88
89
90 **Optional Tools:**
91
92 *   Intel® C++ Compiler (icc). For installation, additional libraries may be required.
93     See the icc Installation Guide found in the Documentation directory under the compiler installation.
94
95 *   IBM® Advance ToolChain for Powerlinux. This is a set of open source development tools and runtime libraries
96     which allows users to take leading edge advantage of IBM's latest POWER hardware features on Linux. To install
97     it, see the IBM official installation document.
98
99 *   libpcap headers and libraries (libpcap-devel) to compile and use the libpcap-based poll-mode driver.
100     This driver is disabled by default and can be enabled by setting ``CONFIG_RTE_LIBRTE_PMD_PCAP=y`` in the build time config file.
101
102 *   libarchive headers and library are needed for some unit tests using tar to get their resources.
103
104
105 Running DPDK Applications
106 -------------------------
107
108 To run an DPDK application, some customization may be required on the target machine.
109
110 System Software
111 ~~~~~~~~~~~~~~~
112
113 **Required:**
114
115 *   Kernel version >= 2.6.34
116
117     The kernel version in use can be checked using the command::
118
119         uname -r
120
121 *   glibc >= 2.7 (for features related to cpuset)
122
123     The version can be checked using the ``ldd --version`` command.
124
125 *   Kernel configuration
126
127     In the Fedora OS and other common distributions, such as Ubuntu, or Red Hat Enterprise Linux,
128     the vendor supplied kernel configurations can be used to run most DPDK applications.
129
130     For other kernel builds, options which should be enabled for DPDK include:
131
132     *   UIO support
133
134     *   HUGETLBFS
135
136     *   PROC_PAGE_MONITOR  support
137
138     *   HPET and HPET_MMAP configuration options should also be enabled if HPET  support is required.
139         See the section on :ref:`High Precision Event Timer (HPET) Functionality <High_Precision_Event_Timer>` for more details.
140
141 .. _linux_gsg_hugepages:
142
143 Use of Hugepages in the Linux Environment
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145
146 Hugepage support is required for the large memory pool allocation used for packet buffers
147 (the HUGETLBFS option must be enabled in the running kernel as indicated the previous section).
148 By using hugepage allocations, performance is increased since fewer pages are needed,
149 and therefore less Translation Lookaside Buffers (TLBs, high speed translation caches),
150 which reduce the time it takes to translate a virtual page address to a physical page address.
151 Without hugepages, high TLB miss rates would occur with the standard 4k page size, slowing performance.
152
153 Reserving Hugepages for DPDK Use
154 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
155
156 The allocation of hugepages should be done at boot time or as soon as possible after system boot
157 to prevent memory from being fragmented in physical memory.
158 To reserve hugepages at boot time, a parameter is passed to the Linux kernel on the kernel command line.
159
160 For 2 MB pages, just pass the hugepages option to the kernel. For example, to reserve 1024 pages of 2 MB, use::
161
162     hugepages=1024
163
164 For other hugepage sizes, for example 1G pages, the size must be specified explicitly and
165 can also be optionally set as the default hugepage size for the system.
166 For example, to reserve 4G of hugepage memory in the form of four 1G pages, the following options should be passed to the kernel::
167
168     default_hugepagesz=1G hugepagesz=1G hugepages=4
169
170 .. note::
171
172     The hugepage sizes that a CPU supports can be determined from the CPU flags on Intel architecture.
173     If pse exists, 2M hugepages are supported; if pdpe1gb exists, 1G hugepages are supported.
174     On IBM Power architecture, the supported hugepage sizes are 16MB and 16GB.
175
176 .. note::
177
178     For 64-bit applications, it is recommended to use 1 GB hugepages if the platform supports them.
179
180 In the case of a dual-socket NUMA system,
181 the number of hugepages reserved at boot time is generally divided equally between the two sockets
182 (on the assumption that sufficient memory is present on both sockets).
183
184 See the Documentation/kernel-parameters.txt file in your Linux source tree for further details of these and other kernel options.
185
186 **Alternative:**
187
188 For 2 MB pages, there is also the option of allocating hugepages after the system has booted.
189 This is done by echoing the number of hugepages required to a nr_hugepages file in the ``/sys/devices/`` directory.
190 For a single-node system, the command to use is as follows (assuming that 1024 pages are required)::
191
192     echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
193
194 On a NUMA machine, pages should be allocated explicitly on separate nodes::
195
196     echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
197     echo 1024 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages
198
199 .. note::
200
201     For 1G pages, it is not possible to reserve the hugepage memory after the system has booted.
202
203 Using Hugepages with the DPDK
204 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
205
206 Once the hugepage memory is reserved, to make the memory available for DPDK use, perform the following steps::
207
208     mkdir /mnt/huge
209     mount -t hugetlbfs nodev /mnt/huge
210
211 The mount point can be made permanent across reboots, by adding the following line to the ``/etc/fstab`` file::
212
213     nodev /mnt/huge hugetlbfs defaults 0 0
214
215 For 1GB pages, the page size must be specified as a mount option::
216
217     nodev /mnt/huge_1GB hugetlbfs pagesize=1GB 0 0
218
219 Xen Domain0 Support in the Linux Environment
220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
222 The existing memory management implementation is based on the Linux kernel hugepage mechanism.
223 On the Xen hypervisor, hugepage support for DomainU (DomU) Guests means that DPDK applications work as normal for guests.
224
225 However, Domain0 (Dom0) does not support hugepages.
226 To work around this limitation, a new kernel module rte_dom0_mm is added to facilitate the allocation and mapping of memory via
227 **IOCTL** (allocation) and **MMAP** (mapping).
228
229 Enabling Xen Dom0 Mode in the DPDK
230 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
231
232 By default, Xen Dom0 mode is disabled in the DPDK build configuration files.
233 To support Xen Dom0, the CONFIG_RTE_LIBRTE_XEN_DOM0 setting should be changed to “y”, which enables the Xen Dom0 mode at compile time.
234
235 Furthermore, the CONFIG_RTE_EAL_ALLOW_INV_SOCKET_ID setting should also be changed to “y” in the case of the wrong socket ID being received.
236
237 Loading the DPDK rte_dom0_mm Module
238 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
239
240 To run any DPDK application on Xen Dom0, the ``rte_dom0_mm`` module must be loaded into the running kernel with rsv_memsize option.
241 The module is found in the kmod sub-directory of the DPDK target directory.
242 This module should be loaded using the insmod command as shown below (assuming that the current directory is the DPDK target directory)::
243
244     sudo insmod kmod/rte_dom0_mm.ko rsv_memsize=X
245
246 The value X cannot be greater than 4096(MB).
247
248 Configuring Memory for DPDK Use
249 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
250
251 After the rte_dom0_mm.ko kernel module has been loaded, the user must configure the memory size for DPDK usage.
252 This is done by echoing the memory size to a memsize file in the /sys/devices/ directory.
253 Use the following command (assuming that 2048 MB is required)::
254
255     echo 2048 > /sys/kernel/mm/dom0-mm/memsize-mB/memsize
256
257 The user can also check how much memory has already been used::
258
259     cat /sys/kernel/mm/dom0-mm/memsize-mB/memsize_rsvd
260
261 Xen Domain0 does not support NUMA configuration, as a result the ``--socket-mem`` command line option is invalid for Xen Domain0.
262
263 .. note::
264
265     The memsize value cannot be greater than the rsv_memsize value.
266
267 Running the DPDK Application on Xen Domain0
268 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
269
270 To run the DPDK application on Xen Domain0, an extra command line option ``--xen-dom0`` is required.