mptcp-pm: A Multipath TCP path manager

[ gpl, library, mptcp, network, program ] [ Propose Tags ]

Multipath TCP (www.multipath-tcp.org) starting from version 0.95 provides a netlink path manager module. This package implements the userspace component in charge of controlling MPTCP subflow establishement and various behaviors. It contains a set of function that is also used in mptcpanalyzer.


[Skip to Readme]

Modules

  • Net
    • Net.Bitset
    • Net.IPAddress
    • Mptcp
      • Net.Mptcp.Constants
      • Net.Mptcp.Netlink
      • Net.Mptcp.PathManager
        • Upstream
          • Net.Mptcp.PathManager.Upstream.NdiffPorts
      • Net.Mptcp.Types
      • Upstream
        • Net.Mptcp.Upstream.Commands
        • Net.Mptcp.Upstream.Constants
      • Net.Mptcp.Utils
    • Net.SockDiag
      • Net.SockDiag.Constants
    • Tcp
      • Net.Tcp.Constants
  • Netlink
    • Netlink.Route

Flags

Automatic Flags
NameDescriptionDefault
withpolysemy

Add polysemy plugin

Enabled
cwndcapping

With an experimental kernel, it's possible to cap some congestion window

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.0.1, 0.0.2, 0.0.3, 0.0.4, 0.0.5
Change log CHANGELOG
Dependencies aeson, aeson-extra, aeson-pretty, base (>=4.12 && <4.17), bytestring, bytestring-conversion, cereal, containers, enumset, filepath, formatting, ip (>=1.7.3), lens, mptcp, mptcp-pm, mtl, netlink (>=1.1.1.0), optparse-applicative, polysemy, polysemy-log, polysemy-log-co, polysemy-plugin, pretty-simple, process, readable, temporary, text, transformers, unordered-containers [details]
License GPL-3.0-only
Author
Maintainer teto
Category Network, Mptcp
Home page https://github.com/teto/quantum2
Source repo head: git clone https://github.com/teto/mptcp-pm
Uploaded by teto at 2022-01-04T23:50:22Z
Distributions NixOS:0.0.5
Executables mptcp-pm
Downloads 933 total (10 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2022-01-05 [all 2 reports]

Readme for mptcp-pm-0.0.5

[back to package description]

Hackage

Presentation

This is a userspace mptcp path manager for the linux multipath TCP kernel, starting from version v0.95. It now also supports the upstream linux kernel.

This allows to monitor MPTCP connections and control what subflows to create and with a custom kernel it can even set specific values for the congestion windows.

Compilation

For now we need a custom version of netlink With a custom netlink and kernel Compile the custom netlink library with

$ cabal configure 

You may need some headers as well (NOTE: reference cabal.project instead):

$ cabal configure --extra-include-dirs=~/mptcp/build/usr/include
# or on nix you can also pass $(nix-build -A linuxHeaders)/include
# e.g., `cabal build --extra-include-dirs=/nix/store/3kag193bcwcslzz83chy93ryjv218rbp-linux-headers-5.14/include`

Usage

The netlink module asks for GENL_ADMIN_PERM which requires the CAP_NET_ADMIN privilege. You can assign this privilege via:

res=$(cabal list-bin exe:mptcp-manager)
sudo setcap cap_net_admin+ep "$res"

Enter the development shell and start the daemon:

$ nix develop
$ cabal run mptcp-manager

TODO

  • remove the need for MptcpSocket everywhere: it's just needed to write the header, which could be added/modifier later instead ! (to increase purity in the library)
  • we need to better keep track of subflow status (established vs WIP) ?
  • pass local/server IPs as commands to the PM ?
  • generate completion scripts via --zsh-completion-script

Acknowledgements

This work is sponsored by NGI.