mptcp.h 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
  2. #ifndef _UAPI_MPTCP_H
  3. #define _UAPI_MPTCP_H
  4. #ifndef __KERNEL__
  5. #include <netinet/in.h> /* for sockaddr_in and sockaddr_in6 */
  6. #include <sys/socket.h> /* for struct sockaddr */
  7. #endif
  8. #include <linux/const.h>
  9. #include <linux/types.h>
  10. #include <linux/in.h> /* for sockaddr_in */
  11. #include <linux/in6.h> /* for sockaddr_in6 */
  12. #include <linux/socket.h> /* for sockaddr_storage and sa_family */
  13. #define MPTCP_SUBFLOW_FLAG_MCAP_REM _BITUL(0)
  14. #define MPTCP_SUBFLOW_FLAG_MCAP_LOC _BITUL(1)
  15. #define MPTCP_SUBFLOW_FLAG_JOIN_REM _BITUL(2)
  16. #define MPTCP_SUBFLOW_FLAG_JOIN_LOC _BITUL(3)
  17. #define MPTCP_SUBFLOW_FLAG_BKUP_REM _BITUL(4)
  18. #define MPTCP_SUBFLOW_FLAG_BKUP_LOC _BITUL(5)
  19. #define MPTCP_SUBFLOW_FLAG_FULLY_ESTABLISHED _BITUL(6)
  20. #define MPTCP_SUBFLOW_FLAG_CONNECTED _BITUL(7)
  21. #define MPTCP_SUBFLOW_FLAG_MAPVALID _BITUL(8)
  22. enum {
  23. MPTCP_SUBFLOW_ATTR_UNSPEC,
  24. MPTCP_SUBFLOW_ATTR_TOKEN_REM,
  25. MPTCP_SUBFLOW_ATTR_TOKEN_LOC,
  26. MPTCP_SUBFLOW_ATTR_RELWRITE_SEQ,
  27. MPTCP_SUBFLOW_ATTR_MAP_SEQ,
  28. MPTCP_SUBFLOW_ATTR_MAP_SFSEQ,
  29. MPTCP_SUBFLOW_ATTR_SSN_OFFSET,
  30. MPTCP_SUBFLOW_ATTR_MAP_DATALEN,
  31. MPTCP_SUBFLOW_ATTR_FLAGS,
  32. MPTCP_SUBFLOW_ATTR_ID_REM,
  33. MPTCP_SUBFLOW_ATTR_ID_LOC,
  34. MPTCP_SUBFLOW_ATTR_PAD,
  35. __MPTCP_SUBFLOW_ATTR_MAX
  36. };
  37. #define MPTCP_SUBFLOW_ATTR_MAX (__MPTCP_SUBFLOW_ATTR_MAX - 1)
  38. /* netlink interface */
  39. #define MPTCP_PM_NAME "mptcp_pm"
  40. #define MPTCP_PM_CMD_GRP_NAME "mptcp_pm_cmds"
  41. #define MPTCP_PM_EV_GRP_NAME "mptcp_pm_events"
  42. #define MPTCP_PM_VER 0x1
  43. /*
  44. * ATTR types defined for MPTCP
  45. */
  46. enum {
  47. MPTCP_PM_ATTR_UNSPEC,
  48. MPTCP_PM_ATTR_ADDR, /* nested address */
  49. MPTCP_PM_ATTR_RCV_ADD_ADDRS, /* u32 */
  50. MPTCP_PM_ATTR_SUBFLOWS, /* u32 */
  51. MPTCP_PM_ATTR_TOKEN, /* u32 */
  52. MPTCP_PM_ATTR_LOC_ID, /* u8 */
  53. MPTCP_PM_ATTR_ADDR_REMOTE, /* nested address */
  54. __MPTCP_PM_ATTR_MAX
  55. };
  56. #define MPTCP_PM_ATTR_MAX (__MPTCP_PM_ATTR_MAX - 1)
  57. enum {
  58. MPTCP_PM_ADDR_ATTR_UNSPEC,
  59. MPTCP_PM_ADDR_ATTR_FAMILY, /* u16 */
  60. MPTCP_PM_ADDR_ATTR_ID, /* u8 */
  61. MPTCP_PM_ADDR_ATTR_ADDR4, /* struct in_addr */
  62. MPTCP_PM_ADDR_ATTR_ADDR6, /* struct in6_addr */
  63. MPTCP_PM_ADDR_ATTR_PORT, /* u16 */
  64. MPTCP_PM_ADDR_ATTR_FLAGS, /* u32 */
  65. MPTCP_PM_ADDR_ATTR_IF_IDX, /* s32 */
  66. __MPTCP_PM_ADDR_ATTR_MAX
  67. };
  68. #define MPTCP_PM_ADDR_ATTR_MAX (__MPTCP_PM_ADDR_ATTR_MAX - 1)
  69. #define MPTCP_PM_ADDR_FLAG_SIGNAL (1 << 0)
  70. #define MPTCP_PM_ADDR_FLAG_SUBFLOW (1 << 1)
  71. #define MPTCP_PM_ADDR_FLAG_BACKUP (1 << 2)
  72. #define MPTCP_PM_ADDR_FLAG_FULLMESH (1 << 3)
  73. #define MPTCP_PM_ADDR_FLAG_IMPLICIT (1 << 4)
  74. enum {
  75. MPTCP_PM_CMD_UNSPEC,
  76. MPTCP_PM_CMD_ADD_ADDR,
  77. MPTCP_PM_CMD_DEL_ADDR,
  78. MPTCP_PM_CMD_GET_ADDR,
  79. MPTCP_PM_CMD_FLUSH_ADDRS,
  80. MPTCP_PM_CMD_SET_LIMITS,
  81. MPTCP_PM_CMD_GET_LIMITS,
  82. MPTCP_PM_CMD_SET_FLAGS,
  83. MPTCP_PM_CMD_ANNOUNCE,
  84. MPTCP_PM_CMD_REMOVE,
  85. MPTCP_PM_CMD_SUBFLOW_CREATE,
  86. MPTCP_PM_CMD_SUBFLOW_DESTROY,
  87. __MPTCP_PM_CMD_AFTER_LAST
  88. };
  89. #define MPTCP_INFO_FLAG_FALLBACK _BITUL(0)
  90. #define MPTCP_INFO_FLAG_REMOTE_KEY_RECEIVED _BITUL(1)
  91. struct mptcp_info {
  92. __u8 mptcpi_subflows;
  93. __u8 mptcpi_add_addr_signal;
  94. __u8 mptcpi_add_addr_accepted;
  95. __u8 mptcpi_subflows_max;
  96. __u8 mptcpi_add_addr_signal_max;
  97. __u8 mptcpi_add_addr_accepted_max;
  98. __u32 mptcpi_flags;
  99. __u32 mptcpi_token;
  100. __u64 mptcpi_write_seq;
  101. __u64 mptcpi_snd_una;
  102. __u64 mptcpi_rcv_nxt;
  103. __u8 mptcpi_local_addr_used;
  104. __u8 mptcpi_local_addr_max;
  105. __u8 mptcpi_csum_enabled;
  106. };
  107. /*
  108. * MPTCP_EVENT_CREATED: token, family, saddr4 | saddr6, daddr4 | daddr6,
  109. * sport, dport
  110. * A new MPTCP connection has been created. It is the good time to allocate
  111. * memory and send ADD_ADDR if needed. Depending on the traffic-patterns
  112. * it can take a long time until the MPTCP_EVENT_ESTABLISHED is sent.
  113. *
  114. * MPTCP_EVENT_ESTABLISHED: token, family, saddr4 | saddr6, daddr4 | daddr6,
  115. * sport, dport
  116. * A MPTCP connection is established (can start new subflows).
  117. *
  118. * MPTCP_EVENT_CLOSED: token
  119. * A MPTCP connection has stopped.
  120. *
  121. * MPTCP_EVENT_ANNOUNCED: token, rem_id, family, daddr4 | daddr6 [, dport]
  122. * A new address has been announced by the peer.
  123. *
  124. * MPTCP_EVENT_REMOVED: token, rem_id
  125. * An address has been lost by the peer.
  126. *
  127. * MPTCP_EVENT_SUB_ESTABLISHED: token, family, loc_id, rem_id,
  128. * saddr4 | saddr6, daddr4 | daddr6, sport,
  129. * dport, backup, if_idx [, error]
  130. * A new subflow has been established. 'error' should not be set.
  131. *
  132. * MPTCP_EVENT_SUB_CLOSED: token, family, loc_id, rem_id, saddr4 | saddr6,
  133. * daddr4 | daddr6, sport, dport, backup, if_idx
  134. * [, error]
  135. * A subflow has been closed. An error (copy of sk_err) could be set if an
  136. * error has been detected for this subflow.
  137. *
  138. * MPTCP_EVENT_SUB_PRIORITY: token, family, loc_id, rem_id, saddr4 | saddr6,
  139. * daddr4 | daddr6, sport, dport, backup, if_idx
  140. * [, error]
  141. * The priority of a subflow has changed. 'error' should not be set.
  142. */
  143. enum mptcp_event_type {
  144. MPTCP_EVENT_UNSPEC = 0,
  145. MPTCP_EVENT_CREATED = 1,
  146. MPTCP_EVENT_ESTABLISHED = 2,
  147. MPTCP_EVENT_CLOSED = 3,
  148. MPTCP_EVENT_ANNOUNCED = 6,
  149. MPTCP_EVENT_REMOVED = 7,
  150. MPTCP_EVENT_SUB_ESTABLISHED = 10,
  151. MPTCP_EVENT_SUB_CLOSED = 11,
  152. MPTCP_EVENT_SUB_PRIORITY = 13,
  153. };
  154. enum mptcp_event_attr {
  155. MPTCP_ATTR_UNSPEC = 0,
  156. MPTCP_ATTR_TOKEN, /* u32 */
  157. MPTCP_ATTR_FAMILY, /* u16 */
  158. MPTCP_ATTR_LOC_ID, /* u8 */
  159. MPTCP_ATTR_REM_ID, /* u8 */
  160. MPTCP_ATTR_SADDR4, /* be32 */
  161. MPTCP_ATTR_SADDR6, /* struct in6_addr */
  162. MPTCP_ATTR_DADDR4, /* be32 */
  163. MPTCP_ATTR_DADDR6, /* struct in6_addr */
  164. MPTCP_ATTR_SPORT, /* be16 */
  165. MPTCP_ATTR_DPORT, /* be16 */
  166. MPTCP_ATTR_BACKUP, /* u8 */
  167. MPTCP_ATTR_ERROR, /* u8 */
  168. MPTCP_ATTR_FLAGS, /* u16 */
  169. MPTCP_ATTR_TIMEOUT, /* u32 */
  170. MPTCP_ATTR_IF_IDX, /* s32 */
  171. MPTCP_ATTR_RESET_REASON,/* u32 */
  172. MPTCP_ATTR_RESET_FLAGS, /* u32 */
  173. MPTCP_ATTR_SERVER_SIDE, /* u8 */
  174. __MPTCP_ATTR_AFTER_LAST
  175. };
  176. #define MPTCP_ATTR_MAX (__MPTCP_ATTR_AFTER_LAST - 1)
  177. /* MPTCP Reset reason codes, rfc8684 */
  178. #define MPTCP_RST_EUNSPEC 0
  179. #define MPTCP_RST_EMPTCP 1
  180. #define MPTCP_RST_ERESOURCE 2
  181. #define MPTCP_RST_EPROHIBIT 3
  182. #define MPTCP_RST_EWQ2BIG 4
  183. #define MPTCP_RST_EBADPERF 5
  184. #define MPTCP_RST_EMIDDLEBOX 6
  185. struct mptcp_subflow_data {
  186. __u32 size_subflow_data; /* size of this structure in userspace */
  187. __u32 num_subflows; /* must be 0, set by kernel */
  188. __u32 size_kernel; /* must be 0, set by kernel */
  189. __u32 size_user; /* size of one element in data[] */
  190. } __attribute__((aligned(8)));
  191. struct mptcp_subflow_addrs {
  192. union {
  193. __kernel_sa_family_t sa_family;
  194. struct sockaddr sa_local;
  195. struct sockaddr_in sin_local;
  196. struct sockaddr_in6 sin6_local;
  197. struct __kernel_sockaddr_storage ss_local;
  198. };
  199. union {
  200. struct sockaddr sa_remote;
  201. struct sockaddr_in sin_remote;
  202. struct sockaddr_in6 sin6_remote;
  203. struct __kernel_sockaddr_storage ss_remote;
  204. };
  205. };
  206. /* MPTCP socket options */
  207. #define MPTCP_INFO 1
  208. #define MPTCP_TCPINFO 2
  209. #define MPTCP_SUBFLOW_ADDRS 3
  210. #endif /* _UAPI_MPTCP_H */