* Use inclusive NIC/HCA language

* Add a description of receive_queues

This commit was SVN r18595.

ompi/mca/btl/openib/mca-btl-openib-hca-params.ini

@@ -6,63 +6,84 @@
 # Additional copyrights may follow
 #
 
-# This is the default HCA parameters file for Open MPI's OpenIB BTL.
-# If HCA vendors wish to add their respective values into this file
-# (that is distributed with Open MPI), please contact the Open MPI
-# development team.  See http://www.open-mpi.org/ for details.
+# This is the default NIC/HCA parameters file for Open MPI's OpenIB
+# BTL.  If NIC/HCA vendors wish to add their respective values into
+# this file (that is distributed with Open MPI), please contact the
+# Open MPI development team.  See http://www.open-mpi.org/ for
+# details.
 
 # This file is in the "ini" style, meaning that it has sections
 # identified section names enclosed in square brackets (e.g.,
 # "[Section name]") followed by "key = value" pairs indicating values
-# for a specific HCA vendor and model.  HCAs are identified by their
-# vendor ID and vendor part ID, which can be obtained by running the
-# diagnostic utility command "ibv_devinfo".  The fields "vendor_id"
-# and "vendor_part"id" are the vendor ID and vendor part ID,
-# respectively.
+# for a specific NIC/HCA vendor and model.  NICs/HCAs are identified
+# by their vendor ID and vendor part ID, which can be obtained by
+# running the diagnostic utility command "ibv_devinfo".  The fields
+# "vendor_id" and "vendor_part"id" are the vendor ID and vendor part
+# ID, respectively.
 
 # The sections in this file only accept a few fields:
 
-# vendor_id: a comma-delimited list of integers of HCA vendor IDs,
+# vendor_id: a comma-delimited list of integers of NIC/HCA vendor IDs,
 # expressed either in decimal or hexidecimal (e.g., "13" or "0xd").
 # Individual values can be taken directly from the output of
-# "ibv_devinfo".  HCA vendor ID's correspond to IEEE OUI's, for which
-# you can find the canonical list here:
+# "ibv_devinfo".  NIC/HCA vendor ID's correspond to IEEE OUI's, for
+# which you can find the canonical list here:
 # http://standards.ieee.org/regauth/oui/.  Example:
 #
 #     vendor_id = 0x05ad
 
-# vendor_part_id: a comma-delimited list of integers of different HCA
-# models from a single vendor, expressed in either decimal or
+# vendor_part_id: a comma-delimited list of integers of different
+# NIC/HCA models from a single vendor, expressed in either decimal or
 # hexidecimal (e.g., "13" or "0xd").  Individual values can be
 # obtained from the output of the "ibv_devinfo".  Example:
 #
 #     vendor_part_id = 25208,25218
 
 # mtu: an integer indicating the maximum transfer unit (MTU) to be
-# used with this HCA.  The effective MTU will be the minimum of an
-# HCA's MTU value and its peer HCA's MTU value.  Valid values are 256,
-# 512, 1024, 2048, and 4096.  Example:
+# used with this NIC/HCA.  The effective MTU will be the minimum of an
+# NIC's/HCA's MTU value and its peer NIC's/HCA's MTU value.  Valid
+# values are 256, 512, 1024, 2048, and 4096.  Example:
 #
 #    mtu = 1024
 
 # use_eager_rdma: an integer indicating whether RDMA should be used
 # for eager messages.  0 values indicate "no" (false); non-zero values
 # indicate "yes" (true).  This flag should only be enabled for
-# HCAs that can provide guarantees about ordering of data in memory --
-# that the last byte of an incoming packet will always be written
-# last.  Certain cards cannot provide this guarantee (such as iWARP
-# cards), while others can (such as many InfiniBand cards).  
+# NICs/HCAs that can provide guarantees about ordering of data in
+# memory -- that the last byte of an incoming RDMA write will always
+# be written last.  Certain cards cannot provide this guarantee, while
+# others can.
 
 #    use_eager_rdma = 1
 
+# receive_queues: a list of "bucket shared receive queues" (BSRQ) that
+# are opened between MPI process peer pairs for point-to-point
+# communications of messages shorter than the total length required
+# for RDMA transfer.  The use of multiple RQs, each with different
+# sized posted receive buffers can allow [much] better registered
+# memory utilization -- MPI messages are sent on the QP with the
+# smallest buffer size that will fit the message.  Note that flow
+# control messages are always sent across the QP with the smallest
+# buffer size.  Also note that the buffers *must* be listed in
+# increasing buffer size.  This parameter matches the
+# mca_btl_openib_receive_queues MCA parameter; see the ompi_info help
+# message and FAQ for a description of its values.  BSRQ
+# specifications are found in this precedence:
+
+# highest: specifying the mca_btl_openib_receive_queues MCA param
+# next:    finding a value in this file
+# lowest:  using the default mca_btl_openib_receive_queues MCA param value
+
+#    receive_queues = P,128,256,192,128:S,65536,256,192,128
+
 ############################################################################
 
 [default]
 # These are the default values, identified by the vendor and part ID
-# numbers of 0 and 0.  If queried HCA does not return vendor and part
-# ID numbers that match any of the sections in this file, the values
-# in this section are used.  Vendor IDs and part IDs can be hex or
-# decimal.
+# numbers of 0 and 0.  If queried NIC/HCA does not return vendor and
+# part ID numbers that match any of the sections in this file, the
+# values in this section are used.  Vendor IDs and part IDs can be hex
+# or decimal.
 vendor_id = 0
 vendor_part_id = 0
 use_eager_rdma = 0