app: deprecate ReactorMask from ini config file

This is not used anywhere, and is not something we can
set over RPC.  So make this a command-line only option
(as it should be).

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I2df862cdce2f17992d2324312d5c0e98b38a8acd
Reviewed-on: https://review.gerrithub.io/423930
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>

CHANGELOG.md

@@ -40,6 +40,12 @@ specified. This default has been removed. Users must now explicitly specify
 the location of this file to load CHAP shared secrets from a file, or use
 the related iSCSI RPC methods to add them at runtime.
 
+### Miscellaneous
+
+The ReactorMask config file parameter has been deprecated.  Users should
+use the -m or --cpumask command line option to specify the CPU core mask
+for the application.
+
 ## v18.07:
 
 ### bdev

doc/iscsi.md

@@ -48,14 +48,14 @@ to gain access to hardware resources such as huge memory pages and CPU core(s).
 functions to assign threads to specific cores.
 To ensure the SPDK iSCSI target has the best performance, place the NICs and the NVMe devices on the
 same NUMA node and configure the target to run on CPU cores associated with that node. The following
-parameters in the configuration file are used to configure SPDK iSCSI target:
+command line option is used to configure the SPDK iSCSI target:
 
-**ReactorMask:** A hexadecimal bit mask of the CPU cores that SPDK is allowed to execute work
-items on. The ReactorMask is located in the [Global] section of the configuration file. For example,
-to assign lcores 24,25,26 and 27 to iSCSI target work items, set the ReactorMask to:
-~~~{.sh}
-ReactorMask 0xF000000
 ~~~
+-m 0xF000000
+~~~
+
+This is a hexadecimal bit mask of the CPU cores where the iSCSI target will start polling threads.
+In this example, CPU cores 24, 25, 26 and 27 would be used.
 
 ### Configuring a LUN in the iSCSI Target {#iscsi_lun}
 

etc/spdk/iscsi.conf.in

@@ -14,11 +14,6 @@
   # Default: <the process PID>
   #SharedMemoryID 0
 
-  # Users can restrict work items to only run on certain cores by
-  #  specifying a ReactorMask.  Default is to allow work items to run
-  #  on core 0.
-  #ReactorMask 0xFFFF
-
   # Disable PCI access. PCI is enabled by default. Setting this
   # option will hide any PCI device from all SPDK modules, making
   # SPDK act as if they don't exist.

etc/spdk/nvmf.conf.in

@@ -10,11 +10,6 @@
 # Bracketed ([]) names define sections
 
 [Global]
-  # Users can restrict work items to only run on certain cores by
-  #  specifying a ReactorMask.  Default ReactorMask mask is defined as
-  #  -c option in the 'ealargs' setting at beginning of file nvmf_tgt.c.
-  #ReactorMask 0x00FF
-
   # Tracepoint group mask for spdk trace buffers
   # Default: 0x0 (all tracepoint groups disabled)
   # Set to 0xFFFF to enable all tracepoint groups.

etc/spdk/rocksdb.conf.in

@@ -11,10 +11,6 @@
 # Number of section key is used as a tag number.
 #  Ex. [TargetNode1] = TargetNode section key with tag number 1
 [Global]
-  # Users can restrict work items to only run on certain cores by
-  #  specifying a ReactorMask.  Default is to allow work items to run
-  #  on all cores.
-  #ReactorMask 0x1
 
 [Ioat]
   Enable No

etc/spdk/vhost.conf.in

@@ -14,11 +14,6 @@
   # Default: 0
   #InstanceID 0
 
-  # Users can restrict work items to only run on certain cores by
-  #  specifying a ReactorMask.  Default is to allow work items to run
-  #  on core 0.
-  #ReactorMask 0xFFFF
-
   # Disable PCI access. PCI is enabled by default. Setting this
   # option will hide any PCI device from all SPDK modules, making
   # SPDK act as if they don't exist.

lib/event/app.c

@@ -415,6 +415,8 @@ spdk_app_read_config_file_global_params(struct spdk_app_opts *opts)
 
 	if (opts->reactor_mask == NULL) {
 		if (sp && spdk_conf_section_get_val(sp, "ReactorMask")) {
+			SPDK_ERRLOG("ReactorMask config option is deprecated.  Use -m/--cpumask\n"
+				    "command line parameter instead.\n");
 			opts->reactor_mask = spdk_conf_section_get_val(sp, "ReactorMask");
 		} else {
 			opts->reactor_mask = SPDK_APP_DPDK_DEFAULT_CORE_MASK;