Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

ethtool: Symmetric OR-XOR RSS hash

Add an additional type of symmetric RSS hash type: OR-XOR.
The "Symmetric-OR-XOR" algorithm transforms the input as follows:

(SRC_IP | DST_IP, SRC_IP ^ DST_IP, SRC_PORT | DST_PORT, SRC_PORT ^ DST_PORT)

Change 'cap_rss_sym_xor_supported' to 'supported_input_xfrm', a bitmap
of supported RXH_XFRM_* types.

Reviewed-by: Cosmin Ratiu <cratiu@nvidia.com>
Reviewed-by: Tariq Toukan <tariqt@nvidia.com>
Signed-off-by: Gal Pressman <gal@nvidia.com>
Reviewed-by: Edward Cree <ecree.xilinx@gmail.com>
Link: https://patch.msgid.link/20250224174416.499070-2-gal@nvidia.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Gal Pressman and committed by
Jakub Kicinski
ecdff893 ad530283

+24 -14
+1 -1
Documentation/networking/ethtool-netlink.rst
··· 1934 1934 indicates queue number. 1935 1935 ETHTOOL_A_RSS_INPUT_XFRM attribute is a bitmap indicating the type of 1936 1936 transformation applied to the input protocol fields before given to the RSS 1937 - hfunc. Current supported option is symmetric-xor. 1937 + hfunc. Current supported options are symmetric-xor and symmetric-or-xor. 1938 1938 1939 1939 PLCA_GET_CFG 1940 1940 ============
+11 -4
Documentation/networking/scaling.rst
··· 49 49 are swapped, the computed hash is the same. This is beneficial in some 50 50 applications that monitor TCP/IP flows (IDS, firewalls, ...etc) and need 51 51 both directions of the flow to land on the same Rx queue (and CPU). The 52 - "Symmetric-XOR" is a type of RSS algorithms that achieves this hash 53 - symmetry by XORing the input source and destination fields of the IP 54 - and/or L4 protocols. This, however, results in reduced input entropy and 55 - could potentially be exploited. Specifically, the algorithm XORs the input 52 + "Symmetric-XOR" and "Symmetric-OR-XOR" are types of RSS algorithms that 53 + achieve this hash symmetry by XOR/ORing the input source and destination 54 + fields of the IP and/or L4 protocols. This, however, results in reduced 55 + input entropy and could potentially be exploited. 56 + 57 + Specifically, the "Symmetric-XOR" algorithm XORs the input 56 58 as follows:: 57 59 58 60 # (SRC_IP ^ DST_IP, SRC_IP ^ DST_IP, SRC_PORT ^ DST_PORT, SRC_PORT ^ DST_PORT) 61 + 62 + The "Symmetric-OR-XOR" algorithm, on the other hand, transforms the input as 63 + follows:: 64 + 65 + # (SRC_IP | DST_IP, SRC_IP ^ DST_IP, SRC_PORT | DST_PORT, SRC_PORT ^ DST_PORT) 59 66 60 67 The result is then fed to the underlying RSS algorithm. 61 68
+1 -1
drivers/net/ethernet/intel/iavf/iavf_ethtool.c
··· 1808 1808 static const struct ethtool_ops iavf_ethtool_ops = { 1809 1809 .supported_coalesce_params = ETHTOOL_COALESCE_USECS | 1810 1810 ETHTOOL_COALESCE_USE_ADAPTIVE, 1811 - .cap_rss_sym_xor_supported = true, 1811 + .supported_input_xfrm = RXH_XFRM_SYM_XOR, 1812 1812 .get_drvinfo = iavf_get_drvinfo, 1813 1813 .get_link = ethtool_op_get_link, 1814 1814 .get_ringparam = iavf_get_ringparam,
+1 -1
drivers/net/ethernet/intel/ice/ice_ethtool.c
··· 4770 4770 .supported_coalesce_params = ETHTOOL_COALESCE_USECS | 4771 4771 ETHTOOL_COALESCE_USE_ADAPTIVE | 4772 4772 ETHTOOL_COALESCE_RX_USECS_HIGH, 4773 - .cap_rss_sym_xor_supported = true, 4773 + .supported_input_xfrm = RXH_XFRM_SYM_XOR, 4774 4774 .rxfh_per_ctx_key = true, 4775 4775 .get_link_ksettings = ice_get_link_ksettings, 4776 4776 .set_link_ksettings = ice_set_link_ksettings,
+2 -3
include/linux/ethtool.h
··· 763 763 764 764 /** 765 765 * struct ethtool_ops - optional netdev operations 766 + * @supported_input_xfrm: supported types of input xfrm from %RXH_XFRM_*. 766 767 * @cap_link_lanes_supported: indicates if the driver supports lanes 767 768 * parameter. 768 769 * @cap_rss_ctx_supported: indicates if the driver supports RSS 769 770 * contexts via legacy API, drivers implementing @create_rxfh_context 770 771 * do not have to set this bit. 771 - * @cap_rss_sym_xor_supported: indicates if the driver supports symmetric-xor 772 - * RSS. 773 772 * @rxfh_per_ctx_key: device supports setting different RSS key for each 774 773 * additional context. Netlink API should report hfunc, key, and input_xfrm 775 774 * for every context, not just context 0. ··· 994 995 * of the generic netdev features interface. 995 996 */ 996 997 struct ethtool_ops { 998 + u32 supported_input_xfrm:8; 997 999 u32 cap_link_lanes_supported:1; 998 1000 u32 cap_rss_ctx_supported:1; 999 - u32 cap_rss_sym_xor_supported:1; 1000 1001 u32 rxfh_per_ctx_key:1; 1001 1002 u32 cap_rss_rxnfc_adds:1; 1002 1003 u32 rxfh_indir_space;
+4
include/uapi/linux/ethtool.h
··· 2289 2289 * be exploited to reduce the RSS queue spread. 2290 2290 */ 2291 2291 #define RXH_XFRM_SYM_XOR (1 << 0) 2292 + /* Similar to SYM_XOR, except that one copy of the XOR'ed fields is replaced by 2293 + * an OR of the same fields 2294 + */ 2295 + #define RXH_XFRM_SYM_OR_XOR (1 << 1) 2292 2296 #define RXH_XFRM_NO_CHANGE 0xff 2293 2297 2294 2298 /* L2-L4 network traffic flow types */
+4 -4
net/ethtool/ioctl.c
··· 1011 1011 if (rc) 1012 1012 return rc; 1013 1013 1014 - /* Sanity check: if symmetric-xor is set, then: 1014 + /* Sanity check: if symmetric-xor/symmetric-or-xor is set, then: 1015 1015 * 1 - no other fields besides IP src/dst and/or L4 src/dst 1016 1016 * 2 - If src is set, dst must also be set 1017 1017 */ 1018 - if ((rxfh.input_xfrm & RXH_XFRM_SYM_XOR) && 1018 + if ((rxfh.input_xfrm & (RXH_XFRM_SYM_XOR | RXH_XFRM_SYM_OR_XOR)) && 1019 1019 ((info.data & ~(RXH_IP_SRC | RXH_IP_DST | 1020 1020 RXH_L4_B_0_1 | RXH_L4_B_2_3)) || 1021 1021 (!!(info.data & RXH_IP_SRC) ^ !!(info.data & RXH_IP_DST)) || ··· 1388 1388 return -EOPNOTSUPP; 1389 1389 /* Check input data transformation capabilities */ 1390 1390 if (rxfh.input_xfrm && rxfh.input_xfrm != RXH_XFRM_SYM_XOR && 1391 + rxfh.input_xfrm != RXH_XFRM_SYM_OR_XOR && 1391 1392 rxfh.input_xfrm != RXH_XFRM_NO_CHANGE) 1392 1393 return -EINVAL; 1393 1394 if (rxfh.input_xfrm != RXH_XFRM_NO_CHANGE && 1394 - (rxfh.input_xfrm & RXH_XFRM_SYM_XOR) && 1395 - !ops->cap_rss_sym_xor_supported) 1395 + rxfh.input_xfrm & ~ops->supported_input_xfrm) 1396 1396 return -EOPNOTSUPP; 1397 1397 create = rxfh.rss_context == ETH_RXFH_CONTEXT_ALLOC; 1398 1398