protocol.h 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /* Multipath TCP
  3. *
  4. * Copyright (c) 2017 - 2019, Intel Corporation.
  5. */
  6. #ifndef __MPTCP_PROTOCOL_H
  7. #define __MPTCP_PROTOCOL_H
  8. #include <linux/random.h>
  9. #include <net/tcp.h>
  10. #include <net/inet_connection_sock.h>
  11. #include <uapi/linux/mptcp.h>
  12. #include <net/genetlink.h>
  13. #include <net/rstreason.h>
  14. #define MPTCP_SUPPORTED_VERSION 1
  15. /* MPTCP option bits */
  16. #define OPTION_MPTCP_MPC_SYN BIT(0)
  17. #define OPTION_MPTCP_MPC_SYNACK BIT(1)
  18. #define OPTION_MPTCP_MPC_ACK BIT(2)
  19. #define OPTION_MPTCP_MPJ_SYN BIT(3)
  20. #define OPTION_MPTCP_MPJ_SYNACK BIT(4)
  21. #define OPTION_MPTCP_MPJ_ACK BIT(5)
  22. #define OPTION_MPTCP_ADD_ADDR BIT(6)
  23. #define OPTION_MPTCP_RM_ADDR BIT(7)
  24. #define OPTION_MPTCP_FASTCLOSE BIT(8)
  25. #define OPTION_MPTCP_PRIO BIT(9)
  26. #define OPTION_MPTCP_RST BIT(10)
  27. #define OPTION_MPTCP_DSS BIT(11)
  28. #define OPTION_MPTCP_FAIL BIT(12)
  29. #define OPTION_MPTCP_CSUMREQD BIT(13)
  30. #define OPTIONS_MPTCP_MPC (OPTION_MPTCP_MPC_SYN | OPTION_MPTCP_MPC_SYNACK | \
  31. OPTION_MPTCP_MPC_ACK)
  32. #define OPTIONS_MPTCP_MPJ (OPTION_MPTCP_MPJ_SYN | OPTION_MPTCP_MPJ_SYNACK | \
  33. OPTION_MPTCP_MPJ_ACK)
  34. /* MPTCP option subtypes */
  35. #define MPTCPOPT_MP_CAPABLE 0
  36. #define MPTCPOPT_MP_JOIN 1
  37. #define MPTCPOPT_DSS 2
  38. #define MPTCPOPT_ADD_ADDR 3
  39. #define MPTCPOPT_RM_ADDR 4
  40. #define MPTCPOPT_MP_PRIO 5
  41. #define MPTCPOPT_MP_FAIL 6
  42. #define MPTCPOPT_MP_FASTCLOSE 7
  43. #define MPTCPOPT_RST 8
  44. /* MPTCP suboption lengths */
  45. #define TCPOLEN_MPTCP_MPC_SYN 4
  46. #define TCPOLEN_MPTCP_MPC_SYNACK 12
  47. #define TCPOLEN_MPTCP_MPC_ACK 20
  48. #define TCPOLEN_MPTCP_MPC_ACK_DATA 22
  49. #define TCPOLEN_MPTCP_MPJ_SYN 12
  50. #define TCPOLEN_MPTCP_MPJ_SYNACK 16
  51. #define TCPOLEN_MPTCP_MPJ_ACK 24
  52. #define TCPOLEN_MPTCP_DSS_BASE 4
  53. #define TCPOLEN_MPTCP_DSS_ACK32 4
  54. #define TCPOLEN_MPTCP_DSS_ACK64 8
  55. #define TCPOLEN_MPTCP_DSS_MAP32 10
  56. #define TCPOLEN_MPTCP_DSS_MAP64 14
  57. #define TCPOLEN_MPTCP_DSS_CHECKSUM 2
  58. #define TCPOLEN_MPTCP_ADD_ADDR 16
  59. #define TCPOLEN_MPTCP_ADD_ADDR_PORT 18
  60. #define TCPOLEN_MPTCP_ADD_ADDR_BASE 8
  61. #define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT 10
  62. #define TCPOLEN_MPTCP_ADD_ADDR6 28
  63. #define TCPOLEN_MPTCP_ADD_ADDR6_PORT 30
  64. #define TCPOLEN_MPTCP_ADD_ADDR6_BASE 20
  65. #define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT 22
  66. #define TCPOLEN_MPTCP_PORT_LEN 2
  67. #define TCPOLEN_MPTCP_PORT_ALIGN 2
  68. #define TCPOLEN_MPTCP_RM_ADDR_BASE 3
  69. #define TCPOLEN_MPTCP_PRIO 3
  70. #define TCPOLEN_MPTCP_PRIO_ALIGN 4
  71. #define TCPOLEN_MPTCP_FASTCLOSE 12
  72. #define TCPOLEN_MPTCP_RST 4
  73. #define TCPOLEN_MPTCP_FAIL 12
  74. #define TCPOLEN_MPTCP_MPC_ACK_DATA_CSUM (TCPOLEN_MPTCP_DSS_CHECKSUM + TCPOLEN_MPTCP_MPC_ACK_DATA)
  75. /* MPTCP MP_JOIN flags */
  76. #define MPTCPOPT_BACKUP BIT(0)
  77. #define MPTCPOPT_THMAC_LEN 8
  78. /* MPTCP MP_CAPABLE flags */
  79. #define MPTCP_VERSION_MASK (0x0F)
  80. #define MPTCP_CAP_CHECKSUM_REQD BIT(7)
  81. #define MPTCP_CAP_EXTENSIBILITY BIT(6)
  82. #define MPTCP_CAP_DENY_JOIN_ID0 BIT(5)
  83. #define MPTCP_CAP_HMAC_SHA256 BIT(0)
  84. #define MPTCP_CAP_FLAG_MASK (0x1F)
  85. /* MPTCP DSS flags */
  86. #define MPTCP_DSS_DATA_FIN BIT(4)
  87. #define MPTCP_DSS_DSN64 BIT(3)
  88. #define MPTCP_DSS_HAS_MAP BIT(2)
  89. #define MPTCP_DSS_ACK64 BIT(1)
  90. #define MPTCP_DSS_HAS_ACK BIT(0)
  91. #define MPTCP_DSS_FLAG_MASK (0x1F)
  92. /* MPTCP ADD_ADDR flags */
  93. #define MPTCP_ADDR_ECHO BIT(0)
  94. /* MPTCP MP_PRIO flags */
  95. #define MPTCP_PRIO_BKUP BIT(0)
  96. /* MPTCP TCPRST flags */
  97. #define MPTCP_RST_TRANSIENT BIT(0)
  98. /* MPTCP socket atomic flags */
  99. #define MPTCP_WORK_RTX 1
  100. #define MPTCP_FALLBACK_DONE 2
  101. #define MPTCP_WORK_CLOSE_SUBFLOW 3
  102. /* MPTCP socket release cb flags */
  103. #define MPTCP_PUSH_PENDING 1
  104. #define MPTCP_CLEAN_UNA 2
  105. #define MPTCP_ERROR_REPORT 3
  106. #define MPTCP_RETRANSMIT 4
  107. #define MPTCP_FLUSH_JOIN_LIST 5
  108. #define MPTCP_SYNC_STATE 6
  109. #define MPTCP_SYNC_SNDBUF 7
  110. struct mptcp_skb_cb {
  111. u64 map_seq;
  112. u64 end_seq;
  113. u32 offset;
  114. u8 has_rxtstamp:1;
  115. };
  116. #define MPTCP_SKB_CB(__skb) ((struct mptcp_skb_cb *)&((__skb)->cb[0]))
  117. static inline bool before64(__u64 seq1, __u64 seq2)
  118. {
  119. return (__s64)(seq1 - seq2) < 0;
  120. }
  121. #define after64(seq2, seq1) before64(seq1, seq2)
  122. struct mptcp_options_received {
  123. u64 sndr_key;
  124. u64 rcvr_key;
  125. u64 data_ack;
  126. u64 data_seq;
  127. u32 subflow_seq;
  128. u16 data_len;
  129. __sum16 csum;
  130. struct_group(status,
  131. u16 suboptions;
  132. u16 use_map:1,
  133. dsn64:1,
  134. data_fin:1,
  135. use_ack:1,
  136. ack64:1,
  137. mpc_map:1,
  138. reset_reason:4,
  139. reset_transient:1,
  140. echo:1,
  141. backup:1,
  142. deny_join_id0:1,
  143. __unused:2;
  144. );
  145. u8 join_id;
  146. u32 token;
  147. u32 nonce;
  148. u64 thmac;
  149. u8 hmac[MPTCPOPT_HMAC_LEN];
  150. struct mptcp_addr_info addr;
  151. struct mptcp_rm_list rm_list;
  152. u64 ahmac;
  153. u64 fail_seq;
  154. };
  155. static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
  156. {
  157. return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
  158. ((nib & 0xF) << 8) | field);
  159. }
  160. enum mptcp_pm_status {
  161. MPTCP_PM_ADD_ADDR_RECEIVED,
  162. MPTCP_PM_ADD_ADDR_SEND_ACK,
  163. MPTCP_PM_RM_ADDR_RECEIVED,
  164. MPTCP_PM_ESTABLISHED,
  165. MPTCP_PM_SUBFLOW_ESTABLISHED,
  166. MPTCP_PM_ALREADY_ESTABLISHED, /* persistent status, set after ESTABLISHED event */
  167. MPTCP_PM_MPC_ENDPOINT_ACCOUNTED /* persistent status, set after MPC local address is
  168. * accounted int id_avail_bitmap
  169. */
  170. };
  171. enum mptcp_pm_type {
  172. MPTCP_PM_TYPE_KERNEL = 0,
  173. MPTCP_PM_TYPE_USERSPACE,
  174. __MPTCP_PM_TYPE_NR,
  175. __MPTCP_PM_TYPE_MAX = __MPTCP_PM_TYPE_NR - 1,
  176. };
  177. /* Status bits below MPTCP_PM_ALREADY_ESTABLISHED need pm worker actions */
  178. #define MPTCP_PM_WORK_MASK ((1 << MPTCP_PM_ALREADY_ESTABLISHED) - 1)
  179. enum mptcp_addr_signal_status {
  180. MPTCP_ADD_ADDR_SIGNAL,
  181. MPTCP_ADD_ADDR_ECHO,
  182. MPTCP_RM_ADDR_SIGNAL,
  183. };
  184. /* max value of mptcp_addr_info.id */
  185. #define MPTCP_PM_MAX_ADDR_ID U8_MAX
  186. struct mptcp_pm_data {
  187. struct mptcp_addr_info local;
  188. struct mptcp_addr_info remote;
  189. struct list_head anno_list;
  190. struct list_head userspace_pm_local_addr_list;
  191. spinlock_t lock; /*protects the whole PM data */
  192. u8 addr_signal;
  193. bool server_side;
  194. bool work_pending;
  195. bool accept_addr;
  196. bool accept_subflow;
  197. bool remote_deny_join_id0;
  198. u8 add_addr_signaled;
  199. u8 add_addr_accepted;
  200. u8 local_addr_used;
  201. u8 pm_type;
  202. u8 subflows;
  203. u8 status;
  204. DECLARE_BITMAP(id_avail_bitmap, MPTCP_PM_MAX_ADDR_ID + 1);
  205. struct mptcp_rm_list rm_list_tx;
  206. struct mptcp_rm_list rm_list_rx;
  207. };
  208. struct mptcp_pm_local {
  209. struct mptcp_addr_info addr;
  210. u8 flags;
  211. int ifindex;
  212. };
  213. struct mptcp_pm_addr_entry {
  214. struct list_head list;
  215. struct mptcp_addr_info addr;
  216. u8 flags;
  217. int ifindex;
  218. struct socket *lsk;
  219. };
  220. struct mptcp_data_frag {
  221. struct list_head list;
  222. u64 data_seq;
  223. u16 data_len;
  224. u16 offset;
  225. u16 overhead;
  226. u16 already_sent;
  227. struct page *page;
  228. };
  229. /* MPTCP connection sock */
  230. struct mptcp_sock {
  231. /* inet_connection_sock must be the first member */
  232. struct inet_connection_sock sk;
  233. u64 local_key; /* protected by the first subflow socket lock
  234. * lockless access read
  235. */
  236. u64 remote_key; /* same as above */
  237. u64 write_seq;
  238. u64 bytes_sent;
  239. u64 snd_nxt;
  240. u64 bytes_received;
  241. u64 ack_seq;
  242. atomic64_t rcv_wnd_sent;
  243. u64 rcv_data_fin_seq;
  244. u64 bytes_retrans;
  245. u64 bytes_consumed;
  246. int rmem_fwd_alloc;
  247. int snd_burst;
  248. int old_wspace;
  249. u64 recovery_snd_nxt; /* in recovery mode accept up to this seq;
  250. * recovery related fields are under data_lock
  251. * protection
  252. */
  253. u64 bytes_acked;
  254. u64 snd_una;
  255. u64 wnd_end;
  256. u32 last_data_sent;
  257. u32 last_data_recv;
  258. u32 last_ack_recv;
  259. unsigned long timer_ival;
  260. u32 token;
  261. int rmem_released;
  262. unsigned long flags;
  263. unsigned long cb_flags;
  264. bool recovery; /* closing subflow write queue reinjected */
  265. bool can_ack;
  266. bool fully_established;
  267. bool rcv_data_fin;
  268. bool snd_data_fin_enable;
  269. bool rcv_fastclose;
  270. bool use_64bit_ack; /* Set when we received a 64-bit DSN */
  271. bool csum_enabled;
  272. bool allow_infinite_fallback;
  273. u8 pending_state; /* A subflow asked to set this sk_state,
  274. * protected by the msk data lock
  275. */
  276. u8 mpc_endpoint_id;
  277. u8 recvmsg_inq:1,
  278. cork:1,
  279. nodelay:1,
  280. fastopening:1,
  281. in_accept_queue:1,
  282. free_first:1,
  283. rcvspace_init:1;
  284. u32 notsent_lowat;
  285. int keepalive_cnt;
  286. int keepalive_idle;
  287. int keepalive_intvl;
  288. struct work_struct work;
  289. struct sk_buff *ooo_last_skb;
  290. struct rb_root out_of_order_queue;
  291. struct sk_buff_head receive_queue;
  292. struct list_head conn_list;
  293. struct list_head rtx_queue;
  294. struct mptcp_data_frag *first_pending;
  295. struct list_head join_list;
  296. struct sock *first; /* The mptcp ops can safely dereference, using suitable
  297. * ONCE annotation, the subflow outside the socket
  298. * lock as such sock is freed after close().
  299. */
  300. struct mptcp_pm_data pm;
  301. struct mptcp_sched_ops *sched;
  302. struct {
  303. u32 space; /* bytes copied in last measurement window */
  304. u32 copied; /* bytes copied in this measurement window */
  305. u64 time; /* start time of measurement window */
  306. u64 rtt_us; /* last maximum rtt of subflows */
  307. } rcvq_space;
  308. u8 scaling_ratio;
  309. u32 subflow_id;
  310. u32 setsockopt_seq;
  311. char ca_name[TCP_CA_NAME_MAX];
  312. };
  313. #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
  314. #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
  315. #define mptcp_for_each_subflow(__msk, __subflow) \
  316. list_for_each_entry(__subflow, &((__msk)->conn_list), node)
  317. #define mptcp_for_each_subflow_safe(__msk, __subflow, __tmp) \
  318. list_for_each_entry_safe(__subflow, __tmp, &((__msk)->conn_list), node)
  319. extern struct genl_family mptcp_genl_family;
  320. static inline void msk_owned_by_me(const struct mptcp_sock *msk)
  321. {
  322. sock_owned_by_me((const struct sock *)msk);
  323. }
  324. #ifdef CONFIG_DEBUG_NET
  325. /* MPTCP-specific: we might (indirectly) call this helper with the wrong sk */
  326. #undef tcp_sk
  327. #define tcp_sk(ptr) ({ \
  328. typeof(ptr) _ptr = (ptr); \
  329. WARN_ON(_ptr->sk_protocol != IPPROTO_TCP); \
  330. container_of_const(_ptr, struct tcp_sock, inet_conn.icsk_inet.sk); \
  331. })
  332. #define mptcp_sk(ptr) ({ \
  333. typeof(ptr) _ptr = (ptr); \
  334. WARN_ON(_ptr->sk_protocol != IPPROTO_MPTCP); \
  335. container_of_const(_ptr, struct mptcp_sock, sk.icsk_inet.sk); \
  336. })
  337. #else /* !CONFIG_DEBUG_NET */
  338. #define mptcp_sk(ptr) container_of_const(ptr, struct mptcp_sock, sk.icsk_inet.sk)
  339. #endif
  340. /* the msk socket don't use the backlog, also account for the bulk
  341. * free memory
  342. */
  343. static inline int __mptcp_rmem(const struct sock *sk)
  344. {
  345. return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
  346. }
  347. static inline int mptcp_win_from_space(const struct sock *sk, int space)
  348. {
  349. return __tcp_win_from_space(mptcp_sk(sk)->scaling_ratio, space);
  350. }
  351. static inline int mptcp_space_from_win(const struct sock *sk, int win)
  352. {
  353. return __tcp_space_from_win(mptcp_sk(sk)->scaling_ratio, win);
  354. }
  355. static inline int __mptcp_space(const struct sock *sk)
  356. {
  357. return mptcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
  358. }
  359. static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
  360. {
  361. const struct mptcp_sock *msk = mptcp_sk(sk);
  362. return READ_ONCE(msk->first_pending);
  363. }
  364. static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
  365. {
  366. struct mptcp_sock *msk = mptcp_sk(sk);
  367. struct mptcp_data_frag *cur;
  368. cur = msk->first_pending;
  369. return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
  370. list_next_entry(cur, list);
  371. }
  372. static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
  373. {
  374. const struct mptcp_sock *msk = mptcp_sk(sk);
  375. if (!msk->first_pending)
  376. return NULL;
  377. if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
  378. return NULL;
  379. return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
  380. }
  381. static inline struct mptcp_data_frag *mptcp_rtx_head(struct sock *sk)
  382. {
  383. struct mptcp_sock *msk = mptcp_sk(sk);
  384. if (msk->snd_una == msk->snd_nxt)
  385. return NULL;
  386. return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
  387. }
  388. struct csum_pseudo_header {
  389. __be64 data_seq;
  390. __be32 subflow_seq;
  391. __be16 data_len;
  392. __sum16 csum;
  393. };
  394. struct mptcp_subflow_request_sock {
  395. struct tcp_request_sock sk;
  396. u16 mp_capable : 1,
  397. mp_join : 1,
  398. backup : 1,
  399. request_bkup : 1,
  400. csum_reqd : 1,
  401. allow_join_id0 : 1;
  402. u8 local_id;
  403. u8 remote_id;
  404. u64 local_key;
  405. u64 idsn;
  406. u32 token;
  407. u32 ssn_offset;
  408. u64 thmac;
  409. u32 local_nonce;
  410. u32 remote_nonce;
  411. struct mptcp_sock *msk;
  412. struct hlist_nulls_node token_node;
  413. };
  414. static inline struct mptcp_subflow_request_sock *
  415. mptcp_subflow_rsk(const struct request_sock *rsk)
  416. {
  417. return (struct mptcp_subflow_request_sock *)rsk;
  418. }
  419. struct mptcp_delegated_action {
  420. struct napi_struct napi;
  421. struct list_head head;
  422. };
  423. DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
  424. #define MPTCP_DELEGATE_SCHEDULED 0
  425. #define MPTCP_DELEGATE_SEND 1
  426. #define MPTCP_DELEGATE_ACK 2
  427. #define MPTCP_DELEGATE_SNDBUF 3
  428. #define MPTCP_DELEGATE_ACTIONS_MASK (~BIT(MPTCP_DELEGATE_SCHEDULED))
  429. /* MPTCP subflow context */
  430. struct mptcp_subflow_context {
  431. struct list_head node;/* conn_list of subflows */
  432. struct_group(reset,
  433. unsigned long avg_pacing_rate; /* protected by msk socket lock */
  434. u64 local_key;
  435. u64 remote_key;
  436. u64 idsn;
  437. u64 map_seq;
  438. u32 snd_isn;
  439. u32 token;
  440. u32 rel_write_seq;
  441. u32 map_subflow_seq;
  442. u32 ssn_offset;
  443. u32 map_data_len;
  444. __wsum map_data_csum;
  445. u32 map_csum_len;
  446. u32 request_mptcp : 1, /* send MP_CAPABLE */
  447. request_join : 1, /* send MP_JOIN */
  448. request_bkup : 1,
  449. mp_capable : 1, /* remote is MPTCP capable */
  450. mp_join : 1, /* remote is JOINing */
  451. pm_notified : 1, /* PM hook called for established status */
  452. conn_finished : 1,
  453. map_valid : 1,
  454. map_csum_reqd : 1,
  455. map_data_fin : 1,
  456. mpc_map : 1,
  457. backup : 1,
  458. send_mp_prio : 1,
  459. send_mp_fail : 1,
  460. send_fastclose : 1,
  461. send_infinite_map : 1,
  462. remote_key_valid : 1, /* received the peer key from */
  463. disposable : 1, /* ctx can be free at ulp release time */
  464. stale : 1, /* unable to snd/rcv data, do not use for xmit */
  465. valid_csum_seen : 1, /* at least one csum validated */
  466. is_mptfo : 1, /* subflow is doing TFO */
  467. close_event_done : 1, /* has done the post-closed part */
  468. mpc_drop : 1, /* the MPC option has been dropped in a rtx */
  469. __unused : 9;
  470. bool data_avail;
  471. bool scheduled;
  472. bool pm_listener; /* a listener managed by the kernel PM? */
  473. bool fully_established; /* path validated */
  474. u32 remote_nonce;
  475. u64 thmac;
  476. u32 local_nonce;
  477. u32 remote_token;
  478. union {
  479. u8 hmac[MPTCPOPT_HMAC_LEN]; /* MPJ subflow only */
  480. u64 iasn; /* initial ack sequence number, MPC subflows only */
  481. };
  482. s16 local_id; /* if negative not initialized yet */
  483. u8 remote_id;
  484. u8 reset_seen:1;
  485. u8 reset_transient:1;
  486. u8 reset_reason:4;
  487. u8 stale_count;
  488. u32 subflow_id;
  489. long delegated_status;
  490. unsigned long fail_tout;
  491. );
  492. struct list_head delegated_node; /* link into delegated_action, protected by local BH */
  493. u32 setsockopt_seq;
  494. u32 stale_rcv_tstamp;
  495. int cached_sndbuf; /* sndbuf size when last synced with the msk sndbuf,
  496. * protected by the msk socket lock
  497. */
  498. struct sock *tcp_sock; /* tcp sk backpointer */
  499. struct sock *conn; /* parent mptcp_sock */
  500. const struct inet_connection_sock_af_ops *icsk_af_ops;
  501. void (*tcp_state_change)(struct sock *sk);
  502. void (*tcp_error_report)(struct sock *sk);
  503. struct rcu_head rcu;
  504. };
  505. static inline struct mptcp_subflow_context *
  506. mptcp_subflow_ctx(const struct sock *sk)
  507. {
  508. const struct inet_connection_sock *icsk = inet_csk(sk);
  509. /* Use RCU on icsk_ulp_data only for sock diag code */
  510. return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
  511. }
  512. static inline struct sock *
  513. mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
  514. {
  515. return subflow->tcp_sock;
  516. }
  517. static inline void
  518. mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
  519. {
  520. memset(&subflow->reset, 0, sizeof(subflow->reset));
  521. subflow->request_mptcp = 1;
  522. WRITE_ONCE(subflow->local_id, -1);
  523. }
  524. /* Convert reset reasons in MPTCP to enum sk_rst_reason type */
  525. static inline enum sk_rst_reason
  526. sk_rst_convert_mptcp_reason(u32 reason)
  527. {
  528. switch (reason) {
  529. case MPTCP_RST_EUNSPEC:
  530. return SK_RST_REASON_MPTCP_RST_EUNSPEC;
  531. case MPTCP_RST_EMPTCP:
  532. return SK_RST_REASON_MPTCP_RST_EMPTCP;
  533. case MPTCP_RST_ERESOURCE:
  534. return SK_RST_REASON_MPTCP_RST_ERESOURCE;
  535. case MPTCP_RST_EPROHIBIT:
  536. return SK_RST_REASON_MPTCP_RST_EPROHIBIT;
  537. case MPTCP_RST_EWQ2BIG:
  538. return SK_RST_REASON_MPTCP_RST_EWQ2BIG;
  539. case MPTCP_RST_EBADPERF:
  540. return SK_RST_REASON_MPTCP_RST_EBADPERF;
  541. case MPTCP_RST_EMIDDLEBOX:
  542. return SK_RST_REASON_MPTCP_RST_EMIDDLEBOX;
  543. default:
  544. /* It should not happen, or else errors may occur
  545. * in MPTCP layer
  546. */
  547. return SK_RST_REASON_ERROR;
  548. }
  549. }
  550. static inline void
  551. mptcp_send_active_reset_reason(struct sock *sk)
  552. {
  553. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
  554. enum sk_rst_reason reason;
  555. reason = sk_rst_convert_mptcp_reason(subflow->reset_reason);
  556. tcp_send_active_reset(sk, GFP_ATOMIC, reason);
  557. }
  558. static inline u64
  559. mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
  560. {
  561. return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
  562. subflow->ssn_offset -
  563. subflow->map_subflow_seq;
  564. }
  565. static inline u64
  566. mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
  567. {
  568. return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
  569. }
  570. void mptcp_subflow_process_delegated(struct sock *ssk, long actions);
  571. static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
  572. {
  573. long old, set_bits = BIT(MPTCP_DELEGATE_SCHEDULED) | BIT(action);
  574. struct mptcp_delegated_action *delegated;
  575. bool schedule;
  576. /* the caller held the subflow bh socket lock */
  577. lockdep_assert_in_softirq();
  578. /* The implied barrier pairs with tcp_release_cb_override()
  579. * mptcp_napi_poll(), and ensures the below list check sees list
  580. * updates done prior to delegated status bits changes
  581. */
  582. old = set_mask_bits(&subflow->delegated_status, 0, set_bits);
  583. if (!(old & BIT(MPTCP_DELEGATE_SCHEDULED))) {
  584. if (WARN_ON_ONCE(!list_empty(&subflow->delegated_node)))
  585. return;
  586. delegated = this_cpu_ptr(&mptcp_delegated_actions);
  587. schedule = list_empty(&delegated->head);
  588. list_add_tail(&subflow->delegated_node, &delegated->head);
  589. sock_hold(mptcp_subflow_tcp_sock(subflow));
  590. if (schedule)
  591. napi_schedule(&delegated->napi);
  592. }
  593. }
  594. static inline struct mptcp_subflow_context *
  595. mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
  596. {
  597. struct mptcp_subflow_context *ret;
  598. if (list_empty(&delegated->head))
  599. return NULL;
  600. ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
  601. list_del_init(&ret->delegated_node);
  602. return ret;
  603. }
  604. int mptcp_is_enabled(const struct net *net);
  605. unsigned int mptcp_get_add_addr_timeout(const struct net *net);
  606. int mptcp_is_checksum_enabled(const struct net *net);
  607. int mptcp_allow_join_id0(const struct net *net);
  608. unsigned int mptcp_stale_loss_cnt(const struct net *net);
  609. unsigned int mptcp_close_timeout(const struct sock *sk);
  610. int mptcp_get_pm_type(const struct net *net);
  611. const char *mptcp_get_scheduler(const struct net *net);
  612. void mptcp_active_disable(struct sock *sk);
  613. bool mptcp_active_should_disable(struct sock *ssk);
  614. void mptcp_active_enable(struct sock *sk);
  615. void mptcp_get_available_schedulers(char *buf, size_t maxlen);
  616. void __mptcp_subflow_fully_established(struct mptcp_sock *msk,
  617. struct mptcp_subflow_context *subflow,
  618. const struct mptcp_options_received *mp_opt);
  619. bool __mptcp_retransmit_pending_data(struct sock *sk);
  620. void mptcp_check_and_set_pending(struct sock *sk);
  621. void __mptcp_push_pending(struct sock *sk, unsigned int flags);
  622. bool mptcp_subflow_data_available(struct sock *sk);
  623. void __init mptcp_subflow_init(void);
  624. void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
  625. void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
  626. struct mptcp_subflow_context *subflow);
  627. void __mptcp_subflow_send_ack(struct sock *ssk);
  628. void mptcp_subflow_reset(struct sock *ssk);
  629. void mptcp_subflow_queue_clean(struct sock *sk, struct sock *ssk);
  630. void mptcp_sock_graft(struct sock *sk, struct socket *parent);
  631. struct sock *__mptcp_nmpc_sk(struct mptcp_sock *msk);
  632. bool __mptcp_close(struct sock *sk, long timeout);
  633. void mptcp_cancel_work(struct sock *sk);
  634. void __mptcp_unaccepted_force_close(struct sock *sk);
  635. void mptcp_set_owner_r(struct sk_buff *skb, struct sock *sk);
  636. void mptcp_set_state(struct sock *sk, int state);
  637. bool mptcp_addresses_equal(const struct mptcp_addr_info *a,
  638. const struct mptcp_addr_info *b, bool use_port);
  639. void mptcp_local_address(const struct sock_common *skc, struct mptcp_addr_info *addr);
  640. /* called with sk socket lock held */
  641. int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_pm_local *local,
  642. const struct mptcp_addr_info *remote);
  643. int mptcp_subflow_create_socket(struct sock *sk, unsigned short family,
  644. struct socket **new_sock);
  645. void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
  646. struct sockaddr_storage *addr,
  647. unsigned short family);
  648. struct mptcp_sched_ops *mptcp_sched_find(const char *name);
  649. int mptcp_register_scheduler(struct mptcp_sched_ops *sched);
  650. void mptcp_unregister_scheduler(struct mptcp_sched_ops *sched);
  651. void mptcp_sched_init(void);
  652. int mptcp_init_sched(struct mptcp_sock *msk,
  653. struct mptcp_sched_ops *sched);
  654. void mptcp_release_sched(struct mptcp_sock *msk);
  655. void mptcp_subflow_set_scheduled(struct mptcp_subflow_context *subflow,
  656. bool scheduled);
  657. struct sock *mptcp_subflow_get_send(struct mptcp_sock *msk);
  658. struct sock *mptcp_subflow_get_retrans(struct mptcp_sock *msk);
  659. int mptcp_sched_get_send(struct mptcp_sock *msk);
  660. int mptcp_sched_get_retrans(struct mptcp_sock *msk);
  661. static inline u64 mptcp_data_avail(const struct mptcp_sock *msk)
  662. {
  663. return READ_ONCE(msk->bytes_received) - READ_ONCE(msk->bytes_consumed);
  664. }
  665. static inline bool mptcp_epollin_ready(const struct sock *sk)
  666. {
  667. u64 data_avail = mptcp_data_avail(mptcp_sk(sk));
  668. if (!data_avail)
  669. return false;
  670. /* mptcp doesn't have to deal with small skbs in the receive queue,
  671. * as it can always coalesce them
  672. */
  673. return (data_avail >= sk->sk_rcvlowat) ||
  674. (mem_cgroup_sockets_enabled && sk->sk_memcg &&
  675. mem_cgroup_under_socket_pressure(sk->sk_memcg)) ||
  676. READ_ONCE(tcp_memory_pressure);
  677. }
  678. int mptcp_set_rcvlowat(struct sock *sk, int val);
  679. static inline bool __tcp_can_send(const struct sock *ssk)
  680. {
  681. /* only send if our side has not closed yet */
  682. return ((1 << inet_sk_state_load(ssk)) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
  683. }
  684. static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
  685. {
  686. /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
  687. if (subflow->request_join && !READ_ONCE(subflow->fully_established))
  688. return false;
  689. return __tcp_can_send(mptcp_subflow_tcp_sock(subflow));
  690. }
  691. void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
  692. bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
  693. void mptcp_subflow_drop_ctx(struct sock *ssk);
  694. static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
  695. struct mptcp_subflow_context *ctx)
  696. {
  697. sk->sk_data_ready = sock_def_readable;
  698. sk->sk_state_change = ctx->tcp_state_change;
  699. sk->sk_write_space = sk_stream_write_space;
  700. sk->sk_error_report = ctx->tcp_error_report;
  701. inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
  702. }
  703. void __init mptcp_proto_init(void);
  704. #if IS_ENABLED(CONFIG_MPTCP_IPV6)
  705. int __init mptcp_proto_v6_init(void);
  706. #endif
  707. struct sock *mptcp_sk_clone_init(const struct sock *sk,
  708. const struct mptcp_options_received *mp_opt,
  709. struct sock *ssk,
  710. struct request_sock *req);
  711. void mptcp_get_options(const struct sk_buff *skb,
  712. struct mptcp_options_received *mp_opt);
  713. void mptcp_finish_connect(struct sock *sk);
  714. void __mptcp_sync_state(struct sock *sk, int state);
  715. void mptcp_reset_tout_timer(struct mptcp_sock *msk, unsigned long fail_tout);
  716. static inline void mptcp_stop_tout_timer(struct sock *sk)
  717. {
  718. if (!inet_csk(sk)->icsk_mtup.probe_timestamp)
  719. return;
  720. sk_stop_timer(sk, &sk->sk_timer);
  721. inet_csk(sk)->icsk_mtup.probe_timestamp = 0;
  722. }
  723. static inline void mptcp_set_close_tout(struct sock *sk, unsigned long tout)
  724. {
  725. /* avoid 0 timestamp, as that means no close timeout */
  726. inet_csk(sk)->icsk_mtup.probe_timestamp = tout ? : 1;
  727. }
  728. static inline void mptcp_start_tout_timer(struct sock *sk)
  729. {
  730. mptcp_set_close_tout(sk, tcp_jiffies32);
  731. mptcp_reset_tout_timer(mptcp_sk(sk), 0);
  732. }
  733. static inline bool mptcp_is_fully_established(struct sock *sk)
  734. {
  735. return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
  736. READ_ONCE(mptcp_sk(sk)->fully_established);
  737. }
  738. void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
  739. void mptcp_data_ready(struct sock *sk, struct sock *ssk);
  740. bool mptcp_finish_join(struct sock *sk);
  741. bool mptcp_schedule_work(struct sock *sk);
  742. int mptcp_setsockopt(struct sock *sk, int level, int optname,
  743. sockptr_t optval, unsigned int optlen);
  744. int mptcp_getsockopt(struct sock *sk, int level, int optname,
  745. char __user *optval, int __user *option);
  746. u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
  747. static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
  748. {
  749. if (use_64bit)
  750. return cur_seq;
  751. return __mptcp_expand_seq(old_seq, cur_seq);
  752. }
  753. void __mptcp_check_push(struct sock *sk, struct sock *ssk);
  754. void __mptcp_data_acked(struct sock *sk);
  755. void __mptcp_error_report(struct sock *sk);
  756. bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
  757. static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
  758. {
  759. return READ_ONCE(msk->snd_data_fin_enable) &&
  760. READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
  761. }
  762. static inline u32 mptcp_notsent_lowat(const struct sock *sk)
  763. {
  764. struct net *net = sock_net(sk);
  765. u32 val;
  766. val = READ_ONCE(mptcp_sk(sk)->notsent_lowat);
  767. return val ?: READ_ONCE(net->ipv4.sysctl_tcp_notsent_lowat);
  768. }
  769. static inline bool mptcp_stream_memory_free(const struct sock *sk, int wake)
  770. {
  771. const struct mptcp_sock *msk = mptcp_sk(sk);
  772. u32 notsent_bytes;
  773. notsent_bytes = READ_ONCE(msk->write_seq) - READ_ONCE(msk->snd_nxt);
  774. return (notsent_bytes << wake) < mptcp_notsent_lowat(sk);
  775. }
  776. static inline bool __mptcp_stream_is_writeable(const struct sock *sk, int wake)
  777. {
  778. return mptcp_stream_memory_free(sk, wake) &&
  779. __sk_stream_is_writeable(sk, wake);
  780. }
  781. static inline void mptcp_write_space(struct sock *sk)
  782. {
  783. /* pairs with memory barrier in mptcp_poll */
  784. smp_mb();
  785. if (mptcp_stream_memory_free(sk, 1))
  786. sk_stream_write_space(sk);
  787. }
  788. static inline void __mptcp_sync_sndbuf(struct sock *sk)
  789. {
  790. struct mptcp_subflow_context *subflow;
  791. int ssk_sndbuf, new_sndbuf;
  792. if (sk->sk_userlocks & SOCK_SNDBUF_LOCK)
  793. return;
  794. new_sndbuf = READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_wmem[0]);
  795. mptcp_for_each_subflow(mptcp_sk(sk), subflow) {
  796. ssk_sndbuf = READ_ONCE(mptcp_subflow_tcp_sock(subflow)->sk_sndbuf);
  797. subflow->cached_sndbuf = ssk_sndbuf;
  798. new_sndbuf += ssk_sndbuf;
  799. }
  800. /* the msk max wmem limit is <nr_subflows> * tcp wmem[2] */
  801. WRITE_ONCE(sk->sk_sndbuf, new_sndbuf);
  802. mptcp_write_space(sk);
  803. }
  804. /* The called held both the msk socket and the subflow socket locks,
  805. * possibly under BH
  806. */
  807. static inline void __mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
  808. {
  809. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
  810. if (READ_ONCE(ssk->sk_sndbuf) != subflow->cached_sndbuf)
  811. __mptcp_sync_sndbuf(sk);
  812. }
  813. /* the caller held only the subflow socket lock, either in process or
  814. * BH context. Additionally this can be called under the msk data lock,
  815. * so we can't acquire such lock here: let the delegate action acquires
  816. * the needed locks in suitable order.
  817. */
  818. static inline void mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
  819. {
  820. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
  821. if (likely(READ_ONCE(ssk->sk_sndbuf) == subflow->cached_sndbuf))
  822. return;
  823. local_bh_disable();
  824. mptcp_subflow_delegate(subflow, MPTCP_DELEGATE_SNDBUF);
  825. local_bh_enable();
  826. }
  827. void mptcp_destroy_common(struct mptcp_sock *msk, unsigned int flags);
  828. #define MPTCP_TOKEN_MAX_RETRIES 4
  829. void __init mptcp_token_init(void);
  830. static inline void mptcp_token_init_request(struct request_sock *req)
  831. {
  832. mptcp_subflow_rsk(req)->token_node.pprev = NULL;
  833. }
  834. int mptcp_token_new_request(struct request_sock *req);
  835. void mptcp_token_destroy_request(struct request_sock *req);
  836. int mptcp_token_new_connect(struct sock *ssk);
  837. void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
  838. struct mptcp_sock *msk);
  839. bool mptcp_token_exists(u32 token);
  840. struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
  841. struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
  842. long *s_num);
  843. void mptcp_token_destroy(struct mptcp_sock *msk);
  844. void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
  845. void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
  846. __sum16 __mptcp_make_csum(u64 data_seq, u32 subflow_seq, u16 data_len, __wsum sum);
  847. void __init mptcp_pm_init(void);
  848. void mptcp_pm_data_init(struct mptcp_sock *msk);
  849. void mptcp_pm_data_reset(struct mptcp_sock *msk);
  850. int mptcp_pm_parse_addr(struct nlattr *attr, struct genl_info *info,
  851. struct mptcp_addr_info *addr);
  852. int mptcp_pm_parse_entry(struct nlattr *attr, struct genl_info *info,
  853. bool require_family,
  854. struct mptcp_pm_addr_entry *entry);
  855. bool mptcp_pm_addr_families_match(const struct sock *sk,
  856. const struct mptcp_addr_info *loc,
  857. const struct mptcp_addr_info *rem);
  858. void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
  859. void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
  860. void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
  861. void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk);
  862. bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
  863. void mptcp_pm_connection_closed(struct mptcp_sock *msk);
  864. void mptcp_pm_subflow_established(struct mptcp_sock *msk);
  865. bool mptcp_pm_nl_check_work_pending(struct mptcp_sock *msk);
  866. void mptcp_pm_subflow_check_next(struct mptcp_sock *msk,
  867. const struct mptcp_subflow_context *subflow);
  868. void mptcp_pm_add_addr_received(const struct sock *ssk,
  869. const struct mptcp_addr_info *addr);
  870. void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
  871. const struct mptcp_addr_info *addr);
  872. void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
  873. bool mptcp_pm_nl_is_init_remote_addr(struct mptcp_sock *msk,
  874. const struct mptcp_addr_info *remote);
  875. void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
  876. void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
  877. const struct mptcp_rm_list *rm_list);
  878. void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
  879. void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
  880. int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
  881. struct mptcp_addr_info *addr,
  882. struct mptcp_addr_info *rem,
  883. u8 bkup);
  884. bool mptcp_pm_alloc_anno_list(struct mptcp_sock *msk,
  885. const struct mptcp_addr_info *addr);
  886. void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
  887. bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
  888. struct mptcp_pm_add_entry *
  889. mptcp_pm_del_add_timer(struct mptcp_sock *msk,
  890. const struct mptcp_addr_info *addr, bool check_id);
  891. struct mptcp_pm_add_entry *
  892. mptcp_lookup_anno_list_by_saddr(const struct mptcp_sock *msk,
  893. const struct mptcp_addr_info *addr);
  894. int mptcp_pm_set_flags(struct sk_buff *skb, struct genl_info *info);
  895. int mptcp_pm_nl_set_flags(struct sk_buff *skb, struct genl_info *info);
  896. int mptcp_userspace_pm_set_flags(struct sk_buff *skb, struct genl_info *info);
  897. int mptcp_pm_announce_addr(struct mptcp_sock *msk,
  898. const struct mptcp_addr_info *addr,
  899. bool echo);
  900. int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
  901. void mptcp_pm_remove_addrs(struct mptcp_sock *msk, struct list_head *rm_list);
  902. void mptcp_free_local_addr_list(struct mptcp_sock *msk);
  903. void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
  904. const struct sock *ssk, gfp_t gfp);
  905. void mptcp_event_addr_announced(const struct sock *ssk, const struct mptcp_addr_info *info);
  906. void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
  907. void mptcp_event_pm_listener(const struct sock *ssk,
  908. enum mptcp_event_type event);
  909. bool mptcp_userspace_pm_active(const struct mptcp_sock *msk);
  910. void __mptcp_fastopen_gen_msk_ackseq(struct mptcp_sock *msk, struct mptcp_subflow_context *subflow,
  911. const struct mptcp_options_received *mp_opt);
  912. void mptcp_fastopen_subflow_synack_set_params(struct mptcp_subflow_context *subflow,
  913. struct request_sock *req);
  914. int mptcp_nl_fill_addr(struct sk_buff *skb,
  915. struct mptcp_pm_addr_entry *entry);
  916. static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
  917. {
  918. return READ_ONCE(msk->pm.addr_signal) &
  919. (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
  920. }
  921. static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
  922. {
  923. return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
  924. }
  925. static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
  926. {
  927. return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
  928. }
  929. static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
  930. {
  931. return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
  932. }
  933. static inline bool mptcp_pm_is_userspace(const struct mptcp_sock *msk)
  934. {
  935. return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_USERSPACE;
  936. }
  937. static inline bool mptcp_pm_is_kernel(const struct mptcp_sock *msk)
  938. {
  939. return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_KERNEL;
  940. }
  941. static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
  942. {
  943. u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
  944. if (family == AF_INET6)
  945. len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
  946. if (!echo)
  947. len += MPTCPOPT_THMAC_LEN;
  948. /* account for 2 trailing 'nop' options */
  949. if (port)
  950. len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
  951. return len;
  952. }
  953. static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
  954. {
  955. if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
  956. return -EINVAL;
  957. return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
  958. }
  959. bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, const struct sk_buff *skb,
  960. unsigned int opt_size, unsigned int remaining,
  961. struct mptcp_addr_info *addr, bool *echo,
  962. bool *drop_other_suboptions);
  963. bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
  964. struct mptcp_rm_list *rm_list);
  965. int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
  966. int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
  967. int mptcp_userspace_pm_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
  968. bool mptcp_pm_is_backup(struct mptcp_sock *msk, struct sock_common *skc);
  969. bool mptcp_pm_nl_is_backup(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
  970. bool mptcp_userspace_pm_is_backup(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
  971. int mptcp_pm_dump_addr(struct sk_buff *msg, struct netlink_callback *cb);
  972. int mptcp_pm_nl_dump_addr(struct sk_buff *msg,
  973. struct netlink_callback *cb);
  974. int mptcp_userspace_pm_dump_addr(struct sk_buff *msg,
  975. struct netlink_callback *cb);
  976. int mptcp_pm_get_addr(struct sk_buff *skb, struct genl_info *info);
  977. int mptcp_pm_nl_get_addr(struct sk_buff *skb, struct genl_info *info);
  978. int mptcp_userspace_pm_get_addr(struct sk_buff *skb,
  979. struct genl_info *info);
  980. static inline u8 subflow_get_local_id(const struct mptcp_subflow_context *subflow)
  981. {
  982. int local_id = READ_ONCE(subflow->local_id);
  983. if (local_id < 0)
  984. return 0;
  985. return local_id;
  986. }
  987. void __init mptcp_pm_nl_init(void);
  988. void mptcp_pm_nl_work(struct mptcp_sock *msk);
  989. unsigned int mptcp_pm_get_add_addr_signal_max(const struct mptcp_sock *msk);
  990. unsigned int mptcp_pm_get_add_addr_accept_max(const struct mptcp_sock *msk);
  991. unsigned int mptcp_pm_get_subflows_max(const struct mptcp_sock *msk);
  992. unsigned int mptcp_pm_get_local_addr_max(const struct mptcp_sock *msk);
  993. /* called under PM lock */
  994. static inline void __mptcp_pm_close_subflow(struct mptcp_sock *msk)
  995. {
  996. if (--msk->pm.subflows < mptcp_pm_get_subflows_max(msk))
  997. WRITE_ONCE(msk->pm.accept_subflow, true);
  998. }
  999. static inline void mptcp_pm_close_subflow(struct mptcp_sock *msk)
  1000. {
  1001. spin_lock_bh(&msk->pm.lock);
  1002. __mptcp_pm_close_subflow(msk);
  1003. spin_unlock_bh(&msk->pm.lock);
  1004. }
  1005. void mptcp_sockopt_sync_locked(struct mptcp_sock *msk, struct sock *ssk);
  1006. static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
  1007. {
  1008. return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
  1009. }
  1010. void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
  1011. static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
  1012. {
  1013. return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
  1014. }
  1015. static inline bool mptcp_check_fallback(const struct sock *sk)
  1016. {
  1017. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
  1018. struct mptcp_sock *msk = mptcp_sk(subflow->conn);
  1019. return __mptcp_check_fallback(msk);
  1020. }
  1021. static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
  1022. {
  1023. if (__mptcp_check_fallback(msk)) {
  1024. pr_debug("TCP fallback already done (msk=%p)\n", msk);
  1025. return;
  1026. }
  1027. set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
  1028. }
  1029. static inline bool __mptcp_has_initial_subflow(const struct mptcp_sock *msk)
  1030. {
  1031. struct sock *ssk = READ_ONCE(msk->first);
  1032. return ssk && ((1 << inet_sk_state_load(ssk)) &
  1033. (TCPF_ESTABLISHED | TCPF_SYN_SENT |
  1034. TCPF_SYN_RECV | TCPF_LISTEN));
  1035. }
  1036. static inline void mptcp_do_fallback(struct sock *ssk)
  1037. {
  1038. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
  1039. struct sock *sk = subflow->conn;
  1040. struct mptcp_sock *msk;
  1041. msk = mptcp_sk(sk);
  1042. __mptcp_do_fallback(msk);
  1043. if (READ_ONCE(msk->snd_data_fin_enable) && !(ssk->sk_shutdown & SEND_SHUTDOWN)) {
  1044. gfp_t saved_allocation = ssk->sk_allocation;
  1045. /* we are in a atomic (BH) scope, override ssk default for data
  1046. * fin allocation
  1047. */
  1048. ssk->sk_allocation = GFP_ATOMIC;
  1049. ssk->sk_shutdown |= SEND_SHUTDOWN;
  1050. tcp_shutdown(ssk, SEND_SHUTDOWN);
  1051. ssk->sk_allocation = saved_allocation;
  1052. }
  1053. }
  1054. #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)\n", __func__, a)
  1055. static inline void mptcp_subflow_early_fallback(struct mptcp_sock *msk,
  1056. struct mptcp_subflow_context *subflow)
  1057. {
  1058. pr_fallback(msk);
  1059. subflow->request_mptcp = 0;
  1060. __mptcp_do_fallback(msk);
  1061. }
  1062. static inline bool mptcp_check_infinite_map(struct sk_buff *skb)
  1063. {
  1064. struct mptcp_ext *mpext;
  1065. mpext = skb ? mptcp_get_ext(skb) : NULL;
  1066. if (mpext && mpext->infinite_map)
  1067. return true;
  1068. return false;
  1069. }
  1070. static inline bool is_active_ssk(struct mptcp_subflow_context *subflow)
  1071. {
  1072. return (subflow->request_mptcp || subflow->request_join);
  1073. }
  1074. static inline bool subflow_simultaneous_connect(struct sock *sk)
  1075. {
  1076. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
  1077. return (1 << sk->sk_state) &
  1078. (TCPF_ESTABLISHED | TCPF_FIN_WAIT1 | TCPF_FIN_WAIT2 | TCPF_CLOSING) &&
  1079. is_active_ssk(subflow) &&
  1080. !subflow->conn_finished;
  1081. }
  1082. #ifdef CONFIG_SYN_COOKIES
  1083. void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
  1084. struct sk_buff *skb);
  1085. bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
  1086. struct sk_buff *skb);
  1087. void __init mptcp_join_cookie_init(void);
  1088. #else
  1089. static inline void
  1090. subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
  1091. struct sk_buff *skb) {}
  1092. static inline bool
  1093. mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
  1094. struct sk_buff *skb)
  1095. {
  1096. return false;
  1097. }
  1098. static inline void mptcp_join_cookie_init(void) {}
  1099. #endif
  1100. #endif /* __MPTCP_PROTOCOL_H */