xref: /dpdk/doc/guides/testpmd_app_ug/build_app.rst (revision e76d7a768ce085c140e41f338f45d50118964ae3)
1ac718398SBernard Iremonger..  BSD LICENSE
2ac718398SBernard Iremonger    Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
3ac718398SBernard Iremonger    All rights reserved.
4ac718398SBernard Iremonger
5ac718398SBernard Iremonger    Redistribution and use in source and binary forms, with or without
6ac718398SBernard Iremonger    modification, are permitted provided that the following conditions
7ac718398SBernard Iremonger    are met:
8ac718398SBernard Iremonger
9ac718398SBernard Iremonger    * Redistributions of source code must retain the above copyright
10ac718398SBernard Iremonger    notice, this list of conditions and the following disclaimer.
11ac718398SBernard Iremonger    * Redistributions in binary form must reproduce the above copyright
12ac718398SBernard Iremonger    notice, this list of conditions and the following disclaimer in
13ac718398SBernard Iremonger    the documentation and/or other materials provided with the
14ac718398SBernard Iremonger    distribution.
15ac718398SBernard Iremonger    * Neither the name of Intel Corporation nor the names of its
16ac718398SBernard Iremonger    contributors may be used to endorse or promote products derived
17ac718398SBernard Iremonger    from this software without specific prior written permission.
18ac718398SBernard Iremonger
19ac718398SBernard Iremonger    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20ac718398SBernard Iremonger    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21ac718398SBernard Iremonger    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22ac718398SBernard Iremonger    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23ac718398SBernard Iremonger    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24ac718398SBernard Iremonger    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25ac718398SBernard Iremonger    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26ac718398SBernard Iremonger    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27ac718398SBernard Iremonger    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28ac718398SBernard Iremonger    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29ac718398SBernard Iremonger    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30ac718398SBernard Iremonger
31ac718398SBernard IremongerCompiling the Application
32ac718398SBernard Iremonger=========================
33ac718398SBernard Iremonger
34*e76d7a76SJohn McNamaraThe ``testpmd`` application is compiled as part of the main compilation of the DPDK libraries and tools.
35*e76d7a76SJohn McNamaraRefer to the DPDK Getting Started Guides for details.
36ac718398SBernard IremongerThe basic compilation steps are:
37ac718398SBernard Iremonger
38ac718398SBernard Iremonger#.  Set the required environmental variables and go to the source directory:
39ac718398SBernard Iremonger
40ac718398SBernard Iremonger    .. code-block:: console
41ac718398SBernard Iremonger
42ac718398SBernard Iremonger        export RTE_SDK=/path/to/rte_sdk
43ac718398SBernard Iremonger        cd $RTE_SDK
44ac718398SBernard Iremonger
45ac718398SBernard Iremonger#.  Set the compilation target. For example:
46ac718398SBernard Iremonger
47ac718398SBernard Iremonger    .. code-block:: console
48ac718398SBernard Iremonger
49ac718398SBernard Iremonger        export RTE_TARGET=x86_64-native-linuxapp-gcc
50ac718398SBernard Iremonger
51ac718398SBernard Iremonger#.  Build the application:
52ac718398SBernard Iremonger
53ac718398SBernard Iremonger    .. code-block:: console
54ac718398SBernard Iremonger
55ac718398SBernard Iremonger        make install T=$RTE_TARGET
56ac718398SBernard Iremonger
57ac718398SBernard Iremonger    The compiled application will be located at:
58ac718398SBernard Iremonger
59ac718398SBernard Iremonger    .. code-block:: console
60ac718398SBernard Iremonger
61ac718398SBernard Iremonger        $RTE_SDK/$RTE_TARGET/build/app/testpmd
62