xref: /linux/Documentation/networking/mptcp-sysctl.rst (revision 484f0a071f8d482649eaf025dee7b76a7202fec9)
1.. SPDX-License-Identifier: GPL-2.0
2
3=====================
4MPTCP Sysfs variables
5=====================
6
7/proc/sys/net/mptcp/* Variables
8===============================
9
10enabled - BOOLEAN
11	Control whether MPTCP sockets can be created.
12
13	MPTCP sockets can be created if the value is 1. This is a
14	per-namespace sysctl.
15
16	Default: 1 (enabled)
17
18add_addr_timeout - INTEGER (seconds)
19	Set the timeout after which an ADD_ADDR control message will be
20	resent to an MPTCP peer that has not acknowledged a previous
21	ADD_ADDR message.
22
23	The default value matches TCP_RTO_MAX. This is a per-namespace
24	sysctl.
25
26	Default: 120
27
28checksum_enabled - BOOLEAN
29	Control whether DSS checksum can be enabled.
30
31	DSS checksum can be enabled if the value is nonzero. This is a
32	per-namespace sysctl.
33
34	Default: 0
35
36allow_join_initial_addr_port - BOOLEAN
37	Allow peers to send join requests to the IP address and port number used
38	by the initial subflow if the value is 1. This controls a flag that is
39	sent to the peer at connection time, and whether such join requests are
40	accepted or denied.
41
42	Joins to addresses advertised with ADD_ADDR are not affected by this
43	value.
44
45	This is a per-namespace sysctl.
46
47	Default: 1
48
49pm_type - INTEGER
50	Set the default path manager type to use for each new MPTCP
51	socket. In-kernel path management will control subflow
52	connections and address advertisements according to
53	per-namespace values configured over the MPTCP netlink
54	API. Userspace path management puts per-MPTCP-connection subflow
55	connection decisions and address advertisements under control of
56	a privileged userspace program, at the cost of more netlink
57	traffic to propagate all of the related events and commands.
58
59	This is a per-namespace sysctl.
60
61	* 0 - In-kernel path manager
62	* 1 - Userspace path manager
63
64	Default: 0
65
66stale_loss_cnt - INTEGER
67	The number of MPTCP-level retransmission intervals with no traffic and
68	pending outstanding data on a given subflow required to declare it stale.
69	The packet scheduler ignores stale subflows.
70	A low stale_loss_cnt  value allows for fast active-backup switch-over,
71	an high value maximize links utilization on edge scenarios e.g. lossy
72	link with high BER or peer pausing the data processing.
73
74	This is a per-namespace sysctl.
75
76	Default: 4
77
78scheduler - STRING
79	Select the scheduler of your choice.
80
81	Support for selection of different schedulers. This is a per-namespace
82	sysctl.
83
84	Default: "default"
85