1.. BSD LICENSE 2 Copyright(c) 2010-2015 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.. _linux_gsg_compiling_dpdk: 32 33Compiling the DPDK Target from Source 34===================================== 35 36.. note:: 37 38 Parts of this process can also be done using the setup script described in 39 the :ref:`linux_setup_script` section of this document. 40 41Install the DPDK and Browse Sources 42----------------------------------- 43 44First, uncompress the archive and move to the uncompressed DPDK source directory: 45 46.. code-block:: console 47 48 tar xJf dpdk-<version>.tar.xz 49 cd dpdk-<version> 50 51The DPDK is composed of several directories: 52 53* lib: Source code of DPDK libraries 54 55* drivers: Source code of DPDK poll-mode drivers 56 57* app: Source code of DPDK applications (automatic tests) 58 59* examples: Source code of DPDK application examples 60 61* config, buildtools, mk: Framework-related makefiles, scripts and configuration 62 63Installation of DPDK Target Environments 64---------------------------------------- 65 66The format of a DPDK target is:: 67 68 ARCH-MACHINE-EXECENV-TOOLCHAIN 69 70where: 71 72* ``ARCH`` can be: ``i686``, ``x86_64``, ``ppc_64``, ``arm64`` 73 74* ``MACHINE`` can be: ``native``, ``power8``, ``armv8a`` 75 76* ``EXECENV`` can be: ``linuxapp``, ``bsdapp`` 77 78* ``TOOLCHAIN`` can be: ``gcc``, ``icc`` 79 80The targets to be installed depend on the 32-bit and/or 64-bit packages and compilers installed on the host. 81Available targets can be found in the DPDK/config directory. 82The defconfig\_ prefix should not be used. 83 84.. note:: 85 86 Configuration files are provided with the ``RTE_MACHINE`` optimization level set. 87 Within the configuration files, the ``RTE_MACHINE`` configuration value is set to native, 88 which means that the compiled software is tuned for the platform on which it is built. 89 For more information on this setting, and its possible values, see the *DPDK Programmers Guide*. 90 91When using the Intel® C++ Compiler (icc), one of the following commands should be invoked for 64-bit or 32-bit use respectively. 92Notice that the shell scripts update the ``$PATH`` variable and therefore should not be performed in the same session. 93Also, verify the compiler's installation directory since the path may be different: 94 95.. code-block:: console 96 97 source /opt/intel/bin/iccvars.sh intel64 98 source /opt/intel/bin/iccvars.sh ia32 99 100To install and make targets, use the ``make install T=<target>`` command in the top-level DPDK directory. 101 102For example, to compile a 64-bit target using icc, run: 103 104.. code-block:: console 105 106 make install T=x86_64-native-linuxapp-icc 107 108To compile a 32-bit build using gcc, the make command should be: 109 110.. code-block:: console 111 112 make install T=i686-native-linuxapp-gcc 113 114To prepare a target without building it, for example, if the configuration changes need to be made before compilation, 115use the ``make config T=<target>`` command: 116 117.. code-block:: console 118 119 make config T=x86_64-native-linuxapp-gcc 120 121.. warning:: 122 123 Any kernel modules to be used, e.g. ``igb_uio``, ``kni``, must be compiled with the 124 same kernel as the one running on the target. 125 If the DPDK is not being built on the target machine, 126 the ``RTE_KERNELDIR`` environment variable should be used to point the compilation at a copy of the kernel version to be used on the target machine. 127 128Once the target environment is created, the user may move to the target environment directory and continue to make code changes and re-compile. 129The user may also make modifications to the compile-time DPDK configuration by editing the .config file in the build directory. 130(This is a build-local copy of the defconfig file from the top- level config directory). 131 132.. code-block:: console 133 134 cd x86_64-native-linuxapp-gcc 135 vi .config 136 make 137 138In addition, the make clean command can be used to remove any existing compiled files for a subsequent full, clean rebuild of the code. 139 140Browsing the Installed DPDK Environment Target 141---------------------------------------------- 142 143Once a target is created it contains all libraries, including poll-mode drivers, and header files for the DPDK environment that are required to build customer applications. 144In addition, the test and testpmd applications are built under the build/app directory, which may be used for testing. 145A kmod directory is also present that contains kernel modules which may be loaded if needed. 146