mptcp-sysctl.rst 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. .. SPDX-License-Identifier: GPL-2.0
  2. =====================
  3. MPTCP Sysfs variables
  4. =====================
  5. /proc/sys/net/mptcp/* Variables
  6. ===============================
  7. add_addr_timeout - INTEGER (seconds)
  8. Set the timeout after which an ADD_ADDR control message will be
  9. resent to an MPTCP peer that has not acknowledged a previous
  10. ADD_ADDR message.
  11. Do not retransmit if set to 0.
  12. The default value matches TCP_RTO_MAX. This is a per-namespace
  13. sysctl.
  14. Default: 120
  15. allow_join_initial_addr_port - BOOLEAN
  16. Allow peers to send join requests to the IP address and port number used
  17. by the initial subflow if the value is 1. This controls a flag that is
  18. sent to the peer at connection time, and whether such join requests are
  19. accepted or denied.
  20. Joins to addresses advertised with ADD_ADDR are not affected by this
  21. value.
  22. This is a per-namespace sysctl.
  23. Default: 1
  24. available_schedulers - STRING
  25. Shows the available schedulers choices that are registered. More packet
  26. schedulers may be available, but not loaded.
  27. blackhole_timeout - INTEGER (seconds)
  28. Initial time period in second to disable MPTCP on active MPTCP sockets
  29. when a MPTCP firewall blackhole issue happens. This time period will
  30. grow exponentially when more blackhole issues get detected right after
  31. MPTCP is re-enabled and will reset to the initial value when the
  32. blackhole issue goes away.
  33. 0 to disable the blackhole detection.
  34. Default: 3600
  35. checksum_enabled - BOOLEAN
  36. Control whether DSS checksum can be enabled.
  37. DSS checksum can be enabled if the value is nonzero. This is a
  38. per-namespace sysctl.
  39. Default: 0
  40. close_timeout - INTEGER (seconds)
  41. Set the make-after-break timeout: in absence of any close or
  42. shutdown syscall, MPTCP sockets will maintain the status
  43. unchanged for such time, after the last subflow removal, before
  44. moving to TCP_CLOSE.
  45. The default value matches TCP_TIMEWAIT_LEN. This is a per-namespace
  46. sysctl.
  47. Default: 60
  48. enabled - BOOLEAN
  49. Control whether MPTCP sockets can be created.
  50. MPTCP sockets can be created if the value is 1. This is a
  51. per-namespace sysctl.
  52. Default: 1 (enabled)
  53. pm_type - INTEGER
  54. Set the default path manager type to use for each new MPTCP
  55. socket. In-kernel path management will control subflow
  56. connections and address advertisements according to
  57. per-namespace values configured over the MPTCP netlink
  58. API. Userspace path management puts per-MPTCP-connection subflow
  59. connection decisions and address advertisements under control of
  60. a privileged userspace program, at the cost of more netlink
  61. traffic to propagate all of the related events and commands.
  62. This is a per-namespace sysctl.
  63. * 0 - In-kernel path manager
  64. * 1 - Userspace path manager
  65. Default: 0
  66. scheduler - STRING
  67. Select the scheduler of your choice.
  68. Support for selection of different schedulers. This is a per-namespace
  69. sysctl.
  70. Default: "default"
  71. stale_loss_cnt - INTEGER
  72. The number of MPTCP-level retransmission intervals with no traffic and
  73. pending outstanding data on a given subflow required to declare it stale.
  74. The packet scheduler ignores stale subflows.
  75. A low stale_loss_cnt value allows for fast active-backup switch-over,
  76. an high value maximize links utilization on edge scenarios e.g. lossy
  77. link with high BER or peer pausing the data processing.
  78. This is a per-namespace sysctl.
  79. Default: 4