xref: /linux/include/uapi/linux/mptcp.h (revision 6a137497178720da8f454c81d2e9fcebc3137b51)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 #ifndef _UAPI_MPTCP_H
3 #define _UAPI_MPTCP_H
4 
5 #ifndef __KERNEL__
6 #include <netinet/in.h>		/* for sockaddr_in and sockaddr_in6	*/
7 #include <sys/socket.h>		/* for struct sockaddr			*/
8 #endif
9 
10 #include <linux/const.h>
11 #include <linux/types.h>
12 #include <linux/in.h>		/* for sockaddr_in			*/
13 #include <linux/in6.h>		/* for sockaddr_in6			*/
14 #include <linux/socket.h>	/* for sockaddr_storage and sa_family	*/
15 
16 #define MPTCP_SUBFLOW_FLAG_MCAP_REM		_BITUL(0)
17 #define MPTCP_SUBFLOW_FLAG_MCAP_LOC		_BITUL(1)
18 #define MPTCP_SUBFLOW_FLAG_JOIN_REM		_BITUL(2)
19 #define MPTCP_SUBFLOW_FLAG_JOIN_LOC		_BITUL(3)
20 #define MPTCP_SUBFLOW_FLAG_BKUP_REM		_BITUL(4)
21 #define MPTCP_SUBFLOW_FLAG_BKUP_LOC		_BITUL(5)
22 #define MPTCP_SUBFLOW_FLAG_FULLY_ESTABLISHED	_BITUL(6)
23 #define MPTCP_SUBFLOW_FLAG_CONNECTED		_BITUL(7)
24 #define MPTCP_SUBFLOW_FLAG_MAPVALID		_BITUL(8)
25 
26 #define MPTCP_PM_CMD_GRP_NAME	"mptcp_pm_cmds"
27 #define MPTCP_PM_EV_GRP_NAME	"mptcp_pm_events"
28 
29 #include <linux/mptcp_pm.h>
30 
31 #define MPTCP_INFO_FLAG_FALLBACK		_BITUL(0)
32 #define MPTCP_INFO_FLAG_REMOTE_KEY_RECEIVED	_BITUL(1)
33 
34 #define MPTCP_PM_EV_FLAG_DENY_JOIN_ID0		_BITUL(0)
35 
36 #define MPTCP_PM_ADDR_FLAG_SIGNAL                      (1 << 0)
37 #define MPTCP_PM_ADDR_FLAG_SUBFLOW                     (1 << 1)
38 #define MPTCP_PM_ADDR_FLAG_BACKUP                      (1 << 2)
39 #define MPTCP_PM_ADDR_FLAG_FULLMESH                    (1 << 3)
40 #define MPTCP_PM_ADDR_FLAG_IMPLICIT                    (1 << 4)
41 
42 struct mptcp_info {
43 	__u8	mptcpi_subflows;
44 	__u8	mptcpi_add_addr_signal;
45 	__u8	mptcpi_add_addr_accepted;
46 	__u8	mptcpi_subflows_max;
47 	__u8	mptcpi_add_addr_signal_max;
48 	__u8	mptcpi_add_addr_accepted_max;
49 	__u32	mptcpi_flags;
50 	__u32	mptcpi_token;
51 	__u64	mptcpi_write_seq;
52 	__u64	mptcpi_snd_una;
53 	__u64	mptcpi_rcv_nxt;
54 	__u8	mptcpi_local_addr_used;
55 	__u8	mptcpi_local_addr_max;
56 	__u8	mptcpi_csum_enabled;
57 	__u32	mptcpi_retransmits;
58 	__u64	mptcpi_bytes_retrans;
59 	__u64	mptcpi_bytes_sent;
60 	__u64	mptcpi_bytes_received;
61 	__u64	mptcpi_bytes_acked;
62 	__u8	mptcpi_subflows_total;
63 	__u8	reserved[3];
64 	__u32	mptcpi_last_data_sent;
65 	__u32	mptcpi_last_data_recv;
66 	__u32	mptcpi_last_ack_recv;
67 };
68 
69 /* MPTCP Reset reason codes, rfc8684 */
70 #define MPTCP_RST_EUNSPEC	0
71 #define MPTCP_RST_EMPTCP	1
72 #define MPTCP_RST_ERESOURCE	2
73 #define MPTCP_RST_EPROHIBIT	3
74 #define MPTCP_RST_EWQ2BIG	4
75 #define MPTCP_RST_EBADPERF	5
76 #define MPTCP_RST_EMIDDLEBOX	6
77 
78 struct mptcp_subflow_data {
79 	__u32		size_subflow_data;		/* size of this structure in userspace */
80 	__u32		num_subflows;			/* must be 0, set by kernel */
81 	__u32		size_kernel;			/* must be 0, set by kernel */
82 	__u32		size_user;			/* size of one element in data[] */
83 } __attribute__((aligned(8)));
84 
85 struct mptcp_subflow_addrs {
86 	union {
87 		__kernel_sa_family_t sa_family;
88 		struct sockaddr sa_local;
89 		struct sockaddr_in sin_local;
90 		struct sockaddr_in6 sin6_local;
91 		struct __kernel_sockaddr_storage ss_local;
92 	};
93 	union {
94 		struct sockaddr sa_remote;
95 		struct sockaddr_in sin_remote;
96 		struct sockaddr_in6 sin6_remote;
97 		struct __kernel_sockaddr_storage ss_remote;
98 	};
99 };
100 
101 struct mptcp_subflow_info {
102 	__u32				id;
103 	struct mptcp_subflow_addrs	addrs;
104 };
105 
106 struct mptcp_full_info {
107 	__u32		size_tcpinfo_kernel;	/* must be 0, set by kernel */
108 	__u32		size_tcpinfo_user;
109 	__u32		size_sfinfo_kernel;	/* must be 0, set by kernel */
110 	__u32		size_sfinfo_user;
111 	__u32		num_subflows;		/* must be 0, set by kernel (real subflow count) */
112 	__u32		size_arrays_user;	/* max subflows that userspace is interested in;
113 						 * the buffers at subflow_info/tcp_info
114 						 * are respectively at least:
115 						 *  size_arrays * size_sfinfo_user
116 						 *  size_arrays * size_tcpinfo_user
117 						 * bytes wide
118 						 */
119 	__aligned_u64		subflow_info;
120 	__aligned_u64		tcp_info;
121 	struct mptcp_info	mptcp_info;
122 };
123 
124 /* MPTCP socket options */
125 #define MPTCP_INFO		1
126 #define MPTCP_TCPINFO		2
127 #define MPTCP_SUBFLOW_ADDRS	3
128 #define MPTCP_FULL_INFO		4
129 
130 #endif /* _UAPI_MPTCP_H */
131