From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: [PATCH] unify tools naming Date: Wed, 20 Jul 2016 16:24:30 +0200 Message-ID: <1469024670-4638-1-git-send-email-thomas.monjalon@6wind.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable To: dev@dpdk.org Return-path: Received: from mail-wm0-f42.google.com (mail-wm0-f42.google.com [74.125.82.42]) by dpdk.org (Postfix) with ESMTP id 539393777 for ; Wed, 20 Jul 2016 16:24:37 +0200 (CEST) Received: by mail-wm0-f42.google.com with SMTP id p129so1199759wmp.0 for ; Wed, 20 Jul 2016 07:24:37 -0700 (PDT) Received: from XPS13.localdomain (184.203.134.77.rev.sfr.net. [77.134.203.184]) by smtp.gmail.com with ESMTPSA id h1sm1539709wjc.19.2016.07.20.07.24.34 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 20 Jul 2016 07:24:34 -0700 (PDT) List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The following tools may be installed system-wise. It may be cleaner and more convenient to find them with the same dpdk- prefix (especially for autocompletion). Moreover, the script dpdk_nic_bind.py deserves a new name because it is not restricted to NICs and can be used for e.g. crypto. These files are renamed: pmdinfogen -> dpdk-pmdinfogen pmdinfo.py -> dpdk-pmdinfo.py dpdk_pdump -> dpdk-pdump dpdk_proc_info -> dpdk-procinfo dpdk_nic_bind.py -> dpdk-devbind.py setup.sh -> dpdk-setup.sh The tools pmdinfogen, pmdinfo.py and dpdk_pdump are new in 16.07. The scripts dpdk_nic_bind.py and setup.sh may have been used with previous releases by end users. That's why a symbolic link still provide the old name in the installed tools directory. Signed-off-by: Thomas Monjalon --- It would be good to have this rename in 16.07 before that pmdinfo.py and dpdk_pdump are widely used. A possible addition to this patch could be renaming the test apps: test -> dpdk-test testacl -> dpdk-testacl testpipeline -> dpdk-testpipeline testpmd -> dpdk-testpmd --- MAINTAINERS | 2 +- app/pdump/Makefile | 2 +- app/proc_info/Makefile | 2 +- buildtools/pmdinfogen/Makefile | 2 +- doc/guides/faq/faq.rst | 2 +- doc/guides/linux_gsg/build_dpdk.rst | 14 +++++++------- doc/guides/linux_gsg/nic_perf_intel_platform.rst | 6 +++--- doc/guides/linux_gsg/quick_start.rst | 12 ++++++------ doc/guides/nics/bnx2x.rst | 4 ++-- doc/guides/nics/cxgbe.rst | 4 ++-- doc/guides/nics/ena.rst | 2 +- doc/guides/nics/enic.rst | 6 +++--- doc/guides/nics/i40e.rst | 4 ++-- doc/guides/nics/intel_vf.rst | 8 ++++---- doc/guides/nics/nfp.rst | 8 ++++---- doc/guides/nics/qede.rst | 2 +- doc/guides/nics/thunderx.rst | 16 ++++++++-------- doc/guides/nics/virtio.rst | 2 +- doc/guides/prog_guide/dev_kit_build_system.rst | 14 +++++++------- doc/guides/rel_notes/release_16_07.rst | 3 +++ doc/guides/sample_app_ug/pdump.rst | 14 +++++++------- doc/guides/sample_app_ug/proc_info.rst | 8 ++++---- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 10 +++++----- doc/guides/xen/pkt_switch.rst | 2 +- lib/librte_eal/common/eal_common_options.c | 4 ++-- mk/internal/rte.compile-pre.mk | 2 +- mk/rte.sdkinstall.mk | 16 ++++++++++------ mk/rte.sdktest.mk | 4 ++-- tools/{dpdk_nic_bind.py =3D> dpdk-devbind.py} | 0 tools/{pmdinfo.py =3D> dpdk-pmdinfo.py} | 4 +--- tools/{setup.sh =3D> dpdk-setup.sh} | 24 ++++++++++++----= -------- 31 files changed, 104 insertions(+), 99 deletions(-) rename tools/{dpdk_nic_bind.py =3D> dpdk-devbind.py} (100%) rename tools/{pmdinfo.py =3D> dpdk-pmdinfo.py} (99%) rename tools/{setup.sh =3D> dpdk-setup.sh} (95%) diff --git a/MAINTAINERS b/MAINTAINERS index 2996b09..3bfcc9f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -70,7 +70,7 @@ F: scripts/validate-abi.sh =20 Driver information F: buildtools/pmdinfogen/ -F: tools/pmdinfo.py +F: tools/dpdk-pmdinfo.py =20 =20 Environment Abstraction Layer diff --git a/app/pdump/Makefile b/app/pdump/Makefile index d85bb08..536198f 100644 --- a/app/pdump/Makefile +++ b/app/pdump/Makefile @@ -33,7 +33,7 @@ include $(RTE_SDK)/mk/rte.vars.mk =20 ifeq ($(CONFIG_RTE_LIBRTE_PDUMP),y) =20 -APP =3D dpdk_pdump +APP =3D dpdk-pdump =20 CFLAGS +=3D $(WERROR_FLAGS) =20 diff --git a/app/proc_info/Makefile b/app/proc_info/Makefile index 33e058e..e051e03 100644 --- a/app/proc_info/Makefile +++ b/app/proc_info/Makefile @@ -31,7 +31,7 @@ =20 include $(RTE_SDK)/mk/rte.vars.mk =20 -APP =3D dpdk_proc_info +APP =3D dpdk-procinfo =20 CFLAGS +=3D $(WERROR_FLAGS) =20 diff --git a/buildtools/pmdinfogen/Makefile b/buildtools/pmdinfogen/Makef= ile index 3885d3b..bd8f900 100644 --- a/buildtools/pmdinfogen/Makefile +++ b/buildtools/pmdinfogen/Makefile @@ -34,7 +34,7 @@ include $(RTE_SDK)/mk/rte.vars.mk # # library name # -HOSTAPP =3D pmdinfogen +HOSTAPP =3D dpdk-pmdinfogen =20 # # all sources are stored in SRCS-y diff --git a/doc/guides/faq/faq.rst b/doc/guides/faq/faq.rst index 3228b92..8d1ea6c 100644 --- a/doc/guides/faq/faq.rst +++ b/doc/guides/faq/faq.rst @@ -50,7 +50,7 @@ When you stop and restart the test application, it look= s to see if the pages are If you look in the directory, you will see ``n`` number of 2M pages file= s. If you specified 1024, you will see 1024 page files. These are then placed in memory segments to get contiguous memory. =20 -If you need to change the number of pages, it is easier to first remove = the pages. The tools/setup.sh script provides an option to do this. +If you need to change the number of pages, it is easier to first remove = the pages. The tools/dpdk-setup.sh script provides an option to do this. See the "Quick Start Setup Script" section in the :ref:`DPDK Getting Sta= rted Guide ` for more information. =20 =20 diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/b= uild_dpdk.rst index fb2c481..f8007b3 100644 --- a/doc/guides/linux_gsg/build_dpdk.rst +++ b/doc/guides/linux_gsg/build_dpdk.rst @@ -198,7 +198,7 @@ however please consult your distributions documentati= on to make sure that is the Also, to use VFIO, both kernel and BIOS must support and be configured t= o use IO virtualization (such as Intel=C2=AE VT-d). =20 For proper operation of VFIO when running DPDK applications as a non-pri= vileged user, correct permissions should also be set up. -This can be done by using the DPDK setup script (called setup.sh and loc= ated in the tools directory). +This can be done by using the DPDK setup script (called dpdk-setup.sh an= d located in the tools directory). =20 .. _linux_gsg_binding_kernel: =20 @@ -224,7 +224,7 @@ and to bind and unbind those ports from the different= kernel modules, including The following are some examples of how the script can be used. A full description of the script and its parameters can be obtained by c= alling the script with the ``--help`` or ``--usage`` options. Note that the uio or vfio kernel modules to be used, should be loaded in= to the kernel before -running the ``dpdk_nic_bind.py`` script. +running the ``dpdk-devbind.py`` script. =20 .. warning:: =20 @@ -238,14 +238,14 @@ running the ``dpdk_nic_bind.py`` script. =20 .. warning:: =20 - While any user can run the dpdk_nic_bind.py script to view the statu= s of the network ports, + While any user can run the dpdk-devbind.py script to view the status= of the network ports, binding or unbinding network ports requires root privileges. =20 To see the status of all network ports on the system: =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --status + ./tools/dpdk-devbind.py --status =20 Network devices using DPDK-compatible driver =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -267,16 +267,16 @@ To bind device ``eth1``,``04:00.1``, to the ``uio_p= ci_generic`` driver: =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind=3Duio_pci_generic 04:00.1 + ./tools/dpdk-devbind.py --bind=3Duio_pci_generic 04:00.1 =20 or, alternatively, =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind=3Duio_pci_generic eth1 + ./tools/dpdk-devbind.py --bind=3Duio_pci_generic eth1 =20 To restore device ``82:00.0`` to its original kernel binding: =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind=3Dixgbe 82:00.0 + ./tools/dpdk-devbind.py --bind=3Dixgbe 82:00.0 diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst b/doc/guide= s/linux_gsg/nic_perf_intel_platform.rst index b433732..d4a8362 100644 --- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst +++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst @@ -192,12 +192,12 @@ Configurations before running DPDK =20 =20 # Bind ports 82:00.0 and 85:00.0 to dpdk driver - ./dpdk_folder/tools/dpdk_nic_bind.py -b igb_uio 82:00.0 85:00.0 + ./dpdk_folder/tools/dpdk-devbind.py -b igb_uio 82:00.0 85:00.0 =20 # Check the port driver status - ./dpdk_folder/tools/dpdk_nic_bind.py --status + ./dpdk_folder/tools/dpdk-devbind.py --status =20 - See ``dpdk_nic_bind.py --help`` for more details. + See ``dpdk-devbind.py --help`` for more details. =20 =20 More details about DPDK setup and Linux kernel requirements see :ref:`li= nux_gsg_compiling_dpdk`. diff --git a/doc/guides/linux_gsg/quick_start.rst b/doc/guides/linux_gsg/= quick_start.rst index 1e0f8ff..8789b58 100644 --- a/doc/guides/linux_gsg/quick_start.rst +++ b/doc/guides/linux_gsg/quick_start.rst @@ -33,7 +33,7 @@ Quick Start Setup Script =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -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 us= er to perform the following tasks: =20 * Build the DPDK libraries =20 @@ -63,7 +63,7 @@ the user may compile their own application that links i= n the EAL libraries to cr Script Organization ------------------- =20 -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 t= hat 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. =20 @@ -98,17 +98,17 @@ The final step has options for restoring the system t= o its original state. Use Cases --------- =20 -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 proce= eding. =20 .. warning:: =20 - The setup.sh script should be run with root privileges. + The dpdk-setup.sh script should be run with root privileges. =20 .. code-block:: console =20 - source tools/setup.sh + source tools/dpdk-setup.sh =20 --------------------------------------------------------------------= ---- =20 @@ -269,7 +269,7 @@ The following selection demonstrates the launch of th= e test application to run o Applications ------------ =20 -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 tar= gets 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 o= ne of the examples provided. =20 The examples in the /examples directory provide a good starting point to= gain an understanding of the operation of the DPDK. diff --git a/doc/guides/nics/bnx2x.rst b/doc/guides/nics/bnx2x.rst index df8fb47..6453168 100644 --- a/doc/guides/nics/bnx2x.rst +++ b/doc/guides/nics/bnx2x.rst @@ -207,7 +207,7 @@ devices managed by ``librte_pmd_bnx2x`` in Linux oper= ating system. #. Bind the QLogic adapters to ``igb_uio`` or ``vfio-pci`` loaded in the previous step:: =20 - ./tools/dpdk_nic_bind.py --bind igb_uio 0000:84:00.0 0000:84:00.1 + ./tools/dpdk-devbind.py --bind igb_uio 0000:84:00.0 0000:84:00.1 =20 or =20 @@ -219,7 +219,7 @@ devices managed by ``librte_pmd_bnx2x`` in Linux oper= ating system. =20 sudo chmod 0666 /dev/vfio/* =20 - ./tools/dpdk_nic_bind.py --bind vfio-pci 0000:84:00.0 0000:84:00.1 + ./tools/dpdk-devbind.py --bind vfio-pci 0000:84:00.0 0000:84:00.1 =20 #. Start ``testpmd`` with basic parameters: =20 diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index d718f19..d8236b0 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -285,7 +285,7 @@ devices managed by librte_pmd_cxgbe in Linux operatin= g system. =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind igb_uio 0000:02:00.4 + ./tools/dpdk-devbind.py --bind igb_uio 0000:02:00.4 =20 or =20 @@ -297,7 +297,7 @@ devices managed by librte_pmd_cxgbe in Linux operatin= g system. =20 sudo chmod 0666 /dev/vfio/* =20 - ./tools/dpdk_nic_bind.py --bind vfio-pci 0000:02:00.4 + ./tools/dpdk-devbind.py --bind vfio-pci 0000:02:00.4 =20 .. note:: =20 diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst index 9f93848..073b35a 100644 --- a/doc/guides/nics/ena.rst +++ b/doc/guides/nics/ena.rst @@ -225,7 +225,7 @@ devices managed by librte_pmd_ena. =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind=3Digb_uio 0000:02:00.1 + ./tools/dpdk-devbind.py --bind=3Digb_uio 0000:02:00.1 =20 #. Start testpmd with basic parameters: =20 diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index e67c3db..2e7d7a4 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -177,13 +177,13 @@ Prerequisites - DPDK suite should be configured based on the user's decision to use VF= IO or UIO framework - If the vNIC device(s) to be used is bound to the kernel mode Ethernet = driver - (enic), use 'ifconfig' to bring the interface down. The dpdk_nic_bind.= py tool + (enic), use 'ifconfig' to bring the interface down. The dpdk-devbind.p= y tool can then be used to unbind the device's bus id from the enic kernel mo= de driver. - Bind the intended vNIC to vfio-pci in case the user wants ENIC PMD to = use - VFIO framework using dpdk_nic_bind.py. + VFIO framework using dpdk-devbind.py. - Bind the intended vNIC to igb_uio in case the user wants ENIC PMD to u= se - UIO framework using dpdk_nic_bind.py. + UIO framework using dpdk-devbind.py. =20 At this point the system should be ready to run DPDK applications. Once = the application runs to completion, the vNIC can be detached from vfio-pci o= r diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index da695af..4d12b10 100644 --- a/doc/guides/nics/i40e.rst +++ b/doc/guides/nics/i40e.rst @@ -164,13 +164,13 @@ devices managed by ``librte_pmd_i40e`` in the Linux= operating system. =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind igb_uio 0000:83:00.0 + ./tools/dpdk-devbind.py --bind igb_uio 0000:83:00.0 =20 Or setup VFIO permissions for regular users and then bind to ``vfio-p= ci``: =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind vfio-pci 0000:83:00.0 + ./tools/dpdk-devbind.py --bind vfio-pci 0000:83:00.0 =20 #. Start ``testpmd`` with basic parameters: =20 diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst index a68198f..95a79b5 100644 --- a/doc/guides/nics/intel_vf.rst +++ b/doc/guides/nics/intel_vf.rst @@ -151,7 +151,7 @@ For example, =20 modprobe uio insmod igb_uio - ./dpdk_nic_bind.py -b igb_uio bb:ss.f + ./dpdk-devbind.py -b igb_uio bb:ss.f echo 2 > /sys/bus/pci/devices/0000\:bb\:ss.f/max_vfs (To enable = two VFs on a specific PCI device) =20 Launch the DPDK testpmd/example or your own host daemon application = using the DPDK PMD library. @@ -236,7 +236,7 @@ For example, =20 modprobe uio insmod igb_uio - ./dpdk_nic_bind.py -b igb_uio bb:ss.f + ./dpdk-devbind.py -b igb_uio bb:ss.f echo 2 > /sys/bus/pci/devices/0000\:bb\:ss.f/max_vfs (To enable = two VFs on a specific PCI device) =20 Launch the DPDK testpmd/example or your own host daemon application = using the DPDK PMD library. @@ -285,7 +285,7 @@ For example, .. code-block:: console =20 insmod igb_uio - ./dpdk_nic_bind.py -b igb_uio bb:ss.f + ./dpdk-devbind.py -b igb_uio bb:ss.f echo 2 > /sys/bus/pci/devices/0000\:bb\:ss.f/max_vfs (To enable = two VFs on a specific pci device) =20 Launch DPDK testpmd/example or your own host daemon application usin= g the DPDK PMD library. @@ -406,7 +406,7 @@ The setup procedure is as follows: =20 modprobe uio insmod igb_uio - ./dpdk_nic_bind.py -b igb_uio 02:00.0 02:00.1 0e:00.0 0e:00.1 + ./dpdk-devbind.py -b igb_uio 02:00.0 02:00.1 0e:00.0 0e:00.1 echo 2 > /sys/bus/pci/devices/0000\:02\:00.0/max_vfs echo 2 > /sys/bus/pci/devices/0000\:02\:00.1/max_vfs echo 2 > /sys/bus/pci/devices/0000\:0e\:00.0/max_vfs diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index e4ebc71..4ef6e02 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -242,9 +242,9 @@ Using the NFP PMD is not different to using other PMD= s. Usual steps are: useful for installing the UIO modules and for binding the right devic= e to those modules avoiding doing so manually: =20 - * **setup.sh** - * **dpdk_nic_bind.py** + * **dpdk-setup.sh** + * **dpdk-devbind.py** =20 - Configuration may be performed by running setup.sh which invokes - dpdk_nic_bind.py as needed. Executing setup.sh will display a menu of + Configuration may be performed by running dpdk-setup.sh which invokes + dpdk-devbind.py as needed. Executing dpdk-setup.sh will display a men= u of configuration options. diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst index f7ca8eb..53d749c 100644 --- a/doc/guides/nics/qede.rst +++ b/doc/guides/nics/qede.rst @@ -177,7 +177,7 @@ devices managed by ``librte_pmd_qede`` in Linux opera= ting system. =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind igb_uio 0000:84:00.0 0000:84:00.1 = \ + ./tools/dpdk-devbind.py --bind igb_uio 0000:84:00.0 0000:84:00.1 \ 0000:84:00.2 0000:84:00.3 =20 #. Start ``testpmd`` with basic parameters: diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst index e38f260..248b1af 100644 --- a/doc/guides/nics/thunderx.rst +++ b/doc/guides/nics/thunderx.rst @@ -146,7 +146,7 @@ managed by ``librte_pmd_thunderx_nicvf`` in the Linux= operating system. =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind vfio-pci 0002:01:00.2 + ./tools/dpdk-devbind.py --bind vfio-pci 0002:01:00.2 =20 #. Start ``testpmd`` with basic parameters: =20 @@ -246,11 +246,11 @@ This section provides instructions to configure SR-= IOV with Linux OS. =20 Unless ``thunder-nicvf`` driver is in use make sure your kernel co= nfig includes ``CONFIG_THUNDER_NIC_VF`` setting. =20 -#. Verify PF/VF bind using ``dpdk_nic_bind.py``: +#. Verify PF/VF bind using ``dpdk-devbind.py``: =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --status + ./tools/dpdk-devbind.py --status =20 Example output: =20 @@ -268,18 +268,18 @@ This section provides instructions to configure SR-= IOV with Linux OS. =20 modprobe vfio-pci =20 -#. Bind VF devices to ``vfio-pci`` using ``dpdk_nic_bind.py``: +#. Bind VF devices to ``vfio-pci`` using ``dpdk-devbind.py``: =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --bind vfio-pci 0002:01:00.1 - ./tools/dpdk_nic_bind.py --bind vfio-pci 0002:01:00.2 + ./tools/dpdk-devbind.py --bind vfio-pci 0002:01:00.1 + ./tools/dpdk-devbind.py --bind vfio-pci 0002:01:00.2 =20 -#. Verify VF bind using ``dpdk_nic_bind.py``: +#. Verify VF bind using ``dpdk-devbind.py``: =20 .. code-block:: console =20 - ./tools/dpdk_nic_bind.py --status + ./tools/dpdk-devbind.py --status =20 Example output: =20 diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst index c6335d4..5431015 100644 --- a/doc/guides/nics/virtio.rst +++ b/doc/guides/nics/virtio.rst @@ -172,7 +172,7 @@ Host2VM communication example modprobe uio echo 512 > /sys/devices/system/node/node0/hugepages/hugepages-20= 48kB/nr_hugepages modprobe uio_pci_generic - python tools/dpdk_nic_bind.py -b uio_pci_generic 00:03.0 + python tools/dpdk-devbind.py -b uio_pci_generic 00:03.0 =20 We use testpmd as the forwarding application in this example. =20 diff --git a/doc/guides/prog_guide/dev_kit_build_system.rst b/doc/guides/= prog_guide/dev_kit_build_system.rst index 18a3010..fa2411f 100644 --- a/doc/guides/prog_guide/dev_kit_build_system.rst +++ b/doc/guides/prog_guide/dev_kit_build_system.rst @@ -309,11 +309,11 @@ Misc Internally Generated Build Tools ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ =20 -``app/pmdinfogen`` +``app/dpdk-pmdinfogen`` =20 =20 -``pmdinfogen`` scans an object (.o) file for various well known symbol n= ames. These -well known symbol names are defined by various macros and used to export +``dpdk-pmdinfogen`` scans an object (.o) file for various well known sym= bol names. +These well known symbol names are defined by various macros and used to = export important information about hardware support and usage for pmd files. F= or instance the macro: =20 @@ -328,10 +328,10 @@ Creates the following symbol: static char this_pmd_name0[] __attribute__((used)) =3D ""; =20 =20 -Which pmdinfogen scans for. Using this information other relevant bits = of data -can be exported from the object file and used to produce a hardware supp= ort -description, that pmdinfogen then encodes into a json formatted string i= n the -following format: +Which ``dpdk-pmdinfogen`` scans for. Using this information other relev= ant +bits of data can be exported from the object file and used to produce a +hardware support description, that ``dpdk-pmdinfogen`` then encodes into= a +json formatted string in the following format: =20 .. code-block:: c =20 diff --git a/doc/guides/rel_notes/release_16_07.rst b/doc/guides/rel_note= s/release_16_07.rst index d3a144f..b79e710 100644 --- a/doc/guides/rel_notes/release_16_07.rst +++ b/doc/guides/rel_notes/release_16_07.rst @@ -289,6 +289,9 @@ API Changes * The function ``rte_eth_dev_set_mtu`` adds a new return value ``-EBUSY`= `, which indicates the operation is forbidden because the port is running. =20 +* The script ``dpdk_nic_bind.py`` is renamed to ``dpdk-devbind.py``. + And the script ``setup.sh`` is renamed to ``dpdk-setup.sh``. + =20 ABI Changes ----------- diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/sample_app_u= g/pdump.rst index ceb038e..ac0e7c9 100644 --- a/doc/guides/sample_app_ug/pdump.rst +++ b/doc/guides/sample_app_ug/pdump.rst @@ -30,15 +30,15 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. =20 =20 -dpdk_pdump Application +dpdk-pdump Application =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -The ``dpdk_pdump`` tool is a Data Plane Development Kit (DPDK) tool that= runs as +The ``dpdk-pdump`` tool is a Data Plane Development Kit (DPDK) tool that= runs as a DPDK secondary process and is capable of enabling packet capture on dp= dk ports. =20 .. Note:: =20 - * The ``dpdk_pdump`` tool depends on libpcap based PMD which is di= sabled + * The ``dpdk-pdump`` tool depends on libpcap based PMD which is di= sabled by default in the build configuration files, owing to an external dependency on the libpcap development files which must be installed on the board. @@ -53,7 +53,7 @@ The tool has a number of command line options: =20 .. code-block:: console =20 - ./build/app/dpdk_pdump -- + ./build/app/dpdk-pdump -- --pdump '(port=3D | device_id=3D), (queue=3D), (rx-dev=3D | @@ -95,10 +95,10 @@ PCI address (or) name of the eth device on which pack= ets should be captured. =20 .. Note:: =20 - * As of now the ``dpdk_pdump`` tool cannot capture the packets of = virtual devices + * As of now the ``dpdk-pdump`` tool cannot capture the packets of = virtual devices in the primary process due to a bug in the ethdev library. Due t= o this bug, in a multi process context, when the primary and secondary have different ports set, then th= e secondary process - (here the ``dpdk_pdump`` tool) overwrites the ``rte_eth_devices[= ]`` entries of the primary process. + (here the ``dpdk-pdump`` tool) overwrites the ``rte_eth_devices[= ]`` entries of the primary process. =20 ``queue``: Queue id of the eth device on which packets should be captured. The user= can pass a queue value of ``*`` to enable @@ -141,4 +141,4 @@ Example =20 .. code-block:: console =20 - $ sudo ./build/app/dpdk_pdump -- --pdump 'port=3D0,queue=3D*,rx-dev=3D= /tmp/rx.pcap' + $ sudo ./build/app/dpdk-pdump -- --pdump 'port=3D0,queue=3D*,rx-dev=3D= /tmp/rx.pcap' diff --git a/doc/guides/sample_app_ug/proc_info.rst b/doc/guides/sample_a= pp_ug/proc_info.rst index 542950b..73f2195 100644 --- a/doc/guides/sample_app_ug/proc_info.rst +++ b/doc/guides/sample_app_ug/proc_info.rst @@ -30,10 +30,10 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. =20 =20 -dpdk_proc_info Application -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D +dpdk-procinfo Application +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D =20 -The dpdk_proc_info application is a Data Plane Development Kit (DPDK) ap= plication +The dpdk-procinfo application is a Data Plane Development Kit (DPDK) app= lication that runs as a DPDK secondary process and is capable of retrieving port statistics, resetting port statistics and printing DPDK memory informati= on. This application extends the original functionality that was supported b= y @@ -45,7 +45,7 @@ The application has a number of command line options: =20 .. code-block:: console =20 - ./$(RTE_TARGET)/app/dpdk_proc_info -- -m | [-p PORTMASK] [--stats | -= -xstats | + ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --= xstats | --stats-reset | --xstats-reset] =20 Parameters diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/tes= tpmd_app_ug/testpmd_funcs.rst index 30e410d..f87e0c2 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -999,7 +999,7 @@ For example, to move a pci device using ixgbe under D= PDK management: .. code-block:: console =20 # Check the status of the available devices. - ./tools/dpdk_nic_bind.py --status + ./tools/dpdk-devbind.py --status =20 Network devices using DPDK-compatible driver =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -1011,11 +1011,11 @@ For example, to move a pci device using ixgbe und= er DPDK management: =20 =20 # Bind the device to igb_uio. - sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0 + sudo ./tools/dpdk-devbind.py -b igb_uio 0000:0a:00.0 =20 =20 # Recheck the status of the devices. - ./tools/dpdk_nic_bind.py --status + ./tools/dpdk-devbind.py --status Network devices using DPDK-compatible driver =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D 0000:0a:00.0 '82599ES 10-Gigabit' drv=3Digb_uio unused=3D @@ -1118,9 +1118,9 @@ For example, to move a pci device under kernel mana= gement: =20 .. code-block:: console =20 - sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0 + sudo ./tools/dpdk-devbind.py -b ixgbe 0000:0a:00.0 =20 - ./tools/dpdk_nic_bind.py --status + ./tools/dpdk-devbind.py --status =20 Network devices using DPDK-compatible driver =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D diff --git a/doc/guides/xen/pkt_switch.rst b/doc/guides/xen/pkt_switch.rs= t index 3a6fc47..00a8f0c 100644 --- a/doc/guides/xen/pkt_switch.rst +++ b/doc/guides/xen/pkt_switch.rst @@ -323,7 +323,7 @@ Building and Running the Switching Backend .. code-block:: console =20 modprobe uio_pci_generic - python tools/dpdk_nic_bind.py -b uio_pci_generic 0000:09:00:00.0 + python tools/dpdk-devbind.py -b uio_pci_generic 0000:09:00:00.0 =20 In this case, 0000:09:00.0 is the PCI address for the NIC controller= . =20 diff --git a/lib/librte_eal/common/eal_common_options.c b/lib/librte_eal/= common/eal_common_options.c index 0a594d7..481c732 100644 --- a/lib/librte_eal/common/eal_common_options.c +++ b/lib/librte_eal/common/eal_common_options.c @@ -116,9 +116,9 @@ TAILQ_HEAD_INITIALIZER(solib_list); static const char *default_solib_dir =3D RTE_EAL_PMD_PATH; =20 /* - * Stringified version of solib path used by pmdinfo.py + * Stringified version of solib path used by dpdk-pmdinfo.py * Note: PLEASE DO NOT ALTER THIS without making a corresponding - * change to tools/pmdinfo.py + * change to tools/dpdk-pmdinfo.py */ static const char dpdk_solib_path[] __attribute__((used)) =3D "DPDK_PLUGIN_PATH=3D" RTE_EAL_PMD_PATH; diff --git a/mk/internal/rte.compile-pre.mk b/mk/internal/rte.compile-pre= .mk index 9c25ff6..f740179 100644 --- a/mk/internal/rte.compile-pre.mk +++ b/mk/internal/rte.compile-pre.mk @@ -84,7 +84,7 @@ C_TO_O =3D $(CC) -Wp,-MD,$(call obj2dep,$(@)).tmp $(CFL= AGS) \ C_TO_O_STR =3D $(subst ','\'',$(C_TO_O)) #'# fix syntax highlight C_TO_O_DISP =3D $(if $(V),"$(C_TO_O_STR)"," CC $(@)") endif -PMDINFO_GEN =3D $(RTE_SDK_BIN)/app/pmdinfogen $@ $@.pmd.c +PMDINFO_GEN =3D $(RTE_SDK_BIN)/app/dpdk-pmdinfogen $@ $@.pmd.c PMDINFO_CC =3D $(CC) $(CFLAGS) -c -o $@.pmd.o $@.pmd.c PMDINFO_LD =3D $(CROSS)ld $(LDFLAGS) -r -o $@.o $@.pmd.o $@ PMDINFO_TO_O =3D if grep -q 'PMD_REGISTER_DRIVER(.*)' $<; then \ diff --git a/mk/rte.sdkinstall.mk b/mk/rte.sdkinstall.mk index 7cd352c..5217063 100644 --- a/mk/rte.sdkinstall.mk +++ b/mk/rte.sdkinstall.mk @@ -117,18 +117,22 @@ install-runtime: $(Q)cp -a $O/lib/* $(DESTDIR)$(libdir) $(Q)$(call rte_mkdir, $(DESTDIR)$(bindir)) $(Q)tar -cf - -C $O --exclude 'app/*.map' \ - --exclude app/pmdinfogen \ + --exclude app/dpdk-pmdinfogen \ --exclude 'app/cmdline*' --exclude app/test \ --exclude app/testacl --exclude app/testpipeline app | \ tar -xf - -C $(DESTDIR)$(bindir) --strip-components=3D1 \ --keep-newer-files --warning=3Dno-ignore-newer $(Q)$(call rte_mkdir, $(DESTDIR)$(datadir)) $(Q)cp -a $(RTE_SDK)/tools $(DESTDIR)$(datadir) + $(Q)$(call rte_symlink, $(DESTDIR)$(datadir)/tools/dpdk-setup.sh, \ + $(DESTDIR)$(datadir)/tools/setup.sh) + $(Q)$(call rte_symlink, $(DESTDIR)$(datadir)/tools/dpdk-devbind.py, = \ + $(DESTDIR)$(datadir)/tools/dpdk_nic_bind.py) $(Q)$(call rte_mkdir, $(DESTDIR)$(sbindir)) - $(Q)$(call rte_symlink, $(DESTDIR)$(datadir)/tools/dpdk_nic_bind.py,= \ - $(DESTDIR)$(sbindir)/dpdk_nic_bind) - $(Q)$(call rte_symlink, $(DESTDIR)$(datadir)/tools/pmdinfo.py, \ - $(DESTDIR)$(bindir)/dpdk_pmdinfo) + $(Q)$(call rte_symlink, $(DESTDIR)$(datadir)/tools/dpdk-devbind.py, = \ + $(DESTDIR)$(sbindir)/dpdk-devbind) + $(Q)$(call rte_symlink, $(DESTDIR)$(datadir)/tools/dpdk-pmdinfo.py, = \ + $(DESTDIR)$(bindir)/dpdk-pmdinfo) =20 install-kmod: ifneq ($(wildcard $O/kmod/*),) @@ -146,7 +150,7 @@ install-sdk: $(Q)cp -a $(RTE_SDK)/scripts $(DESTDIR)$(sdkdir) $(Q)$(call rte_mkdir, $(DESTDIR)$(targetdir)= /app) $(Q)cp -a $O/.config $(DESTDIR)$(targetdir) - $(Q)cp -a $O/app/pmdinfogen $(DESTDIR)$(targetdir)= /app + $(Q)cp -a $O/app/dpdk-pmdinfogen $(DESTDIR)$(targetdir)= /app $(Q)$(call rte_symlink, $(DESTDIR)$(includedir), $(DESTDIR)$(targetdir)= /include) $(Q)$(call rte_symlink, $(DESTDIR)$(libdir), $(DESTDIR)$(targetdir)= /lib) =20 diff --git a/mk/rte.sdktest.mk b/mk/rte.sdktest.mk index ff57181..ddbbbf6 100644 --- a/mk/rte.sdktest.mk +++ b/mk/rte.sdktest.mk @@ -66,7 +66,7 @@ test fast_test perf_test: fi =20 # this is a special target to ease the pain of running coverage tests -# this runs all the autotests, cmdline_test script and dpdk_proc_info +# this runs all the autotests, cmdline_test script and dpdk-procinfo coverage: @mkdir -p $(AUTOTEST_DIR) ; \ cd $(AUTOTEST_DIR) ; \ @@ -78,7 +78,7 @@ coverage: $(RTE_OUTPUT)/app/test \ $(RTE_TARGET) \ $(BLACKLIST) $(WHITELIST) ; \ - $(RTE_OUTPUT)/app/dpdk_proc_info --file-prefix=3Dring_perf -- -m; \ + $(RTE_OUTPUT)/app/dpdk-procinfo --file-prefix=3Dring_perf -- -m; \ else \ echo "No test found, please do a 'make build' first, or specify O=3D" = ;\ fi diff --git a/tools/dpdk_nic_bind.py b/tools/dpdk-devbind.py similarity index 100% rename from tools/dpdk_nic_bind.py rename to tools/dpdk-devbind.py diff --git a/tools/pmdinfo.py b/tools/dpdk-pmdinfo.py similarity index 99% rename from tools/pmdinfo.py rename to tools/dpdk-pmdinfo.py index 662034a..dcc8db8 100755 --- a/tools/pmdinfo.py +++ b/tools/dpdk-pmdinfo.py @@ -1,6 +1,5 @@ #!/usr/bin/env python # ----------------------------------------------------------------------= --- -# scripts/pmdinfo.py # # Utility to dump PMD_INFO_STRING support from an object file # @@ -569,8 +568,7 @@ def main(stream=3DNone): optparser =3D OptionParser( usage=3D'usage: %prog [-hrtp] [-d ', description=3D"Dump pmd hardware support info", - add_help_option=3DTrue, - prog=3D'pmdinfo.py') + add_help_option=3DTrue) optparser.add_option('-r', '--raw', action=3D'store_true', dest=3D'raw_output', help=3D'Dump raw json strings') diff --git a/tools/setup.sh b/tools/dpdk-setup.sh similarity index 95% rename from tools/setup.sh rename to tools/dpdk-setup.sh index 6097ab7..ac81b2e 100755 --- a/tools/setup.sh +++ b/tools/dpdk-setup.sh @@ -32,7 +32,7 @@ # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. =20 # -# Run with "source /path/to/setup.sh" +# Run with "source /path/to/dpdk-setup.sh" # =20 # @@ -422,13 +422,13 @@ grep_meminfo() } =20 # -# Calls dpdk_nic_bind.py --status to show the NIC and what they +# Calls dpdk-devbind.py --status to show the NIC and what they # are all bound to, in terms of drivers. # show_nics() { if [ -d /sys/module/vfio_pci -o -d /sys/module/igb_uio ]; then - ${RTE_SDK}/tools/dpdk_nic_bind.py --status + ${RTE_SDK}/tools/dpdk-devbind.py --status else echo "# Please load the 'igb_uio' or 'vfio-pci' kernel module before " echo "# querying or adjusting NIC device bindings" @@ -436,16 +436,16 @@ show_nics() } =20 # -# Uses dpdk_nic_bind.py to move devices to work with vfio-pci +# Uses dpdk-devbind.py to move devices to work with vfio-pci # bind_nics_to_vfio() { if [ -d /sys/module/vfio_pci ]; then - ${RTE_SDK}/tools/dpdk_nic_bind.py --status + ${RTE_SDK}/tools/dpdk-devbind.py --status echo "" echo -n "Enter PCI address of device to bind to VFIO driver: " read PCI_PATH - sudo ${RTE_SDK}/tools/dpdk_nic_bind.py -b vfio-pci $PCI_PATH && + sudo ${RTE_SDK}/tools/dpdk-devbind.py -b vfio-pci $PCI_PATH && echo "OK" else echo "# Please load the 'vfio-pci' kernel module before querying or " @@ -454,16 +454,16 @@ bind_nics_to_vfio() } =20 # -# Uses dpdk_nic_bind.py to move devices to work with igb_uio +# Uses dpdk-devbind.py to move devices to work with igb_uio # bind_nics_to_igb_uio() { if [ -d /sys/module/igb_uio ]; then - ${RTE_SDK}/tools/dpdk_nic_bind.py --status + ${RTE_SDK}/tools/dpdk-devbind.py --status echo "" echo -n "Enter PCI address of device to bind to IGB UIO driver: " read PCI_PATH - sudo ${RTE_SDK}/tools/dpdk_nic_bind.py -b igb_uio $PCI_PATH && echo "O= K" + sudo ${RTE_SDK}/tools/dpdk-devbind.py -b igb_uio $PCI_PATH && echo "OK= " else echo "# Please load the 'igb_uio' kernel module before querying or " echo "# adjusting NIC device bindings" @@ -471,18 +471,18 @@ bind_nics_to_igb_uio() } =20 # -# Uses dpdk_nic_bind.py to move devices to work with kernel drivers agai= n +# Uses dpdk-devbind.py to move devices to work with kernel drivers again # unbind_nics() { - ${RTE_SDK}/tools/dpdk_nic_bind.py --status + ${RTE_SDK}/tools/dpdk-devbind.py --status echo "" echo -n "Enter PCI address of device to unbind: " read PCI_PATH echo "" echo -n "Enter name of kernel driver to bind the device to: " read DRV - sudo ${RTE_SDK}/tools/dpdk_nic_bind.py -b $DRV $PCI_PATH && echo "OK" + sudo ${RTE_SDK}/tools/dpdk-devbind.py -b $DRV $PCI_PATH && echo "OK" } =20 # --=20 2.7.0