Re: [PATCH v5 1/3] eal: deprecate old coremask-based EAL parameters

[David Marchand <david.marchand@redhat.com>]

On Tue, May 27, 2025 at 5:29 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> As the number of cores/cpus on platforms has increased over the years,
> the use of coremasks rather than core-lists for identifying DPDK cores
> has become more and more unwieldy. At this point, let's deprecate the
> coremask-based EAL parameters for future removal, and point users to the
> core-list based versions instead.
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
>  doc/guides/eventdevs/dlb2.rst                |  6 +++---
>  doc/guides/faq/faq.rst                       |  8 +++-----
>  doc/guides/linux_gsg/build_sample_apps.rst   |  7 +++----
>  doc/guides/linux_gsg/eal_args.include.rst    |  8 ++------
>  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/rel_notes/deprecation.rst         | 10 ++++++++++
>  doc/guides/sample_app_ug/ip_frag.rst         |  7 +------
>  doc/guides/sample_app_ug/ip_reassembly.rst   |  7 +------
>  doc/guides/sample_app_ug/multi_process.rst   | 14 +++++---------
>  doc/guides/sample_app_ug/qos_scheduler.rst   |  2 +-
>  doc/guides/sample_app_ug/test_pipeline.rst   |  2 +-
>  doc/guides/tools/testbbdev.rst               |  2 +-
>  lib/eal/common/eal_common_options.c          |  6 ++++++
>  15 files changed, 43 insertions(+), 48 deletions(-)

This patch will need some rebase.

I see you fixed a few docs, but there are quite some misses in
copy/pasted blocks:

doc/guides/bbdevs/acc100.rst:  ./test-bbdev.py -e="-c 0xff0
-a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v
./ldpc_dec_default.data
doc/guides/bbdevs/fpga_5gnr_fec.rst:  ./test-bbdev.py -e="-c 0xff0
-a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v
./ldpc_dec_default.data
doc/guides/bbdevs/fpga_5gnr_fec.rst:  ./test-bbdev.py -e="-c 0xff0
-a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v
./ldpc_dec_default.data
doc/guides/bbdevs/fpga_lte_fec.rst:  ./test-bbdev.py -e="-c 0xff0
-a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v
./turbo_dec_default.data
doc/guides/bbdevs/vrb1.rst:   test-bbdev.py -e="-c 0xff0
-a${VF_PCI_ADDR}" -c validation -n 64 -b 64 -l 1 -v
./ldpc_dec_default.data
doc/guides/bbdevs/vrb2.rst:   test-bbdev.py -e="-c 0xff0
-a${VF_PCI_ADDR}" -c validation -n 64 -b 64 -l 1 -v
./ldpc_dec_default.data

doc/guides/cryptodevs/mlx5.rst:      dpdk-test -c 1 -n 1 -w
<dev>,class=crypto,wcs_file=<file_path>
doc/guides/cryptodevs/mlx5.rst:      dpdk-test -c 1 -n 1 -w <dev>,class=crypto
doc/guides/cryptodevs/octeontx.rst:        ./build/ipsec-secgw
--log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config

doc/guides/howto/packet_capture_framework.rst:     sudo
<build_dir>/app/dpdk-testpmd -c 0xf0 -n 4 -- -i
--port-topology=chained

doc/guides/mempool/cnxk.rst:     echo "mempool_autotest" |
<build_dir>/app/test/dpdk-test -c 0xf0
--mbuf-pool-ops-name="cn10k_mempool_ops"
doc/guides/mempool/octeontx.rst:    ./<build_dir>/app/test/dpdk-test
-c 0xf --base-virtaddr=0x100000000000 \

doc/guides/nics/cnxk.rst:      ./<build_dir>/app/dpdk-testpmd -c 0xc
-a 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop
--rxq=1 --txq=1
doc/guides/nics/cnxk.rst:   ./dpdk-testpmd -c 3 -w
0002:02:00.0,switch_header=exdsa -- -i \
doc/guides/nics/cpfl.rst:      dpdk-testpmd -c 0x3 -n 4 -a
0000:af:00.6,vport=[0-1],flow_parser="refpkg.json" -- -i
doc/guides/nics/dpaa.rst:      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 1 \
doc/guides/nics/dpaa2.rst:      ./dpdk-testpmd -c 0xff -n 1 -- -i
--portmask=0x3 --nb-cores=1 --no-flush-rx
doc/guides/nics/dpaa2.rst:      ./dpdk-testpmd  -c 0xf -n 1 -- -i
--portmask 0x3 --nb-cores=1 --txq=4 --rxq=4
doc/guides/nics/fail_safe.rst:      ./<build_dir>/app/dpdk-testpmd -c
0xff -n 4 \
doc/guides/nics/fail_safe.rst:      ./<build_dir>/app/dpdk-testpmd -c
0xff -n 4 \
doc/guides/nics/fail_safe.rst:      ./<build_dir>/app/dpdk-testpmd -c
0xff -n 4 -a ff:ff.f \
doc/guides/nics/fail_safe.rst:      ./<build_dir>/app/dpdk-testpmd -c
0xff -n 4 \
doc/guides/nics/ice.rst:    dpdk-testpmd -c 0xff -- -i
doc/guides/nics/ice.rst:    dpdk-testpmd -c 0xff -- -i
doc/guides/nics/ice.rst:   examples/dpdk-ptpclient -c f -n 3 -a
0000:ec:00.1 --force-max-simd-bitwidth=64 -- -T 1 -p 0x1 -c 1
doc/guides/nics/mvneta.rst:    -c 3 -- -i --p 3 -a
doc/guides/nics/mvneta.rst:   ./dpdk-testpmd
--vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \
doc/guides/nics/mvneta.rst:   ./dpdk-l2fwd
--vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3
doc/guides/nics/mvpp2.rst:   ./dpdk-testpmd
--vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 7 -- \
doc/guides/nics/mvpp2.rst:     -c 7 -- -i -a --disable-hw-vlan-strip
--rxq=3 --txq=3
doc/guides/nics/mvpp2.rst:   ./dpdk-testpmd
--vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 3 -- -i --p 3 -a
--disable-hw-vlan-strip
doc/guides/nics/mvpp2.rst:              ./dpdk-testpmd
--vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 6 -- -i -p 3 -a --txd 1024
--rxd 1024
doc/guides/nics/mvpp2.rst:              ./dpdk-testpmd
--vdev=net_mrvl,iface=eth0,iface=eth2,cfg=./qos_config -c 7 -- \
doc/guides/nics/octeontx.rst:      ./<build_dir>/app/dpdk-testpmd -c 700 \
doc/guides/nics/softnic.rst:         ./dpdk-testpmd -c 0x7 -s 0x4
--vdev 'net_softnic0,firmware=<script
path>/firmware.cli,cpu_id=0,conn_port=8086' -- -i
doc/guides/nics/softnic.rst:        ./<build_dir>/app/dpdk-testpmd -c
0x7 -s 0x4 -n 4 \

doc/guides/sample_app_ug/bbdev_app.rst:    -c 0x38 --numa-mem=2,2
--file-prefix=bbdev -- -e 0x10 -d 0x20
doc/guides/sample_app_ug/ip_pipeline.rst:    $
./<build_dir>/examples/dpdk-ip_pipeline -c 0x3 -- -s
examples/route_ecmp.cli
doc/guides/sample_app_ug/l2_forward_macsec.rst:       -a 0002:06:00.0
-a 0002:07:00.0 -c 0x1E -- -p 0xf                      \
doc/guides/sample_app_ug/l2_forward_macsec.rst:       -a 0002:06:00.0
-a 0002:07:00.0 -c 0x1E -- -p 0xf                      \
doc/guides/sample_app_ug/ntb.rst:    ./<build_dir>/examples/dpdk-ntb
-c 0xf -n 6 -- -i
doc/guides/sample_app_ug/packet_ordering.rst:The -c EAL CPU_COREMASK
option has to contain at least 3 CPU cores.
doc/guides/sample_app_ug/pipeline.rst:    $
./<build_dir>/examples/dpdk-pipeline -c 0x3 -- -s
examples/pipeline/examples/vxlan.cli
doc/guides/sample_app_ug/vdpa.rst:        ./dpdk-vdpa -c 0x2 -n 4
--numa-mem 1024,1024 \
doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst:multiple queues. When
run with 8 threads, that is, with the -c FF option, each thread
receives and forwards packets from 16 queues.
doc/guides/sample_app_ug/vmdq_forwarding.rst:multiple queues. When run
with 8 threads, that is, with the -c FF option, each thread receives
and forwards packets from 16 queues.

doc/guides/tools/dumpcap.rst:   # <build_dir>/app/dpdk-dumpcap -i
0000:00:03.0 -c 6 -w /tmp/sample.pcapng
doc/guides/tools/graph.rst:   ./dpdk-graph -c 0xff -a 0002:02:00.0 -a
0002:03:00.0 --
doc/guides/tools/graph.rst:   ./dpdk-graph -c 0xff -a 0002:02:00.0 -a
0002:03:00.0 --
doc/guides/tools/graph.rst:   ./dpdk-graph -c 0xff
--vdev=net_pcap0,rx_pcap=in_net_pcap0.pcap,tx_pcap=out_net_pcap1.pcap
doc/guides/tools/graph.rst:   ./dpdk-graph -c 0xff
--vdev=net_pcap0,rx_pcap=in_net_pcap0.pcap,tx_pcap=out_net_pcap1.pcap

doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0x1f -s 0x10 --vdev=event_sw0 --
\
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0x1f -s 0x10 --vdev=event_sw0 --
\
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0x1f --vdev=event_dsw0 -- \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0x1f -- \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0x1f -- \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x2 --vdev=event_sw0 -- \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x2 --vdev=event_sw0 -- \
doc/guides/tools/testeventdev.rst:   sudo build/app/dpdk-test-eventdev
-c 0xf -s 0x2 --vdev=event_sw0 -- \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0xfff1 \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0x1f -s 0x2 \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0xf -- \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0xfff1 \
doc/guides/tools/testeventdev.rst:   sudo
<build_dir>/app/dpdk-test-eventdev -c 0x1f -s 0x2 \
doc/guides/tools/testeventdev.rst:    sudo
<build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
doc/guides/tools/testeventdev.rst:    sudo
<build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
doc/guides/tools/testeventdev.rst:    sudo
<build_dir>/app/dpdk-test-eventdev -c 0xf -- \
doc/guides/tools/testeventdev.rst:    sudo
<build_dir>/app/dpdk-test-eventdev -c 0xf -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \
doc/guides/tools/testmldev.rst:   sudo <build_dir>/app/dpdk-test-mldev
-c 0xf -a <PCI_ID> -- \

Otherwise, this change looks fine to me.

Thanks Bruce.

-- 
David Marchand