doc: add note about CPU 0
PATCH v3 1/2 doc: add note about CPU 0
On Linux (and probably BSD), CPU 0 can not be fully isolated because it receives timer interrupts and is used for other kernel related functions. The DPDK documentation should be updated to tell users to avoid polling on that CPU.
--- doc/guides/linux_gsg/enable_func.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)
doc/guides/linux_gsg/enable_func.rst +7 -2
@@ -131,9 +131,14 @@ from running on those cores, it is possible to use the Linux kernel parameters ``isolcpus``, ``nohz_full``, ``irqaffinity`` to isolate them from the general Linux scheduler tasks. +.. note:: + + It is not recommended to use CPU core 0 for DPDK polling applications + because it can not be isolated from other system and kernel activity. + For example, if a given CPU has 0-7 cores -and DPDK applications are to run on logical cores 2, 4 and 6, -the following should be added to the kernel parameter list: +and DPDK applications are to run on logical cores 2, 4 and 6. +The following should be added to the kernel parameter list: .. code-block:: console
Signature · 1 line
2.43.0
PATCH v3 2/2 doc: remove use of -n 4 option in documentation
Many places in the documentation are using -n 4 to set the number of memory channels. This should not be recommended since it is not always right and the default should be used instead.
--- doc/guides/contributing/documentation.rst | 2 +- doc/guides/cryptodevs/aesni_gcm.rst | 2 +- doc/guides/cryptodevs/aesni_mb.rst | 2 +- doc/guides/cryptodevs/ccp.rst | 4 ++-- doc/guides/cryptodevs/kasumi.rst | 2 +- doc/guides/cryptodevs/null.rst | 2 +- doc/guides/cryptodevs/openssl.rst | 2 +- doc/guides/cryptodevs/snow3g.rst | 2 +- doc/guides/cryptodevs/zuc.rst | 2 +- doc/guides/howto/lm_bond_virtio_sriov.rst | 2 +- doc/guides/howto/lm_virtio_vhost_user.rst | 2 +- doc/guides/howto/packet_capture_framework.rst | 2 +- doc/guides/howto/pvp_reference_benchmark.rst | 4 ++-- doc/guides/howto/vfd.rst | 4 ++-- .../virtio_user_for_container_networking.rst | 4 ++-- doc/guides/linux_gsg/build_sample_apps.rst | 2 +- doc/guides/linux_gsg/linux_drivers.rst | 4 ++-- doc/guides/nics/build_and_test.rst | 2 +- doc/guides/nics/cpfl.rst | 2 +- doc/guides/nics/cxgbe.rst | 2 +- doc/guides/nics/fail_safe.rst | 8 ++++---- doc/guides/nics/hns3.rst | 4 ++-- doc/guides/nics/i40e.rst | 6 +++--- doc/guides/nics/ice.rst | 4 ++-- doc/guides/nics/intel_vf.rst | 2 +- doc/guides/nics/ipn3ke.rst | 4 ++-- doc/guides/nics/mlx4.rst | 2 +- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/null.rst | 6 +++--- doc/guides/nics/pcap_ring.rst | 18 ++++++++--------- doc/guides/nics/qede.rst | 2 +- doc/guides/nics/softnic.rst | 2 +- doc/guides/nics/thunderx.rst | 2 +- doc/guides/nics/vhost.rst | 2 +- doc/guides/nics/virtio.rst | 2 +- .../link_bonding_poll_mode_drv_lib.rst | 10 +++++----- doc/guides/prog_guide/overview.rst | 11 +++++----- doc/guides/sample_app_ug/cmd_line.rst | 2 +- doc/guides/sample_app_ug/dist_app.rst | 2 +- doc/guides/sample_app_ug/hello_world.rst | 2 +- doc/guides/sample_app_ug/ipsec_secgw.rst | 4 ++-- doc/guides/sample_app_ug/keep_alive.rst | 2 +- doc/guides/sample_app_ug/l2_forward_cat.rst | 4 ++-- doc/guides/sample_app_ug/l2_forward_event.rst | 8 ++++---- .../sample_app_ug/l2_forward_job_stats.rst | 2 +- .../sample_app_ug/l2_forward_real_virtual.rst | 4 ++-- doc/guides/sample_app_ug/l3_forward.rst | 8 ++++---- doc/guides/sample_app_ug/l3_forward_graph.rst | 6 +++--- doc/guides/sample_app_ug/link_status_intr.rst | 2 +- doc/guides/sample_app_ug/multi_process.rst | 20 +++++++++---------- doc/guides/sample_app_ug/ptpclient.rst | 2 +- doc/guides/sample_app_ug/qos_scheduler.rst | 4 ++-- doc/guides/sample_app_ug/rxtx_callbacks.rst | 2 +- doc/guides/sample_app_ug/skeleton.rst | 2 +- doc/guides/sample_app_ug/timer.rst | 2 +- doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/sample_app_ug/vhost.rst | 2 +- .../sample_app_ug/vm_power_management.rst | 6 +++--- .../sample_app_ug/vmdq_dcb_forwarding.rst | 2 +- doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +- doc/guides/testpmd_app_ug/run_app.rst | 2 +- doc/guides/tools/flow-perf.rst | 2 +- 62 files changed, 117 insertions(+), 116 deletions(-)
doc/guides/contributing/documentation.rst +1 -1
@@ -253,7 +253,7 @@ Line Length and Wrapping Long literal command lines can be shown wrapped with backslashes. For example:: - dpdk-testpmd -l 2-3 -n 4 \ + dpdk-testpmd -l 2-3 \ --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \ -- -i --tx-offloads=0x0000002c --enable-lro --txq=2 --rxq=2 \ --txd=1024 --rxd=1024
doc/guides/cryptodevs/aesni_gcm.rst +1 -1
@@ -103,5 +103,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"
doc/guides/cryptodevs/aesni_mb.rst +1 -1
@@ -161,7 +161,7 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac" Extra notes
doc/guides/cryptodevs/ccp.rst +2 -2
@@ -94,7 +94,7 @@ To validate ccp PMD, l2fwd-crypto example can be used with following command: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1 + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 --vdev "crypto_ccp" -- -p 0x1 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
@@ -109,7 +109,7 @@ following: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1 + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
doc/guides/cryptodevs/kasumi.rst +1 -1
@@ -109,7 +109,7 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "kasumi-f8" Extra notes on KASUMI F9
doc/guides/cryptodevs/null.rst +1 -1
@@ -67,5 +67,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
doc/guides/cryptodevs/openssl.rst +1 -1
@@ -80,7 +80,7 @@ To verify real traffic l2fwd-crypto example can be used with this command: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_openssl" + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 --vdev "crypto_openssl" --vdev "crypto_openssl"-- -p 0x3 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo AES_CBC --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
doc/guides/cryptodevs/snow3g.rst +1 -1
@@ -118,5 +118,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2"
doc/guides/cryptodevs/zuc.rst +1 -1
@@ -117,5 +117,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3"
doc/guides/howto/lm_bond_virtio_sriov.rst +1 -1
@@ -614,7 +614,7 @@ Run testpmd in the Virtual Machine. # use for bonding of virtio and vf tests in VM /root/dpdk/<build_dir>/app/dpdk-testpmd \ - -l 0-3 -n 4 --socket-mem 350 -- --i --port-topology=chained + -l 0-3 --socket-mem 350 -- --i --port-topology=chained .. _lm_bond_virtio_sriov_switch_conf:
doc/guides/howto/lm_virtio_vhost_user.rst +1 -1
@@ -438,4 +438,4 @@ run_testpmd_in_vm.sh # test system has 8 cpus (0-7), use cpus 2-7 for VM /root/dpdk/<build_dir>/app/dpdk-testpmd \ - -l 0-5 -n 4 --socket-mem 350 -- --burst=64 --i + -l 0-5 --socket-mem 350 -- --burst=64 --i
doc/guides/howto/packet_capture_framework.rst +1 -1
@@ -89,7 +89,7 @@ inspect them using ``tcpdump``. #. Launch testpmd as the primary application:: - sudo <build_dir>/app/dpdk-testpmd -c 0xf0 -n 4 -- -i --port-topology=chained + sudo <build_dir>/app/dpdk-testpmd -c 0xf0 -- -i --port-topology=chained #. Launch the dpdk-dumpcap as follows::
doc/guides/howto/pvp_reference_benchmark.rst +2 -2
@@ -122,7 +122,7 @@ Testpmd launch .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 0,2,3,4,5 --socket-mem=1024 -n 4 \ + <build_dir>/app/dpdk-testpmd -l 0,2,3,4,5 --socket-mem=1024 \ --vdev 'net_vhost0,iface=/tmp/vhost-user1' \ --vdev 'net_vhost1,iface=/tmp/vhost-user2' -- \ --portmask=f -i --rxq=1 --txq=1 \
@@ -332,7 +332,7 @@ Start testpmd: .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 0,1,2 --socket-mem 1024 -n 4 \ + <build_dir>/app/dpdk-testpmd -l 0,1,2 --socket-mem 1024 \ --proc-type auto --file-prefix pg -- \ --portmask=3 --forward-mode=macswap --port-topology=chained \ --disable-rss -i --rxq=1 --txq=1 \
doc/guides/howto/vfd.rst +2 -2
@@ -83,7 +83,7 @@ The typical procedure to achieve this is as follows: #. Run a DPDK application on the PF in the host:: - dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0 + dpdk-testpmd -l 0-7 -- -i --txqflags=0 #. Bind the VF port to ``igb_uio`` in the VM::
@@ -91,7 +91,7 @@ The typical procedure to achieve this is as follows: #. Run a DPDK application on the VF in the VM:: - dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0 + dpdk-testpmd -l 0-7 -- -i --txqflags=0 Common functions of IXGBE and I40E
doc/guides/howto/virtio_user_for_container_networking.rst +2 -2
@@ -77,7 +77,7 @@ some minor changes. .. code-block:: console - $(testpmd) -l 0-1 -n 4 --socket-mem 1024,1024 \ + $(testpmd) -l 0-1 --socket-mem 1024,1024 \ --vdev 'eth_vhost0,iface=/tmp/sock0' \ --file-prefix=host --no-pci -- -i
@@ -87,7 +87,7 @@ some minor changes. docker run -i -t -v /tmp/sock0:/var/run/usvhost \ -v /dev/hugepages:/dev/hugepages \ - dpdk-app-testpmd testpmd -l 6-7 -n 4 -m 1024 --no-pci \ + dpdk-app-testpmd testpmd -l 6-7 -m 1024 --no-pci \ --vdev=virtio_user0,path=/var/run/usvhost \ --file-prefix=container \ -- -i
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -114,7 +114,7 @@ Copy the DPDK application binary to your target, then run the application as fol (assuming the platform has four memory channels per processor socket, and that cores 0-3 are present and are to be used for running the application):: - ./dpdk-helloworld -l 0-3 -n 4 + ./dpdk-helloworld -l 0-3 .. note::
doc/guides/linux_gsg/linux_drivers.rst +2 -2
@@ -252,14 +252,14 @@ The token will be used for all PF and VF ports within the application. .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -a 86:00.0 \ + <build_dir>/app/dpdk-testpmd -l 22-25 -a 86:00.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i #. Start the DPDK application that will manage the VF device .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -a 86:02.0 \ + <build_dir>/app/dpdk-testpmd -l 26-29 -a 86:02.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=vf0 -- -i .. note::
doc/guides/nics/build_and_test.rst +1 -1
@@ -133,7 +133,7 @@ This section demonstrates how to setup and run ``testpmd`` in Linux. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -- -i Successful execution will show initialization messages from EAL, PMD and testpmd application. A prompt will be displayed at the end for user commands
doc/guides/nics/cpfl.rst +1 -1
@@ -208,7 +208,7 @@ low level hardware resources. .. code-block:: console - dpdk-testpmd -c 0x3 -n 4 -a 0000:af:00.6,vport=[0-1],flow_parser="refpkg.json" -- -i + dpdk-testpmd -c 0x3 -a 0000:af:00.6,vport=[0-1],flow_parser="refpkg.json" -- -i #. Create one flow to forward ETH-IPV4-TCP from I/O port to a local(CPF's) vport. Flow should be created on vport X. Group M should match fxp module. Action port_representor Y means forward packet to local vport Y::
doc/guides/nics/cxgbe.rst +1 -1
@@ -749,7 +749,7 @@ devices managed by librte_net_cxgbe in FreeBSD operating system. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -a 0000:02:00.4 -- -i Example output:
doc/guides/nics/fail_safe.rst +4 -4
@@ -116,7 +116,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \ + ./<build_dir>/app/dpdk-testpmd -c 0xff \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -b 84:00.0 -b 00:04.0 -- -i
@@ -130,7 +130,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \ + ./<build_dir>/app/dpdk-testpmd -c 0xff \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -a 81:00.0 -- -i
@@ -138,7 +138,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -a ff:ff.f \ + ./<build_dir>/app/dpdk-testpmd -c 0xff -a ff:ff.f \ --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i #. Start testpmd, automatically probing the device 84:00.0 and using it with
@@ -146,7 +146,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \ + ./<build_dir>/app/dpdk-testpmd -c 0xff \ --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i
doc/guides/nics/hns3.rst +2 -2
@@ -201,7 +201,7 @@ To start ``testpmd``, and add VLAN 10 to port 0: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --forward-mode=mac + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --forward-mode=mac ... testpmd> set promisc 0 off
@@ -222,7 +222,7 @@ Start ``testpmd``: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --rxq=8 --txq=8 \ + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --rxq=8 --txq=8 \ --nb-cores=8 --nb-ports=1 Add a rule to direct ``ipv4-udp`` packet whose ``dst_ip=2.2.2.5, src_ip=2.2.2.3,
doc/guides/nics/i40e.rst +3 -3
@@ -401,7 +401,7 @@ To start ``testpmd``, and add vlan 10 to port 0: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --forward-mode=mac + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --forward-mode=mac ... testpmd> set promisc 0 off
@@ -436,7 +436,7 @@ Start ``testpmd`` with ``--disable-rss`` and ``--pkt-filter-mode=perfect``: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --disable-rss \ + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --disable-rss \ --pkt-filter-mode=perfect --rxq=8 --txq=8 --nb-cores=8 \ --nb-ports=1
@@ -1012,7 +1012,7 @@ See :numref:`figure_intel_perf_test_setup` for the performance test setup. #. The command line of running l3fwd would be something like the following:: - ./dpdk-l3fwd -l 18-21 -n 4 -a 82:00.0 -a 85:00.0 \ + ./dpdk-l3fwd -l 18-21 -a 82:00.0 -a 85:00.0 \ -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)' This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding,
doc/guides/nics/ice.rst +2 -2
@@ -420,7 +420,7 @@ Additional Options #. Bind the VF0, and run testpmd with 'cap=dcf' with port representor for VF 1 and 2:: - dpdk-testpmd -l 22-25 -n 4 -a 18:01.0,cap=dcf,representor=vf[1-2] -- -i + dpdk-testpmd -l 22-25 -a 18:01.0,cap=dcf,representor=vf[1-2] -- -i #. Monitor the VF2 interface network traffic::
@@ -449,7 +449,7 @@ To start ``testpmd``, and add vlan 10 to port 0: .. code-block:: console - ./app/dpdk-testpmd -l 0-15 -n 4 -- -i + ./app/dpdk-testpmd -l 0-15 -- -i ... testpmd> rx_vlan add 10 0
doc/guides/nics/intel_vf.rst +1 -1
@@ -521,7 +521,7 @@ The setup procedure is as follows: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -- -i #. Finally, access the Guest OS using vncviewer with the localhost:5900 port and check the lspci command output in the Guest OS. The virtual functions will be listed as available for use.
doc/guides/nics/ipn3ke.rst +2 -2
@@ -76,7 +76,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop + ./<build_dir>/app/dpdk-testpmd -l 0-15 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop HQoS and flow acceleration ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -87,7 +87,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port, enable FPGA HQoS and .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap + ./<build_dir>/app/dpdk-testpmd -l 0-15 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap Limitations or Known issues ---------------------------
doc/guides/nics/mlx4.rst +1 -1
@@ -428,7 +428,7 @@ devices managed by librte_net_mlx4. #. Start testpmd with basic parameters:: - dpdk-testpmd -l 8-15 -n 4 -a 0000:83:00.0 -a 0000:84:00.0 -- --rxq=2 --txq=2 -i + dpdk-testpmd -l 8-15 -a 0000:83:00.0 -a 0000:84:00.0 -- --rxq=2 --txq=2 -i Example output::
doc/guides/nics/mlx5.rst +1 -1
@@ -2112,7 +2112,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5. #. Start testpmd with basic parameters:: - dpdk-testpmd -l 8-15 -n 4 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i + dpdk-testpmd -l 8-15 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i Example output::
doc/guides/nics/null.rst +3 -3
@@ -14,7 +14,7 @@ Usage .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev net_null0 --vdev net_null1 -- -i Runtime Configuration
@@ -26,7 +26,7 @@ Runtime Configuration .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev "net_null0,copy=1" -- -i - ``size`` [optional, default=64 bytes]
@@ -35,7 +35,7 @@ Runtime Configuration .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev "net_null0,size=256" -- -i - ``no-rx`` [optional, default disabled]
doc/guides/nics/pcap_ring.rst +9 -9
@@ -40,7 +40,7 @@ Device name and stream options must be separated by commas as shown below: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,stream_opt0=..,stream_opt1=..' \ --vdev='net_pcap1,stream_opt0=..'
@@ -139,7 +139,7 @@ Read packets from one pcap file and write them to another: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained
@@ -147,7 +147,7 @@ Read packets from a network interface and write them to a pcap file: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface=eth0,tx_pcap=file_tx.pcap' \ -- --port-topology=chained
@@ -155,7 +155,7 @@ Read packets from a pcap file and write them to a network interface: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_iface=eth1' \ -- --port-topology=chained
@@ -163,14 +163,14 @@ Forward packets through two network interfaces: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,iface=eth0' --vdev='net_pcap1,iface=eth1' Enable 2 tx queues on a network interface: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface=eth1,tx_iface=eth1,tx_iface=eth1' \ -- --txq 2
@@ -178,7 +178,7 @@ Read only incoming packets from a network interface and write them back to the s .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface_in=eth1,tx_iface=eth1' Using libpcap-based PMD with the testpmd Application
@@ -203,7 +203,7 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained --no-flush-rx
@@ -223,7 +223,7 @@ Multiple devices may be specified, separated by commas. .. code-block:: console - ./dpdk-testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i + ./dpdk-testpmd -l 1-3 --vdev=net_ring0 --vdev=net_ring1 -- -i EAL: Detected lcore 1 as core 1 on socket 0 ...
doc/guides/nics/qede.rst +1 -1
@@ -272,7 +272,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - dpdk-testpmd -l 0,4-11 -n 4 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \ + dpdk-testpmd -l 0,4-11 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \ --txd=4096 --txfreet=4068 --enable-rx-cksum --rxq=4 --txq=4 \ --rss-ip --rss-udp
doc/guides/nics/softnic.rst +1 -1
@@ -366,7 +366,7 @@ commands. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0x7 -s 0x4 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -c 0x7 -s 0x4 \ --vdev 'net_softnic0, \ firmware=./drivers/net/softnic/ \ firmware.cli, \
doc/guides/nics/thunderx.rst +1 -1
@@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0002:01:00.2 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 -a 0002:01:00.2 \ -- -i --no-flush-rx \ --port-topology=loop
doc/guides/nics/vhost.rst +1 -1
@@ -96,7 +96,7 @@ This section demonstrates vhost PMD with testpmd DPDK sample application. .. code-block:: console - ./dpdk-testpmd -l 0-3 -n 4 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i + ./dpdk-testpmd -l 0-3 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i Other basic DPDK preparations like hugepage enabling here. Please refer to the *DPDK Getting Started Guide* for detailed instructions.
doc/guides/nics/virtio.rst +1 -1
@@ -183,7 +183,7 @@ There is no vector callbacks for packed virtqueue for now. Example of using the vector version of the virtio poll mode driver in ``testpmd``:: - dpdk-testpmd -l 0-2 -n 4 -- -i --rxq=1 --txq=1 --nb-cores=1 + dpdk-testpmd -l 0-2 -- -i --rxq=1 --txq=1 --nb-cores=1 In-order callbacks only work on simulated virtio user vdev.
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +5 -5
@@ -378,7 +378,7 @@ Device names and bonding options must be separated by commas as shown below: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..' + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..' Link Bonding EAL Options ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -478,25 +478,25 @@ Create a bonding device in round robin mode with two members specified by their .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00' -- --port-topology=chained Create a bonding device in round robin mode with two members specified by their PCI address and an overriding MAC address: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained Create a bonding device in active backup mode with two members specified, and a primary member specified by their PCI addresses: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,member=0000:0a:00.01,member=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=1,member=0000:0a:00.01,member=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained Create a bonding device in balance mode with two members specified by their PCI addresses, and a transmission policy of layer 3 + 4 forwarding: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,member=0000:0a:00.01,member=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=2,member=0000:0a:00.01,member=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained .. _bonding_testpmd_commands:
doc/guides/prog_guide/overview.rst +6 -5
@@ -22,16 +22,17 @@ Other libraries, outside of EAL, including the Hash, Longest Prefix Match (LPM) and rings libraries are also provided. Sample applications are provided to help show the user how to use various features of the DPDK. -The DPDK implements a run to completion model for packet processing, -where all resources must be allocated prior to calling Data Plane applications, -running as execution units on logical processing cores. -The model does not support a scheduler and all devices are accessed by polling. -The primary reason for not using interrupts is the performance overhead imposed by interrupt processing. +The DPDK supports multiple programming models for packet processing. +Mos of the sample applications use a polling mode for performance but +some of the samples use interrupt driven model is useful for saving power +but has additional performance overhead. If available, it is possible +to use the DPDK with event based hardware support. In addition to the run-to-completion model, a pipeline model may also be used by passing packets or messages between cores via the rings. This allows work to be performed in stages and may allow more efficient use of code on cores. + Development Environment -----------------------
doc/guides/sample_app_ug/cmd_line.rst +1 -1
@@ -52,7 +52,7 @@ To run the application in linux environment, issue the following command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-cmdline -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-cmdline -l 0-3 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/dist_app.rst +1 -1
@@ -54,7 +54,7 @@ Running the Application .. code-block:: console - $ ./<build-dir>/examples/dpdk-distributor -l 1-9,22 -n 4 -- -p f + $ ./<build-dir>/examples/dpdk-distributor -l 1-9,22 -- -p f #. Refer to the DPDK Getting Started Guide for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/hello_world.rst +1 -1
@@ -21,7 +21,7 @@ To run the example in a linux environment: .. code-block:: console - $ ./<build_dir>/examples/dpdk-helloworld -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-helloworld -l 0-3 Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/ipsec_secgw.rst +2 -2
@@ -270,7 +270,7 @@ The mapping of lcores to port/queues is similar to other l3fwd applications. For example, given the following command line to run application in poll mode:: - ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \ + ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 --socket-mem 0,2048 \ --vdev "crypto_null" -- -p 0xf -P -u 0x3 \ --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \ -f /path/to/config_file --transfer-mode poll \
@@ -368,7 +368,7 @@ For example, something like the following command line: .. code-block:: console - ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \ + ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 --socket-mem 0,2048 \ -a 81:00.0 -a 81:00.1 -a 81:00.2 -a 81:00.3 \ --vdev "crypto_aesni_mb" --vdev "crypto_null" \ -- \
doc/guides/sample_app_ug/keep_alive.rst +1 -1
@@ -68,7 +68,7 @@ To run the application in linux environment with 4 lcores, 16 ports .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-keepalive -l 0-3 -n 4 -- -q 8 -p ffff -K 10 + ./<build_dir>/examples/dpdk-l2fwd-keepalive -l 0-3 -- -q 8 -p ffff -K 10 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL)
doc/guides/sample_app_ug/l2_forward_cat.rst +2 -2
@@ -69,13 +69,13 @@ To run the example in a ``linux`` environment and enable CAT on cpus 0-2: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -n 4 -- --l3ca="0x3@(0-2)" + ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -- --l3ca="0x3@(0-2)" or to enable CAT and CDP on cpus 1,3: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -n 4 -- --l3ca="(0x00C00,0x00300)@(1,3)" + ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -- --l3ca="(0x00C00,0x00300)@(1,3)" If CDP is not supported it will fail with following error message:
doc/guides/sample_app_ug/l2_forward_event.rst +4 -4
@@ -86,20 +86,20 @@ issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=poll + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -q 8 -p ffff --mode=poll Eventdev mode with 4 lcores, 16 ports , sched method ordered and MAC address updating enabled, issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -p ffff --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -p ffff --eventq-sched=ordered or .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
@@ -116,7 +116,7 @@ scheduler. Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-7 -s 0-3 -n 4 --vdev event_sw0 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-7 -s 0-3 --vdev event_sw0 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered Explanation -----------
doc/guides/sample_app_ug/l2_forward_job_stats.rst +1 -1
@@ -96,7 +96,7 @@ thousands separator printing, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd-jobstats -l 0-3 -n 4 -- -q 8 -p ffff -l + $ ./<build_dir>/examples/dpdk-l2fwd-jobstats -l 0-3 -- -q 8 -p ffff -l Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/l2_forward_real_virtual.rst +2 -2
@@ -117,7 +117,7 @@ updating enabled, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p ffff + $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -- -q 8 -p ffff To run the application in linux environment with 4 lcores, 4 ports, 8 RX queues per lcore, to forward RX traffic of ports 0 & 1 on ports 2 & 3 respectively and
@@ -125,7 +125,7 @@ vice versa, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p f --portmap="(0,2)(1,3)" + $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -- -q 8 -p f --portmap="(0,2)(1,3)" Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/l3_forward.rst +4 -4
@@ -158,7 +158,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In this command:
@@ -189,13 +189,13 @@ Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -a <event device> -- -p 0x3 --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" or .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -a <event device> \ -- -p 0x03 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In this command:
@@ -219,7 +219,7 @@ scheduler. Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-7 -s 0xf0000 -n 4 --vdev event_sw0 -- -p 0x3 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 0-7 -s 0xf0000 --vdev event_sw0 -- -p 0x3 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In case of eventdev mode, *--config* option is not used for ethernet port configuration. Instead each ethernet port will be configured with mentioned
doc/guides/sample_app_ug/l3_forward_graph.rst +3 -3
@@ -92,7 +92,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" In this command:
@@ -118,7 +118,7 @@ To enable pcap trace on each graph, use following command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --pcap-enable --pcap-num-cap=<number of packets> --pcap-file-name "</path/to/file>" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" --pcap-enable --pcap-num-cap=<number of packets> --pcap-file-name "</path/to/file>" In this command:
@@ -133,7 +133,7 @@ before including rte_graph_worker.h. Recompile and use following command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2,3,4 -n 4 -- -p 0x1 --config="(0,0,1)" -P --model="dispatch" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2,3,4 -- -p 0x1 --config="(0,0,1)" -P --model="dispatch" To enable graph walking model selection in run-time, remove the define of ``RTE_GRAPH_MODEL_SELECT``. Recompile and use the same command.
doc/guides/sample_app_ug/link_status_intr.rst +1 -1
@@ -54,7 +54,7 @@ issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-link_status_interrupt -l 0-3 -n 4-- -q 8 -p ffff + $ ./<build_dir>/examples/dpdk-link_status_interrupt -l 0-3-- -q 8 -p ffff Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/multi_process.rst +10 -10
@@ -41,7 +41,7 @@ passing at least two cores in the coremask/corelist, as follows: .. code-block:: console - ./<build_dir>/examples/dpdk-simple_mp -l 0-1 -n 4 --proc-type=primary + ./<build_dir>/examples/dpdk-simple_mp -l 0-1 --proc-type=primary For the first DPDK process run, the proc-type flag can be omitted or set to auto, since all DPDK processes will default to being a primary instance,
@@ -50,7 +50,7 @@ The process should start successfully and display a command prompt as follows: .. code-block:: console - $ ./<build_dir>/examples/dpdk-simple_mp -l 0-1 -n 4 --proc-type=primary + $ ./<build_dir>/examples/dpdk-simple_mp -l 0-1 --proc-type=primary EAL: coremask set to 3 EAL: Detected lcore 0 on socket 0 EAL: Detected lcore 1 on socket 0
@@ -77,7 +77,7 @@ again run the same binary setting at least two cores in the coremask/corelist: .. code-block:: console - ./<build_dir>/examples/dpdk-simple_mp -l 2-3 -n 4 --proc-type=secondary + ./<build_dir>/examples/dpdk-simple_mp -l 2-3 --proc-type=secondary When running a secondary process such as that shown above, the proc-type parameter can again be specified as auto. However, omitting the parameter altogether will cause the process to try and start as a primary rather than secondary process.
@@ -177,10 +177,10 @@ the following commands can be used (assuming run as root): .. code-block:: console - # ./<build_dir>/examples/dpdk-symmetric_mp -l 1 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=0 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 2 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=1 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 3 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=2 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 4 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=3 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 1 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=0 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 2 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=1 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 3 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=2 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=3 .. note::
@@ -272,9 +272,9 @@ the following commands could be used: .. code-block:: console - # ./<build_dir>/examples/dpdk-mp_server -l 1-2 -n 4 -- -p 3 -n 2 - # ./<build_dir>/examples/dpdk-mp_client -l 3 -n 4 --proc-type=auto -- -n 0 - # ./<build_dir>/examples/dpdk-mp_client -l 4 -n 4 --proc-type=auto -- -n 1 + # ./<build_dir>/examples/dpdk-mp_server -l 1-2 -- -p 3 -n 2 + # ./<build_dir>/examples/dpdk-mp_client -l 3 --proc-type=auto -- -n 0 + # ./<build_dir>/examples/dpdk-mp_client -l 4 --proc-type=auto -- -n 1 .. note::
doc/guides/sample_app_ug/ptpclient.rst +1 -1
@@ -65,7 +65,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-ptpclient -l 1 -n 4 -- -p 0x1 -T 0 + ./<build_dir>/examples/dpdk-ptpclient -l 1 -- -p 0x1 -T 0 Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/qos_scheduler.rst +2 -2
@@ -180,7 +180,7 @@ The following is an example command with a single packet flow configuration: .. code-block:: console - ./<build_dir>/examples/dpdk-qos_sched -l 1,5,7 -n 4 -- --pfc "3,2,5,7" --cfg ./profile.cfg + ./<build_dir>/examples/dpdk-qos_sched -l 1,5,7 -- --pfc "3,2,5,7" --cfg ./profile.cfg This example uses a single packet flow configuration which creates one RX thread on lcore 5 reading from port 3 and a worker thread on lcore 7 writing to port 2.
@@ -189,7 +189,7 @@ Another example with 2 packet flow configurations using different ports but shar .. code-block:: console - ./<build_dir>/examples/dpdk-qos_sched -l 1,2,6,7 -n 4 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg + ./<build_dir>/examples/dpdk-qos_sched -l 1,2,6,7 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg Note that independent cores for the packet flow configurations for each of the RX, WT and TX thread are also supported, providing flexibility to balance the work.
doc/guides/sample_app_ug/rxtx_callbacks.rst +1 -1
@@ -33,7 +33,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-rxtx_callbacks -l 1 -n 4 -- [-t] + ./<build_dir>/examples/dpdk-rxtx_callbacks -l 1 -- [-t] Use -t to enable hardware timestamping. If not supported by the NIC, an error will be displayed.
doc/guides/sample_app_ug/skeleton.rst +1 -1
@@ -25,7 +25,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-skeleton -l 1 -n 4 + ./<build_dir>/examples/dpdk-skeleton -l 1 Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/timer.rst +1 -1
@@ -21,7 +21,7 @@ To run the example in linux environment: .. code-block:: console - $ ./<build_dir>/examples/dpdk-timer -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-timer -l 0-3 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/vdpa.rst +1 -1
@@ -54,7 +54,7 @@ Take IFCVF driver for example: .. code-block:: console - ./dpdk-vdpa -c 0x2 -n 4 --socket-mem 1024,1024 \ + ./dpdk-vdpa -c 0x2 --socket-mem 1024,1024 \ -a 0000:06:00.3,vdpa=1 -a 0000:06:00.4,vdpa=1 \ -- --interactive
doc/guides/sample_app_ug/vhost.rst +1 -1
@@ -60,7 +60,7 @@ Start the vswitch example .. code-block:: console - ./dpdk-vhost -l 0-3 -n 4 --socket-mem 1024 \ + ./dpdk-vhost -l 0-3 --socket-mem 1024 \ -- --socket-file /tmp/sock0 --client \ ...
doc/guides/sample_app_ug/vm_power_management.rst +3 -3
@@ -279,7 +279,7 @@ cores 0 and 1 on a system with four memory channels, issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-vm_power_mgr -l 0-1 -n 4 + ./<build_dir>/examples/dpdk-vm_power_mgr -l 0-1 After successful initialization, the VM Power Manager CLI prompt appears:
@@ -587,7 +587,7 @@ host, use a command like the following: .. code-block:: console - ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 + ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command will send the policy to the host:
@@ -701,7 +701,7 @@ To start the application and configure the power policy, and send it to the host .. code-block:: console - ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 + ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command will send the policy to the host:
doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst +1 -1
@@ -72,7 +72,7 @@ To run the example in a linux environment: .. code-block:: console - user@target:~$ ./<build_dir>/examples/dpdk-vmdq_dcb -l 0-3 -n 4 -- -p 0x3 --nb-pools 32 --nb-tcs 4 + user@target:~$ ./<build_dir>/examples/dpdk-vmdq_dcb -l 0-3 -- -p 0x3 --nb-pools 32 --nb-tcs 4 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/vmdq_forwarding.rst +1 -1
@@ -56,7 +56,7 @@ To run the example in a Linux environment: .. code-block:: console - user@target:~$ ./<build_dir>/examples/dpdk-vmdq -l 0-3 -n 4 -- -p 0x3 --nb-pools 16 + user@target:~$ ./<build_dir>/examples/dpdk-vmdq -l 0-3 -- -p 0x3 --nb-pools 16 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/testpmd_app_ug/run_app.rst +1 -1
@@ -20,7 +20,7 @@ They must be separated from the EAL options, shown in the previous section, with .. code-block:: console - sudo ./dpdk-testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2 + sudo ./dpdk-testpmd -l 0-3 -- -i --portmask=0x1 --nb-cores=2 The command line options are:
doc/guides/tools/flow-perf.rst +1 -1
@@ -58,7 +58,7 @@ with a ``--`` separator: .. code-block:: console - sudo ./dpdk-test-flow_perf -n 4 -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 + sudo ./dpdk-test-flow_perf -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 The command line options are:
Signature · 1 line
2.43.0
Re: [PATCH 2/2] doc: remove use of -n 4 option in documentation
Quoted 7 lines · Stephen Hemminger
Many places in the documentation are using -n 4 to set the number of memory channels. This should not be recommended since it is not always right and the default should be used instead.
Signed-off-by Stephen Hemminger <[email protected]>---
However, the reason I'd give is just that it's unnecessary rather than being wrong.
Re: [PATCH 2/2] doc: remove use of -n 4 option in documentation
In reply to Stephen HemmingerQuoted 6 lines · Stephen Hemminger
Many places in the documentation are using -n 4 to set the number of memory channels. This should not be recommended since it is not always right and the default should be used instead.
Signed-off-by Stephen Hemminger <[email protected]>
doc/guides/linux_gsg/build_sample_apps.rst Copy·the·DPDK·application·binary·to·your·target,·then·run·the·application·as·fol · line 117
Quoted 10 lines
doc/guides/linux_gsg/build_sample_apps.rst +1
-1@@ -114,7 +114,7 @@ Copy·the·DPDK·application·binary·to·your·target,·then·run·the·application·as·fol (assuming·the·platform·has·four·memory·channels·per·processor·socket, and·that·cores·0-3·are·present·and·are·to·be·used·for·running·the·application):: -····./dpdk-helloworld·-l·0-3·-n·4 +····./dpdk-helloworld·-l·0-3
The comment above about assuming the platform has four memory channels is still correct I guess (since the default is 4), but it feels out of place now without the -n option specified in the command line.
doc/guides/sample_app_ug/link_status_intr.rst issue·the·command: · line 57
Quoted 10 lines
doc/guides/sample_app_ug/link_status_intr.rst +1
-1@@ -54,7 +54,7 @@ issue·the·command: ..·code-block::·console -····$·./<build_dir>/examples/dpdk-link_status_interrupt·-l·0-3·-n·4--·-q·8·-p·ffff +····$·./<build_dir>/examples/dpdk-link_status_interrupt·-l·0-3--·-q·8·-p·ffff
Same comment applies here. Also, whilst this patch isn't the cause, should there not be a space before --?
doc/guides/sample_app_ug/vm_power_management.rst cores·0·and·1·on·a·system·with·four·memory·channels,·issue·the·command: · line 282
Quoted 10 lines
doc/guides/sample_app_ug/vm_power_management.rst +1
-1@@ -279,7 +279,7 @@ cores·0·and·1·on·a·system·with·four·memory·channels,·issue·the·command: ..·code-block::·console -···./<build_dir>/examples/dpdk-vm_power_mgr·-l·0-1·-n·4 +···./<build_dir>/examples/dpdk-vm_power_mgr·-l·0-1
Same comment.
Should we also remove the note saying "The command line must always have the number of memory channels specified for the processor." from the mempool library programmer's guide?
18/07/2024 20:43, Stephen Hemminger:
doc/guides/linux_gsg/enable_func.rst from running on those cores, it is possible to use · line 137
Quoted 11 lines
On Linux (and probably BSD), CPU 0 can not be fully isolated because it receives timer interrupts and is used for other kernel related functions. The DPDK documentation should be updated to tell users to avoid polling on that CPU.
Signed-off-by Stephen Hemminger <[email protected]>---
+.. note::doc/guides/linux_gsg/enable_func.rst +3
-0+ + It is not recommended to use CPU core 0 for DPDK polling applications + because it can not be isolated from other system and kernel activity.
Indent should be 3 spaces.
doc/guides/linux_gsg/enable_func.rst from running on those cores, it is possible to use · line 141
Quoted 5 lines
For example, if a given CPU has 0-7 cores
doc/guides/linux_gsg/enable_func.rst +2
-2-and DPDK applications are to run on logical cores 2, 4 and 6, -the following should be added to the kernel parameter list: +and DPDK applications are to run on logical cores 2, 4 and 6. +The following should be added to the kernel parameter list:
I think it was better as 1 sentence with the comma.
PATCH v2 1/2 doc: add note about CPU 0
In reply to Stephen HemmingerOn Linux (and probably BSD), CPU 0 can not be fully isolated because it receives timer interrupts and is used for other kernel related functions. The DPDK documentation should be updated to tell users to avoid polling on that CPU.
--- doc/guides/linux_gsg/enable_func.rst | 5 +++++ 1 file changed, 5 insertions(+)
doc/guides/linux_gsg/enable_func.rst +5 -0
@@ -131,6 +131,11 @@ from running on those cores, it is possible to use the Linux kernel parameters ``isolcpus``, ``nohz_full``, ``irqaffinity`` to isolate them from the general Linux scheduler tasks. +.. note:: + + It is not recommended to use CPU core 0 for DPDK polling applications + because it can not be completely isolated from other system and kernel activity. + For example, if a given CPU has 0-7 cores and DPDK applications are to run on logical cores 2, 4 and 6, the following should be added to the kernel parameter list:
Signature · 1 line
2.43.0
PATCH v2 2/2 doc: remove use of -n 4 option in documentation
Many places in the documentation are using -n 4 to set the number of memory channels. This is no longer required and is unneccessary in most cases.
--- doc/guides/contributing/documentation.rst | 2 +- doc/guides/cryptodevs/aesni_gcm.rst | 2 +- doc/guides/cryptodevs/aesni_mb.rst | 2 +- doc/guides/cryptodevs/ccp.rst | 4 ++-- doc/guides/cryptodevs/kasumi.rst | 2 +- doc/guides/cryptodevs/null.rst | 2 +- doc/guides/cryptodevs/openssl.rst | 2 +- doc/guides/cryptodevs/snow3g.rst | 2 +- doc/guides/cryptodevs/zuc.rst | 2 +- doc/guides/howto/lm_bond_virtio_sriov.rst | 2 +- doc/guides/howto/lm_virtio_vhost_user.rst | 2 +- doc/guides/howto/packet_capture_framework.rst | 2 +- doc/guides/howto/pvp_reference_benchmark.rst | 4 ++-- doc/guides/howto/vfd.rst | 4 ++-- .../virtio_user_for_container_networking.rst | 4 ++-- doc/guides/linux_gsg/build_sample_apps.rst | 2 +- doc/guides/linux_gsg/linux_drivers.rst | 4 ++-- doc/guides/nics/build_and_test.rst | 2 +- doc/guides/nics/cpfl.rst | 2 +- doc/guides/nics/cxgbe.rst | 2 +- doc/guides/nics/fail_safe.rst | 8 ++++---- doc/guides/nics/hns3.rst | 4 ++-- doc/guides/nics/i40e.rst | 6 +++--- doc/guides/nics/ice.rst | 4 ++-- doc/guides/nics/intel_vf.rst | 2 +- doc/guides/nics/ipn3ke.rst | 4 ++-- doc/guides/nics/mlx4.rst | 2 +- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/null.rst | 6 +++--- doc/guides/nics/pcap_ring.rst | 18 ++++++++--------- doc/guides/nics/qede.rst | 2 +- doc/guides/nics/softnic.rst | 2 +- doc/guides/nics/thunderx.rst | 2 +- doc/guides/nics/vhost.rst | 2 +- doc/guides/nics/virtio.rst | 2 +- .../link_bonding_poll_mode_drv_lib.rst | 10 +++++----- doc/guides/prog_guide/mempool_lib.rst | 3 --- doc/guides/prog_guide/overview.rst | 11 +++++----- doc/guides/sample_app_ug/cmd_line.rst | 2 +- doc/guides/sample_app_ug/dist_app.rst | 2 +- doc/guides/sample_app_ug/hello_world.rst | 2 +- doc/guides/sample_app_ug/ipsec_secgw.rst | 4 ++-- doc/guides/sample_app_ug/keep_alive.rst | 2 +- doc/guides/sample_app_ug/l2_forward_cat.rst | 4 ++-- doc/guides/sample_app_ug/l2_forward_event.rst | 8 ++++---- .../sample_app_ug/l2_forward_job_stats.rst | 2 +- .../sample_app_ug/l2_forward_real_virtual.rst | 4 ++-- doc/guides/sample_app_ug/l3_forward.rst | 8 ++++---- doc/guides/sample_app_ug/l3_forward_graph.rst | 6 +++--- doc/guides/sample_app_ug/link_status_intr.rst | 4 ++-- doc/guides/sample_app_ug/multi_process.rst | 20 +++++++++---------- doc/guides/sample_app_ug/ptpclient.rst | 2 +- doc/guides/sample_app_ug/qos_scheduler.rst | 4 ++-- doc/guides/sample_app_ug/rxtx_callbacks.rst | 2 +- doc/guides/sample_app_ug/skeleton.rst | 2 +- doc/guides/sample_app_ug/timer.rst | 2 +- doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/sample_app_ug/vhost.rst | 2 +- .../sample_app_ug/vm_power_management.rst | 12 +++++------ .../sample_app_ug/vmdq_dcb_forwarding.rst | 2 +- doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +- doc/guides/testpmd_app_ug/run_app.rst | 2 +- doc/guides/tools/flow-perf.rst | 2 +- 63 files changed, 121 insertions(+), 123 deletions(-)
doc/guides/contributing/documentation.rst +1 -1
@@ -253,7 +253,7 @@ Line Length and Wrapping Long literal command lines can be shown wrapped with backslashes. For example:: - dpdk-testpmd -l 2-3 -n 4 \ + dpdk-testpmd -l 2-3 \ --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \ -- -i --tx-offloads=0x0000002c --enable-lro --txq=2 --rxq=2 \ --txd=1024 --rxd=1024
doc/guides/cryptodevs/aesni_gcm.rst +1 -1
@@ -103,5 +103,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"
doc/guides/cryptodevs/aesni_mb.rst +1 -1
@@ -161,7 +161,7 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac" Extra notes
doc/guides/cryptodevs/ccp.rst +2 -2
@@ -94,7 +94,7 @@ To validate ccp PMD, l2fwd-crypto example can be used with following command: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1 + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 --vdev "crypto_ccp" -- -p 0x1 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
@@ -109,7 +109,7 @@ following: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1 + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
doc/guides/cryptodevs/kasumi.rst +1 -1
@@ -109,7 +109,7 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "kasumi-f8" Extra notes on KASUMI F9
doc/guides/cryptodevs/null.rst +1 -1
@@ -67,5 +67,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
doc/guides/cryptodevs/openssl.rst +1 -1
@@ -80,7 +80,7 @@ To verify real traffic l2fwd-crypto example can be used with this command: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_openssl" + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 --vdev "crypto_openssl" --vdev "crypto_openssl"-- -p 0x3 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo AES_CBC --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
doc/guides/cryptodevs/snow3g.rst +1 -1
@@ -118,5 +118,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2"
doc/guides/cryptodevs/zuc.rst +1 -1
@@ -117,5 +117,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3"
doc/guides/howto/lm_bond_virtio_sriov.rst +1 -1
@@ -614,7 +614,7 @@ Run testpmd in the Virtual Machine. # use for bonding of virtio and vf tests in VM /root/dpdk/<build_dir>/app/dpdk-testpmd \ - -l 0-3 -n 4 --socket-mem 350 -- --i --port-topology=chained + -l 0-3 --socket-mem 350 -- --i --port-topology=chained .. _lm_bond_virtio_sriov_switch_conf:
doc/guides/howto/lm_virtio_vhost_user.rst +1 -1
@@ -438,4 +438,4 @@ run_testpmd_in_vm.sh # test system has 8 cpus (0-7), use cpus 2-7 for VM /root/dpdk/<build_dir>/app/dpdk-testpmd \ - -l 0-5 -n 4 --socket-mem 350 -- --burst=64 --i + -l 0-5 --socket-mem 350 -- --burst=64 --i
doc/guides/howto/packet_capture_framework.rst +1 -1
@@ -89,7 +89,7 @@ inspect them using ``tcpdump``. #. Launch testpmd as the primary application:: - sudo <build_dir>/app/dpdk-testpmd -c 0xf0 -n 4 -- -i --port-topology=chained + sudo <build_dir>/app/dpdk-testpmd -c 0xf0 -- -i --port-topology=chained #. Launch the dpdk-dumpcap as follows::
doc/guides/howto/pvp_reference_benchmark.rst +2 -2
@@ -122,7 +122,7 @@ Testpmd launch .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 0,2,3,4,5 --socket-mem=1024 -n 4 \ + <build_dir>/app/dpdk-testpmd -l 0,2,3,4,5 --socket-mem=1024 \ --vdev 'net_vhost0,iface=/tmp/vhost-user1' \ --vdev 'net_vhost1,iface=/tmp/vhost-user2' -- \ --portmask=f -i --rxq=1 --txq=1 \
@@ -332,7 +332,7 @@ Start testpmd: .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 0,1,2 --socket-mem 1024 -n 4 \ + <build_dir>/app/dpdk-testpmd -l 0,1,2 --socket-mem 1024 \ --proc-type auto --file-prefix pg -- \ --portmask=3 --forward-mode=macswap --port-topology=chained \ --disable-rss -i --rxq=1 --txq=1 \
doc/guides/howto/vfd.rst +2 -2
@@ -83,7 +83,7 @@ The typical procedure to achieve this is as follows: #. Run a DPDK application on the PF in the host:: - dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0 + dpdk-testpmd -l 0-7 -- -i --txqflags=0 #. Bind the VF port to ``igb_uio`` in the VM::
@@ -91,7 +91,7 @@ The typical procedure to achieve this is as follows: #. Run a DPDK application on the VF in the VM:: - dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0 + dpdk-testpmd -l 0-7 -- -i --txqflags=0 Common functions of IXGBE and I40E
doc/guides/howto/virtio_user_for_container_networking.rst +2 -2
@@ -77,7 +77,7 @@ some minor changes. .. code-block:: console - $(testpmd) -l 0-1 -n 4 --socket-mem 1024,1024 \ + $(testpmd) -l 0-1 --socket-mem 1024,1024 \ --vdev 'eth_vhost0,iface=/tmp/sock0' \ --file-prefix=host --no-pci -- -i
@@ -87,7 +87,7 @@ some minor changes. docker run -i -t -v /tmp/sock0:/var/run/usvhost \ -v /dev/hugepages:/dev/hugepages \ - dpdk-app-testpmd testpmd -l 6-7 -n 4 -m 1024 --no-pci \ + dpdk-app-testpmd testpmd -l 6-7 -m 1024 --no-pci \ --vdev=virtio_user0,path=/var/run/usvhost \ --file-prefix=container \ -- -i
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -114,7 +114,7 @@ Copy the DPDK application binary to your target, then run the application as fol (assuming the platform has four memory channels per processor socket, and that cores 0-3 are present and are to be used for running the application):: - ./dpdk-helloworld -l 0-3 -n 4 + ./dpdk-helloworld -l 0-3 .. note::
doc/guides/linux_gsg/linux_drivers.rst +2 -2
@@ -252,14 +252,14 @@ The token will be used for all PF and VF ports within the application. .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -a 86:00.0 \ + <build_dir>/app/dpdk-testpmd -l 22-25 -a 86:00.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i #. Start the DPDK application that will manage the VF device .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -a 86:02.0 \ + <build_dir>/app/dpdk-testpmd -l 26-29 -a 86:02.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=vf0 -- -i .. note::
doc/guides/nics/build_and_test.rst +1 -1
@@ -133,7 +133,7 @@ This section demonstrates how to setup and run ``testpmd`` in Linux. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -- -i Successful execution will show initialization messages from EAL, PMD and testpmd application. A prompt will be displayed at the end for user commands
doc/guides/nics/cpfl.rst +1 -1
@@ -208,7 +208,7 @@ low level hardware resources. .. code-block:: console - dpdk-testpmd -c 0x3 -n 4 -a 0000:af:00.6,vport=[0-1],flow_parser="refpkg.json" -- -i + dpdk-testpmd -c 0x3 -a 0000:af:00.6,vport=[0-1],flow_parser="refpkg.json" -- -i #. Create one flow to forward ETH-IPV4-TCP from I/O port to a local(CPF's) vport. Flow should be created on vport X. Group M should match fxp module. Action port_representor Y means forward packet to local vport Y::
doc/guides/nics/cxgbe.rst +1 -1
@@ -749,7 +749,7 @@ devices managed by librte_net_cxgbe in FreeBSD operating system. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -a 0000:02:00.4 -- -i Example output:
doc/guides/nics/fail_safe.rst +4 -4
@@ -116,7 +116,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \ + ./<build_dir>/app/dpdk-testpmd -c 0xff \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -b 84:00.0 -b 00:04.0 -- -i
@@ -130,7 +130,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \ + ./<build_dir>/app/dpdk-testpmd -c 0xff \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -a 81:00.0 -- -i
@@ -138,7 +138,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -a ff:ff.f \ + ./<build_dir>/app/dpdk-testpmd -c 0xff -a ff:ff.f \ --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i #. Start testpmd, automatically probing the device 84:00.0 and using it with
@@ -146,7 +146,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \ + ./<build_dir>/app/dpdk-testpmd -c 0xff \ --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i
doc/guides/nics/hns3.rst +2 -2
@@ -201,7 +201,7 @@ To start ``testpmd``, and add VLAN 10 to port 0: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --forward-mode=mac + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --forward-mode=mac ... testpmd> set promisc 0 off
@@ -222,7 +222,7 @@ Start ``testpmd``: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --rxq=8 --txq=8 \ + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --rxq=8 --txq=8 \ --nb-cores=8 --nb-ports=1 Add a rule to direct ``ipv4-udp`` packet whose ``dst_ip=2.2.2.5, src_ip=2.2.2.3,
doc/guides/nics/i40e.rst +3 -3
@@ -401,7 +401,7 @@ To start ``testpmd``, and add vlan 10 to port 0: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --forward-mode=mac + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --forward-mode=mac ... testpmd> set promisc 0 off
@@ -436,7 +436,7 @@ Start ``testpmd`` with ``--disable-rss`` and ``--pkt-filter-mode=perfect``: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --disable-rss \ + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --disable-rss \ --pkt-filter-mode=perfect --rxq=8 --txq=8 --nb-cores=8 \ --nb-ports=1
@@ -1012,7 +1012,7 @@ See :numref:`figure_intel_perf_test_setup` for the performance test setup. #. The command line of running l3fwd would be something like the following:: - ./dpdk-l3fwd -l 18-21 -n 4 -a 82:00.0 -a 85:00.0 \ + ./dpdk-l3fwd -l 18-21 -a 82:00.0 -a 85:00.0 \ -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)' This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding,
doc/guides/nics/ice.rst +2 -2
@@ -420,7 +420,7 @@ Additional Options #. Bind the VF0, and run testpmd with 'cap=dcf' with port representor for VF 1 and 2:: - dpdk-testpmd -l 22-25 -n 4 -a 18:01.0,cap=dcf,representor=vf[1-2] -- -i + dpdk-testpmd -l 22-25 -a 18:01.0,cap=dcf,representor=vf[1-2] -- -i #. Monitor the VF2 interface network traffic::
@@ -449,7 +449,7 @@ To start ``testpmd``, and add vlan 10 to port 0: .. code-block:: console - ./app/dpdk-testpmd -l 0-15 -n 4 -- -i + ./app/dpdk-testpmd -l 0-15 -- -i ... testpmd> rx_vlan add 10 0
doc/guides/nics/intel_vf.rst +1 -1
@@ -521,7 +521,7 @@ The setup procedure is as follows: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -- -i #. Finally, access the Guest OS using vncviewer with the localhost:5900 port and check the lspci command output in the Guest OS. The virtual functions will be listed as available for use.
doc/guides/nics/ipn3ke.rst +2 -2
@@ -76,7 +76,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop + ./<build_dir>/app/dpdk-testpmd -l 0-15 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop HQoS and flow acceleration ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -87,7 +87,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port, enable FPGA HQoS and .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap + ./<build_dir>/app/dpdk-testpmd -l 0-15 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap Limitations or Known issues ---------------------------
doc/guides/nics/mlx4.rst +1 -1
@@ -428,7 +428,7 @@ devices managed by librte_net_mlx4. #. Start testpmd with basic parameters:: - dpdk-testpmd -l 8-15 -n 4 -a 0000:83:00.0 -a 0000:84:00.0 -- --rxq=2 --txq=2 -i + dpdk-testpmd -l 8-15 -a 0000:83:00.0 -a 0000:84:00.0 -- --rxq=2 --txq=2 -i Example output::
doc/guides/nics/mlx5.rst +1 -1
@@ -2132,7 +2132,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5. #. Start testpmd with basic parameters:: - dpdk-testpmd -l 8-15 -n 4 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i + dpdk-testpmd -l 8-15 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i Example output::
doc/guides/nics/null.rst +3 -3
@@ -14,7 +14,7 @@ Usage .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev net_null0 --vdev net_null1 -- -i Runtime Configuration
@@ -26,7 +26,7 @@ Runtime Configuration .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev "net_null0,copy=1" -- -i - ``size`` [optional, default=64 bytes]
@@ -35,7 +35,7 @@ Runtime Configuration .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev "net_null0,size=256" -- -i - ``no-rx`` [optional, default disabled]
doc/guides/nics/pcap_ring.rst +9 -9
@@ -40,7 +40,7 @@ Device name and stream options must be separated by commas as shown below: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,stream_opt0=..,stream_opt1=..' \ --vdev='net_pcap1,stream_opt0=..'
@@ -139,7 +139,7 @@ Read packets from one pcap file and write them to another: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained
@@ -147,7 +147,7 @@ Read packets from a network interface and write them to a pcap file: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface=eth0,tx_pcap=file_tx.pcap' \ -- --port-topology=chained
@@ -155,7 +155,7 @@ Read packets from a pcap file and write them to a network interface: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_iface=eth1' \ -- --port-topology=chained
@@ -163,14 +163,14 @@ Forward packets through two network interfaces: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,iface=eth0' --vdev='net_pcap1,iface=eth1' Enable 2 tx queues on a network interface: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface=eth1,tx_iface=eth1,tx_iface=eth1' \ -- --txq 2
@@ -178,7 +178,7 @@ Read only incoming packets from a network interface and write them back to the s .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface_in=eth1,tx_iface=eth1' Using libpcap-based PMD with the testpmd Application
@@ -203,7 +203,7 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained --no-flush-rx
@@ -223,7 +223,7 @@ Multiple devices may be specified, separated by commas. .. code-block:: console - ./dpdk-testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i + ./dpdk-testpmd -l 1-3 --vdev=net_ring0 --vdev=net_ring1 -- -i EAL: Detected lcore 1 as core 1 on socket 0 ...
doc/guides/nics/qede.rst +1 -1
@@ -272,7 +272,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - dpdk-testpmd -l 0,4-11 -n 4 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \ + dpdk-testpmd -l 0,4-11 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \ --txd=4096 --txfreet=4068 --enable-rx-cksum --rxq=4 --txq=4 \ --rss-ip --rss-udp
doc/guides/nics/softnic.rst +1 -1
@@ -366,7 +366,7 @@ commands. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0x7 -s 0x4 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -c 0x7 -s 0x4 \ --vdev 'net_softnic0, \ firmware=./drivers/net/softnic/ \ firmware.cli, \
doc/guides/nics/thunderx.rst +1 -1
@@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0002:01:00.2 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 -a 0002:01:00.2 \ -- -i --no-flush-rx \ --port-topology=loop
doc/guides/nics/vhost.rst +1 -1
@@ -96,7 +96,7 @@ This section demonstrates vhost PMD with testpmd DPDK sample application. .. code-block:: console - ./dpdk-testpmd -l 0-3 -n 4 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i + ./dpdk-testpmd -l 0-3 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i Other basic DPDK preparations like hugepage enabling here. Please refer to the *DPDK Getting Started Guide* for detailed instructions.
doc/guides/nics/virtio.rst +1 -1
@@ -183,7 +183,7 @@ There is no vector callbacks for packed virtqueue for now. Example of using the vector version of the virtio poll mode driver in ``testpmd``:: - dpdk-testpmd -l 0-2 -n 4 -- -i --rxq=1 --txq=1 --nb-cores=1 + dpdk-testpmd -l 0-2 -- -i --rxq=1 --txq=1 --nb-cores=1 In-order callbacks only work on simulated virtio user vdev.
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +5 -5
@@ -378,7 +378,7 @@ Device names and bonding options must be separated by commas as shown below: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..' + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..' Link Bonding EAL Options ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -478,25 +478,25 @@ Create a bonding device in round robin mode with two members specified by their .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00' -- --port-topology=chained Create a bonding device in round robin mode with two members specified by their PCI address and an overriding MAC address: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained Create a bonding device in active backup mode with two members specified, and a primary member specified by their PCI addresses: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,member=0000:0a:00.01,member=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=1,member=0000:0a:00.01,member=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained Create a bonding device in balance mode with two members specified by their PCI addresses, and a transmission policy of layer 3 + 4 forwarding: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,member=0000:0a:00.01,member=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=2,member=0000:0a:00.01,member=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained .. _bonding_testpmd_commands:
doc/guides/prog_guide/mempool_lib.rst +0 -3
@@ -47,9 +47,6 @@ The physical layout of the DRAM chips on the DIMM itself does not necessarily re When running an application, the EAL command line options provide the ability to add the number of memory channels and ranks. -.. note:: - - The command line must always have the number of memory channels specified for the processor. Examples of alignment for different DIMM architectures are shown in :numref:`figure_memory-management` and :numref:`figure_memory-management2`.
doc/guides/prog_guide/overview.rst +6 -5
@@ -22,16 +22,17 @@ Other libraries, outside of EAL, including the Hash, Longest Prefix Match (LPM) and rings libraries are also provided. Sample applications are provided to help show the user how to use various features of the DPDK. -The DPDK implements a run to completion model for packet processing, -where all resources must be allocated prior to calling Data Plane applications, -running as execution units on logical processing cores. -The model does not support a scheduler and all devices are accessed by polling. -The primary reason for not using interrupts is the performance overhead imposed by interrupt processing. +The DPDK supports multiple programming models for packet processing. +Mos of the sample applications use a polling mode for performance but +some of the samples use interrupt driven model is useful for saving power +but has additional performance overhead. If available, it is possible +to use the DPDK with event based hardware support. In addition to the run-to-completion model, a pipeline model may also be used by passing packets or messages between cores via the rings. This allows work to be performed in stages and may allow more efficient use of code on cores. + Development Environment -----------------------
doc/guides/sample_app_ug/cmd_line.rst +1 -1
@@ -52,7 +52,7 @@ To run the application in linux environment, issue the following command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-cmdline -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-cmdline -l 0-3 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/dist_app.rst +1 -1
@@ -54,7 +54,7 @@ Running the Application .. code-block:: console - $ ./<build-dir>/examples/dpdk-distributor -l 1-9,22 -n 4 -- -p f + $ ./<build-dir>/examples/dpdk-distributor -l 1-9,22 -- -p f #. Refer to the DPDK Getting Started Guide for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/hello_world.rst +1 -1
@@ -21,7 +21,7 @@ To run the example in a linux environment: .. code-block:: console - $ ./<build_dir>/examples/dpdk-helloworld -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-helloworld -l 0-3 Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/ipsec_secgw.rst +2 -2
@@ -270,7 +270,7 @@ The mapping of lcores to port/queues is similar to other l3fwd applications. For example, given the following command line to run application in poll mode:: - ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \ + ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 --socket-mem 0,2048 \ --vdev "crypto_null" -- -p 0xf -P -u 0x3 \ --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \ -f /path/to/config_file --transfer-mode poll \
@@ -368,7 +368,7 @@ For example, something like the following command line: .. code-block:: console - ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \ + ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 --socket-mem 0,2048 \ -a 81:00.0 -a 81:00.1 -a 81:00.2 -a 81:00.3 \ --vdev "crypto_aesni_mb" --vdev "crypto_null" \ -- \
doc/guides/sample_app_ug/keep_alive.rst +1 -1
@@ -68,7 +68,7 @@ To run the application in linux environment with 4 lcores, 16 ports .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-keepalive -l 0-3 -n 4 -- -q 8 -p ffff -K 10 + ./<build_dir>/examples/dpdk-l2fwd-keepalive -l 0-3 -- -q 8 -p ffff -K 10 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL)
doc/guides/sample_app_ug/l2_forward_cat.rst +2 -2
@@ -69,13 +69,13 @@ To run the example in a ``linux`` environment and enable CAT on cpus 0-2: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -n 4 -- --l3ca="0x3@(0-2)" + ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -- --l3ca="0x3@(0-2)" or to enable CAT and CDP on cpus 1,3: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -n 4 -- --l3ca="(0x00C00,0x00300)@(1,3)" + ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -- --l3ca="(0x00C00,0x00300)@(1,3)" If CDP is not supported it will fail with following error message:
doc/guides/sample_app_ug/l2_forward_event.rst +4 -4
@@ -86,20 +86,20 @@ issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=poll + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -q 8 -p ffff --mode=poll Eventdev mode with 4 lcores, 16 ports , sched method ordered and MAC address updating enabled, issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -p ffff --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -p ffff --eventq-sched=ordered or .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
@@ -116,7 +116,7 @@ scheduler. Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-7 -s 0-3 -n 4 --vdev event_sw0 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-7 -s 0-3 --vdev event_sw0 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered Explanation -----------
doc/guides/sample_app_ug/l2_forward_job_stats.rst +1 -1
@@ -96,7 +96,7 @@ thousands separator printing, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd-jobstats -l 0-3 -n 4 -- -q 8 -p ffff -l + $ ./<build_dir>/examples/dpdk-l2fwd-jobstats -l 0-3 -- -q 8 -p ffff -l Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/l2_forward_real_virtual.rst +2 -2
@@ -117,7 +117,7 @@ updating enabled, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p ffff + $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -- -q 8 -p ffff To run the application in linux environment with 4 lcores, 4 ports, 8 RX queues per lcore, to forward RX traffic of ports 0 & 1 on ports 2 & 3 respectively and
@@ -125,7 +125,7 @@ vice versa, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p f --portmap="(0,2)(1,3)" + $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -- -q 8 -p f --portmap="(0,2)(1,3)" Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/l3_forward.rst +4 -4
@@ -158,7 +158,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In this command:
@@ -189,13 +189,13 @@ Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -a <event device> -- -p 0x3 --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" or .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -a <event device> \ -- -p 0x03 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In this command:
@@ -219,7 +219,7 @@ scheduler. Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-7 -s 0xf0000 -n 4 --vdev event_sw0 -- -p 0x3 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 0-7 -s 0xf0000 --vdev event_sw0 -- -p 0x3 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In case of eventdev mode, *--config* option is not used for ethernet port configuration. Instead each ethernet port will be configured with mentioned
doc/guides/sample_app_ug/l3_forward_graph.rst +3 -3
@@ -92,7 +92,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" In this command:
@@ -118,7 +118,7 @@ To enable pcap trace on each graph, use following command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --pcap-enable --pcap-num-cap=<number of packets> --pcap-file-name "</path/to/file>" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" --pcap-enable --pcap-num-cap=<number of packets> --pcap-file-name "</path/to/file>" In this command:
@@ -133,7 +133,7 @@ before including rte_graph_worker.h. Recompile and use following command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2,3,4 -n 4 -- -p 0x1 --config="(0,0,1)" -P --model="dispatch" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2,3,4 -- -p 0x1 --config="(0,0,1)" -P --model="dispatch" To enable graph walking model selection in run-time, remove the define of ``RTE_GRAPH_MODEL_SELECT``. Recompile and use the same command.
doc/guides/sample_app_ug/link_status_intr.rst +2 -2
@@ -49,12 +49,12 @@ where, * -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default) -To run the application in a linux environment with 4 lcores, 4 memory channels, 16 ports and 8 RX queues per lcore, +To run the application in a linux environment with 4 lcores, 16 ports and 8 RX queues per lcore, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-link_status_interrupt -l 0-3 -n 4-- -q 8 -p ffff + $ ./<build_dir>/examples/dpdk-link_status_interrupt -l 0-3 -- -q 8 -p ffff Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/multi_process.rst +10 -10
@@ -41,7 +41,7 @@ passing at least two cores in the coremask/corelist, as follows: .. code-block:: console - ./<build_dir>/examples/dpdk-simple_mp -l 0-1 -n 4 --proc-type=primary + ./<build_dir>/examples/dpdk-simple_mp -l 0-1 --proc-type=primary For the first DPDK process run, the proc-type flag can be omitted or set to auto, since all DPDK processes will default to being a primary instance,
@@ -50,7 +50,7 @@ The process should start successfully and display a command prompt as follows: .. code-block:: console - $ ./<build_dir>/examples/dpdk-simple_mp -l 0-1 -n 4 --proc-type=primary + $ ./<build_dir>/examples/dpdk-simple_mp -l 0-1 --proc-type=primary EAL: coremask set to 3 EAL: Detected lcore 0 on socket 0 EAL: Detected lcore 1 on socket 0
@@ -77,7 +77,7 @@ again run the same binary setting at least two cores in the coremask/corelist: .. code-block:: console - ./<build_dir>/examples/dpdk-simple_mp -l 2-3 -n 4 --proc-type=secondary + ./<build_dir>/examples/dpdk-simple_mp -l 2-3 --proc-type=secondary When running a secondary process such as that shown above, the proc-type parameter can again be specified as auto. However, omitting the parameter altogether will cause the process to try and start as a primary rather than secondary process.
@@ -177,10 +177,10 @@ the following commands can be used (assuming run as root): .. code-block:: console - # ./<build_dir>/examples/dpdk-symmetric_mp -l 1 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=0 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 2 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=1 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 3 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=2 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 4 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=3 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 1 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=0 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 2 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=1 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 3 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=2 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=3 .. note::
@@ -272,9 +272,9 @@ the following commands could be used: .. code-block:: console - # ./<build_dir>/examples/dpdk-mp_server -l 1-2 -n 4 -- -p 3 -n 2 - # ./<build_dir>/examples/dpdk-mp_client -l 3 -n 4 --proc-type=auto -- -n 0 - # ./<build_dir>/examples/dpdk-mp_client -l 4 -n 4 --proc-type=auto -- -n 1 + # ./<build_dir>/examples/dpdk-mp_server -l 1-2 -- -p 3 -n 2 + # ./<build_dir>/examples/dpdk-mp_client -l 3 --proc-type=auto -- -n 0 + # ./<build_dir>/examples/dpdk-mp_client -l 4 --proc-type=auto -- -n 1 .. note::
doc/guides/sample_app_ug/ptpclient.rst +1 -1
@@ -65,7 +65,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-ptpclient -l 1 -n 4 -- -p 0x1 -T 0 + ./<build_dir>/examples/dpdk-ptpclient -l 1 -- -p 0x1 -T 0 Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/qos_scheduler.rst +2 -2
@@ -180,7 +180,7 @@ The following is an example command with a single packet flow configuration: .. code-block:: console - ./<build_dir>/examples/dpdk-qos_sched -l 1,5,7 -n 4 -- --pfc "3,2,5,7" --cfg ./profile.cfg + ./<build_dir>/examples/dpdk-qos_sched -l 1,5,7 -- --pfc "3,2,5,7" --cfg ./profile.cfg This example uses a single packet flow configuration which creates one RX thread on lcore 5 reading from port 3 and a worker thread on lcore 7 writing to port 2.
@@ -189,7 +189,7 @@ Another example with 2 packet flow configurations using different ports but shar .. code-block:: console - ./<build_dir>/examples/dpdk-qos_sched -l 1,2,6,7 -n 4 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg + ./<build_dir>/examples/dpdk-qos_sched -l 1,2,6,7 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg Note that independent cores for the packet flow configurations for each of the RX, WT and TX thread are also supported, providing flexibility to balance the work.
doc/guides/sample_app_ug/rxtx_callbacks.rst +1 -1
@@ -33,7 +33,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-rxtx_callbacks -l 1 -n 4 -- [-t] + ./<build_dir>/examples/dpdk-rxtx_callbacks -l 1 -- [-t] Use -t to enable hardware timestamping. If not supported by the NIC, an error will be displayed.
doc/guides/sample_app_ug/skeleton.rst +1 -1
@@ -25,7 +25,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-skeleton -l 1 -n 4 + ./<build_dir>/examples/dpdk-skeleton -l 1 Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/timer.rst +1 -1
@@ -21,7 +21,7 @@ To run the example in linux environment: .. code-block:: console - $ ./<build_dir>/examples/dpdk-timer -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-timer -l 0-3 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/vdpa.rst +1 -1
@@ -54,7 +54,7 @@ Take IFCVF driver for example: .. code-block:: console - ./dpdk-vdpa -c 0x2 -n 4 --socket-mem 1024,1024 \ + ./dpdk-vdpa -c 0x2 --socket-mem 1024,1024 \ -a 0000:06:00.3,vdpa=1 -a 0000:06:00.4,vdpa=1 \ -- --interactive
doc/guides/sample_app_ug/vhost.rst +1 -1
@@ -60,7 +60,7 @@ Start the vswitch example .. code-block:: console - ./dpdk-vhost -l 0-3 -n 4 --socket-mem 1024 \ + ./dpdk-vhost -l 0-3 --socket-mem 1024 \ -- --socket-file /tmp/sock0 --client \ ...
doc/guides/sample_app_ug/vm_power_management.rst +6 -6
@@ -186,7 +186,7 @@ Hypervisor Channel Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Configure ``virtio-serial`` channels using ``libvirt`` XML. -The XML structure is as follows: +The XML structure is as follows: .. code-block:: XML
@@ -275,11 +275,11 @@ than the EAL options: The application requires exactly two cores to run. One core for the CLI and the other for the channel endpoint monitor. For example, to run on -cores 0 and 1 on a system with four memory channels, issue the command: +cores 0 and 1 on a system, issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-vm_power_mgr -l 0-1 -n 4 + ./<build_dir>/examples/dpdk-vm_power_mgr -l 0-1 After successful initialization, the VM Power Manager CLI prompt appears:
@@ -365,7 +365,7 @@ physical CPU mask: set_pcpu_mask {vm_name} {vcpu} {pcpu} Set the binding of the virtual CPU on the VM to the physical CPU: - + .. code-block:: console set_pcpu {vm_name} {vcpu} {pcpu}
@@ -587,7 +587,7 @@ host, use a command like the following: .. code-block:: console - ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 + ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command will send the policy to the host:
@@ -701,7 +701,7 @@ To start the application and configure the power policy, and send it to the host .. code-block:: console - ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 + ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command will send the policy to the host:
doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst +1 -1
@@ -72,7 +72,7 @@ To run the example in a linux environment: .. code-block:: console - user@target:~$ ./<build_dir>/examples/dpdk-vmdq_dcb -l 0-3 -n 4 -- -p 0x3 --nb-pools 32 --nb-tcs 4 + user@target:~$ ./<build_dir>/examples/dpdk-vmdq_dcb -l 0-3 -- -p 0x3 --nb-pools 32 --nb-tcs 4 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/vmdq_forwarding.rst +1 -1
@@ -56,7 +56,7 @@ To run the example in a Linux environment: .. code-block:: console - user@target:~$ ./<build_dir>/examples/dpdk-vmdq -l 0-3 -n 4 -- -p 0x3 --nb-pools 16 + user@target:~$ ./<build_dir>/examples/dpdk-vmdq -l 0-3 -- -p 0x3 --nb-pools 16 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/testpmd_app_ug/run_app.rst +1 -1
@@ -20,7 +20,7 @@ They must be separated from the EAL options, shown in the previous section, with .. code-block:: console - sudo ./dpdk-testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2 + sudo ./dpdk-testpmd -l 0-3 -- -i --portmask=0x1 --nb-cores=2 The command line options are:
doc/guides/tools/flow-perf.rst +1 -1
@@ -58,7 +58,7 @@ with a ``--`` separator: .. code-block:: console - sudo ./dpdk-test-flow_perf -n 4 -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 + sudo ./dpdk-test-flow_perf -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 The command line options are:
Signature · 1 line
2.43.0
Re: [PATCH v2 2/2] doc: remove use of -n 4 option in documentation
31/07/2024 06:38, Stephen Hemminger:
doc/guides/linux_gsg/build_sample_apps.rst Copy the DPDK application binary to your target, then run the application as fol · line 118
Quoted 9 lines
doc/guides/linux_gsg/build_sample_apps.rst +1
-1@@ -114,7 +114,7 @@ Copy the DPDK application binary to your target, then run the application as fol (assuming the platform has four memory channels per processor socket, and that cores 0-3 are present and are to be used for running the application):: - ./dpdk-helloworld -l 0-3 -n 4 + ./dpdk-helloworld -l 0-3
There were some comments from Jack about updating the sentences above in several locations to skip the memory channels considerations.
v3 cover cpu0 and memory channels doc update
In reply to Stephen HemmingerThis is revised version of earlier patches to address some guidance about CPU and memory channels in the documentation.
Stephen Hemminger (2):
doc: add note about CPU 0
doc: remove use of '-n 4' option in documentation examples
doc/guides/contributing/documentation.rst | 2 +- doc/guides/cryptodevs/aesni_gcm.rst | 2 +- doc/guides/cryptodevs/aesni_mb.rst | 2 +- doc/guides/cryptodevs/ccp.rst | 4 ++-- doc/guides/cryptodevs/kasumi.rst | 2 +- doc/guides/cryptodevs/null.rst | 2 +- doc/guides/cryptodevs/openssl.rst | 2 +- doc/guides/cryptodevs/snow3g.rst | 2 +- doc/guides/cryptodevs/zuc.rst | 2 +- doc/guides/howto/lm_bond_virtio_sriov.rst | 2 +- doc/guides/howto/lm_virtio_vhost_user.rst | 2 +- doc/guides/howto/packet_capture_framework.rst | 2 +- doc/guides/howto/pvp_reference_benchmark.rst | 4 ++-- doc/guides/howto/vfd.rst | 4 ++-- .../virtio_user_for_container_networking.rst | 4 ++-- doc/guides/linux_gsg/build_sample_apps.rst | 5 ++--- doc/guides/linux_gsg/enable_func.rst | 5 +++++ doc/guides/linux_gsg/linux_drivers.rst | 4 ++-- doc/guides/nics/build_and_test.rst | 2 +- doc/guides/nics/cpfl.rst | 2 +- doc/guides/nics/cxgbe.rst | 2 +- doc/guides/nics/fail_safe.rst | 8 ++++---- doc/guides/nics/hns3.rst | 4 ++-- doc/guides/nics/i40e.rst | 6 +++--- doc/guides/nics/ice.rst | 6 +++--- doc/guides/nics/intel_vf.rst | 2 +- doc/guides/nics/ipn3ke.rst | 4 ++-- doc/guides/nics/mlx4.rst | 2 +- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/null.rst | 6 +++--- doc/guides/nics/pcap_ring.rst | 18 ++++++++--------- doc/guides/nics/qede.rst | 2 +- doc/guides/nics/softnic.rst | 2 +- doc/guides/nics/thunderx.rst | 2 +- doc/guides/nics/vhost.rst | 2 +- doc/guides/nics/virtio.rst | 2 +- .../link_bonding_poll_mode_drv_lib.rst | 10 +++++----- doc/guides/prog_guide/mempool_lib.rst | 3 --- doc/guides/prog_guide/overview.rst | 11 +++++----- doc/guides/sample_app_ug/cmd_line.rst | 2 +- doc/guides/sample_app_ug/dist_app.rst | 2 +- doc/guides/sample_app_ug/hello_world.rst | 2 +- doc/guides/sample_app_ug/ipsec_secgw.rst | 4 ++-- doc/guides/sample_app_ug/ipv4_multicast.rst | 4 +--- doc/guides/sample_app_ug/keep_alive.rst | 2 +- doc/guides/sample_app_ug/l2_forward_cat.rst | 4 ++-- doc/guides/sample_app_ug/l2_forward_event.rst | 8 ++++---- .../sample_app_ug/l2_forward_job_stats.rst | 2 +- .../sample_app_ug/l2_forward_real_virtual.rst | 4 ++-- doc/guides/sample_app_ug/l3_forward.rst | 8 ++++---- doc/guides/sample_app_ug/l3_forward_graph.rst | 6 +++--- doc/guides/sample_app_ug/link_status_intr.rst | 4 ++-- doc/guides/sample_app_ug/multi_process.rst | 20 +++++++++---------- doc/guides/sample_app_ug/ptpclient.rst | 2 +- doc/guides/sample_app_ug/qos_scheduler.rst | 4 ++-- doc/guides/sample_app_ug/rxtx_callbacks.rst | 2 +- doc/guides/sample_app_ug/skeleton.rst | 2 +- doc/guides/sample_app_ug/timer.rst | 2 +- doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/sample_app_ug/vhost.rst | 2 +- .../sample_app_ug/vm_power_management.rst | 12 +++++------ .../sample_app_ug/vmdq_dcb_forwarding.rst | 2 +- doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +- doc/guides/testpmd_app_ug/run_app.rst | 2 +- doc/guides/tools/flow-perf.rst | 2 +- 65 files changed, 129 insertions(+), 129 deletions(-)
Signature · 1 line
2.47.2
PATCH v3 1/2 doc: add note about CPU 0
On Linux (and probably BSD), CPU 0 can not be fully isolated because it receives timer interrupts and is used for other kernel related functions. The DPDK documentation should be updated to tell users to avoid polling on that CPU.
--- doc/guides/linux_gsg/enable_func.rst | 5 +++++ 1 file changed, 5 insertions(+)
doc/guides/linux_gsg/enable_func.rst +5 -0
@@ -131,6 +131,11 @@ from running on those cores, it is possible to use the Linux kernel parameters ``isolcpus``, ``nohz_full``, ``irqaffinity`` to isolate them from the general Linux scheduler tasks. +.. note:: + + It is not recommended to use CPU core 0 for DPDK polling applications + because it can not be truly isolated from other system and kernel activity. + For example, if a given CPU has 0-7 cores and DPDK applications are to run on logical cores 2, 4 and 6, the following should be added to the kernel parameter list:
Signature · 1 line
2.47.2
PATCH v3 2/2 doc: remove use of '-n 4' option in documentation examples
In reply to Stephen HemmingerMany places in the documentation are using -n 4 to set the number of memory channels. This is no longer required and is unneccessary in most cases.
--- doc/guides/contributing/documentation.rst | 2 +- doc/guides/cryptodevs/aesni_gcm.rst | 2 +- doc/guides/cryptodevs/aesni_mb.rst | 2 +- doc/guides/cryptodevs/ccp.rst | 4 ++-- doc/guides/cryptodevs/kasumi.rst | 2 +- doc/guides/cryptodevs/null.rst | 2 +- doc/guides/cryptodevs/openssl.rst | 2 +- doc/guides/cryptodevs/snow3g.rst | 2 +- doc/guides/cryptodevs/zuc.rst | 2 +- doc/guides/howto/lm_bond_virtio_sriov.rst | 2 +- doc/guides/howto/lm_virtio_vhost_user.rst | 2 +- doc/guides/howto/packet_capture_framework.rst | 2 +- doc/guides/howto/pvp_reference_benchmark.rst | 4 ++-- doc/guides/howto/vfd.rst | 4 ++-- .../virtio_user_for_container_networking.rst | 4 ++-- doc/guides/linux_gsg/build_sample_apps.rst | 5 ++--- doc/guides/linux_gsg/linux_drivers.rst | 4 ++-- doc/guides/nics/build_and_test.rst | 2 +- doc/guides/nics/cpfl.rst | 2 +- doc/guides/nics/cxgbe.rst | 2 +- doc/guides/nics/fail_safe.rst | 8 ++++---- doc/guides/nics/hns3.rst | 4 ++-- doc/guides/nics/i40e.rst | 6 +++--- doc/guides/nics/ice.rst | 6 +++--- doc/guides/nics/intel_vf.rst | 2 +- doc/guides/nics/ipn3ke.rst | 4 ++-- doc/guides/nics/mlx4.rst | 2 +- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/null.rst | 6 +++--- doc/guides/nics/pcap_ring.rst | 18 ++++++++--------- doc/guides/nics/qede.rst | 2 +- doc/guides/nics/softnic.rst | 2 +- doc/guides/nics/thunderx.rst | 2 +- doc/guides/nics/vhost.rst | 2 +- doc/guides/nics/virtio.rst | 2 +- .../link_bonding_poll_mode_drv_lib.rst | 10 +++++----- doc/guides/prog_guide/mempool_lib.rst | 3 --- doc/guides/prog_guide/overview.rst | 11 +++++----- doc/guides/sample_app_ug/cmd_line.rst | 2 +- doc/guides/sample_app_ug/dist_app.rst | 2 +- doc/guides/sample_app_ug/hello_world.rst | 2 +- doc/guides/sample_app_ug/ipsec_secgw.rst | 4 ++-- doc/guides/sample_app_ug/ipv4_multicast.rst | 4 +--- doc/guides/sample_app_ug/keep_alive.rst | 2 +- doc/guides/sample_app_ug/l2_forward_cat.rst | 4 ++-- doc/guides/sample_app_ug/l2_forward_event.rst | 8 ++++---- .../sample_app_ug/l2_forward_job_stats.rst | 2 +- .../sample_app_ug/l2_forward_real_virtual.rst | 4 ++-- doc/guides/sample_app_ug/l3_forward.rst | 8 ++++---- doc/guides/sample_app_ug/l3_forward_graph.rst | 6 +++--- doc/guides/sample_app_ug/link_status_intr.rst | 4 ++-- doc/guides/sample_app_ug/multi_process.rst | 20 +++++++++---------- doc/guides/sample_app_ug/ptpclient.rst | 2 +- doc/guides/sample_app_ug/qos_scheduler.rst | 4 ++-- doc/guides/sample_app_ug/rxtx_callbacks.rst | 2 +- doc/guides/sample_app_ug/skeleton.rst | 2 +- doc/guides/sample_app_ug/timer.rst | 2 +- doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/sample_app_ug/vhost.rst | 2 +- .../sample_app_ug/vm_power_management.rst | 12 +++++------ .../sample_app_ug/vmdq_dcb_forwarding.rst | 2 +- doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +- doc/guides/testpmd_app_ug/run_app.rst | 2 +- doc/guides/tools/flow-perf.rst | 2 +- 64 files changed, 124 insertions(+), 129 deletions(-)
doc/guides/contributing/documentation.rst +1 -1
@@ -255,7 +255,7 @@ Line Length and Wrapping Long literal command lines can be shown wrapped with backslashes. For example:: - dpdk-testpmd -l 2-3 -n 4 \ + dpdk-testpmd -l 2-3 \ --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \ -- -i --tx-offloads=0x0000002c --enable-lro --txq=2 --rxq=2 \ --txd=1024 --rxd=1024
doc/guides/cryptodevs/aesni_gcm.rst +1 -1
@@ -104,5 +104,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"
doc/guides/cryptodevs/aesni_mb.rst +1 -1
@@ -168,7 +168,7 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac" Extra notes
doc/guides/cryptodevs/ccp.rst +2 -2
@@ -94,7 +94,7 @@ To validate ccp PMD, l2fwd-crypto example can be used with following command: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1 + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 --vdev "crypto_ccp" -- -p 0x1 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
@@ -109,7 +109,7 @@ following: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1 + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
doc/guides/cryptodevs/kasumi.rst +1 -1
@@ -110,7 +110,7 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "kasumi-f8" Extra notes on KASUMI F9
doc/guides/cryptodevs/null.rst +1 -1
@@ -67,5 +67,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
doc/guides/cryptodevs/openssl.rst +1 -1
@@ -80,7 +80,7 @@ To verify real traffic l2fwd-crypto example can be used with this command: .. code-block:: console - sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_openssl" + sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 --vdev "crypto_openssl" --vdev "crypto_openssl"-- -p 0x3 --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo AES_CBC --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
doc/guides/cryptodevs/snow3g.rst +1 -1
@@ -119,5 +119,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2"
doc/guides/cryptodevs/zuc.rst +1 -1
@@ -118,5 +118,5 @@ Example: .. code-block:: console - ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ + ./dpdk-l2fwd-crypto -l 1 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \ -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3"
doc/guides/howto/lm_bond_virtio_sriov.rst +1 -1
@@ -614,7 +614,7 @@ Run testpmd in the Virtual Machine. # use for bonding of virtio and vf tests in VM /root/dpdk/<build_dir>/app/dpdk-testpmd \ - -l 0-3 -n 4 --numa-mem 350 -- --i --port-topology=chained + -l 0-3 --numa-mem 350 -- --i --port-topology=chained .. _lm_bond_virtio_sriov_switch_conf:
doc/guides/howto/lm_virtio_vhost_user.rst +1 -1
@@ -438,4 +438,4 @@ run_testpmd_in_vm.sh # test system has 8 cpus (0-7), use cpus 2-7 for VM /root/dpdk/<build_dir>/app/dpdk-testpmd \ - -l 0-5 -n 4 --numa-mem 350 -- --burst=64 --i + -l 0-5 --numa-mem 350 -- --burst=64 --i
doc/guides/howto/packet_capture_framework.rst +1 -1
@@ -89,7 +89,7 @@ inspect them using ``tcpdump``. #. Launch testpmd as the primary application:: - sudo <build_dir>/app/dpdk-testpmd -l 4-7 -n 4 -- -i --port-topology=chained + sudo <build_dir>/app/dpdk-testpmd -l 4-7 -- -i --port-topology=chained #. Launch the dpdk-dumpcap as follows::
doc/guides/howto/pvp_reference_benchmark.rst +2 -2
@@ -122,7 +122,7 @@ Testpmd launch .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 0,2,3,4,5 --numa-mem=1024 -n 4 \ + <build_dir>/app/dpdk-testpmd -l 0,2,3,4,5 --numa-mem=1024 \ --vdev 'net_vhost0,iface=/tmp/vhost-user1' \ --vdev 'net_vhost1,iface=/tmp/vhost-user2' -- \ --portmask=f -i --rxq=1 --txq=1 \
@@ -332,7 +332,7 @@ Start testpmd: .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 0,1,2 --numa-mem 1024 -n 4 \ + <build_dir>/app/dpdk-testpmd -l 0,1,2 --numa-mem 1024 \ --proc-type auto --file-prefix pg -- \ --portmask=3 --forward-mode=macswap --port-topology=chained \ --disable-rss -i --rxq=1 --txq=1 \
doc/guides/howto/vfd.rst +2 -2
@@ -83,7 +83,7 @@ The typical procedure to achieve this is as follows: #. Run a DPDK application on the PF in the host:: - dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0 + dpdk-testpmd -l 0-7 -- -i --txqflags=0 #. Bind the VF port to ``igb_uio`` in the VM::
@@ -91,7 +91,7 @@ The typical procedure to achieve this is as follows: #. Run a DPDK application on the VF in the VM:: - dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0 + dpdk-testpmd -l 0-7 -- -i --txqflags=0 Common functions of IXGBE and I40E
doc/guides/howto/virtio_user_for_container_networking.rst +2 -2
@@ -77,7 +77,7 @@ some minor changes. .. code-block:: console - $(testpmd) -l 0-1 -n 4 --numa-mem 1024,1024 \ + $(testpmd) -l 0-1 --numa-mem 1024,1024 \ --vdev 'eth_vhost0,iface=/tmp/sock0' \ --file-prefix=host --no-pci -- -i
@@ -87,7 +87,7 @@ some minor changes. docker run -i -t -v /tmp/sock0:/var/run/usvhost \ -v /dev/hugepages:/dev/hugepages \ - dpdk-app-testpmd testpmd -l 6-7 -n 4 -m 1024 --no-pci \ + dpdk-app-testpmd testpmd -l 6-7 -m 1024 --no-pci \ --vdev=virtio_user0,path=/var/run/usvhost \ --file-prefix=container \ -- -i
doc/guides/linux_gsg/build_sample_apps.rst +2 -3
@@ -109,10 +109,9 @@ The EAL options are as follows: affect legacy memory mode). Copy the DPDK application binary to your target, then run the application as follows -(assuming the platform has four memory channels per processor socket, -and that cores 0-3 are present and are to be used for running the application):: +(assuming that cores 0-3 are present and are to be used for running the application):: - ./dpdk-helloworld -l 0-3 -n 4 + ./dpdk-helloworld -l 0-3 .. note::
doc/guides/linux_gsg/linux_drivers.rst +2 -2
@@ -252,14 +252,14 @@ The token will be used for all PF and VF ports within the application. .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -a 86:00.0 \ + <build_dir>/app/dpdk-testpmd -l 22-25 -a 86:00.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i #. Start the DPDK application that will manage the VF device .. code-block:: console - <build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -a 86:02.0 \ + <build_dir>/app/dpdk-testpmd -l 26-29 -a 86:02.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=vf0 -- -i .. note::
doc/guides/nics/build_and_test.rst +1 -1
@@ -133,7 +133,7 @@ This section demonstrates how to setup and run ``testpmd`` in Linux. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -- -i Successful execution will show initialization messages from EAL, PMD and testpmd application. A prompt will be displayed at the end for user commands
doc/guides/nics/cpfl.rst +1 -1
@@ -215,7 +215,7 @@ low level hardware resources. .. code-block:: console - dpdk-testpmd -l 0,1 -n 4 -a 0000:af:00.6,vport=[0-1],flow_parser="refpkg.json" -- -i + dpdk-testpmd -l 0,1 -a 0000:af:00.6,vport=[0-1],flow_parser="refpkg.json" -- -i #. Create one flow to forward ETH-IPV4-TCP from I/O port to a local(CPF's) vport. Flow should be created on vport X. Group M should match fxp module. Action port_representor Y means forward packet to local vport Y::
doc/guides/nics/cxgbe.rst +1 -1
@@ -749,7 +749,7 @@ devices managed by librte_net_cxgbe in FreeBSD operating system. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -a 0000:02:00.4 -- -i Example output:
doc/guides/nics/fail_safe.rst +4 -4
@@ -116,7 +116,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-7 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-7 \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -b 84:00.0 -b 00:04.0 -- -i
@@ -130,7 +130,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-7 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-7 \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -a 81:00.0 -- -i
@@ -138,7 +138,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-7 -n 4 -a ff:ff.f \ + ./<build_dir>/app/dpdk-testpmd -l 0-7 -a ff:ff.f \ --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i #. Start testpmd, automatically probing the device 84:00.0 and using it with
@@ -146,7 +146,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-7 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-7 \ --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i
doc/guides/nics/hns3.rst +2 -2
@@ -221,7 +221,7 @@ To start ``testpmd``, and add VLAN 10 to port 0: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --forward-mode=mac + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --forward-mode=mac ... testpmd> set promisc 0 off
@@ -242,7 +242,7 @@ Start ``testpmd``: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --rxq=8 --txq=8 \ + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --rxq=8 --txq=8 \ --nb-cores=8 --nb-ports=1 Add a rule to direct ``ipv4-udp`` packet whose ``dst_ip=2.2.2.5, src_ip=2.2.2.3,
doc/guides/nics/i40e.rst +3 -3
@@ -413,7 +413,7 @@ To start ``testpmd``, and add vlan 10 to port 0: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --forward-mode=mac + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --forward-mode=mac ... testpmd> set promisc 0 off
@@ -448,7 +448,7 @@ Start ``testpmd`` with ``--disable-rss`` and ``--pkt-filter-mode=perfect``: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 -- -i --disable-rss \ + ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --disable-rss \ --pkt-filter-mode=perfect --rxq=8 --txq=8 --nb-cores=8 \ --nb-ports=1
@@ -1026,7 +1026,7 @@ See :numref:`figure_intel_perf_test_setup` for the performance test setup. #. The command line of running l3fwd would be something like the following:: - ./dpdk-l3fwd -l 18-21 -n 4 -a 82:00.0 -a 85:00.0 \ + ./dpdk-l3fwd -l 18-21 -a 82:00.0 -a 85:00.0 \ -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)' This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding,
doc/guides/nics/ice.rst +3 -3
@@ -429,7 +429,7 @@ For example: .. code-block:: console - dpdk-testpmd -a 0000:31:00.0 -l 0-3 -n 4 -- -i --tx-offloads=0x200000 + dpdk-testpmd -a 0000:31:00.0 -l 0-3 -- -i --tx-offloads=0x200000 set fwd txonly set txtimes <inter_burst>,<intra_burst> start
@@ -541,7 +541,7 @@ Additional Options #. Bind the VF0, and run testpmd with 'cap=dcf' with port representor for VF 1 and 2:: - dpdk-testpmd -l 22-25 -n 4 -a 18:01.0,cap=dcf,representor=vf[1-2] -- -i + dpdk-testpmd -l 22-25 -a 18:01.0,cap=dcf,representor=vf[1-2] -- -i #. Monitor the VF2 interface network traffic::
@@ -570,7 +570,7 @@ To start ``testpmd``, and add vlan 10 to port 0: .. code-block:: console - ./app/dpdk-testpmd -l 0-15 -n 4 -- -i + ./app/dpdk-testpmd -l 0-15 -- -i ... testpmd> rx_vlan add 10 0
doc/guides/nics/intel_vf.rst +1 -1
@@ -545,7 +545,7 @@ The setup procedure is as follows: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -- -i #. Finally, access the Guest OS using vncviewer with the localhost:5900 port and check the lspci command output in the Guest OS. The virtual functions will be listed as available for use.
doc/guides/nics/ipn3ke.rst +2 -2
@@ -76,7 +76,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop + ./<build_dir>/app/dpdk-testpmd -l 0-15 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop HQoS and flow acceleration ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -87,7 +87,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port, enable FPGA HQoS and .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap + ./<build_dir>/app/dpdk-testpmd -l 0-15 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap Limitations or Known issues ---------------------------
doc/guides/nics/mlx4.rst +1 -1
@@ -428,7 +428,7 @@ devices managed by librte_net_mlx4. #. Start testpmd with basic parameters:: - dpdk-testpmd -l 8-15 -n 4 -a 0000:83:00.0 -a 0000:84:00.0 -- --rxq=2 --txq=2 -i + dpdk-testpmd -l 8-15 -a 0000:83:00.0 -a 0000:84:00.0 -- --rxq=2 --txq=2 -i Example output::
doc/guides/nics/mlx5.rst +1 -1
@@ -2359,7 +2359,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5. #. Start testpmd with basic parameters:: - dpdk-testpmd -l 8-15 -n 4 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i + dpdk-testpmd -l 8-15 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i Example output::
doc/guides/nics/null.rst +3 -3
@@ -14,7 +14,7 @@ Usage .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev net_null0 --vdev net_null1 -- -i Runtime Configuration
@@ -26,7 +26,7 @@ Runtime Configuration .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev "net_null0,copy=1" -- -i - ``size`` [optional, default=64 bytes]
@@ -35,7 +35,7 @@ Runtime Configuration .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev "net_null0,size=256" -- -i - ``no-rx`` [optional, default disabled]
doc/guides/nics/pcap_ring.rst +9 -9
@@ -40,7 +40,7 @@ Device name and stream options must be separated by commas as shown below: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,stream_opt0=..,stream_opt1=..' \ --vdev='net_pcap1,stream_opt0=..'
@@ -139,7 +139,7 @@ Read packets from one pcap file and write them to another: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained
@@ -147,7 +147,7 @@ Read packets from a network interface and write them to a pcap file: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface=eth0,tx_pcap=file_tx.pcap' \ -- --port-topology=chained
@@ -155,7 +155,7 @@ Read packets from a pcap file and write them to a network interface: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_iface=eth1' \ -- --port-topology=chained
@@ -163,14 +163,14 @@ Forward packets through two network interfaces: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,iface=eth0' --vdev='net_pcap1,iface=eth1' Enable 2 tx queues on a network interface: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface=eth1,tx_iface=eth1,tx_iface=eth1' \ -- --txq 2
@@ -178,7 +178,7 @@ Read only incoming packets from a network interface and write them back to the s .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_iface_in=eth1,tx_iface=eth1' Using libpcap-based PMD with the testpmd Application
@@ -203,7 +203,7 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained --no-flush-rx
@@ -223,7 +223,7 @@ Multiple devices may be specified, separated by commas. .. code-block:: console - ./dpdk-testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i + ./dpdk-testpmd -l 1-3 --vdev=net_ring0 --vdev=net_ring1 -- -i ... Interactive-mode selected Configuring Port 0 (socket 0)
doc/guides/nics/qede.rst +1 -1
@@ -272,7 +272,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - dpdk-testpmd -l 0,4-11 -n 4 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \ + dpdk-testpmd -l 0,4-11 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \ --txd=4096 --txfreet=4068 --enable-rx-cksum --rxq=4 --txq=4 \ --rss-ip --rss-udp
doc/guides/nics/softnic.rst +1 -1
@@ -366,7 +366,7 @@ commands. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-2 -S 2 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-2 -S 2 \ --vdev 'net_softnic0, \ firmware=./drivers/net/softnic/ \ firmware.cli, \
doc/guides/nics/thunderx.rst +1 -1
@@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0002:01:00.2 \ + ./<build_dir>/app/dpdk-testpmd -l 0-3 -a 0002:01:00.2 \ -- -i --no-flush-rx \ --port-topology=loop
doc/guides/nics/vhost.rst +1 -1
@@ -101,7 +101,7 @@ This section demonstrates vhost PMD with testpmd DPDK sample application. .. code-block:: console - ./dpdk-testpmd -l 0-3 -n 4 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i + ./dpdk-testpmd -l 0-3 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i Other basic DPDK preparations like hugepage enabling here. Please refer to the *DPDK Getting Started Guide* for detailed instructions.
doc/guides/nics/virtio.rst +1 -1
@@ -186,7 +186,7 @@ There is no vector callbacks for packed virtqueue for now. Example of using the vector version of the virtio poll mode driver in ``testpmd``:: - dpdk-testpmd -l 0-2 -n 4 -- -i --rxq=1 --txq=1 --nb-cores=1 + dpdk-testpmd -l 0-2 -- -i --rxq=1 --txq=1 --nb-cores=1 In-order callbacks only work on simulated virtio user vdev.
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +5 -5
@@ -378,7 +378,7 @@ Device names and bonding options must be separated by commas as shown below: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..' + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..' Link Bonding EAL Options ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -478,25 +478,25 @@ Create a bonding device in round robin mode with two members specified by their .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00' -- --port-topology=chained Create a bonding device in round robin mode with two members specified by their PCI address and an overriding MAC address: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=0,member=0000:0a:00.01,member=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained Create a bonding device in active backup mode with two members specified, and a primary member specified by their PCI addresses: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,member=0000:0a:00.01,member=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=1,member=0000:0a:00.01,member=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained Create a bonding device in balance mode with two members specified by their PCI addresses, and a transmission policy of layer 3 + 4 forwarding: .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,member=0000:0a:00.01,member=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained + ./<build_dir>/app/dpdk-testpmd -l 0-3 --vdev 'net_bonding0,mode=2,member=0000:0a:00.01,member=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained .. _bonding_testpmd_commands:
doc/guides/prog_guide/mempool_lib.rst +0 -3
@@ -45,9 +45,6 @@ The physical layout of the DRAM chips on the DIMM itself does not necessarily re When running an application, the EAL command line options provide the ability to add the number of memory channels and ranks. -.. note:: - - The command line must always have the number of memory channels specified for the processor. Examples of alignment for different DIMM architectures are shown in :numref:`figure_memory-management` and :numref:`figure_memory-management2`.
doc/guides/prog_guide/overview.rst +6 -5
@@ -22,16 +22,17 @@ Other libraries, outside of EAL, including the Hash, Longest Prefix Match (LPM) and rings libraries are also provided. Sample applications are provided to help show the user how to use various features of the DPDK. -The DPDK implements a run to completion model for packet processing, -where all resources must be allocated prior to calling Data Plane applications, -running as execution units on logical processing cores. -The model does not support a scheduler and all devices are accessed by polling. -The primary reason for not using interrupts is the performance overhead imposed by interrupt processing. +The DPDK supports multiple programming models for packet processing. +Mos of the sample applications use a polling mode for performance but +some of the samples use interrupt driven model is useful for saving power +but has additional performance overhead. If available, it is possible +to use the DPDK with event based hardware support. In addition to the run-to-completion model, a pipeline model may also be used by passing packets or messages between cores via the rings. This allows work to be performed in stages and may allow more efficient use of code on cores. + Development Environment -----------------------
doc/guides/sample_app_ug/cmd_line.rst +1 -1
@@ -55,7 +55,7 @@ To run the application in a Linux environment, issue the following command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-cmdline -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-cmdline -l 0-3 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/dist_app.rst +1 -1
@@ -54,7 +54,7 @@ Running the Application .. code-block:: console - $ ./<build-dir>/examples/dpdk-distributor -l 1-9,22 -n 4 -- -p f + $ ./<build-dir>/examples/dpdk-distributor -l 1-9,22 -- -p f #. Refer to the DPDK Getting Started Guide for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/hello_world.rst +1 -1
@@ -25,7 +25,7 @@ To run the example in a linux environment: .. code-block:: console - $ ./<build_dir>/examples/dpdk-helloworld -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-helloworld -l 0-3 Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/ipsec_secgw.rst +2 -2
@@ -270,7 +270,7 @@ The mapping of lcores to port/queues is similar to other l3fwd applications. For example, given the following command line to run application in poll mode:: - ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --numa-mem 0,2048 \ + ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 --numa-mem 0,2048 \ --vdev "crypto_null" -- -p 0xf -P -u 0x3 \ --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \ -f /path/to/config_file --transfer-mode poll \
@@ -368,7 +368,7 @@ For example, something like the following command line: .. code-block:: console - ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --numa-mem 0,2048 \ + ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 --numa-mem 0,2048 \ -a 81:00.0 -a 81:00.1 -a 81:00.2 -a 81:00.3 \ --vdev "crypto_aesni_mb" --vdev "crypto_null" \ -- \
doc/guides/sample_app_ug/ipv4_multicast.rst +1 -3
@@ -74,14 +74,12 @@ Typically, to run the IPv4 Multicast sample application, issue the following com .. code-block:: console - ./<build_dir>/examples/dpdk-ipv4_multicast -l 0-3 -n 3 -- -p 0x3 -q 1 + ./<build_dir>/examples/dpdk-ipv4_multicast -l 0-3 -- -p 0x3 -q 1 In this command: * The -l option enables cores 0, 1, 2 and 3 -* The -n option specifies 3 memory channels - * The -p option enables ports 0 and 1 * The -q option assigns 1 queue to each lcore
doc/guides/sample_app_ug/keep_alive.rst +1 -1
@@ -68,7 +68,7 @@ To run the application in linux environment with 4 lcores, 16 ports .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-keepalive -l 0-3 -n 4 -- -q 8 -p ffff -K 10 + ./<build_dir>/examples/dpdk-l2fwd-keepalive -l 0-3 -- -q 8 -p ffff -K 10 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL)
doc/guides/sample_app_ug/l2_forward_cat.rst +2 -2
@@ -74,13 +74,13 @@ To run the example in a ``linux`` environment and enable CAT on cpus 0-2: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -n 4 -- --l3ca="0x3@(0-2)" + ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -- --l3ca="0x3@(0-2)" Or to enable CAT and CDP on cpus 1,3: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -n 4 -- --l3ca="(0x00C00,0x00300)@(1,3)" + ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -- --l3ca="(0x00C00,0x00300)@(1,3)" If CDP is not supported, it will fail with following error message:
doc/guides/sample_app_ug/l2_forward_event.rst +4 -4
@@ -85,20 +85,20 @@ issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=poll + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -q 8 -p ffff --mode=poll Eventdev mode with 4 lcores, 16 ports, schedule method ordered and MAC address updating enabled, issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -p ffff --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -p ffff --eventq-sched=ordered or .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered Refer to the *DPDK Getting Started Guide* for general information on running applications and Environment Abstraction Layer (EAL) options.
@@ -116,7 +116,7 @@ The following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l2fwd-event -l 0-7 -s 0-3 -n 4 --vdev event_sw0 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l2fwd-event -l 0-7 -s 0-3 --vdev event_sw0 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered Explanation -----------
doc/guides/sample_app_ug/l2_forward_job_stats.rst +1 -1
@@ -99,7 +99,7 @@ and thousands separator printing, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd-jobstats -l 0-3 -n 4 -- -q 8 -p ffff -l + $ ./<build_dir>/examples/dpdk-l2fwd-jobstats -l 0-3 -- -q 8 -p ffff -l Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/l2_forward_real_virtual.rst +2 -2
@@ -116,7 +116,7 @@ updating enabled, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p ffff + $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -- -q 8 -p ffff To run the application in linux environment with 4 lcores, 4 ports, 8 RX queues per lcore, to forward RX traffic of ports 0 & 1 on ports 2 & 3 respectively and
@@ -124,7 +124,7 @@ vice versa, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p f --portmap="(0,2)(1,3)" + $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -- -q 8 -p f --portmap="(0,2)(1,3)" Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/l3_forward.rst +4 -4
@@ -157,7 +157,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In this command:
@@ -188,13 +188,13 @@ the following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -a <event device> -- -p 0x3 --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" or .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -a <event device> \ -- -p 0x03 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In this command:
@@ -218,7 +218,7 @@ scheduler. The following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-7 -S 16-19 -n 4 --vdev event_sw0 -- -p 0x3 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" + ./<build_dir>/examples/dpdk-l3fwd -l 0-7 -S 16-19 --vdev event_sw0 -- -p 0x3 --mode=eventdev --eventq-sched=ordered --rule_ipv4="rule_ipv4.cfg" --rule_ipv6="rule_ipv6.cfg" In case of eventdev mode, *--config* option is not used for ethernet port configuration. Instead, each ethernet port will be configured with this
doc/guides/sample_app_ug/l3_forward_graph.rst +3 -3
@@ -93,7 +93,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" In this command:
@@ -119,7 +119,7 @@ To enable pcap trace on each graph, use following command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --pcap-enable --pcap-num-cap=<number of packets> --pcap-file-name "</path/to/file>" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -- -p 0x3 --config="(0,0,1),(1,0,2)" --pcap-enable --pcap-num-cap=<number of packets> --pcap-file-name "</path/to/file>" In this command:
@@ -134,7 +134,7 @@ before including rte_graph_worker.h. Recompile and use following command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2,3,4 -n 4 -- -p 0x1 --config="(0,0,1)" -P --model="dispatch" + ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2,3,4 -- -p 0x1 --config="(0,0,1)" -P --model="dispatch" To enable graph walking model selection in run-time, remove the define of ``RTE_GRAPH_MODEL_SELECT``. Recompile and use the same command.
doc/guides/sample_app_ug/link_status_intr.rst +2 -2
@@ -50,12 +50,12 @@ where, * -T PERIOD: statistics will be refreshed each PERIOD seconds (0 to disable, 10 default) -To run the application in a linux environment with 4 lcores, 4 memory channels, 16 ports and 8 RX queues per lcore, +To run the application in a linux environment with 4 lcores, 16 ports and 8 RX queues per lcore, issue the command: .. code-block:: console - $ ./<build_dir>/examples/dpdk-link_status_interrupt -l 0-3 -n 4-- -q 8 -p ffff + $ ./<build_dir>/examples/dpdk-link_status_interrupt -l 0-3 -- -q 8 -p ffff Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/multi_process.rst +10 -10
@@ -40,7 +40,7 @@ passing at least two cores in the corelist: .. code-block:: console - ./<build_dir>/examples/dpdk-simple_mp -l 0-1 -n 4 --proc-type=primary + ./<build_dir>/examples/dpdk-simple_mp -l 0-1 --proc-type=primary For the first DPDK process run, the proc-type flag can be omitted or set to auto, since all DPDK processes will default to being a primary instance,
@@ -49,7 +49,7 @@ The process should start successfully and display a command prompt as follows: .. code-block:: console - $ ./<build_dir>/examples/dpdk-simple_mp -l 0-1 -n 4 --proc-type=primary + $ ./<build_dir>/examples/dpdk-simple_mp -l 0-1 --proc-type=primary ... EAL: Requesting 2 pages of size 1073741824 EAL: Requesting 768 pages of size 2097152
@@ -69,7 +69,7 @@ again run the same binary setting at least two cores in the corelist: .. code-block:: console - ./<build_dir>/examples/dpdk-simple_mp -l 2-3 -n 4 --proc-type=secondary + ./<build_dir>/examples/dpdk-simple_mp -l 2-3 --proc-type=secondary When running a secondary process such as above, the ``proc-type`` parameter can be specified as auto.
@@ -163,10 +163,10 @@ Example: .. code-block:: console - # ./<build_dir>/examples/dpdk-symmetric_mp -l 1 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=0 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 2 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=1 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 3 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=2 - # ./<build_dir>/examples/dpdk-symmetric_mp -l 4 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=3 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 1 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=0 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 2 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=1 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 3 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=2 + # ./<build_dir>/examples/dpdk-symmetric_mp -l 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=3 .. note::
@@ -243,9 +243,9 @@ the commands are: .. code-block:: console - # ./<build_dir>/examples/dpdk-mp_server -l 1-2 -n 4 -- -p 3 -n 2 - # ./<build_dir>/examples/dpdk-mp_client -l 3 -n 4 --proc-type=auto -- -n 0 - # ./<build_dir>/examples/dpdk-mp_client -l 4 -n 4 --proc-type=auto -- -n 1 + # ./<build_dir>/examples/dpdk-mp_server -l 1-2 -- -p 3 -n 2 + # ./<build_dir>/examples/dpdk-mp_client -l 3 --proc-type=auto -- -n 0 + # ./<build_dir>/examples/dpdk-mp_client -l 4 --proc-type=auto -- -n 1 .. note::
doc/guides/sample_app_ug/ptpclient.rst +1 -1
@@ -65,7 +65,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-ptpclient -l 1 -n 4 -- -p 0x1 -T 0 + ./<build_dir>/examples/dpdk-ptpclient -l 1 -- -p 0x1 -T 0 Refer to *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/qos_scheduler.rst +2 -2
@@ -180,7 +180,7 @@ The following is an example command with a single packet flow configuration: .. code-block:: console - ./<build_dir>/examples/dpdk-qos_sched -l 1,5,7 -n 4 -- --pfc "3,2,5,7" --cfg ./profile.cfg + ./<build_dir>/examples/dpdk-qos_sched -l 1,5,7 -- --pfc "3,2,5,7" --cfg ./profile.cfg This example uses a single packet flow configuration which creates one RX thread on lcore 5 reading from port 3 and a worker thread on lcore 7 writing to port 2.
@@ -189,7 +189,7 @@ Another example with 2 packet flow configurations using different ports but shar .. code-block:: console - ./<build_dir>/examples/dpdk-qos_sched -l 1,2,6,7 -n 4 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg + ./<build_dir>/examples/dpdk-qos_sched -l 1,2,6,7 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg Note that independent cores for the packet flow configurations for each of the RX, WT and TX thread are also supported, providing flexibility to balance the work.
doc/guides/sample_app_ug/rxtx_callbacks.rst +1 -1
@@ -38,7 +38,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-rxtx_callbacks -l 1 -n 4 -- [-t] + ./<build_dir>/examples/dpdk-rxtx_callbacks -l 1 -- [-t] Use -t to enable hardware timestamping. If not supported by the NIC, an error will be displayed.
doc/guides/sample_app_ug/skeleton.rst +1 -1
@@ -27,7 +27,7 @@ To run the example in a ``linux`` environment: .. code-block:: console - ./<build_dir>/examples/dpdk-skeleton -l 1 -n 4 + ./<build_dir>/examples/dpdk-skeleton -l 1 Refer to *DPDK Getting Started Guide* for general information on running applications and Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/timer.rst +1 -1
@@ -21,7 +21,7 @@ To run the example in linux environment: .. code-block:: console - $ ./<build_dir>/examples/dpdk-timer -l 0-3 -n 4 + $ ./<build_dir>/examples/dpdk-timer -l 0-3 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/vdpa.rst +1 -1
@@ -54,7 +54,7 @@ Take IFCVF driver for example: .. code-block:: console - ./dpdk-vdpa -l 1 -n 4 --numa-mem 1024,1024 \ + ./dpdk-vdpa -l 1 --numa-mem 1024,1024 \ -a 0000:06:00.3,vdpa=1 -a 0000:06:00.4,vdpa=1 \ -- --interactive
doc/guides/sample_app_ug/vhost.rst +1 -1
@@ -60,7 +60,7 @@ Start the vswitch example .. code-block:: console - ./dpdk-vhost -l 0-3 -n 4 --numa-mem 1024 \ + ./dpdk-vhost -l 0-3 --numa-mem 1024 \ -- --socket-file /tmp/sock0 --client \ ...
doc/guides/sample_app_ug/vm_power_management.rst +6 -6
@@ -186,7 +186,7 @@ Hypervisor Channel Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Configure ``virtio-serial`` channels using ``libvirt`` XML. -The XML structure is as follows: +The XML structure is as follows: .. code-block:: XML
@@ -275,11 +275,11 @@ than the EAL options: The application requires exactly two cores to run. One core for the CLI and the other for the channel endpoint monitor. For example, to run on -cores 0 and 1 on a system with four memory channels, issue the command: +cores 0 and 1 on a system, issue the command: .. code-block:: console - ./<build_dir>/examples/dpdk-vm_power_mgr -l 0-1 -n 4 + ./<build_dir>/examples/dpdk-vm_power_mgr -l 0-1 After successful initialization, the VM Power Manager CLI prompt appears:
@@ -365,7 +365,7 @@ physical CPU mask: set_pcpu_mask {vm_name} {vcpu} {pcpu} Set the binding of the virtual CPU on the VM to the physical CPU: - + .. code-block:: console set_pcpu {vm_name} {vcpu} {pcpu}
@@ -587,7 +587,7 @@ host, use a command like the following: .. code-block:: console - ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 + ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command will send the policy to the host:
@@ -701,7 +701,7 @@ To start the application and configure the power policy, and send it to the host .. code-block:: console - ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 + ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command will send the policy to the host:
doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst +1 -1
@@ -72,7 +72,7 @@ To run the example in a linux environment: .. code-block:: console - user@target:~$ ./<build_dir>/examples/dpdk-vmdq_dcb -l 0-3 -n 4 -- -p 0x3 --nb-pools 32 --nb-tcs 4 + user@target:~$ ./<build_dir>/examples/dpdk-vmdq_dcb -l 0-3 -- -p 0x3 --nb-pools 32 --nb-tcs 4 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/vmdq_forwarding.rst +1 -1
@@ -56,7 +56,7 @@ To run the example in a Linux environment: .. code-block:: console - user@target:~$ ./<build_dir>/examples/dpdk-vmdq -l 0-3 -n 4 -- -p 0x3 --nb-pools 16 + user@target:~$ ./<build_dir>/examples/dpdk-vmdq -l 0-3 -- -p 0x3 --nb-pools 16 Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/testpmd_app_ug/run_app.rst +1 -1
@@ -20,7 +20,7 @@ They must be separated from the EAL options, shown in the previous section, with .. code-block:: console - sudo ./dpdk-testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2 + sudo ./dpdk-testpmd -l 0-3 -- -i --portmask=0x1 --nb-cores=2 The command line options are:
doc/guides/tools/flow-perf.rst +1 -1
@@ -58,7 +58,7 @@ with a ``--`` separator: .. code-block:: console - sudo ./dpdk-test-flow_perf -n 4 -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 + sudo ./dpdk-test-flow_perf -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 The command line options are:
Signature · 1 line
2.47.2
Re: [PATCH v3 2/2] doc: remove use of '-n 4' option in documentation examples
Quoted 8 lines · On Tue, 15 Jul 2025 14:56:29 -0700 Stephen Hemminger…
Many places in the documentation are using -n 4 to set the number of memory channels. This is no longer required and is unneccessary in most cases.
Signed-off-by Stephen Hemminger <[email protected]>Acked-by Bruce Richardson <[email protected]>---
There still is wide variety of usage across examples an many likely require user to think "where is that binary?". It should be standardized in the documentation.
Also, checkpatch complained about the docker example, but it was always that way.
Thomas Monjalon
AppliedRe: [PATCH v3 0/2] cpu0 and memory channels doc update
In reply to Stephen Hemminger15/07/2025 23:56, Stephen Hemminger:
Quoted 6 lines
This is revised version of earlier patches to address some guidance about CPU and memory channels in the documentation.
Stephen Hemminger (2):
doc: add note about CPU 0
doc: remove use of '-n 4' option in documentation examples
Applied, thanks.