use core lists not masks in documentation
Subsystems (2)
cover use core lists not masks in documentation
For real-world use with dozens if not hundreds of cores, use of core masks becomes unwieldy. Core lists are preferred so update the examples and DPDK docs to refer to core lists over core masks i.e.
* use "-l" EAL option rather than "-c"
* use "-S" service core list option rather than "-s"
Bruce Richardson (2):
doc/eal: add doc entry for service core list flag
doc: use core lists rather than masks in guides
doc/guides/bbdevs/acc100.rst | 2 +- doc/guides/bbdevs/fpga_5gnr_fec.rst | 4 +- doc/guides/bbdevs/fpga_lte_fec.rst | 2 +- doc/guides/bbdevs/vrb1.rst | 2 +- doc/guides/bbdevs/vrb2.rst | 2 +- doc/guides/cryptodevs/octeontx.rst | 2 +- doc/guides/eventdevs/dlb2.rst | 6 +-- doc/guides/faq/faq.rst | 8 ++-- doc/guides/freebsd_gsg/build_sample_apps.rst | 8 ++-- doc/guides/howto/packet_capture_framework.rst | 2 +- doc/guides/linux_gsg/build_sample_apps.rst | 10 ++--- doc/guides/linux_gsg/eal_args.include.rst | 5 +++ doc/guides/mempool/cnxk.rst | 2 +- doc/guides/mempool/octeontx.rst | 2 +- doc/guides/nics/cnxk.rst | 2 +- doc/guides/nics/cpfl.rst | 2 +- doc/guides/nics/dpaa.rst | 2 +- doc/guides/nics/dpaa2.rst | 4 +- doc/guides/nics/fail_safe.rst | 8 ++-- doc/guides/nics/ice.rst | 4 +- doc/guides/nics/softnic.rst | 4 +- doc/guides/prog_guide/meson_ut.rst | 2 +- doc/guides/prog_guide/multi_proc_support.rst | 2 +- doc/guides/prog_guide/service_cores.rst | 8 ++-- doc/guides/sample_app_ug/bbdev_app.rst | 6 +-- doc/guides/sample_app_ug/ip_pipeline.rst | 2 +- doc/guides/sample_app_ug/ipsec_secgw.rst | 4 +- .../sample_app_ug/l2_forward_macsec.rst | 4 +- doc/guides/sample_app_ug/l3_forward.rst | 2 +- doc/guides/sample_app_ug/multi_process.rst | 8 ++-- doc/guides/sample_app_ug/ntb.rst | 2 +- doc/guides/sample_app_ug/pipeline.rst | 2 +- doc/guides/sample_app_ug/qos_scheduler.rst | 2 +- doc/guides/sample_app_ug/test_pipeline.rst | 2 +- doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/tools/comp_perf.rst | 5 +-- doc/guides/tools/cryptoperf.rst | 5 +-- doc/guides/tools/graph.rst | 13 +++---- doc/guides/tools/testbbdev.rst | 2 +- doc/guides/tools/testeventdev.rst | 39 +++++++++---------- doc/guides/tools/testmldev.rst | 27 +++++++------ 41 files changed, 110 insertions(+), 112 deletions(-)
--
2.48.1
PATCH 1/2 doc/eal: add doc entry for service core list flag
In the list of EAL arguments, only the "-s" flag for service cores was documented. Add an entry for the "-S" one too, which takes a core list instead of a core mask.
--- doc/guides/linux_gsg/eal_args.include.rst | 5 +++++ 1 file changed, 5 insertions(+)
doc/guides/linux_gsg/eal_args.include.rst +5 -0
@@ -79,6 +79,11 @@ Lcore-related options Hexadecimal bitmask of cores to be used as service cores. +* ``-S <service core list>`` + + List of cores to be used as service cores. + + Device-related options ~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.48.1
Re: [PATCH 1/2] doc/eal: add doc entry for service core list flag
Quoted 15 lines · Bruce Richardson
In the list of EAL arguments, only the "-s" flag for service cores was documented. Add an entry for the "-S" one too, which takes a core list instead of a core mask.
Signed-off-by Bruce Richardson <[email protected]>--- doc/guides/linux_gsg/eal_args.include.rst | 5 +++++ 1 file changed, 5 insertions(+)doc/guides/linux_gsg/eal_args.include.rst +0
-0@@ -79,6 +79,11 @@ Lcore-related options
doc/guides/linux_gsg/eal_args.include.rst Lcore-related options · line 89
Quoted 10 lines
doc/guides/linux_gsg/eal_args.include.rst +5
-0Hexadecimal bitmask of cores to be used as service cores. +* ``-S <service core list>`` + + List of cores to be used as service cores. + + Device-related options ~~~~~~~~~~~~~~~~~~~~~~
Signature · 2 lines
Thanks, Anatoly
RE: [PATCH 1/2] doc/eal: add doc entry for service core list flag
In reply to Bruce RichardsonQuoted 19 lines
In the list of EAL arguments, only the "-s" flag for service cores was documented. Add an entry for the "-S" one too, which takes a core list instead of a core mask.
Signed-off-by Bruce Richardson <[email protected]>--- doc/guides/linux_gsg/eal_args.include.rst | 5 +++++ 1 file changed, 5 insertions(+)doc/guides/linux_gsg/eal_args.include.rst +0
-0@@ -79,6 +79,11 @@ Lcore-related options Hexadecimal bitmask of cores to be used as service cores.
doc/guides/linux_gsg/eal_args.include.rst Lcore-related options
Quoted 10 lines
doc/guides/linux_gsg/eal_args.include.rst +5
-1+* ``-S <service core list>`` + + List of cores to be used as service cores. + + Device-related options ~~~~~~~~~~~~~~~~~~~~~~ --
Quoted 1 line
2.48.1
PATCH 2/2 doc: use core lists rather than masks in guides
In reply to Bruce RichardsonFor the guides for applications and examples, use the "-l" flag rather than the "-c" flag to pass in core lists rather than core masks. While for the trivial examples given, core masks work fine and may be easier; in real-world cases, with potentially hundreds of cores, core lists are a much better fix, so update the docs to reflect this.
Similarly replace instances of "-s <service-coremask>" with "-S <service-core-list>".
--- doc/guides/bbdevs/acc100.rst | 2 +- doc/guides/bbdevs/fpga_5gnr_fec.rst | 4 +- doc/guides/bbdevs/fpga_lte_fec.rst | 2 +- doc/guides/bbdevs/vrb1.rst | 2 +- doc/guides/bbdevs/vrb2.rst | 2 +- doc/guides/cryptodevs/octeontx.rst | 2 +- doc/guides/eventdevs/dlb2.rst | 6 +-- doc/guides/faq/faq.rst | 8 ++-- doc/guides/freebsd_gsg/build_sample_apps.rst | 8 ++-- doc/guides/howto/packet_capture_framework.rst | 2 +- doc/guides/linux_gsg/build_sample_apps.rst | 10 ++--- doc/guides/mempool/cnxk.rst | 2 +- doc/guides/mempool/octeontx.rst | 2 +- doc/guides/nics/cnxk.rst | 2 +- doc/guides/nics/cpfl.rst | 2 +- doc/guides/nics/dpaa.rst | 2 +- doc/guides/nics/dpaa2.rst | 4 +- doc/guides/nics/fail_safe.rst | 8 ++-- doc/guides/nics/ice.rst | 4 +- doc/guides/nics/softnic.rst | 4 +- doc/guides/prog_guide/meson_ut.rst | 2 +- doc/guides/prog_guide/multi_proc_support.rst | 2 +- doc/guides/prog_guide/service_cores.rst | 8 ++-- doc/guides/sample_app_ug/bbdev_app.rst | 6 +-- doc/guides/sample_app_ug/ip_pipeline.rst | 2 +- doc/guides/sample_app_ug/ipsec_secgw.rst | 4 +- .../sample_app_ug/l2_forward_macsec.rst | 4 +- doc/guides/sample_app_ug/l3_forward.rst | 2 +- doc/guides/sample_app_ug/multi_process.rst | 8 ++-- doc/guides/sample_app_ug/ntb.rst | 2 +- doc/guides/sample_app_ug/pipeline.rst | 2 +- doc/guides/sample_app_ug/qos_scheduler.rst | 2 +- doc/guides/sample_app_ug/test_pipeline.rst | 2 +- doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/tools/comp_perf.rst | 5 +-- doc/guides/tools/cryptoperf.rst | 5 +-- doc/guides/tools/graph.rst | 13 +++---- doc/guides/tools/testbbdev.rst | 2 +- doc/guides/tools/testeventdev.rst | 39 +++++++++---------- doc/guides/tools/testmldev.rst | 27 +++++++------ 40 files changed, 105 insertions(+), 112 deletions(-)
doc/guides/bbdevs/acc100.rst +1 -1
@@ -153,4 +153,4 @@ Specifically for the BBDEV ACC100 PMD, the command below can be used: .. code-block:: console ./pf_bb_config ACC100 -c acc100/acc100_config_vf_5g.cfg - ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data + ./test-bbdev.py -e="-l 4-11 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
doc/guides/bbdevs/fpga_5gnr_fec.rst +2 -2
@@ -231,11 +231,11 @@ Vista Creek (N3000) .. code-block:: console ./pf_bb_config FPGA_5GNR -c fpga_5gnr/fpga_5gnr_config_vf.cfg - ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data + ./test-bbdev.py -e="-l 4-11 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data Arrow Creek (N6000) .. code-block:: console ./pf_bb_config AGX100 -c agx100/agx100_config_1vf.cfg - ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data + ./test-bbdev.py -e="-l 4-11 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
doc/guides/bbdevs/fpga_lte_fec.rst +1 -1
@@ -211,4 +211,4 @@ Specifically for the BBDEV FPGA LTE FEC PMD, the command below can be used: .. code-block:: console ./pf_bb_config FPGA_LTE -c fpga_lte/fpga_lte_config_vf.cfg - ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./turbo_dec_default.data + ./test-bbdev.py -e="-l 4-11 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./turbo_dec_default.data
doc/guides/bbdevs/vrb1.rst +1 -1
@@ -163,4 +163,4 @@ Specifically for the bbdev Intel vRAN Boost v1 PMD, the command below can be use .. code-block:: console pf_bb_config ACC200 -c ./acc200/acc200_config_vf_5g.cfg - test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 64 -l 1 -v ./ldpc_dec_default.data + test-bbdev.py -e="-l 4-11 -a${VF_PCI_ADDR}" -c validation -n 64 -b 64 -l 1 -v ./ldpc_dec_default.data
doc/guides/bbdevs/vrb2.rst +1 -1
@@ -175,4 +175,4 @@ Specifically for the bbdev Intel vRAN Boost v2 PMD, the command below can be use .. code-block:: console pf_bb_config VRB2 -c ./vrb2/vrb2_config_vf_5g.cfg - test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 64 -l 1 -v ./ldpc_dec_default.data + test-bbdev.py -e="-l 4-11 -a${VF_PCI_ADDR}" -c validation -n 64 -b 64 -l 1 -v ./ldpc_dec_default.data
doc/guides/cryptodevs/octeontx.rst +1 -1
@@ -114,7 +114,7 @@ OCTEON TX crypto PMD. .. code-block:: console - ./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config + ./build/ipsec-secgw --log-level=8 -l 0-7 -- -P -p 0x3 -u 0x2 --config "(1,0,0),(0,0,0)" -f ep1.cfg Testing
doc/guides/eventdevs/dlb2.rst +3 -3
@@ -408,9 +408,9 @@ the DLB device locally available on the same tile along with other resources. To allocate optimal resources, probing is done for each producer port (PP) for a given CPU and the best performing ports are allocated to producers. The cpu used for probing is either the first -core of producer coremask (if present) or the second core of EAL -coremask. This will be extended later to probe for all CPUs in the -producer coremask or EAL coremask. Producer coremask can be passed +core of producer coremask DLB2 device parameter (if present) or the second core of EAL +core list. This will be extended later to probe for all CPUs in the +producer coremask or EAL core list. Producer coremask can be passed along with the BDF of the DLB devices. .. code-block:: console
doc/guides/faq/faq.rst +3 -5
@@ -47,11 +47,9 @@ therefore all the hugepages are allocated on the wrong socket. To avoid this scenario, either lower the amount of hugepage memory available to 1 GB size (or less), or run the application with taskset affinitizing the application to a would-be main core. -For example, if your EAL coremask is 0xff0, the main core will usually be the first core in the coremask (0x10); this is what you have to supply to taskset:: +For example, if your EAL core list is '4-11', the main core will usually be the first core in the list (core 4); this is what you have to supply to taskset:: - taskset 0x10 ./l2fwd -l 4-11 -n 2 - -.. Note: Instead of '-c 0xff0' use the '-l 4-11' as a cleaner way to define lcores. + taskset -c 4 ./l2fwd -l 4-11 -n 2 In this way, the hugepages have a greater chance of being allocated to the correct socket. Additionally, a ``--numa-mem`` option could be used to ensure the availability of memory for each socket, so that if hugepages were allocated on
@@ -167,7 +165,7 @@ Can I split packet RX to use DPDK and have an application's higher order functio ---------------------------------------------------------------------------------------------------------------- The DPDK's lcore threads are Linux pthreads bound onto specific cores. Configure the DPDK to do work on the same -cores and run the application's other work on other cores using the DPDK's "coremask" setting to specify which +cores and run the application's other work on other cores using the DPDK's "core list" (-l/--lcores) setting to specify which cores it should launch itself on.
doc/guides/freebsd_gsg/build_sample_apps.rst +4 -4
@@ -61,10 +61,10 @@ A large number of options can be given to the EAL when running an application. A full list of options can be got by passing `--help` to a DPDK application. Some of the EAL options for FreeBSD are as follows: -* ``-c COREMASK`` or ``-l CORELIST``: - A hexadecimal bit mask of the cores to run on. Note that core numbering - can change between platforms and should be determined beforehand. The corelist - is a list of cores to use instead of a core mask. +* ``-l CORELIST``: + A comma-separated list of the cores, or ranges of cores to run on. + For example, ``-l 0,1,4-6`` will run on cores 0, 1, 4, 5 and 6. + Note that core numbering can change between platforms and should be determined beforehand. * ``-b <domain:bus:devid.func>``: Blocklisting of ports; prevent EAL from using specified PCI device
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 -l 4-7 -n 4 -- -i --port-topology=chained #. Launch the dpdk-dumpcap as follows::
doc/guides/linux_gsg/build_sample_apps.rst +5 -5
@@ -33,16 +33,16 @@ The following is the list of options that can be given to the EAL: .. code-block:: console - ./rte-app [-c COREMASK | -l CORELIST] [-n NUM] [-b <domain:bus:devid.func>] \ + ./rte-app [ -l CORELIST] [-n NUM] [-b <domain:bus:devid.func>] \ [--numa-mem=MB,...] [-d LIB.so|DIR] [-m MB] [-r NUM] [-v] [--file-prefix] \ [--proc-type <primary|secondary|auto>] The EAL options are as follows: -* ``-c COREMASK`` or ``-l CORELIST``: - An hexadecimal bit mask of the cores to run on. Note that core numbering can - change between platforms and should be determined beforehand. The corelist is - a set of core numbers instead of a bitmap core mask. +* ``-l CORELIST``: + A comma-separated list of the cores, or ranges of cores to run on. + For example, ``-l 0,1,4-6`` will run on cores 0, 1, 4, 5 and 6. + Note that core numbering can change between platforms and should be determined beforehand. * ``-n NUM``: Number of memory channels per processor socket.
doc/guides/mempool/cnxk.rst +1 -1
@@ -88,4 +88,4 @@ Standalone mempool device Example command to run ``mempool_autotest`` test with standalone CN10K NPA device:: - echo "mempool_autotest" | <build_dir>/app/test/dpdk-test -c 0xf0 --mbuf-pool-ops-name="cn10k_mempool_ops" + echo "mempool_autotest" | <build_dir>/app/test/dpdk-test -l 4-7 --mbuf-pool-ops-name="cn10k_mempool_ops"
doc/guides/mempool/octeontx.rst +1 -1
@@ -60,5 +60,5 @@ Example: .. code-block:: console - ./<build_dir>/app/test/dpdk-test -c 0xf --base-virtaddr=0x100000000000 \ + ./<build_dir>/app/test/dpdk-test -l 0-3 --base-virtaddr=0x100000000000 \ --mbuf-pool-ops-name="octeontx_fpavf"
doc/guides/nics/cnxk.rst +1 -1
@@ -63,7 +63,7 @@ for details. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xc -a 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + ./<build_dir>/app/dpdk-testpmd -l 2,3 -a 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 EAL: Detected 4 lcore(s) EAL: Detected 1 NUMA nodes EAL: Multi-process socket /var/run/dpdk/rte/mp_socket
doc/guides/nics/cpfl.rst +1 -1
@@ -213,7 +213,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 -l 0,1 -n 4 -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/dpaa.rst +1 -1
@@ -254,7 +254,7 @@ for details. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 1 \ + ./<build_dir>/app/dpdk-testpmd -l 0-7 -n 1 \ -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx .....
doc/guides/nics/dpaa2.rst +2 -2
@@ -445,7 +445,7 @@ for details. .. code-block:: console - ./dpdk-testpmd -c 0xff -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx + ./dpdk-testpmd -l 0-7 -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx ..... EAL: Registered [pci] bus.
@@ -607,7 +607,7 @@ For a detailed usage description please refer to "Traffic Management" section in .. code-block:: console - ./dpdk-testpmd -c 0xf -n 1 -- -i --portmask 0x3 --nb-cores=1 --txq=4 --rxq=4 + ./dpdk-testpmd -l 0-3 -n 1 -- -i --portmask 0x3 --nb-cores=1 --txq=4 --rxq=4 #. Stop all ports:
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 -l 0-7 -n 4 \ --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 -l 0-7 -n 4 \ --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 -l 0-7 -n 4 -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 -l 0-7 -n 4 \ --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i
doc/guides/nics/ice.rst +2 -2
@@ -189,7 +189,7 @@ Runtime Configuration .. code-block:: console - dpdk-testpmd -c 0xff -- -i + dpdk-testpmd -l 0-7 -- -i port stop 0 port detach 0 port attach 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]',field_offs=92,field_name=pmd_dyn
@@ -200,7 +200,7 @@ Runtime Configuration .. code-block:: console - dpdk-testpmd -c 0xff -- -i + dpdk-testpmd -l 0-7 -- -i port stop 0 port detach 0 port attach 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]', \
doc/guides/nics/softnic.rst +2 -2
@@ -121,7 +121,7 @@ Soft NIC testing .. code-block:: console - ./dpdk-testpmd -c 0x7 -s 0x4 --vdev 'net_softnic0,firmware=<script path>/firmware.cli,cpu_id=0,conn_port=8086' -- -i + ./dpdk-testpmd -l 0-2 -S 2 --vdev 'net_softnic0,firmware=<script path>/firmware.cli,cpu_id=0,conn_port=8086' -- -i --portmask=0x2 .. code-block:: console
@@ -366,7 +366,7 @@ commands. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0x7 -s 0x4 -n 4 \ + ./<build_dir>/app/dpdk-testpmd -l 0-2 -S 2 -n 4 \ --vdev 'net_softnic0, \ firmware=./drivers/net/softnic/ \ firmware.cli, \
doc/guides/prog_guide/meson_ut.rst +1 -1
@@ -60,7 +60,7 @@ Arguments of ``test()`` that can be provided in meson.build are as below: Note: the content of meson ``--test-args`` option and the content of ``args`` are appended when invoking the DPDK test binary. -Because of this, it is recommended not to set any default coremask or memory +Because of this, it is recommended not to set any default corelist or memory configuration in per test ``args`` and rather let users select what best fits their environment. If a test can't run, then it should be skipped, as described below.
doc/guides/prog_guide/multi_proc_support.rst +1 -1
@@ -166,7 +166,7 @@ Some of these are documented below: so it is recommended that it be disabled only when absolutely necessary, and only when the implications of this change have been understood. -* All DPDK processes running as a single application and using shared memory must have distinct coremask/corelist arguments. +* All DPDK processes running as a single application and using shared memory must have distinct corelist arguments. It is not possible to have a primary and secondary instance, or two secondary instances, using any of the same logical cores. Attempting to do so can cause corruption of memory pool caches, among other issues.
doc/guides/prog_guide/service_cores.rst +4 -4
@@ -26,10 +26,10 @@ Service Core Initialization ~~~~~~~~~~~~~~~~~~~~~~~~~~~ There are two methods to having service cores in a DPDK application, either by -using the service coremask, or by dynamically adding cores using the API. -The simpler of the two is to pass the `-s` coremask argument to EAL, which will -take any cores available in the main DPDK coremask, and if the bits are also set -in the service coremask the cores become service-cores instead of DPDK +using the service corelist, or by dynamically adding cores using the API. +The simpler of the two is to pass the `-S` corelist argument to EAL, which will +take any cores available in the main DPDK corelist, and if also set +in the service corelist the cores become service-cores instead of DPDK application lcores. Enabling Services on Cores
doc/guides/sample_app_ug/bbdev_app.rst +3 -3
@@ -67,7 +67,7 @@ issue the command: .. code-block:: console $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -a <NIC0PCIADDR> \ - -c 0x38 --numa-mem=2,2 --file-prefix=bbdev -- -e 0x10 -d 0x20 + -l 3,4,5 --numa-mem=2,2 --file-prefix=bbdev -- -e 0x10 -d 0x20 where, NIC0PCIADDR is the PCI address of the Rx port
@@ -98,12 +98,12 @@ ports. .. code-block:: console - $ ./pktgen-3.4.0/app/x86_64-native-linux-gcc/pktgen -c 0x3 \ + $ ./pktgen-3.4.0/app/x86_64-native-linux-gcc/pktgen -l 1,2 \ --numa-mem=1,1 --file-prefix=pg -a <NIC1PCIADDR> -- -m 1.0 -P where: -* ``-c COREMASK``: A hexadecimal bitmask of cores to run on +* ``-l CORELIST``: A list of cores on which the app should run * ``--numa-mem``: Memory to allocate on specific sockets (use comma separated values) * ``--file-prefix``: Prefix for hugepage filenames * ``-a <NIC1PCIADDR>``: Add a PCI device in allow list. The argument format is <[domain:]bus:devid.func>.
doc/guides/sample_app_ug/ip_pipeline.rst +1 -1
@@ -71,7 +71,7 @@ The following is an example command to run ip pipeline application configured fo .. code-block:: console - $ ./<build_dir>/examples/dpdk-ip_pipeline -c 0x3 -- -s examples/route_ecmp.cli + $ ./<build_dir>/examples/dpdk-ip_pipeline -l 0,1 -- -s examples/route_ecmp.cli The application should start successfully and display as follows:
doc/guides/sample_app_ug/ipsec_secgw.rst +2 -2
@@ -322,14 +322,14 @@ where each option means: Similarly for example, given the following command line to run application in event app mode:: - ./<build_dir>/examples/dpdk-ipsec-secgw -c 0x3 -- -P -p 0x3 -u 0x1 \ + ./<build_dir>/examples/dpdk-ipsec-secgw -l 0,1 -- -P -p 0x3 -u 0x1 \ -f /path/to/config_file --transfer-mode event \ --event-schedule-type parallel --event-vector --vector-size 32 \ --vector-tmo 102400 \ where each option means: -* The ``-c`` option selects cores 0 and 1 to run on. +* The ``-l`` option selects cores 0 and 1 to run on. * The ``-P`` option enables promiscuous mode.
doc/guides/sample_app_ug/l2_forward_macsec.rst +2 -2
@@ -75,7 +75,7 @@ issue the command: .. code-block:: console $ ./<build_dir>/examples/dpdk-l2fwd-macsec -a 0002:04:00.0 -a 0002:05:00.0 \ - -a 0002:06:00.0 -a 0002:07:00.0 -c 0x1E -- -p 0xf \ + -a 0002:06:00.0 -a 0002:07:00.0 -l 1-4 -- -p 0xf \ --mcs-tx-portmask 0x5 --mcs-rx-portmask 0xA \ --mcs-port-config '(0,02:03:04:05:06:07,01:02:03:04:05:06), \ (1,02:03:04:05:06:17,01:02:03:04:05:16), \
@@ -89,7 +89,7 @@ issue the command: .. code-block:: console $ ./<build_dir>/examples/dpdk-l2fwd-macsec -a 0002:04:00.0 -a 0002:05:00.0 \ - -a 0002:06:00.0 -a 0002:07:00.0 -c 0x1E -- -p 0xf \ + -a 0002:06:00.0 -a 0002:07:00.0 -l 1-4 -- -p 0xf \ --mcs-tx-portmask 0x5 --mcs-rx-portmask 0xA \ --mcs-port-config="(0,02:03:04:05:06:07,01:02:03:04:05:06), \ (1,02:03:04:05:06:17,01:02:03:04:05:16), \
doc/guides/sample_app_ug/l3_forward.rst +1 -1
@@ -218,7 +218,7 @@ scheduler. The 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 16-19 -n 4 --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/multi_process.rst +4 -4
@@ -36,7 +36,7 @@ Running the Application ^^^^^^^^^^^^^^^^^^^^^^^ To run the application, start ``simple_mp`` binary in one terminal, -passing at least two cores in the coremask/corelist: +passing at least two cores in the corelist: .. code-block:: console
@@ -65,7 +65,7 @@ The process should start successfully and display a command prompt as follows: simple_mp > To run the secondary process to communicate with the primary process, -again run the same binary setting at least two cores in the coremask/corelist: +again run the same binary setting at least two cores in the corelist: .. code-block:: console
@@ -230,8 +230,8 @@ In addition to the EAL parameters, the application-specific parameters are: .. note:: In the server process, has a single thread using the lowest numbered lcore - in the coremask/corelist, performs all packet I/O. - If coremask/corelist parameter specifies with more than a single lcore bit set, + in the corelist, performs all packet I/O. + If corelist parameter specifies with more than a single lcore, an additional lcore will be used for a thread to print packet count periodically. The server application stores configuration data in shared memory,
doc/guides/sample_app_ug/ntb.rst +1 -1
@@ -32,7 +32,7 @@ The only available options are the standard ones for the EAL: .. code-block:: console - ./<build_dir>/examples/dpdk-ntb -c 0xf -n 6 -- -i + ./<build_dir>/examples/dpdk-ntb -l 0-3 -n 6 -- -i Refer to the *DPDK Getting Started Guide* for general information on running applications and the Environment Abstraction Layer (EAL)
doc/guides/sample_app_ug/pipeline.rst +1 -1
@@ -58,7 +58,7 @@ The following is an example command to run the application configured for the VX .. code-block:: console - $ ./<build_dir>/examples/dpdk-pipeline -c 0x3 -- -s examples/pipeline/examples/vxlan.cli + $ ./<build_dir>/examples/dpdk-pipeline -l 0,1 -- -s examples/pipeline/examples/vxlan.cli The application should start successfully and display as follows:
doc/guides/sample_app_ug/qos_scheduler.rst +1 -1
@@ -194,7 +194,7 @@ Another example with 2 packet flow configurations using different ports but shar 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. -The EAL coremask/corelist is constrained to contain the default main core 1 and the RX, WT and TX cores only. +The EAL corelist is constrained to contain the default main core 1 and the RX, WT and TX cores only. Explanation -----------
doc/guides/sample_app_ug/test_pipeline.rst +1 -1
@@ -47,7 +47,7 @@ The application execution command line is: ./dpdk-test-pipeline [EAL options] -- -p PORTMASK --TABLE_TYPE -The -c or -l EAL CPU coremask/corelist option has to contain exactly 3 CPU cores. +The ``-l/--lcores`` EAL CPU corelist option has to contain exactly 3 CPU cores. The first CPU core in the core mask is assigned for core A, the second for core B and the third for core C. The PORTMASK parameter must contain 2 or 4 ports.
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 --numa-mem 1024,1024 \ + ./dpdk-vdpa -l 1 -n 4 --numa-mem 1024,1024 \ -a 0000:06:00.3,vdpa=1 -a 0000:06:00.4,vdpa=1 \ -- --interactive
doc/guides/tools/comp_perf.rst +2 -3
@@ -43,10 +43,9 @@ The following are the EAL command-line options that can be used in conjunction with the ``dpdk-test-compress-perf`` application. See the DPDK Getting Started Guides for more information on these options. -* ``-c <COREMASK>`` or ``-l <CORELIST>`` +* ``-l <CORELIST>`` - Set the hexadecimal bitmask of the cores to run on. The corelist is a - list cores to use. + Specify the cores to be used by the application. .. Note::
doc/guides/tools/cryptoperf.rst +2 -3
@@ -60,10 +60,9 @@ The following are the EAL command-line options that can be used in conjunction with the ``dpdk-test-crypto-perf`` application. See the DPDK Getting Started Guides for more information on these options. -* ``-c <COREMASK>`` or ``-l <CORELIST>`` +* ``-l <CORELIST>`` - Set the hexadecimal bitmask of the cores to run on. The corelist is a - list cores to use. + Specify the cores to be used by the application. * ``-a <PCI>``
doc/guides/tools/graph.rst +6 -7
@@ -31,10 +31,9 @@ Following are the EAL command-line options that can be used in conjunction with the ``dpdk-graph`` application. See the DPDK Getting Started Guides for more information on these options. -``-c <COREMASK>`` or ``-l <CORELIST>`` +``-l <CORELIST>`` - Set the hexadecimal bit mask of the cores to run on. - The CORELIST is a list of cores to be used. + List the set of cores to be used. Application Options ~~~~~~~~~~~~~~~~~~~
@@ -95,21 +94,21 @@ For H/W devices .. code-block:: console - ./dpdk-graph -c 0xff -a 0002:02:00.0 -a 0002:03:00.0 -- + ./dpdk-graph -l 0-7 -a 0002:02:00.0 -a 0002:03:00.0 -- -s <dpdk_root_dir>/app/graph/examples/l3fwd.cli - ./dpdk-graph -c 0xff -a 0002:02:00.0 -a 0002:03:00.0 -- + ./dpdk-graph -l 0-7 -a 0002:02:00.0 -a 0002:03:00.0 -- -s <dpdk_root_dir>/app/graph/examples/l2fwd.cli For net_pcapX devices .. code-block:: console - ./dpdk-graph -c 0xff --vdev=net_pcap0,rx_pcap=in_net_pcap0.pcap,tx_pcap=out_net_pcap1.pcap + ./dpdk-graph -l 0-7 --vdev=net_pcap0,rx_pcap=in_net_pcap0.pcap,tx_pcap=out_net_pcap1.pcap --vdev=net_pcap1,rx_pcap=in_net_pcap1.pcap,tx_pcap=out_net_pcap0.pcap -- -s <dpdk_root_dir>/app/graph/examples/l3fwd_pcap.cli - ./dpdk-graph -c 0xff --vdev=net_pcap0,rx_pcap=in_net_pcap0.pcap,tx_pcap=out_net_pcap1.pcap + ./dpdk-graph -l 0-7 --vdev=net_pcap0,rx_pcap=in_net_pcap0.pcap,tx_pcap=out_net_pcap1.pcap --vdev=net_pcap1,rx_pcap=in_net_pcap1.pcap,tx_pcap=out_net_pcap0.pcap -- -s <dpdk_root_dir>/app/graph/examples/l2fwd_pcap.cli
doc/guides/tools/testbbdev.rst +1 -1
@@ -78,7 +78,7 @@ The following are the command-line options: ``-l NUM_LCORES, --num_lcores NUM_LCORES`` Specifies number of lcores to run. If not specified num_lcores is set - according to value from RTE configuration (EAL coremask) + according to value from RTE configuration (EAL corelist) ``-b BURST_SIZE [BURST_SIZE ...], --burst-size BURST_SIZE [BURST_SIZE ...]`` Specifies operations enqueue/dequeue burst size. If not specified burst_size is
doc/guides/tools/testeventdev.rst +19 -20
@@ -27,10 +27,9 @@ The following are the EAL command-line options that can be used in conjunction with the ``dpdk-test-eventdev`` application. See the DPDK Getting Started Guides for more information on these options. -* ``-c <COREMASK>`` or ``-l <CORELIST>`` +* ``-l <CORELIST>`` - Set the hexadecimal bitmask of the cores to run on. The corelist is a - list of cores to use. + List the set of cores to use. * ``--vdev <driver><id>``
@@ -329,7 +328,7 @@ Example command to run order queue test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0x1f -s 0x10 --vdev=event_sw0 -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-4 -S 4 --vdev=event_sw0 -- \ --test=order_queue --plcores 1 --wlcores 2,3
@@ -416,14 +415,14 @@ Example command to run with the software event device: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0x1f -s 0x10 --vdev=event_sw0 -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-4 -S 4 --vdev=event_sw0 -- \ --test=atomic_queue --plcores 1 --wlcores 2,3 Example command to run with the distributed software event device: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0x1f --vdev=event_dsw0 -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-4 --vdev=event_dsw0 -- \ --test=atomic_queue --plcores 1 --wlcores 2,3,4
@@ -486,7 +485,7 @@ Example command to run order ``all types queue`` test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0x1f -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-4 -- \ --test=order_atq --plcores 1 --wlcores 2,3
@@ -550,7 +549,7 @@ Example command to run order ``all types queue`` test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0x1f -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-4 -- \ --test=atomic_atq --plcores 1 --wlcores 2,3
@@ -657,14 +656,14 @@ Example command to run perf queue test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x2 --vdev=event_sw0 -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-3 -S 1 --vdev=event_sw0 -- \ --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0 Example command to run perf queue test with producer enqueuing a burst of events: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x2 --vdev=event_sw0 -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-3 -S 1 --vdev=event_sw0 -- \ --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0 \ --prod_enq_burst_sz=32
@@ -672,14 +671,14 @@ Example command to run perf queue test with ethernet ports: .. code-block:: console - sudo build/app/dpdk-test-eventdev -c 0xf -s 0x2 --vdev=event_sw0 -- \ + sudo build/app/dpdk-test-eventdev -l 0-3 -S 1 --vdev=event_sw0 -- \ --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev Example command to run perf queue test with event timer adapter: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xfff1 \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0,4-15 \ -- --wlcores 4 --plcores 12 --test perf_queue --stlist=a \ --prod_type_timerdev --fwd_latency
@@ -687,7 +686,7 @@ Example command to run perf queue test with event DMA adapter: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0x1f -s 0x2 \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-4 -S 1 \ -- --test=perf_queue --plcores= 2 --wlcore=3 --stlist=a \ --prod_type_dmadev --dma_adptr_mode=1
@@ -778,14 +777,14 @@ Example command to run perf ``all types queue`` test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-3 -- \ --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0 Example command to run perf ``all types queue`` test with event timer adapter: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xfff1 \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0,4-15 \ -- --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \ --stlist=a --prod_type_timerdev --fwd_latency
@@ -793,7 +792,7 @@ Example command to run perf atq test with event DMA adapter: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0x1f -s 0x2 \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-4 -S 1 \ -- --test=perf_atq --plcores= 2 --wlcore=3 --stlist=a \ --prod_type_dmadev --dma_adptr_mode=1
@@ -911,14 +910,14 @@ Example command to run pipeline queue test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-3 -S 3 --vdev=event_sw0 -- \ --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a Example command to run pipeline atq test with vector events: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-3 -S 3 --vdev=event_sw0 -- \ --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a \ --enable_vector --vector_size 512
@@ -1017,13 +1016,13 @@ Example command to run pipeline atq test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-3 -- \ --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a Example command to run pipeline atq test with vector events: .. code-block:: console - sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -- \ + sudo <build_dir>/app/dpdk-test-eventdev -l 0-3 -- \ --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a \ --enable_vector --vector_size 512
doc/guides/tools/testmldev.rst +13 -14
@@ -28,9 +28,8 @@ The following are the EAL command-line options that can be used with the ``dpdk-test-mldev`` application. See the DPDK Getting Started Guides for more information on these options. -``-c <COREMASK>`` or ``-l <CORELIST>`` - Set the hexadecimal bitmask of the cores to run on. - The corelist is a list of cores to use. +``-l <CORELIST>`` + List the set of cores to use. ``-a <PCI_ID>`` Attach a PCI based ML device.
@@ -160,14 +159,14 @@ Command to run ``device_ops`` test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=device_ops Command to run ``device_ops`` test with user options: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=device_ops --queue_pairs <M> --queue_size <N>
@@ -254,7 +253,7 @@ Command to run ``model_ops`` test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=model_ops --models model_1.bin,model_2.bin,model_3.bin, model_4.bin
@@ -349,14 +348,14 @@ Example command to run ``inference_ordered`` test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=inference_ordered --filelist model.bin,input.bin,output.bin Example command to run ``inference_ordered`` test with a specific burst size: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=inference_ordered --filelist model.bin,input.bin,output.bin \ --burst_size 12
@@ -364,7 +363,7 @@ Example command to run ``inference_ordered`` test with multiple queue-pairs and .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=inference_ordered --filelist model.bin,input.bin,output.bin \ --queue_pairs 4 --queue_size 16
@@ -372,7 +371,7 @@ Example command to run ``inference_ordered`` with output validation using tolera .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=inference_ordered --filelist model.bin,input.bin,output.bin,reference.bin \ --tolerance 1.0
@@ -405,14 +404,14 @@ Example command to run ``inference_interleave`` test: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=inference_interleave --filelist model.bin,input.bin,output.bin Example command to run ``inference_interleave`` test with multiple models: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=inference_interleave --filelist model_A.bin,input_A.bin,output_A.bin \ --filelist model_B.bin,input_B.bin,output_B.bin
@@ -421,7 +420,7 @@ with a specific burst size, multiple queue-pairs and queue size: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=inference_interleave --filelist model.bin,input.bin,output.bin \ --queue_pairs 8 --queue_size 12 --burst_size 16
@@ -430,7 +429,7 @@ with multiple models and output validation using tolerance of ``2.0%``: .. code-block:: console - sudo <build_dir>/app/dpdk-test-mldev -c 0xf -a <PCI_ID> -- \ + sudo <build_dir>/app/dpdk-test-mldev -l 0-3 -a <PCI_ID> -- \ --test=inference_interleave \ --filelist model_A.bin,input_A.bin,output_A.bin,reference_A.bin \ --filelist model_B.bin,input_B.bin,output_B.bin,reference_B.bin \
--
2.48.1
Re: [PATCH 2/2] doc: use core lists rather than masks in guides
Quoted 11 lines · Bruce Richardson
For the guides for applications and examples, use the "-l" flag rather than the "-c" flag to pass in core lists rather than core masks. While for the trivial examples given, core masks work fine and may be easier; in real-world cases, with potentially hundreds of cores, core lists are a much better fix, so update the docs to reflect this.
Similarly replace instances of "-s <service-coremask>" with "-S <service-core-list>".
Signed-off-by Bruce Richardson <[email protected]>---
Signature · 2 lines
Thanks, Anatoly
RE: [PATCH 2/2] doc: use core lists rather than masks in guides
In reply to Bruce RichardsonQuoted 8 lines
For the guides for applications and examples, use the "-l" flag rather than the "-c" flag to pass in core lists rather than core masks. While for the trivial examples given, core masks work fine and may be easier; in real-world cases, with potentially hundreds of cores, core lists are a much better fix, so update the docs to reflect this.
Quoted 5 lines
Similarly replace instances of "-s <service-coremask>" with "-S <service-core-list>".
Signed-off-by Bruce Richardson <[email protected]>---
Quoted 1 line
2.48.1
Re: [PATCH 2/2] doc: use core lists rather than masks in guides
In reply to Bruce RichardsonHello Bruce,
Quoted 11 lines · Bruce Richardson
For the guides for applications and examples, use the "-l" flag rather than the "-c" flag to pass in core lists rather than core masks. While for the trivial examples given, core masks work fine and may be easier; in real-world cases, with potentially hundreds of cores, core lists are a much better fix, so update the docs to reflect this.
Similarly replace instances of "-s <service-coremask>" with "-S <service-core-list>".
Signed-off-by Bruce Richardson <[email protected]>
I have a few more changes.
I can squash them when applying if you double check them:
doc/guides/cryptodevs/mlx5.rst +2 -2
@@ -136,11 +136,11 @@ DEK is passed in plaintext without keytag. The mlx5 crypto PMD can be verified by running the test application:: Wrapped mode: - dpdk-test -c 1 -n 1 -w <dev>,class=crypto,wcs_file=<file_path> + dpdk-test -l 0 -n 1 -w <dev>,class=crypto,wcs_file=<file_path> RTE>>cryptodev_mlx5_autotest Plaintext mode: - dpdk-test -c 1 -n 1 -w <dev>,class=crypto + dpdk-test -l 0 -n 1 -w <dev>,class=crypto RTE>>cryptodev_mlx5_autotest
doc/guides/nics/cnxk.rst +1 -1
@@ -582,7 +582,7 @@ pattern. Example usage in testpmd:: - ./dpdk-testpmd -c 3 -w 0002:02:00.0,switch_header=exdsa -- -i \ + ./dpdk-testpmd -l 0,1 -w 0002:02:00.0,switch_header=exdsa -- -i \ --rx-offloads=0x00080000 --rxq 8 --txq 8 testpmd> flow create 0 ingress pattern eth / raw relative is 0 pattern \ spec ab pattern mask ab offset is 4 / end actions queue index 1 / end
doc/guides/nics/ice.rst +0 -0
@@ -413,7 +413,7 @@ and add the ``--force-max-simd-bitwidth=64``
startup parameter to disable vector
.. code-block:: console
- examples/dpdk-ptpclient -c f -n 3 -a 0000:ec:00.1
--force-max-simd-bitwidth=64 -- -T 1 -p 0x1 -c 1
+ examples/dpdk-ptpclient -l 0-3 -n 3 -a 0000:ec:00.1
--force-max-simd-bitwidth=64 -- -T 1 -p 0x1 -c 1
Tx Packet Pacing
~~~~~~~~~~~~~~~~
@@ -429,7 +429,7 @@ For example:
.. code-block:: console
- dpdk-testpmd -a 0000:31:00.0 -c f -n 4 -- -i --tx-offloads=0x200000
+ dpdk-testpmd -a 0000:31:00.0 -l 0-3 -n 4 -- -i --tx-offloads=0x200000
set fwd txonly
set txtimes <inter_burst>,<intra_burst>
start
doc/guides/nics/mvneta.rst +2 -2
@@ -90,8 +90,8 @@ be passed as part of EAL arguments. .. code-block:: console - ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 \ - -c 3 -- -i --p 3 -a + ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -l 0,1 -- \ + -i -p 3 -a Building MUSDK
@@ -144,12 +144,12 @@ In order to run testpmd example application
following command can be used:
.. code-block:: console
- ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \
- -i --p 3 -a --txd 256 --rxd 128 --rxq=1 --txq=1 --nb-cores=1
+ ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -l 0,1 -- \
+ -i -p 3 -a --txd 256 --rxd 128 --rxq=1 --txq=1 --nb-cores=1
In order to run l2fwd example application following command can be used:
.. code-block:: console
- ./dpdk-l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3
+ ./dpdk-l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -l 0,1 -- -T 1 -p 3
doc/guides/nics/mvpp2.rst +0 -0
@@ -162,7 +162,7 @@ In order to run testpmd example application
following command can be used:
.. code-block:: console
- ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 7 -- \
+ ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -l 0-2 -- \
--burst=128 --txd=2048 --rxd=1024 --rxq=2 --txq=2 --nb-cores=2 \
-i -a --rss-udp@@ -391,7 +391,7 @@ Usage example
.. code-block:: console
./dpdk-testpmd
--vdev=eth_mvpp2,iface=eth0,iface=eth2,cfg=/home/user/mrvl.conf \
- -c 7 -- -i -a --disable-hw-vlan-strip --rxq=3 --txq=3
+ -l 0-2 -- -i -a --disable-hw-vlan-strip --rxq=3 --txq=3
.. _flowapi:
@@ -504,7 +504,7 @@ Before proceeding run testpmd user application:
.. code-block:: console
- ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 3 -- -i
--p 3 -a --disable-hw-vlan-strip
+ ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -l 0,1 -- -i
--p 3 -a --disable-hw-vlan-strip
Example #1
^^^^^^^^^^
@@ -598,7 +598,7 @@ Usage example
.. code-block:: console
- ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2
-c 6 -- -i -p 3 -a --txd 1024 --rxd 1024
+ ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2
-l 1,2 -- -i -p 3 -a --txd 1024 --rxd 1024
#. Create meter profile:
@@ -680,7 +680,7 @@ For a detailed usage description please refer to "Traffic Management" section in
.. code-block:: console
- ./dpdk-testpmd
--vdev=net_mrvl,iface=eth0,iface=eth2,cfg=./qos_config -c 7 -- \
+ ./dpdk-testpmd
--vdev=net_mrvl,iface=eth0,iface=eth2,cfg=./qos_config -l 0-2 -- \
-i -p 3 --disable-hw-vlan-strip --rxq 3 --txq 3 --txd1024 --rxd 1024
#. Stop all ports:
doc/guides/nics/octeontx.rst +1 -1
@@ -68,7 +68,7 @@ for details. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 700 \ + ./<build_dir>/app/dpdk-testpmd -l 8-10 \ --base-virtaddr=0x100000000000 \ --mbuf-pool-ops-name="octeontx_fpavf" \ --vdev='event_octeontx' \
(quoted diff) +0 -0
b/doc/guides/sample_app_ug/packet_ordering.rst
index 1eb9a478aa..f96c0ad697 100644
doc/guides/sample_app_ug/packet_ordering.rst +1 -1
@@ -46,7 +46,7 @@ The application execution command line is: ./<build_dir>/examples/dpdk-packet_ordering [EAL options] -- -p PORTMASK / [--disable-reorder] [--insight-worker] -The -c EAL CPU_COREMASK option has to contain at least 3 CPU cores. +The -l EAL corelist option has to contain at least 3 CPU cores. The first CPU core in the core mask is the main core and would be assigned to RX core, the last to TX core and the rest to Worker cores.
Signature · 1 line
David Marchand
Re: [PATCH 2/2] doc: use core lists rather than masks in guides
Quoted 11 lines · David Marchand
Hello Bruce,
Quoted 7 lines · Bruce Richardson
For the guides for applications and examples, use the "-l" flag rather than the "-c" flag to pass in core lists rather than core masks. While for the trivial examples given, core masks work fine and may be easier; in real-world cases, with potentially hundreds of cores, core lists are a much better fix, so update the docs to reflect this.
Quoted 9 lines
Quoted 4 lines
Similarly replace instances of "-s <service-coremask>" with "-S <service-core-list>".
Signed-off-by Bruce Richardson <[email protected]>I have a few more changes.
I can squash them when applying if you double check them:
Yes, those look fine to me. Thanks for catching these.
I forgot when checking that we could have masks without the 0x on them.
/Bruce
Quoted 46 lines · Bruce Richardson
For real-world use with dozens if not hundreds of cores, use of core masks becomes unwieldy. Core lists are preferred so update the examples and DPDK docs to refer to core lists over core masks i.e.
* use "-l" EAL option rather than "-c"
* use "-S" service core list option rather than "-s"Bruce Richardson (2):
doc/eal: add doc entry for service core list flag
doc: use core lists rather than masks in guidesdoc/guides/bbdevs/acc100.rst | 2 +- doc/guides/bbdevs/fpga_5gnr_fec.rst | 4 +- doc/guides/bbdevs/fpga_lte_fec.rst | 2 +- doc/guides/bbdevs/vrb1.rst | 2 +- doc/guides/bbdevs/vrb2.rst | 2 +- doc/guides/cryptodevs/octeontx.rst | 2 +- doc/guides/eventdevs/dlb2.rst | 6 +-- doc/guides/faq/faq.rst | 8 ++-- doc/guides/freebsd_gsg/build_sample_apps.rst | 8 ++-- doc/guides/howto/packet_capture_framework.rst | 2 +- doc/guides/linux_gsg/build_sample_apps.rst | 10 ++--- doc/guides/linux_gsg/eal_args.include.rst | 5 +++ doc/guides/mempool/cnxk.rst | 2 +- doc/guides/mempool/octeontx.rst | 2 +- doc/guides/nics/cnxk.rst | 2 +- doc/guides/nics/cpfl.rst | 2 +- doc/guides/nics/dpaa.rst | 2 +- doc/guides/nics/dpaa2.rst | 4 +- doc/guides/nics/fail_safe.rst | 8 ++-- doc/guides/nics/ice.rst | 4 +- doc/guides/nics/softnic.rst | 4 +- doc/guides/prog_guide/meson_ut.rst | 2 +- doc/guides/prog_guide/multi_proc_support.rst | 2 +- doc/guides/prog_guide/service_cores.rst | 8 ++-- doc/guides/sample_app_ug/bbdev_app.rst | 6 +-- doc/guides/sample_app_ug/ip_pipeline.rst | 2 +- doc/guides/sample_app_ug/ipsec_secgw.rst | 4 +- .../sample_app_ug/l2_forward_macsec.rst | 4 +- doc/guides/sample_app_ug/l3_forward.rst | 2 +- doc/guides/sample_app_ug/multi_process.rst | 8 ++-- doc/guides/sample_app_ug/ntb.rst | 2 +- doc/guides/sample_app_ug/pipeline.rst | 2 +- doc/guides/sample_app_ug/qos_scheduler.rst | 2 +- doc/guides/sample_app_ug/test_pipeline.rst | 2 +-
Quoted 8 lines
doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/tools/comp_perf.rst | 5 +-- doc/guides/tools/cryptoperf.rst | 5 +-- doc/guides/tools/graph.rst | 13 +++---- doc/guides/tools/testbbdev.rst | 2 +- doc/guides/tools/testeventdev.rst | 39 +++++++++---------- doc/guides/tools/testmldev.rst | 27 +++++++------ 41 files changed, 110 insertions(+), 112 deletions(-)
Series applied, thanks Bruce.
Signature · 1 line
David Marchand