Development Kit Build System
============================
-The Intel® DPDK requires a build system for compilation activities and so on.
-This section describes the constraints and the mechanisms used in the Intel® DPDK framework.
+The DPDK requires a build system for compilation activities and so on.
+This section describes the constraints and the mechanisms used in the DPDK framework.
There are two use-cases for the framework:
-* Compilation of the Intel® DPDK libraries and sample applications;
+* Compilation of the DPDK libraries and sample applications;
the framework generates specific binary libraries,
include files and sample applications
-* Compilation of an external application or library, using an installed binary Intel® DPDK
+* Compilation of an external application or library, using an installed binary DPDK
Building the Development Kit Binary
-----------------------------------
-The following provides details on how to build the Intel® DPDK binary.
+The following provides details on how to build the DPDK binary.
Build Directory Concept
~~~~~~~~~~~~~~~~~~~~~~~
librte_cmdline.a librte_lpm.a librte_mempool.a librte_ring.a
- librte_eal.a librte_malloc.a librte_pmd_e1000.a librte_timer.a
+ librte_eal.a librte_pmd_e1000.a librte_timer.a
~/DEV/DPDK$ ls i686-native-linuxapp-gcc/include/
Refer to
:ref:`Development Kit Root Makefile Help <Development_Kit_Root_Makefile_Help>`
-for details about make commands that can be used from the root of Intel® DPDK.
+for details about make commands that can be used from the root of DPDK.
Building External Applications
------------------------------
-Since Intel® DPDK is in essence a development kit, the first objective of end users will be to create an application using this SDK.
+Since DPDK is in essence a development kit, the first objective of end users will be to create an application using this SDK.
To compile an application, the user must set the RTE_SDK and RTE_TARGET environment variables.
.. code-block:: console
cd /path/to/my_app
For a new application, the user must create their own Makefile that includes some .mk files, such as
-${RTE_SDK}/mk/DPDK.vars.mk, and ${RTE_SDK}/mk/ DPDK.app.mk.
+${RTE_SDK}/mk/rte.vars.mk, and ${RTE_SDK}/mk/ rte.app.mk.
This is described in
:ref:`Building Your Own Application <Building_Your_Own_Application>`.
Makefile Description
--------------------
-General Rules For Intel® DPDK Makefiles
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+General Rules For DPDK Makefiles
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-In the Intel® DPDK, Makefiles always follow the same scheme:
+In the DPDK, Makefiles always follow the same scheme:
-#. Include $(RTE_SDK)/mk/DPDK.vars.mk at the beginning.
+#. Include $(RTE_SDK)/mk/rte.vars.mk at the beginning.
#. Define specific variables for RTE build system.
-#. Include a specific $(RTE_SDK)/mk/DPDK.XYZ.mk, where XYZ can be app, lib, extapp, extlib, obj, gnuconfigure,
+#. Include a specific $(RTE_SDK)/mk/rte.XYZ.mk, where XYZ can be app, lib, extapp, extlib, obj, gnuconfigure,
and so on, depending on what kind of object you want to build.
:ref:`See Makefile Types <Makefile_Types>` below.
.. code-block:: make
- include $(RTE_SDK)/mk/DPDK.vars.mk
+ include $(RTE_SDK)/mk/rte.vars.mk
# binary name
APP = helloworld
CFLAGS += -O3
CFLAGS += $(WERROR_FLAGS)
- include $(RTE_SDK)/mk/DPDK.extapp.mk
+ include $(RTE_SDK)/mk/rte.extapp.mk
.. _Makefile_Types:
* rte.doc.mk: Documentation in the development kit framework
-* rte.gnuconfigure.mk: Build an application that is configure-based (used to compile *newlib*).
+* rte.gnuconfigure.mk: Build an application that is configure-based.
* rte.subdir.mk: Build several directories in the development kit framework.
Useful Variables Provided by the Build System
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-* RTE_SDK: The absolute path to the Intel® DPDK sources.
+* RTE_SDK: The absolute path to the DPDK sources.
When compiling the development kit, this variable is automatically set by the framework.
It has to be defined by the user as an environment variable if compiling an external application.
When compiling an external application, the variable points to the root of external application sources.
* RTE_OUTPUT: The path to which output files are written.
- Typically, it is $(RTE_SRCDIR)/build, but it can be overriden by the O= option in the make command line.
+ Typically, it is $(RTE_SRCDIR)/build, but it can be overridden by the O= option in the make command line.
* RTE_TARGET: A string identifying the target for which we are building.
The format is arch-machine-execenv-toolchain.
* SYMLINK-y-$(INSTPATH): A list of files to be installed in $(INSTPATH).
The files must be available from VPATH and will be linked (symbolically) in $(RTE_OUTPUT)/$(INSTPATH).
- This variable can be used in almost any Intel® DPDK Makefile.
+ This variable can be used in almost any DPDK Makefile.
* PREBUILD: A list of prerequisite actions to be taken before building. The user should use += to append data in this variable.
* LDFLAGS_my_app: Specific flags to add when linking my_app.
-* NO_AUTOLIBS: If set, the libraries provided by the framework will not be included in the LDLIBS variable automatically.
-
* EXTRA_CFLAGS: The content of this variable is appended after CFLAGS when compiling.
* EXTRA_LDFLAGS: The content of this variable is appended after LDFLAGS when linking.
+* EXTRA_LDLIBS: The content of this variable is appended after LDLIBS when linking.
+
* EXTRA_ASFLAGS: The content of this variable is appended after ASFLAGS when assembling.
* EXTRA_CPPFLAGS: The content of this variable is appended after CPPFLAGS when using a C preprocessor on assembly files.
git.droids-corp.org / dpdk.git / blobdiff