Commit 22ba9d0d authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'custom-multipath-hash' 

Ido Schimmel says:

====================
Add support for custom multipath hash

This patchset adds support for custom multipath hash policy for both
IPv4 and IPv6 traffic. The new policy allows user space to control the
outer and inner packet fields used for the hash computation.

Motivation
==========

Linux currently supports different multipath hash policies for IPv4 and
IPv6 traffic:

* Layer 3
* Layer 4
* Layer 3 or inner layer 3, if present

These policies hash on a fixed set of fields, which is inflexible and
against operators' requirements to control the hash input: "The ability
to control the inputs to the hash function should be a consideration in
any load-balancing RFP" [1].

An example of this inflexibility can be seen by the fact that none of
the current policies allows operators to use the standard 5-tuple and
the flow label for multipath hash computation. Such a policy is useful
in the following real-world example of a data center with the following
types of traffic:

* Anycast IPv6 TCP traffic towards layer 4 load balancers. Flow label is
constant (zero) to avoid breaking established connections

* Non-encapsulated IPv6 traffic. Flow label is used to re-route flows
around problematic (congested / failed) paths [2]

* IPv6 encapsulated traffic (IPv4-in-IPv6 or IPv6-in-IPv6). Outer flow
label is generated from encapsulated packet

* UDP encapsulated traffic. Outer source port is generated from
encapsulated packet

In the above example, using the inner flow information for hash
computation in addition to the outer flow information is useful during
failures of the BPF agent that selectively generates the flow label
based on the traffic type. In such cases, the self-healing properties of
the flow label are lost, but encapsulated flows are still load balanced.

Control over the inner fields is even more critical when encapsulation
is performed by hardware routers. For example, the Spectrum ASIC can
only encode 8 bits of entropy in the outer flow label / outer UDP source
port when performing IP / UDP encapsulation. In the case of IPv4 GRE
encapsulation there is no outer field to encode the inner hash in.

User interface
==============

In accordance with existing multipath hash configuration, the new custom
policy is added as a new option (3) to the
net.ipv{4,6}.fib_multipath_hash_policy sysctls. When the new policy is
used, the packet fields used for hash computation are determined by the
net.ipv{4,6}.fib_multipath_hash_fields sysctls. These sysctls accept a
bitmask according to the following table (from ip-sysctl.rst):

	====== ============================
	0x0001 Source IP address
	0x0002 Destination IP address
	0x0004 IP protocol
	0x0008 Flow Label
	0x0010 Source port
	0x0020 Destination port
	0x0040 Inner source IP address
	0x0080 Inner destination IP address
	0x0100 Inner IP protocol
	0x0200 Inner Flow Label
	0x0400 Inner source port
	0x0800 Inner destination port
	====== ============================

For example, to allow IPv6 traffic to be hashed based on standard
5-tuple and flow label:

 # sysctl -wq net.ipv6.fib_multipath_hash_fields=0x0037
 # sysctl -wq net.ipv6.fib_multipath_hash_policy=3

Implementation
==============

As with existing policies, the new policy relies on the flow dissector
to extract the packet fields for the hash computation. However, unlike
existing policies that either use the outer or inner flow, the new
policy might require both flows to be dissected.

To avoid unnecessary invocations of the flow dissector, the data path
skips dissection of the outer or inner flows if none of the outer or
inner fields are required.

In addition, inner flow dissection is not performed when no
encapsulation was encountered (i.e., 'FLOW_DIS_ENCAPSULATION' not set by
flow dissector) during dissection of the outer flow.

Testing
=======

Three new selftests are added with three different topologies that allow
testing of following traffic combinations:

* Non-encapsulated IPv4 / IPv6 traffic
* IPv4 / IPv6 overlay over IPv4 underlay
* IPv4 / IPv6 overlay over IPv6 underlay

All three tests follow the same pattern. Each time a different packet
field is used for hash computation. When the field changes in the packet
stream, traffic is expected to be balanced across the two paths. When
the field does not change, traffic is expected to be unbalanced across
the two paths.

Patchset overview
=================

Patches #1-#3 add custom multipath hash support for IPv4 traffic
Patches #4-#7 do the same for IPv6
Patches #8-#10 add selftests

Future work
===========

mlxsw support can be found here [3].

Changes since RFC v2 [4]:

* Patch #2: Document that 0x0008 is used for Flow Label
* Patch #2: Do not allow the bitmask to be zero
* Patch #6: Do not allow the bitmask to be zero

Changes since RFC v1 [5]:

* Use a bitmask instead of a bitmap

[1] https://blog.apnic.net/2018/01/11/ipv6-flow-label-misuse-hashing/
[2] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3acf3ec3f4b0fd4263989f2e4227bbd1c42b5fe1
[3] https://github.com/idosch/linux/tree/submit/custom_hash_mlxsw_v2
[4] https://lore.kernel.org/netdev/20210509151615.200608-1-idosch@idosch.org/
[5] https://lore.kernel.org/netdev/20210502162257.3472453-1-idosch@idosch.org/


====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents 06b38e23 b7715acb

Documentation/networking/ip-sysctl.rst

+58 −0
Original line number Diff line number Diff line
@@ -99,6 +99,35 @@ fib_multipath_hash_policy - INTEGER 
	- 0 - Layer 3

	- 1 - Layer 4

	- 2 - Layer 3 or inner Layer 3 if present

	- 3 - Custom multipath hash. Fields used for multipath hash calculation

	  are determined by fib_multipath_hash_fields sysctl



fib_multipath_hash_fields - UNSIGNED INTEGER

	When fib_multipath_hash_policy is set to 3 (custom multipath hash), the

	fields used for multipath hash calculation are determined by this

	sysctl.



	This value is a bitmask which enables various fields for multipath hash

	calculation.



	Possible fields are:



	====== ============================

	0x0001 Source IP address

	0x0002 Destination IP address

	0x0004 IP protocol

	0x0008 Unused (Flow Label)

	0x0010 Source port

	0x0020 Destination port

	0x0040 Inner source IP address

	0x0080 Inner destination IP address

	0x0100 Inner IP protocol

	0x0200 Inner Flow Label

	0x0400 Inner source port

	0x0800 Inner destination port

	====== ============================



	Default: 0x0007 (source IP, destination IP and IP protocol)



fib_sync_mem - UNSIGNED INTEGER

	Amount of dirty memory from fib entries that can be backlogged before
@@ -1743,6 +1772,35 @@ fib_multipath_hash_policy - INTEGER 
	- 0 - Layer 3 (source and destination addresses plus flow label)

	- 1 - Layer 4 (standard 5-tuple)

	- 2 - Layer 3 or inner Layer 3 if present

	- 3 - Custom multipath hash. Fields used for multipath hash calculation

	  are determined by fib_multipath_hash_fields sysctl



fib_multipath_hash_fields - UNSIGNED INTEGER

	When fib_multipath_hash_policy is set to 3 (custom multipath hash), the

	fields used for multipath hash calculation are determined by this

	sysctl.



	This value is a bitmask which enables various fields for multipath hash

	calculation.



	Possible fields are:



	====== ============================

	0x0001 Source IP address

	0x0002 Destination IP address

	0x0004 IP protocol

	0x0008 Flow Label

	0x0010 Source port

	0x0020 Destination port

	0x0040 Inner source IP address

	0x0080 Inner destination IP address

	0x0100 Inner IP protocol

	0x0200 Inner Flow Label

	0x0400 Inner source port

	0x0800 Inner destination port

	====== ============================



	Default: 0x0007 (source IP, destination IP and IP protocol)



anycast_src_echo_reply - BOOLEAN

	Controls the use of anycast addresses as source addresses for ICMPv6

include/net/ip_fib.h

+43 −0
Original line number Diff line number Diff line
@@ -466,6 +466,49 @@ int fib_sync_up(struct net_device *dev, unsigned char nh_flags); 
void fib_sync_mtu(struct net_device *dev, u32 orig_mtu);

void fib_nhc_update_mtu(struct fib_nh_common *nhc, u32 new, u32 orig);



/* Fields used for sysctl_fib_multipath_hash_fields.

 * Common to IPv4 and IPv6.

 *

 * Add new fields at the end. This is user API.

 */

#define FIB_MULTIPATH_HASH_FIELD_SRC_IP			BIT(0)

#define FIB_MULTIPATH_HASH_FIELD_DST_IP			BIT(1)

#define FIB_MULTIPATH_HASH_FIELD_IP_PROTO		BIT(2)

#define FIB_MULTIPATH_HASH_FIELD_FLOWLABEL		BIT(3)

#define FIB_MULTIPATH_HASH_FIELD_SRC_PORT		BIT(4)

#define FIB_MULTIPATH_HASH_FIELD_DST_PORT		BIT(5)

#define FIB_MULTIPATH_HASH_FIELD_INNER_SRC_IP		BIT(6)

#define FIB_MULTIPATH_HASH_FIELD_INNER_DST_IP		BIT(7)

#define FIB_MULTIPATH_HASH_FIELD_INNER_IP_PROTO		BIT(8)

#define FIB_MULTIPATH_HASH_FIELD_INNER_FLOWLABEL	BIT(9)

#define FIB_MULTIPATH_HASH_FIELD_INNER_SRC_PORT		BIT(10)

#define FIB_MULTIPATH_HASH_FIELD_INNER_DST_PORT		BIT(11)



#define FIB_MULTIPATH_HASH_FIELD_OUTER_MASK		\

	(FIB_MULTIPATH_HASH_FIELD_SRC_IP |		\

	 FIB_MULTIPATH_HASH_FIELD_DST_IP |		\

	 FIB_MULTIPATH_HASH_FIELD_IP_PROTO |		\

	 FIB_MULTIPATH_HASH_FIELD_FLOWLABEL |		\

	 FIB_MULTIPATH_HASH_FIELD_SRC_PORT |		\

	 FIB_MULTIPATH_HASH_FIELD_DST_PORT)



#define FIB_MULTIPATH_HASH_FIELD_INNER_MASK		\

	(FIB_MULTIPATH_HASH_FIELD_INNER_SRC_IP |	\

	 FIB_MULTIPATH_HASH_FIELD_INNER_DST_IP |	\

	 FIB_MULTIPATH_HASH_FIELD_INNER_IP_PROTO |	\

	 FIB_MULTIPATH_HASH_FIELD_INNER_FLOWLABEL |	\

	 FIB_MULTIPATH_HASH_FIELD_INNER_SRC_PORT |	\

	 FIB_MULTIPATH_HASH_FIELD_INNER_DST_PORT)



#define FIB_MULTIPATH_HASH_FIELD_ALL_MASK		\

	(FIB_MULTIPATH_HASH_FIELD_OUTER_MASK |		\

	 FIB_MULTIPATH_HASH_FIELD_INNER_MASK)



#define FIB_MULTIPATH_HASH_FIELD_DEFAULT_MASK		\

	(FIB_MULTIPATH_HASH_FIELD_SRC_IP |		\

	 FIB_MULTIPATH_HASH_FIELD_DST_IP |		\

	 FIB_MULTIPATH_HASH_FIELD_IP_PROTO)



#ifdef CONFIG_IP_ROUTE_MULTIPATH

int fib_multipath_hash(const struct net *net, const struct flowi4 *fl4,

		       const struct sk_buff *skb, struct flow_keys *flkeys);

include/net/ipv6.h

+8 −0
Original line number Diff line number Diff line
@@ -926,11 +926,19 @@ static inline int ip6_multipath_hash_policy(const struct net *net) 
{

	return net->ipv6.sysctl.multipath_hash_policy;

}

static inline u32 ip6_multipath_hash_fields(const struct net *net)

{

	return net->ipv6.sysctl.multipath_hash_fields;

}

#else

static inline int ip6_multipath_hash_policy(const struct net *net)

{

	return 0;

}

static inline u32 ip6_multipath_hash_fields(const struct net *net)

{

	return 0;

}

#endif



/*

include/net/netns/ipv4.h

+1 −0
Original line number Diff line number Diff line
@@ -210,6 +210,7 @@ struct netns_ipv4 { 
#endif

#endif

#ifdef CONFIG_IP_ROUTE_MULTIPATH

	u32 sysctl_fib_multipath_hash_fields;

	u8 sysctl_fib_multipath_use_neigh;

	u8 sysctl_fib_multipath_hash_policy;

#endif

include/net/netns/ipv6.h

+2 −1
Original line number Diff line number Diff line
@@ -28,8 +28,9 @@ struct netns_sysctl_ipv6 { 
	int ip6_rt_gc_elasticity;

	int ip6_rt_mtu_expires;

	int ip6_rt_min_advmss;

	u8 bindv6only;

	u32 multipath_hash_fields;

	u8 multipath_hash_policy;

	u8 bindv6only;

	u8 flowlabel_consistency;

	u8 auto_flowlabels;

	int icmpv6_time;