mbox series

[v2,00/17] Replace terms master/slave

Message ID 20200914182002.6750-1-stephen@networkplumber.org (mailing list archive)
Headers
Series Replace terms master/slave |

Message

Stephen Hemminger Sept. 14, 2020, 6:19 p.m. UTC 
  As announced in 20.08 release notes, the terms for lcore role
will change in 20.11 release.

This is a project wide patchset to terminolgy used for DPDK lcore.
The term "master" referring to lcore is replaced with "main" and
"slave" lcore is replaced with "worker" lcore.

This is most visible in API for rte_get_master_lcore() which is
replaced with rte_get_main_lcore(). And the macros for iterating
over lcores are replaced as well.

The first patch introduces a way to mark macro's as deprecated
as well.

v2
   - fix more places found by Anatoly and grep
   - add coding style update
   - add memif changes

Stephen Hemminger (17):
  doc/coding_style: add policy about master/slave
  eal: add macro to mark macros as deprecated
  eal: rename lcore word choices
  rte_power: replace rte_master_lcore with rte_main_lcore
  drivers: replace master lcore with main lcore
  net/memif: replace master/slave arguments with server/client
  doc: replace master lcore with main lcore
  app/test: replace uses of master/slave
  app/test-pmd: replace master lcore with main lcore
  app/test-eventdev: replace use of master lcore with main lcore
  app: replace references to master/slave
  examples: replace use of master with main
  examples/multi_process: replace references to master/slave
  examples/performance-thread: replace reference to master lcore
  examples/qos: replace references to master
  examples/ipsec-secgw: replace master lcore with main lcore
  examples: replace master lcore with main lcore

 app/pdump/main.c                              |   2 +-
 app/test-acl/main.c                           |   2 +-
 app/test-bbdev/test_bbdev_perf.c              |  16 +--
 app/test-compress-perf/main.c                 |   8 +-
 app/test-crypto-perf/main.c                   |  14 +-
 app/test-eventdev/evt_options.c               |   2 +-
 app/test-eventdev/test_order_common.c         |  12 +-
 app/test-eventdev/test_perf_common.c          |  16 +--
 app/test-eventdev/test_pipeline_common.c      |  11 +-
 app/test-flow-perf/main.c                     |   2 +-
 app/test-pipeline/main.c                      |   4 +-
 app/test-pmd/cmdline.c                        |   2 +-
 app/test-pmd/config.c                         |   4 +-
 app/test-pmd/parameters.c                     |   2 +-
 app/test-pmd/testpmd.c                        |   4 +-
 app/test-sad/main.c                           |   4 +-
 app/test/autotest_test_funcs.py               |   2 +-
 app/test/meson.build                          |   2 +-
 app/test/test.c                               |   2 +-
 app/test/test_atomic.c                        |  26 ++--
 app/test/test_barrier.c                       |   2 +-
 app/test/test_compressdev_test_buffer.h       |   2 +-
 app/test/test_cryptodev.c                     |  16 +--
 app/test/test_distributor.c                   |   8 +-
 app/test/test_distributor_perf.c              |  10 +-
 app/test/test_eal_flags.c                     |  32 ++---
 app/test/test_efd.c                           |   2 +-
 app/test/test_efd_perf.c                      |   2 +-
 app/test/test_func_reentrancy.c               |  20 +--
 app/test/test_hash_multiwriter.c              |   4 +-
 app/test/test_hash_readwrite.c                |  39 +++--
 app/test/test_kni.c                           |  16 +--
 app/test/test_lpm_perf.c                      |   4 +-
 app/test/test_malloc.c                        |  12 +-
 app/test/test_mbuf.c                          |  33 +++--
 app/test/test_mcslock.c                       |  28 ++--
 app/test/test_mempool_perf.c                  |  10 +-
 app/test/test_mp_secondary.c                  |   2 +-
 app/test/test_pdump.c                         |   2 +-
 app/test/test_per_lcore.c                     |  14 +-
 app/test/test_pmd_perf.c                      |  20 +--
 app/test/test_rcu_qsbr.c                      |   2 +-
 app/test/test_rcu_qsbr_perf.c                 |   2 +-
 app/test/test_ring_perf.c                     |  14 +-
 app/test/test_ring_stress_impl.h              |  10 +-
 app/test/test_rwlock.c                        |  28 ++--
 app/test/test_service_cores.c                 |  14 +-
 app/test/test_spinlock.c                      |  34 ++---
 app/test/test_stack.c                         |   2 +-
 app/test/test_stack_perf.c                    |   6 +-
 app/test/test_ticketlock.c                    |  36 ++---
 app/test/test_timer.c                         | 109 +++++++-------
 app/test/test_timer_racecond.c                |  26 ++--
 app/test/test_timer_secondary.c               |   8 +-
 app/test/test_trace_perf.c                    |   4 +-
 doc/guides/contributing/coding_style.rst      |  25 +++-
 doc/guides/faq/faq.rst                        |   6 +-
 doc/guides/howto/debug_troubleshoot.rst       |   2 +-
 doc/guides/linux_gsg/eal_args.include.rst     |   4 +-
 doc/guides/nics/bnxt.rst                      |   2 +-
 doc/guides/nics/memif.rst                     |  78 +++++-----
 .../prog_guide/env_abstraction_layer.rst      |   6 +-
 .../prog_guide/event_ethernet_rx_adapter.rst  |   2 +-
 doc/guides/prog_guide/glossary.rst            |  10 +-
 doc/guides/rel_notes/deprecation.rst          |  19 ---
 doc/guides/rel_notes/release_20_11.rst        |  11 ++
 doc/guides/sample_app_ug/bbdev_app.rst        |   2 +-
 doc/guides/sample_app_ug/ethtool.rst          |   4 +-
 doc/guides/sample_app_ug/hello_world.rst      |  10 +-
 doc/guides/sample_app_ug/ioat.rst             |  14 +-
 doc/guides/sample_app_ug/ip_pipeline.rst      |   4 +-
 doc/guides/sample_app_ug/keep_alive.rst       |   2 +-
 doc/guides/sample_app_ug/l2_forward_event.rst |   4 +-
 .../sample_app_ug/l2_forward_real_virtual.rst |   5 +-
 doc/guides/sample_app_ug/l3_forward_graph.rst |   6 +-
 .../sample_app_ug/l3_forward_power_man.rst    |   2 +-
 doc/guides/sample_app_ug/link_status_intr.rst |   5 +-
 doc/guides/sample_app_ug/multi_process.rst    |   6 +-
 doc/guides/sample_app_ug/packet_ordering.rst  |   8 +-
 .../sample_app_ug/performance_thread.rst      |   6 +-
 doc/guides/sample_app_ug/ptpclient.rst        |   2 +-
 doc/guides/sample_app_ug/qos_scheduler.rst    |   4 +-
 doc/guides/sample_app_ug/timer.rst            |  16 +--
 doc/guides/testpmd_app_ug/run_app.rst         |   2 +-
 doc/guides/testpmd_app_ug/testpmd_funcs.rst   |   2 +-
 drivers/bus/dpaa/dpaa_bus.c                   |   2 +-
 drivers/net/bnxt/bnxt_ring.c                  |   4 +-
 drivers/net/memif/memif.h                     |  40 +++---
 drivers/net/memif/memif_socket.c              |  54 +++----
 drivers/net/memif/memif_socket.h              |   5 +-
 drivers/net/memif/rte_eth_memif.c             | 134 +++++++++---------
 drivers/net/memif/rte_eth_memif.h             |  20 +--
 drivers/net/mvpp2/mrvl_ethdev.c               |   6 +-
 drivers/net/qede/base/bcm_osal.c              |   4 +-
 drivers/net/softnic/rte_eth_softnic_thread.c  |   4 +-
 examples/bbdev_app/main.c                     |  14 +-
 examples/bond/main.c                          |  32 ++---
 examples/distributor/main.c                   |  10 +-
 examples/ethtool/ethtool-app/main.c           |  11 +-
 examples/eventdev_pipeline/main.c             |   2 +-
 examples/flow_classify/flow_classify.c        |   2 +-
 examples/helloworld/main.c                    |   6 +-
 examples/ioat/ioatfwd.c                       |   6 +-
 examples/ip_fragmentation/main.c              |   4 +-
 examples/ip_pipeline/main.c                   |   2 +-
 examples/ip_pipeline/thread.c                 |  16 +--
 examples/ip_reassembly/main.c                 |   4 +-
 examples/ipsec-secgw/event_helper.c           |   6 +-
 examples/ipsec-secgw/ipsec-secgw.c            |   4 +-
 examples/ipv4_multicast/main.c                |   4 +-
 examples/kni/main.c                           |   6 +-
 examples/l2fwd-cat/l2fwd-cat.c                |   2 +-
 examples/l2fwd-crypto/main.c                  |   8 +-
 examples/l2fwd-event/l2fwd_event_generic.c    |   2 +-
 .../l2fwd-event/l2fwd_event_internal_port.c   |   2 +-
 examples/l2fwd-event/l2fwd_poll.c             |   2 +-
 examples/l2fwd-event/main.c                   |   2 +-
 examples/l2fwd-jobstats/main.c                |   4 +-
 examples/l2fwd-keepalive/main.c               |   6 +-
 examples/l2fwd/main.c                         |   8 +-
 examples/l3fwd-acl/main.c                     |   4 +-
 examples/l3fwd-graph/main.c                   |  14 +-
 examples/l3fwd-power/main.c                   |  22 +--
 examples/l3fwd/main.c                         |   2 +-
 examples/link_status_interrupt/main.c         |   8 +-
 .../client_server_mp/mp_server/main.c         |  10 +-
 examples/multi_process/simple_mp/main.c       |   6 +-
 examples/multi_process/symmetric_mp/main.c    |   2 +-
 examples/ntb/ntb_fwd.c                        |  14 +-
 examples/packet_ordering/main.c               |  22 +--
 .../performance-thread/l3fwd-thread/main.c    |  16 +--
 .../performance-thread/pthread_shim/main.c    |   4 +-
 examples/ptpclient/ptpclient.c                |   4 +-
 examples/qos_meter/main.c                     |   4 +-
 examples/qos_sched/args.c                     |  26 ++--
 examples/qos_sched/cmdline.c                  |   2 +-
 examples/qos_sched/main.c                     |   2 +-
 examples/rxtx_callbacks/main.c                |   2 +-
 examples/server_node_efd/server/main.c        |  10 +-
 examples/skeleton/basicfwd.c                  |   2 +-
 examples/tep_termination/main.c               |  12 +-
 examples/timer/main.c                         |   8 +-
 examples/vhost/main.c                         |  10 +-
 examples/vmdq/main.c                          |   4 +-
 examples/vmdq_dcb/main.c                      |   6 +-
 lib/librte_eal/common/eal_common_dynmem.c     |  10 +-
 lib/librte_eal/common/eal_common_launch.c     |  36 ++---
 lib/librte_eal/common/eal_common_lcore.c      |   8 +-
 lib/librte_eal/common/eal_common_options.c    |  56 ++++----
 lib/librte_eal/common/eal_options.h           |   2 +
 lib/librte_eal/common/eal_private.h           |   6 +-
 lib/librte_eal/common/rte_random.c            |   2 +-
 lib/librte_eal/common/rte_service.c           |   2 +-
 lib/librte_eal/freebsd/eal.c                  |  28 ++--
 lib/librte_eal/freebsd/eal_thread.c           |  32 ++---
 lib/librte_eal/include/rte_common.h           |  11 ++
 lib/librte_eal/include/rte_eal.h              |   4 +-
 lib/librte_eal/include/rte_eal_trace.h        |   4 +-
 lib/librte_eal/include/rte_launch.h           |  60 ++++----
 lib/librte_eal/include/rte_lcore.h            |  35 +++--
 lib/librte_eal/linux/eal.c                    |  28 ++--
 lib/librte_eal/linux/eal_memory.c             |   8 +-
 lib/librte_eal/linux/eal_thread.c             |  32 ++---
 lib/librte_eal/rte_eal_version.map            |   2 +-
 lib/librte_eal/windows/eal.c                  |  16 +--
 lib/librte_eal/windows/eal_thread.c           |  30 ++--
 lib/librte_power/rte_power_empty_poll.c       |   2 +-
 167 files changed, 1055 insertions(+), 992 deletions(-)

Comments

Burakov, Anatoly Sept. 15, 2020, 10:09 a.m. UTC | #1 
On 14-Sep-20 7:19 PM, Stephen Hemminger wrote:
> As announced in 20.08 release notes, the terms for lcore role
> will change in 20.11 release.
> 
> This is a project wide patchset to terminolgy used for DPDK lcore.
> The term "master" referring to lcore is replaced with "main" and
> "slave" lcore is replaced with "worker" lcore.
> 
> This is most visible in API for rte_get_master_lcore() which is
> replaced with rte_get_main_lcore(). And the macros for iterating
> over lcores are replaced as well.
> 
> The first patch introduces a way to mark macro's as deprecated
> as well.
> 
> v2
>     - fix more places found by Anatoly and grep
>     - add coding style update
>     - add memif changes
> 

More missed places:

doc/guides/linux_gsg/quick_start.rst
   235,10:     EAL: Master core 0 is ready (tid=1b2ad720)
   297,10:     EAL: Master core 0 is ready (tid=de25b700)

doc/guides/sample_app_ug/performance_thread.rst
   1220,27: main EAL thread after all slave threads have stopped and 
returned to the C

drivers/bus/pci/pci_common_uio.c
   54,27: 			/* fd is not needed in slave process, close it */

drivers/bus/vmbus/vmbus_common_uio.c
   88,25: 	/* fd is not needed in slave process, close it */

drivers/event/dpaa2/dpaa2_eventdev_selftest.c
   504,31: launch_workers_and_wait(int (*master_worker)(void *),
   505,10: 			int (*slave_workers)(void *), uint32_t total_events,
   540,12: 			/* skip master */ 1,
   542,24: 	rte_eal_remote_launch(master_worker, &param[0], w_lcore);
   551,25: 		rte_eal_remote_launch(slave_workers, &param[port], w_lcore);

drivers/event/octeontx/ssovf_evdev_selftest.c
   604,31: launch_workers_and_wait(int (*master_worker)(void *),
   605,10: 			int (*slave_workers)(void *), uint32_t total_events,
   640,12: 			/* skip master */ 1,
   642,24: 	rte_eal_remote_launch(master_worker, &param[0], w_lcore);
   651,25: 		rte_eal_remote_launch(slave_workers, &param[port], w_lcore);

drivers/event/sw/sw_evdev_selftest.c
   3111,12: 			/* skip master */ 1,

drivers/net/softnic/rte_eth_softnic_internals.h
   550,4:  * Master thead: data plane thread context

drivers/net/softnic/rte_eth_softnic_thread.c
   21,4:  * Master thread: data plane thread init
   81,6: 		/* Master thread records */
   212,4:  * Master thread & data plane threads: message passing
   246,4:  * Master thread
   590,4:  * Master thread & data plane threads: message passing
   756,4:  * Master thread

lib/librte_eal/linux/eal_memory.c
   1740,55: 	 *    --socket-mem, we allocate all of our memory on master 
core socket.

lib/librte_kni/rte_kni.h
   83,43:  * This function is to be executed on the MASTER lcore only, 
after EAL