(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.. _linux_setup_script:
+
Quick Start Setup Script
========================
-The setup.sh script, found in the tools subdirectory, allows the user to perform the following tasks:
+The dpdk-setup.sh script, found in the tools subdirectory, allows the user to perform the following tasks:
* Build the DPDK libraries
* Look at hugepages in the meminfo
-* List hugepages in /mnt/huge
+* List hugepages in ``/mnt/huge``
* Remove built DPDK libraries
Script Organization
-------------------
-The setup.sh script is logically organized into a series of steps that a user performs in sequence.
+The dpdk-setup.sh script is logically organized into a series of steps that a user performs in sequence.
Each step provides a number of options that guide the user to completing the desired task.
The following is a brief synopsis of each step.
Use Cases
---------
-The following are some example of how to use the setup.sh script.
+The following are some example of how to use the dpdk-setup.sh script.
The script should be run using the source command.
Some options in the script prompt the user for further data before proceeding.
.. warning::
- The setup.sh script should be run with root privileges.
+ The dpdk-setup.sh script should be run with root privileges.
.. code-block:: console
- user@host:~/rte$ source tools/setup.sh
+ source tools/dpdk-setup.sh
------------------------------------------------------------------------
[2] i686-native-linuxapp-icc
- [3] x86_64-ivshmem-linuxapp-gcc
+ [3] ppc_64-power8-linuxapp-gcc
+
+ [4] x86_64-ivshmem-linuxapp-gcc
- [4] x86_64-ivshmem-linuxapp-icc
+ [5] x86_64-ivshmem-linuxapp-icc
- [5] x86_64-native-bsdapp-gcc
+ [6] x86_64-native-bsdapp-clang
- [6] x86_64-native-linuxapp-gcc
+ [7] x86_64-native-bsdapp-gcc
- [7] x86_64-native-linuxapp-icc
+ [8] x86_64-native-linuxapp-clang
- [8] ppc_64-power8-linuxapp-gcc
+ [9] x86_64-native-linuxapp-gcc
+
+ [10] x86_64-native-linuxapp-icc
------------------------------------------------------------------------
------------------------------------------------------------------------
- [9] Insert IGB UIO module
+ [11] Insert IGB UIO module
- [10] Insert VFIO module
+ [12] Insert VFIO module
- [11] Insert KNI module
+ [13] Insert KNI module
- [12] Setup hugepage mappings for non-NUMA systems
+ [14] Setup hugepage mappings for non-NUMA systems
- [13] Setup hugepage mappings for NUMA systems
+ [15] Setup hugepage mappings for NUMA systems
- [14] Display current Ethernet device settings
+ [16] Display current Ethernet device settings
- [15] Bind Ethernet device to IGB UIO module
+ [17] Bind Ethernet device to IGB UIO module
- [16] Bind Ethernet device to VFIO module
+ [18] Bind Ethernet device to VFIO module
- [17] Setup VFIO permissions
+ [19] Setup VFIO permissions
------------------------------------------------------------------------
------------------------------------------------------------------------
- [18] Run test application ($RTE_TARGET/app/test)
+ [20] Run test application ($RTE_TARGET/app/test)
- [19] Run testpmd application in interactive mode ($RTE_TARGET/app/testpmd)
+ [21] Run testpmd application in interactive mode ($RTE_TARGET/app/testpmd)
------------------------------------------------------------------------
------------------------------------------------------------------------
- [20] List hugepage info from /proc/meminfo
+ [22] List hugepage info from /proc/meminfo
------------------------------------------------------------------------
------------------------------------------------------------------------
- [21] Uninstall all targets
+ [23] Uninstall all targets
- [22] Unbind NICs from IGB UIO driver
+ [24] Unbind NICs from IGB UIO driver
- [23] Remove IGB UIO module
+ [25] Remove IGB UIO module
- [24] Remove VFIO module
+ [26] Remove VFIO module
- [25] Remove KNI module
+ [27] Remove KNI module
- [26] Remove hugepage mappings
+ [28] Remove hugepage mappings
- [27] Exit Script
+ [29] Exit Script
Option:
-The following selection demonstrates the creation of the x86_64-native-linuxapp-gcc DPDK library.
+The following selection demonstrates the creation of the ``x86_64-native-linuxapp-gcc`` DPDK library.
.. code-block:: console
- Option: 4
+ Option: 9
================== Installing x86_64-native-linuxapp-gcc
Configuration done
- == Build scripts
- == Build scripts/testhost
- HOSTCC testhost.o
+ == Build lib
...
Build complete
- RTE_TARGET exported as x86_64-native -linuxapp-gcc
+ RTE_TARGET exported as x86_64-native-linuxapp-gcc
The following selection demonstrates the starting of the DPDK UIO driver.
.. code-block:: console
- Option: 5
+ Option: 25
Unloading any existing DPDK UIO module
Loading DPDK UIO module
The following selection demonstrates the creation of hugepages in a NUMA system.
-1024 2 Mbyte pages are assigned to each node.
+1024 2 MByte pages are assigned to each node.
The result is that the application should use -m 4096 for starting the application to access both memory areas
(this is done automatically if the -m option is not provided).
.. note::
- If prompts are displayed to remove temporary files, type ‘y’.
+ If prompts are displayed to remove temporary files, type 'y'.
.. code-block:: console
- Option: 11
+ Option: 15
Removing currently reserved hugepages
- nmounting /mnt/huge and removing directory
+ mounting /mnt/huge and removing directory
Input the number of 2MB pages for each node
Example: to have 128MB of hugepages available per node,
enter '64' to reserve 64 * 2MB pages on each node
.. code-block:: console
- Option: 14
+ Option: 20
Enter hex bitmask of cores to execute test app on
Example: to execute app on cores 0 to 7, enter 0xff
Applications
------------
-Once the user has run the setup.sh script, built one of the EAL targets and set up hugepages (if using one of the Linux EAL targets),
+Once the user has run the dpdk-setup.sh script, built one of the EAL targets and set up hugepages (if using one of the Linux EAL targets),
the user can then move on to building and running their application or one of the examples provided.
The examples in the /examples directory provide a good starting point to gain an understanding of the operation of the DPDK.
The following command sequence shows how the helloworld sample application is built and run.
-As recommended in Section 4.2.1 , “Logical Core Use by Applications ” on page 14,
+As recommended in Section 4.2.1 , "Logical Core Use by Applications",
the logical core layout of the platform should be determined when selecting a core mask to use for an application.
.. code-block:: console
- rte@rte-desktop:~/rte/examples$ cd helloworld/
- rte@rte-desktop:~/rte/examples/helloworld$ make
- CC main.o
- LD helloworld
- INSTALL-APP helloworld
- INSTALL-MAP helloworld.map
+ cd helloworld/
+ make
+ CC main.o
+ LD helloworld
+ INSTALL-APP helloworld
+ INSTALL-MAP helloworld.map
- rte@rte-desktop:~/rte/examples/helloworld$ sudo ./build/app/helloworld -c 0xf -n 3
+ sudo ./build/app/helloworld -c 0xf -n 3
[sudo] password for rte:
+
EAL: coremask set to f
EAL: Detected lcore 0 as core 0 on socket 0
EAL: Detected lcore 1 as core 0 on socket 1
git.droids-corp.org / dpdk.git / blobdiff