Documentation/netlink/specs/mptcp_pm.yaml

Source file repositories/reference/linux-study-clean/Documentation/netlink/specs/mptcp_pm.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/netlink/specs/mptcp_pm.yaml
Extension
.yaml
Size
8764 bytes
Lines
397
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
---
name: mptcp_pm
protocol: genetlink-legacy
doc: Multipath TCP.

c-family-name: mptcp-pm-name
c-version-name: mptcp-pm-ver
max-by-define: true
kernel-policy: per-op
cmd-cnt-name: --mptcp-pm-cmd-after-last

definitions:
  -
    type: enum
    name: event-type
    enum-name: mptcp-event-type
    doc: Netlink MPTCP event types
    name-prefix: mptcp-event-
    entries:
      -
        name: unspec
        doc: unused event
      -
        name: created
        doc: >-
          A new MPTCP connection has been created. It is the good time to
          allocate memory and send ADD_ADDR if needed. Depending on the
          traffic-patterns it can take a long time until the
          MPTCP_EVENT_ESTABLISHED is sent.
          Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,
          dport, [server-side], [flags].
      -
        name: established
        doc: >-
          A MPTCP connection is established (can start new subflows).
          Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,
          dport, [server-side], [flags].
      -
        name: closed
        doc: >-
          A MPTCP connection has stopped.
          Attribute: token.
      -
        name: announced
        value: 6
        doc: >-
          A new address has been announced by the peer.
          Attributes: token, rem_id, family, daddr4 | daddr6 [, dport].
      -
        name: removed
        doc: >-
          An address has been lost by the peer.
          Attributes: token, rem_id.
      -
        name: sub-established
        value: 10
        doc: >-
          A new subflow has been established. 'error' should not be set.
          Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |
          daddr6, sport, dport, backup, if-idx [, error].
      -
        name: sub-closed
        doc: >-
          A subflow has been closed. An error (copy of sk_err) could be set if
          an error has been detected for this subflow.
          Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |
          daddr6, sport, dport, backup, if-idx [, error].
      -
        name: sub-priority

Annotation

Implementation Notes