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