protocol.h 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311
  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. bool allow_subflows;
  310. u32 subflow_id;
  311. u32 setsockopt_seq;
  312. char ca_name[TCP_CA_NAME_MAX];
  313. spinlock_t fallback_lock; /* protects fallback,
  314. * allow_infinite_fallback and
  315. * allow_join
  316. */
  317. };
  318. #define mptcp_data_lock(sk) spin_lock_bh(&(sk)->sk_lock.slock)
  319. #define mptcp_data_unlock(sk) spin_unlock_bh(&(sk)->sk_lock.slock)
  320. #define mptcp_for_each_subflow(__msk, __subflow) \
  321. list_for_each_entry(__subflow, &((__msk)->conn_list), node)
  322. #define mptcp_for_each_subflow_safe(__msk, __subflow, __tmp) \
  323. list_for_each_entry_safe(__subflow, __tmp, &((__msk)->conn_list), node)
  324. extern struct genl_family mptcp_genl_family;
  325. static inline void msk_owned_by_me(const struct mptcp_sock *msk)
  326. {
  327. sock_owned_by_me((const struct sock *)msk);
  328. }
  329. #ifdef CONFIG_DEBUG_NET
  330. /* MPTCP-specific: we might (indirectly) call this helper with the wrong sk */
  331. #undef tcp_sk
  332. #define tcp_sk(ptr) ({ \
  333. typeof(ptr) _ptr = (ptr); \
  334. WARN_ON(_ptr->sk_protocol != IPPROTO_TCP); \
  335. container_of_const(_ptr, struct tcp_sock, inet_conn.icsk_inet.sk); \
  336. })
  337. #define mptcp_sk(ptr) ({ \
  338. typeof(ptr) _ptr = (ptr); \
  339. WARN_ON(_ptr->sk_protocol != IPPROTO_MPTCP); \
  340. container_of_const(_ptr, struct mptcp_sock, sk.icsk_inet.sk); \
  341. })
  342. #else /* !CONFIG_DEBUG_NET */
  343. #define mptcp_sk(ptr) container_of_const(ptr, struct mptcp_sock, sk.icsk_inet.sk)
  344. #endif
  345. /* the msk socket don't use the backlog, also account for the bulk
  346. * free memory
  347. */
  348. static inline int __mptcp_rmem(const struct sock *sk)
  349. {
  350. return atomic_read(&sk->sk_rmem_alloc) - READ_ONCE(mptcp_sk(sk)->rmem_released);
  351. }
  352. static inline int mptcp_win_from_space(const struct sock *sk, int space)
  353. {
  354. return __tcp_win_from_space(mptcp_sk(sk)->scaling_ratio, space);
  355. }
  356. static inline int mptcp_space_from_win(const struct sock *sk, int win)
  357. {
  358. return __tcp_space_from_win(mptcp_sk(sk)->scaling_ratio, win);
  359. }
  360. static inline int __mptcp_space(const struct sock *sk)
  361. {
  362. return mptcp_win_from_space(sk, READ_ONCE(sk->sk_rcvbuf) - __mptcp_rmem(sk));
  363. }
  364. static inline struct mptcp_data_frag *mptcp_send_head(const struct sock *sk)
  365. {
  366. const struct mptcp_sock *msk = mptcp_sk(sk);
  367. return READ_ONCE(msk->first_pending);
  368. }
  369. static inline struct mptcp_data_frag *mptcp_send_next(struct sock *sk)
  370. {
  371. struct mptcp_sock *msk = mptcp_sk(sk);
  372. struct mptcp_data_frag *cur;
  373. cur = msk->first_pending;
  374. return list_is_last(&cur->list, &msk->rtx_queue) ? NULL :
  375. list_next_entry(cur, list);
  376. }
  377. static inline struct mptcp_data_frag *mptcp_pending_tail(const struct sock *sk)
  378. {
  379. const struct mptcp_sock *msk = mptcp_sk(sk);
  380. if (!msk->first_pending)
  381. return NULL;
  382. if (WARN_ON_ONCE(list_empty(&msk->rtx_queue)))
  383. return NULL;
  384. return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
  385. }
  386. static inline struct mptcp_data_frag *mptcp_rtx_head(struct sock *sk)
  387. {
  388. struct mptcp_sock *msk = mptcp_sk(sk);
  389. if (msk->snd_una == msk->snd_nxt)
  390. return NULL;
  391. return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
  392. }
  393. struct csum_pseudo_header {
  394. __be64 data_seq;
  395. __be32 subflow_seq;
  396. __be16 data_len;
  397. __sum16 csum;
  398. };
  399. struct mptcp_subflow_request_sock {
  400. struct tcp_request_sock sk;
  401. u16 mp_capable : 1,
  402. mp_join : 1,
  403. backup : 1,
  404. request_bkup : 1,
  405. csum_reqd : 1,
  406. allow_join_id0 : 1;
  407. u8 local_id;
  408. u8 remote_id;
  409. u64 local_key;
  410. u64 idsn;
  411. u32 token;
  412. u32 ssn_offset;
  413. u64 thmac;
  414. u32 local_nonce;
  415. u32 remote_nonce;
  416. struct mptcp_sock *msk;
  417. struct hlist_nulls_node token_node;
  418. };
  419. static inline struct mptcp_subflow_request_sock *
  420. mptcp_subflow_rsk(const struct request_sock *rsk)
  421. {
  422. return (struct mptcp_subflow_request_sock *)rsk;
  423. }
  424. struct mptcp_delegated_action {
  425. struct napi_struct napi;
  426. struct list_head head;
  427. };
  428. DECLARE_PER_CPU(struct mptcp_delegated_action, mptcp_delegated_actions);
  429. #define MPTCP_DELEGATE_SCHEDULED 0
  430. #define MPTCP_DELEGATE_SEND 1
  431. #define MPTCP_DELEGATE_ACK 2
  432. #define MPTCP_DELEGATE_SNDBUF 3
  433. #define MPTCP_DELEGATE_ACTIONS_MASK (~BIT(MPTCP_DELEGATE_SCHEDULED))
  434. /* MPTCP subflow context */
  435. struct mptcp_subflow_context {
  436. struct list_head node;/* conn_list of subflows */
  437. struct_group(reset,
  438. unsigned long avg_pacing_rate; /* protected by msk socket lock */
  439. u64 local_key;
  440. u64 remote_key;
  441. u64 idsn;
  442. u64 map_seq;
  443. u32 snd_isn;
  444. u32 token;
  445. u32 rel_write_seq;
  446. u32 map_subflow_seq;
  447. u32 ssn_offset;
  448. u32 map_data_len;
  449. __wsum map_data_csum;
  450. u32 map_csum_len;
  451. u32 request_mptcp : 1, /* send MP_CAPABLE */
  452. request_join : 1, /* send MP_JOIN */
  453. request_bkup : 1,
  454. mp_capable : 1, /* remote is MPTCP capable */
  455. mp_join : 1, /* remote is JOINing */
  456. pm_notified : 1, /* PM hook called for established status */
  457. conn_finished : 1,
  458. map_valid : 1,
  459. map_csum_reqd : 1,
  460. map_data_fin : 1,
  461. mpc_map : 1,
  462. backup : 1,
  463. send_mp_prio : 1,
  464. send_mp_fail : 1,
  465. send_fastclose : 1,
  466. send_infinite_map : 1,
  467. remote_key_valid : 1, /* received the peer key from */
  468. disposable : 1, /* ctx can be free at ulp release time */
  469. stale : 1, /* unable to snd/rcv data, do not use for xmit */
  470. valid_csum_seen : 1, /* at least one csum validated */
  471. is_mptfo : 1, /* subflow is doing TFO */
  472. close_event_done : 1, /* has done the post-closed part */
  473. mpc_drop : 1, /* the MPC option has been dropped in a rtx */
  474. __unused : 9;
  475. bool data_avail;
  476. bool scheduled;
  477. bool pm_listener; /* a listener managed by the kernel PM? */
  478. bool fully_established; /* path validated */
  479. u32 remote_nonce;
  480. u64 thmac;
  481. u32 local_nonce;
  482. u32 remote_token;
  483. union {
  484. u8 hmac[MPTCPOPT_HMAC_LEN]; /* MPJ subflow only */
  485. u64 iasn; /* initial ack sequence number, MPC subflows only */
  486. };
  487. s16 local_id; /* if negative not initialized yet */
  488. u8 remote_id;
  489. u8 reset_seen:1;
  490. u8 reset_transient:1;
  491. u8 reset_reason:4;
  492. u8 stale_count;
  493. u32 subflow_id;
  494. long delegated_status;
  495. unsigned long fail_tout;
  496. );
  497. struct list_head delegated_node; /* link into delegated_action, protected by local BH */
  498. u32 setsockopt_seq;
  499. u32 stale_rcv_tstamp;
  500. int cached_sndbuf; /* sndbuf size when last synced with the msk sndbuf,
  501. * protected by the msk socket lock
  502. */
  503. struct sock *tcp_sock; /* tcp sk backpointer */
  504. struct sock *conn; /* parent mptcp_sock */
  505. const struct inet_connection_sock_af_ops *icsk_af_ops;
  506. void (*tcp_state_change)(struct sock *sk);
  507. void (*tcp_error_report)(struct sock *sk);
  508. struct rcu_head rcu;
  509. };
  510. static inline struct mptcp_subflow_context *
  511. mptcp_subflow_ctx(const struct sock *sk)
  512. {
  513. const struct inet_connection_sock *icsk = inet_csk(sk);
  514. /* Use RCU on icsk_ulp_data only for sock diag code */
  515. return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
  516. }
  517. static inline struct sock *
  518. mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
  519. {
  520. return subflow->tcp_sock;
  521. }
  522. static inline void
  523. mptcp_subflow_ctx_reset(struct mptcp_subflow_context *subflow)
  524. {
  525. memset(&subflow->reset, 0, sizeof(subflow->reset));
  526. subflow->request_mptcp = 1;
  527. WRITE_ONCE(subflow->local_id, -1);
  528. }
  529. /* Convert reset reasons in MPTCP to enum sk_rst_reason type */
  530. static inline enum sk_rst_reason
  531. sk_rst_convert_mptcp_reason(u32 reason)
  532. {
  533. switch (reason) {
  534. case MPTCP_RST_EUNSPEC:
  535. return SK_RST_REASON_MPTCP_RST_EUNSPEC;
  536. case MPTCP_RST_EMPTCP:
  537. return SK_RST_REASON_MPTCP_RST_EMPTCP;
  538. case MPTCP_RST_ERESOURCE:
  539. return SK_RST_REASON_MPTCP_RST_ERESOURCE;
  540. case MPTCP_RST_EPROHIBIT:
  541. return SK_RST_REASON_MPTCP_RST_EPROHIBIT;
  542. case MPTCP_RST_EWQ2BIG:
  543. return SK_RST_REASON_MPTCP_RST_EWQ2BIG;
  544. case MPTCP_RST_EBADPERF:
  545. return SK_RST_REASON_MPTCP_RST_EBADPERF;
  546. case MPTCP_RST_EMIDDLEBOX:
  547. return SK_RST_REASON_MPTCP_RST_EMIDDLEBOX;
  548. default:
  549. /* It should not happen, or else errors may occur
  550. * in MPTCP layer
  551. */
  552. return SK_RST_REASON_ERROR;
  553. }
  554. }
  555. static inline void
  556. mptcp_send_active_reset_reason(struct sock *sk)
  557. {
  558. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
  559. enum sk_rst_reason reason;
  560. reason = sk_rst_convert_mptcp_reason(subflow->reset_reason);
  561. tcp_send_active_reset(sk, GFP_ATOMIC, reason);
  562. }
  563. static inline u64
  564. mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
  565. {
  566. return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
  567. subflow->ssn_offset -
  568. subflow->map_subflow_seq;
  569. }
  570. static inline u64
  571. mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
  572. {
  573. return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
  574. }
  575. void mptcp_subflow_process_delegated(struct sock *ssk, long actions);
  576. static inline void mptcp_subflow_delegate(struct mptcp_subflow_context *subflow, int action)
  577. {
  578. long old, set_bits = BIT(MPTCP_DELEGATE_SCHEDULED) | BIT(action);
  579. struct mptcp_delegated_action *delegated;
  580. bool schedule;
  581. /* the caller held the subflow bh socket lock */
  582. lockdep_assert_in_softirq();
  583. /* The implied barrier pairs with tcp_release_cb_override()
  584. * mptcp_napi_poll(), and ensures the below list check sees list
  585. * updates done prior to delegated status bits changes
  586. */
  587. old = set_mask_bits(&subflow->delegated_status, 0, set_bits);
  588. if (!(old & BIT(MPTCP_DELEGATE_SCHEDULED))) {
  589. if (WARN_ON_ONCE(!list_empty(&subflow->delegated_node)))
  590. return;
  591. delegated = this_cpu_ptr(&mptcp_delegated_actions);
  592. schedule = list_empty(&delegated->head);
  593. list_add_tail(&subflow->delegated_node, &delegated->head);
  594. sock_hold(mptcp_subflow_tcp_sock(subflow));
  595. if (schedule)
  596. napi_schedule(&delegated->napi);
  597. }
  598. }
  599. static inline struct mptcp_subflow_context *
  600. mptcp_subflow_delegated_next(struct mptcp_delegated_action *delegated)
  601. {
  602. struct mptcp_subflow_context *ret;
  603. if (list_empty(&delegated->head))
  604. return NULL;
  605. ret = list_first_entry(&delegated->head, struct mptcp_subflow_context, delegated_node);
  606. list_del_init(&ret->delegated_node);
  607. return ret;
  608. }
  609. int mptcp_is_enabled(const struct net *net);
  610. unsigned int mptcp_get_add_addr_timeout(const struct net *net);
  611. int mptcp_is_checksum_enabled(const struct net *net);
  612. int mptcp_allow_join_id0(const struct net *net);
  613. unsigned int mptcp_stale_loss_cnt(const struct net *net);
  614. unsigned int mptcp_close_timeout(const struct sock *sk);
  615. int mptcp_get_pm_type(const struct net *net);
  616. const char *mptcp_get_scheduler(const struct net *net);
  617. void mptcp_active_disable(struct sock *sk);
  618. bool mptcp_active_should_disable(struct sock *ssk);
  619. void mptcp_active_enable(struct sock *sk);
  620. void mptcp_get_available_schedulers(char *buf, size_t maxlen);
  621. void __mptcp_subflow_fully_established(struct mptcp_sock *msk,
  622. struct mptcp_subflow_context *subflow,
  623. const struct mptcp_options_received *mp_opt);
  624. bool __mptcp_retransmit_pending_data(struct sock *sk);
  625. void mptcp_check_and_set_pending(struct sock *sk);
  626. void __mptcp_push_pending(struct sock *sk, unsigned int flags);
  627. bool mptcp_subflow_data_available(struct sock *sk);
  628. void __init mptcp_subflow_init(void);
  629. void mptcp_subflow_shutdown(struct sock *sk, struct sock *ssk, int how);
  630. void mptcp_close_ssk(struct sock *sk, struct sock *ssk,
  631. struct mptcp_subflow_context *subflow);
  632. void __mptcp_subflow_send_ack(struct sock *ssk);
  633. void mptcp_subflow_reset(struct sock *ssk);
  634. void mptcp_subflow_queue_clean(struct sock *sk, struct sock *ssk);
  635. void mptcp_sock_graft(struct sock *sk, struct socket *parent);
  636. struct sock *__mptcp_nmpc_sk(struct mptcp_sock *msk);
  637. bool __mptcp_close(struct sock *sk, long timeout);
  638. void mptcp_cancel_work(struct sock *sk);
  639. void __mptcp_unaccepted_force_close(struct sock *sk);
  640. void mptcp_set_owner_r(struct sk_buff *skb, struct sock *sk);
  641. void mptcp_set_state(struct sock *sk, int state);
  642. bool mptcp_addresses_equal(const struct mptcp_addr_info *a,
  643. const struct mptcp_addr_info *b, bool use_port);
  644. void mptcp_local_address(const struct sock_common *skc, struct mptcp_addr_info *addr);
  645. /* called with sk socket lock held */
  646. int __mptcp_subflow_connect(struct sock *sk, const struct mptcp_pm_local *local,
  647. const struct mptcp_addr_info *remote);
  648. int mptcp_subflow_create_socket(struct sock *sk, unsigned short family,
  649. struct socket **new_sock);
  650. void mptcp_info2sockaddr(const struct mptcp_addr_info *info,
  651. struct sockaddr_storage *addr,
  652. unsigned short family);
  653. struct mptcp_sched_ops *mptcp_sched_find(const char *name);
  654. int mptcp_register_scheduler(struct mptcp_sched_ops *sched);
  655. void mptcp_unregister_scheduler(struct mptcp_sched_ops *sched);
  656. void mptcp_sched_init(void);
  657. int mptcp_init_sched(struct mptcp_sock *msk,
  658. struct mptcp_sched_ops *sched);
  659. void mptcp_release_sched(struct mptcp_sock *msk);
  660. void mptcp_subflow_set_scheduled(struct mptcp_subflow_context *subflow,
  661. bool scheduled);
  662. struct sock *mptcp_subflow_get_send(struct mptcp_sock *msk);
  663. struct sock *mptcp_subflow_get_retrans(struct mptcp_sock *msk);
  664. int mptcp_sched_get_send(struct mptcp_sock *msk);
  665. int mptcp_sched_get_retrans(struct mptcp_sock *msk);
  666. static inline u64 mptcp_data_avail(const struct mptcp_sock *msk)
  667. {
  668. return READ_ONCE(msk->bytes_received) - READ_ONCE(msk->bytes_consumed);
  669. }
  670. static inline bool mptcp_epollin_ready(const struct sock *sk)
  671. {
  672. u64 data_avail = mptcp_data_avail(mptcp_sk(sk));
  673. if (!data_avail)
  674. return false;
  675. /* mptcp doesn't have to deal with small skbs in the receive queue,
  676. * as it can always coalesce them
  677. */
  678. return (data_avail >= sk->sk_rcvlowat) ||
  679. (mem_cgroup_sockets_enabled && sk->sk_memcg &&
  680. mem_cgroup_under_socket_pressure(sk->sk_memcg)) ||
  681. READ_ONCE(tcp_memory_pressure);
  682. }
  683. int mptcp_set_rcvlowat(struct sock *sk, int val);
  684. static inline bool __tcp_can_send(const struct sock *ssk)
  685. {
  686. /* only send if our side has not closed yet */
  687. return ((1 << inet_sk_state_load(ssk)) & (TCPF_ESTABLISHED | TCPF_CLOSE_WAIT));
  688. }
  689. static inline bool __mptcp_subflow_active(struct mptcp_subflow_context *subflow)
  690. {
  691. /* can't send if JOIN hasn't completed yet (i.e. is usable for mptcp) */
  692. if (subflow->request_join && !READ_ONCE(subflow->fully_established))
  693. return false;
  694. return __tcp_can_send(mptcp_subflow_tcp_sock(subflow));
  695. }
  696. void mptcp_subflow_set_active(struct mptcp_subflow_context *subflow);
  697. bool mptcp_subflow_active(struct mptcp_subflow_context *subflow);
  698. void mptcp_subflow_drop_ctx(struct sock *ssk);
  699. static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
  700. struct mptcp_subflow_context *ctx)
  701. {
  702. sk->sk_data_ready = sock_def_readable;
  703. sk->sk_state_change = ctx->tcp_state_change;
  704. sk->sk_write_space = sk_stream_write_space;
  705. sk->sk_error_report = ctx->tcp_error_report;
  706. inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
  707. }
  708. void __init mptcp_proto_init(void);
  709. #if IS_ENABLED(CONFIG_MPTCP_IPV6)
  710. int __init mptcp_proto_v6_init(void);
  711. #endif
  712. struct sock *mptcp_sk_clone_init(const struct sock *sk,
  713. const struct mptcp_options_received *mp_opt,
  714. struct sock *ssk,
  715. struct request_sock *req);
  716. void mptcp_get_options(const struct sk_buff *skb,
  717. struct mptcp_options_received *mp_opt);
  718. void mptcp_finish_connect(struct sock *sk);
  719. void __mptcp_sync_state(struct sock *sk, int state);
  720. void mptcp_reset_tout_timer(struct mptcp_sock *msk, unsigned long fail_tout);
  721. static inline void mptcp_stop_tout_timer(struct sock *sk)
  722. {
  723. if (!inet_csk(sk)->icsk_mtup.probe_timestamp)
  724. return;
  725. sk_stop_timer(sk, &sk->sk_timer);
  726. inet_csk(sk)->icsk_mtup.probe_timestamp = 0;
  727. }
  728. static inline void mptcp_set_close_tout(struct sock *sk, unsigned long tout)
  729. {
  730. /* avoid 0 timestamp, as that means no close timeout */
  731. inet_csk(sk)->icsk_mtup.probe_timestamp = tout ? : 1;
  732. }
  733. static inline void mptcp_start_tout_timer(struct sock *sk)
  734. {
  735. mptcp_set_close_tout(sk, tcp_jiffies32);
  736. mptcp_reset_tout_timer(mptcp_sk(sk), 0);
  737. }
  738. static inline bool mptcp_is_fully_established(struct sock *sk)
  739. {
  740. return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
  741. READ_ONCE(mptcp_sk(sk)->fully_established);
  742. }
  743. void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
  744. void mptcp_data_ready(struct sock *sk, struct sock *ssk);
  745. bool mptcp_finish_join(struct sock *sk);
  746. bool mptcp_schedule_work(struct sock *sk);
  747. int mptcp_setsockopt(struct sock *sk, int level, int optname,
  748. sockptr_t optval, unsigned int optlen);
  749. int mptcp_getsockopt(struct sock *sk, int level, int optname,
  750. char __user *optval, int __user *option);
  751. u64 __mptcp_expand_seq(u64 old_seq, u64 cur_seq);
  752. static inline u64 mptcp_expand_seq(u64 old_seq, u64 cur_seq, bool use_64bit)
  753. {
  754. if (use_64bit)
  755. return cur_seq;
  756. return __mptcp_expand_seq(old_seq, cur_seq);
  757. }
  758. void __mptcp_check_push(struct sock *sk, struct sock *ssk);
  759. void __mptcp_data_acked(struct sock *sk);
  760. void __mptcp_error_report(struct sock *sk);
  761. bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq, bool use_64bit);
  762. static inline bool mptcp_data_fin_enabled(const struct mptcp_sock *msk)
  763. {
  764. return READ_ONCE(msk->snd_data_fin_enable) &&
  765. READ_ONCE(msk->write_seq) == READ_ONCE(msk->snd_nxt);
  766. }
  767. static inline u32 mptcp_notsent_lowat(const struct sock *sk)
  768. {
  769. struct net *net = sock_net(sk);
  770. u32 val;
  771. val = READ_ONCE(mptcp_sk(sk)->notsent_lowat);
  772. return val ?: READ_ONCE(net->ipv4.sysctl_tcp_notsent_lowat);
  773. }
  774. static inline bool mptcp_stream_memory_free(const struct sock *sk, int wake)
  775. {
  776. const struct mptcp_sock *msk = mptcp_sk(sk);
  777. u32 notsent_bytes;
  778. notsent_bytes = READ_ONCE(msk->write_seq) - READ_ONCE(msk->snd_nxt);
  779. return (notsent_bytes << wake) < mptcp_notsent_lowat(sk);
  780. }
  781. static inline bool __mptcp_stream_is_writeable(const struct sock *sk, int wake)
  782. {
  783. return mptcp_stream_memory_free(sk, wake) &&
  784. __sk_stream_is_writeable(sk, wake);
  785. }
  786. static inline void mptcp_write_space(struct sock *sk)
  787. {
  788. /* pairs with memory barrier in mptcp_poll */
  789. smp_mb();
  790. if (mptcp_stream_memory_free(sk, 1))
  791. sk_stream_write_space(sk);
  792. }
  793. static inline void __mptcp_sync_sndbuf(struct sock *sk)
  794. {
  795. struct mptcp_subflow_context *subflow;
  796. int ssk_sndbuf, new_sndbuf;
  797. if (sk->sk_userlocks & SOCK_SNDBUF_LOCK)
  798. return;
  799. new_sndbuf = READ_ONCE(sock_net(sk)->ipv4.sysctl_tcp_wmem[0]);
  800. mptcp_for_each_subflow(mptcp_sk(sk), subflow) {
  801. ssk_sndbuf = READ_ONCE(mptcp_subflow_tcp_sock(subflow)->sk_sndbuf);
  802. subflow->cached_sndbuf = ssk_sndbuf;
  803. new_sndbuf += ssk_sndbuf;
  804. }
  805. /* the msk max wmem limit is <nr_subflows> * tcp wmem[2] */
  806. WRITE_ONCE(sk->sk_sndbuf, new_sndbuf);
  807. mptcp_write_space(sk);
  808. }
  809. /* The called held both the msk socket and the subflow socket locks,
  810. * possibly under BH
  811. */
  812. static inline void __mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
  813. {
  814. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
  815. if (READ_ONCE(ssk->sk_sndbuf) != subflow->cached_sndbuf)
  816. __mptcp_sync_sndbuf(sk);
  817. }
  818. /* the caller held only the subflow socket lock, either in process or
  819. * BH context. Additionally this can be called under the msk data lock,
  820. * so we can't acquire such lock here: let the delegate action acquires
  821. * the needed locks in suitable order.
  822. */
  823. static inline void mptcp_propagate_sndbuf(struct sock *sk, struct sock *ssk)
  824. {
  825. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
  826. if (likely(READ_ONCE(ssk->sk_sndbuf) == subflow->cached_sndbuf))
  827. return;
  828. local_bh_disable();
  829. mptcp_subflow_delegate(subflow, MPTCP_DELEGATE_SNDBUF);
  830. local_bh_enable();
  831. }
  832. void mptcp_destroy_common(struct mptcp_sock *msk, unsigned int flags);
  833. #define MPTCP_TOKEN_MAX_RETRIES 4
  834. void __init mptcp_token_init(void);
  835. static inline void mptcp_token_init_request(struct request_sock *req)
  836. {
  837. mptcp_subflow_rsk(req)->token_node.pprev = NULL;
  838. }
  839. int mptcp_token_new_request(struct request_sock *req);
  840. void mptcp_token_destroy_request(struct request_sock *req);
  841. int mptcp_token_new_connect(struct sock *ssk);
  842. void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
  843. struct mptcp_sock *msk);
  844. bool mptcp_token_exists(u32 token);
  845. struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token);
  846. struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
  847. long *s_num);
  848. void mptcp_token_destroy(struct mptcp_sock *msk);
  849. void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);
  850. void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);
  851. __sum16 __mptcp_make_csum(u64 data_seq, u32 subflow_seq, u16 data_len, __wsum sum);
  852. void __init mptcp_pm_init(void);
  853. void mptcp_pm_data_init(struct mptcp_sock *msk);
  854. void mptcp_pm_data_reset(struct mptcp_sock *msk);
  855. int mptcp_pm_parse_addr(struct nlattr *attr, struct genl_info *info,
  856. struct mptcp_addr_info *addr);
  857. int mptcp_pm_parse_entry(struct nlattr *attr, struct genl_info *info,
  858. bool require_family,
  859. struct mptcp_pm_addr_entry *entry);
  860. bool mptcp_pm_addr_families_match(const struct sock *sk,
  861. const struct mptcp_addr_info *loc,
  862. const struct mptcp_addr_info *rem);
  863. void mptcp_pm_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
  864. void mptcp_pm_nl_subflow_chk_stale(const struct mptcp_sock *msk, struct sock *ssk);
  865. void mptcp_pm_new_connection(struct mptcp_sock *msk, const struct sock *ssk, int server_side);
  866. void mptcp_pm_fully_established(struct mptcp_sock *msk, const struct sock *ssk);
  867. bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
  868. void mptcp_pm_connection_closed(struct mptcp_sock *msk);
  869. void mptcp_pm_subflow_established(struct mptcp_sock *msk);
  870. bool mptcp_pm_nl_check_work_pending(struct mptcp_sock *msk);
  871. void mptcp_pm_subflow_check_next(struct mptcp_sock *msk,
  872. const struct mptcp_subflow_context *subflow);
  873. void mptcp_pm_add_addr_received(const struct sock *ssk,
  874. const struct mptcp_addr_info *addr);
  875. void mptcp_pm_add_addr_echoed(struct mptcp_sock *msk,
  876. const struct mptcp_addr_info *addr);
  877. void mptcp_pm_add_addr_send_ack(struct mptcp_sock *msk);
  878. bool mptcp_pm_nl_is_init_remote_addr(struct mptcp_sock *msk,
  879. const struct mptcp_addr_info *remote);
  880. void mptcp_pm_nl_addr_send_ack(struct mptcp_sock *msk);
  881. void mptcp_pm_rm_addr_received(struct mptcp_sock *msk,
  882. const struct mptcp_rm_list *rm_list);
  883. void mptcp_pm_mp_prio_received(struct sock *sk, u8 bkup);
  884. void mptcp_pm_mp_fail_received(struct sock *sk, u64 fail_seq);
  885. int mptcp_pm_nl_mp_prio_send_ack(struct mptcp_sock *msk,
  886. struct mptcp_addr_info *addr,
  887. struct mptcp_addr_info *rem,
  888. u8 bkup);
  889. bool mptcp_pm_alloc_anno_list(struct mptcp_sock *msk,
  890. const struct mptcp_addr_info *addr);
  891. void mptcp_pm_free_anno_list(struct mptcp_sock *msk);
  892. bool mptcp_pm_sport_in_anno_list(struct mptcp_sock *msk, const struct sock *sk);
  893. struct mptcp_pm_add_entry *
  894. mptcp_pm_del_add_timer(struct mptcp_sock *msk,
  895. const struct mptcp_addr_info *addr, bool check_id);
  896. struct mptcp_pm_add_entry *
  897. mptcp_lookup_anno_list_by_saddr(const struct mptcp_sock *msk,
  898. const struct mptcp_addr_info *addr);
  899. int mptcp_pm_set_flags(struct sk_buff *skb, struct genl_info *info);
  900. int mptcp_pm_nl_set_flags(struct sk_buff *skb, struct genl_info *info);
  901. int mptcp_userspace_pm_set_flags(struct sk_buff *skb, struct genl_info *info);
  902. int mptcp_pm_announce_addr(struct mptcp_sock *msk,
  903. const struct mptcp_addr_info *addr,
  904. bool echo);
  905. int mptcp_pm_remove_addr(struct mptcp_sock *msk, const struct mptcp_rm_list *rm_list);
  906. void mptcp_pm_remove_addrs(struct mptcp_sock *msk, struct list_head *rm_list);
  907. void mptcp_free_local_addr_list(struct mptcp_sock *msk);
  908. void mptcp_event(enum mptcp_event_type type, const struct mptcp_sock *msk,
  909. const struct sock *ssk, gfp_t gfp);
  910. void mptcp_event_addr_announced(const struct sock *ssk, const struct mptcp_addr_info *info);
  911. void mptcp_event_addr_removed(const struct mptcp_sock *msk, u8 id);
  912. void mptcp_event_pm_listener(const struct sock *ssk,
  913. enum mptcp_event_type event);
  914. bool mptcp_userspace_pm_active(const struct mptcp_sock *msk);
  915. void __mptcp_fastopen_gen_msk_ackseq(struct mptcp_sock *msk, struct mptcp_subflow_context *subflow,
  916. const struct mptcp_options_received *mp_opt);
  917. void mptcp_fastopen_subflow_synack_set_params(struct mptcp_subflow_context *subflow,
  918. struct request_sock *req);
  919. int mptcp_nl_fill_addr(struct sk_buff *skb,
  920. struct mptcp_pm_addr_entry *entry);
  921. static inline bool mptcp_pm_should_add_signal(struct mptcp_sock *msk)
  922. {
  923. return READ_ONCE(msk->pm.addr_signal) &
  924. (BIT(MPTCP_ADD_ADDR_SIGNAL) | BIT(MPTCP_ADD_ADDR_ECHO));
  925. }
  926. static inline bool mptcp_pm_should_add_signal_addr(struct mptcp_sock *msk)
  927. {
  928. return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_SIGNAL);
  929. }
  930. static inline bool mptcp_pm_should_add_signal_echo(struct mptcp_sock *msk)
  931. {
  932. return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_ADD_ADDR_ECHO);
  933. }
  934. static inline bool mptcp_pm_should_rm_signal(struct mptcp_sock *msk)
  935. {
  936. return READ_ONCE(msk->pm.addr_signal) & BIT(MPTCP_RM_ADDR_SIGNAL);
  937. }
  938. static inline bool mptcp_pm_is_userspace(const struct mptcp_sock *msk)
  939. {
  940. return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_USERSPACE;
  941. }
  942. static inline bool mptcp_pm_is_kernel(const struct mptcp_sock *msk)
  943. {
  944. return READ_ONCE(msk->pm.pm_type) == MPTCP_PM_TYPE_KERNEL;
  945. }
  946. static inline unsigned int mptcp_add_addr_len(int family, bool echo, bool port)
  947. {
  948. u8 len = TCPOLEN_MPTCP_ADD_ADDR_BASE;
  949. if (family == AF_INET6)
  950. len = TCPOLEN_MPTCP_ADD_ADDR6_BASE;
  951. if (!echo)
  952. len += MPTCPOPT_THMAC_LEN;
  953. /* account for 2 trailing 'nop' options */
  954. if (port)
  955. len += TCPOLEN_MPTCP_PORT_LEN + TCPOLEN_MPTCP_PORT_ALIGN;
  956. return len;
  957. }
  958. static inline int mptcp_rm_addr_len(const struct mptcp_rm_list *rm_list)
  959. {
  960. if (rm_list->nr == 0 || rm_list->nr > MPTCP_RM_IDS_MAX)
  961. return -EINVAL;
  962. return TCPOLEN_MPTCP_RM_ADDR_BASE + roundup(rm_list->nr - 1, 4) + 1;
  963. }
  964. bool mptcp_pm_add_addr_signal(struct mptcp_sock *msk, const struct sk_buff *skb,
  965. unsigned int opt_size, unsigned int remaining,
  966. struct mptcp_addr_info *addr, bool *echo,
  967. bool *drop_other_suboptions);
  968. bool mptcp_pm_rm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
  969. struct mptcp_rm_list *rm_list);
  970. int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);
  971. int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
  972. int mptcp_userspace_pm_get_local_id(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
  973. bool mptcp_pm_is_backup(struct mptcp_sock *msk, struct sock_common *skc);
  974. bool mptcp_pm_nl_is_backup(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
  975. bool mptcp_userspace_pm_is_backup(struct mptcp_sock *msk, struct mptcp_addr_info *skc);
  976. int mptcp_pm_dump_addr(struct sk_buff *msg, struct netlink_callback *cb);
  977. int mptcp_pm_nl_dump_addr(struct sk_buff *msg,
  978. struct netlink_callback *cb);
  979. int mptcp_userspace_pm_dump_addr(struct sk_buff *msg,
  980. struct netlink_callback *cb);
  981. int mptcp_pm_get_addr(struct sk_buff *skb, struct genl_info *info);
  982. int mptcp_pm_nl_get_addr(struct sk_buff *skb, struct genl_info *info);
  983. int mptcp_userspace_pm_get_addr(struct sk_buff *skb,
  984. struct genl_info *info);
  985. static inline u8 subflow_get_local_id(const struct mptcp_subflow_context *subflow)
  986. {
  987. int local_id = READ_ONCE(subflow->local_id);
  988. if (local_id < 0)
  989. return 0;
  990. return local_id;
  991. }
  992. void __init mptcp_pm_nl_init(void);
  993. void mptcp_pm_nl_work(struct mptcp_sock *msk);
  994. unsigned int mptcp_pm_get_add_addr_signal_max(const struct mptcp_sock *msk);
  995. unsigned int mptcp_pm_get_add_addr_accept_max(const struct mptcp_sock *msk);
  996. unsigned int mptcp_pm_get_subflows_max(const struct mptcp_sock *msk);
  997. unsigned int mptcp_pm_get_local_addr_max(const struct mptcp_sock *msk);
  998. /* called under PM lock */
  999. static inline void __mptcp_pm_close_subflow(struct mptcp_sock *msk)
  1000. {
  1001. if (--msk->pm.subflows < mptcp_pm_get_subflows_max(msk))
  1002. WRITE_ONCE(msk->pm.accept_subflow, true);
  1003. }
  1004. static inline void mptcp_pm_close_subflow(struct mptcp_sock *msk)
  1005. {
  1006. spin_lock_bh(&msk->pm.lock);
  1007. __mptcp_pm_close_subflow(msk);
  1008. spin_unlock_bh(&msk->pm.lock);
  1009. }
  1010. static inline bool mptcp_pm_add_addr_c_flag_case(struct mptcp_sock *msk)
  1011. {
  1012. return READ_ONCE(msk->pm.remote_deny_join_id0) &&
  1013. msk->pm.local_addr_used == 0 &&
  1014. mptcp_pm_get_add_addr_accept_max(msk) == 0 &&
  1015. msk->pm.subflows < mptcp_pm_get_subflows_max(msk);
  1016. }
  1017. void mptcp_sockopt_sync_locked(struct mptcp_sock *msk, struct sock *ssk);
  1018. static inline struct mptcp_ext *mptcp_get_ext(const struct sk_buff *skb)
  1019. {
  1020. return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
  1021. }
  1022. void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
  1023. static inline bool __mptcp_check_fallback(const struct mptcp_sock *msk)
  1024. {
  1025. return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
  1026. }
  1027. static inline bool mptcp_check_fallback(const struct sock *sk)
  1028. {
  1029. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
  1030. struct mptcp_sock *msk = mptcp_sk(subflow->conn);
  1031. return __mptcp_check_fallback(msk);
  1032. }
  1033. static inline bool __mptcp_try_fallback(struct mptcp_sock *msk)
  1034. {
  1035. if (__mptcp_check_fallback(msk)) {
  1036. pr_debug("TCP fallback already done (msk=%p)\n", msk);
  1037. return true;
  1038. }
  1039. spin_lock_bh(&msk->fallback_lock);
  1040. if (!msk->allow_infinite_fallback) {
  1041. spin_unlock_bh(&msk->fallback_lock);
  1042. return false;
  1043. }
  1044. msk->allow_subflows = false;
  1045. set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
  1046. spin_unlock_bh(&msk->fallback_lock);
  1047. return true;
  1048. }
  1049. static inline bool __mptcp_has_initial_subflow(const struct mptcp_sock *msk)
  1050. {
  1051. struct sock *ssk = READ_ONCE(msk->first);
  1052. return ssk && ((1 << inet_sk_state_load(ssk)) &
  1053. (TCPF_ESTABLISHED | TCPF_SYN_SENT |
  1054. TCPF_SYN_RECV | TCPF_LISTEN));
  1055. }
  1056. static inline bool mptcp_try_fallback(struct sock *ssk)
  1057. {
  1058. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(ssk);
  1059. struct sock *sk = subflow->conn;
  1060. struct mptcp_sock *msk;
  1061. msk = mptcp_sk(sk);
  1062. if (!__mptcp_try_fallback(msk))
  1063. return false;
  1064. if (READ_ONCE(msk->snd_data_fin_enable) && !(ssk->sk_shutdown & SEND_SHUTDOWN)) {
  1065. gfp_t saved_allocation = ssk->sk_allocation;
  1066. /* we are in a atomic (BH) scope, override ssk default for data
  1067. * fin allocation
  1068. */
  1069. ssk->sk_allocation = GFP_ATOMIC;
  1070. ssk->sk_shutdown |= SEND_SHUTDOWN;
  1071. tcp_shutdown(ssk, SEND_SHUTDOWN);
  1072. ssk->sk_allocation = saved_allocation;
  1073. }
  1074. return true;
  1075. }
  1076. #define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)\n", __func__, a)
  1077. static inline void mptcp_subflow_early_fallback(struct mptcp_sock *msk,
  1078. struct mptcp_subflow_context *subflow)
  1079. {
  1080. pr_fallback(msk);
  1081. subflow->request_mptcp = 0;
  1082. WARN_ON_ONCE(!__mptcp_try_fallback(msk));
  1083. }
  1084. static inline bool mptcp_check_infinite_map(struct sk_buff *skb)
  1085. {
  1086. struct mptcp_ext *mpext;
  1087. mpext = skb ? mptcp_get_ext(skb) : NULL;
  1088. if (mpext && mpext->infinite_map)
  1089. return true;
  1090. return false;
  1091. }
  1092. static inline bool is_active_ssk(struct mptcp_subflow_context *subflow)
  1093. {
  1094. return (subflow->request_mptcp || subflow->request_join);
  1095. }
  1096. static inline bool subflow_simultaneous_connect(struct sock *sk)
  1097. {
  1098. struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
  1099. return (1 << sk->sk_state) &
  1100. (TCPF_ESTABLISHED | TCPF_FIN_WAIT1 | TCPF_FIN_WAIT2 | TCPF_CLOSING) &&
  1101. is_active_ssk(subflow) &&
  1102. !subflow->conn_finished;
  1103. }
  1104. #ifdef CONFIG_SYN_COOKIES
  1105. void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
  1106. struct sk_buff *skb);
  1107. bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
  1108. struct sk_buff *skb);
  1109. void __init mptcp_join_cookie_init(void);
  1110. #else
  1111. static inline void
  1112. subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
  1113. struct sk_buff *skb) {}
  1114. static inline bool
  1115. mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
  1116. struct sk_buff *skb)
  1117. {
  1118. return false;
  1119. }
  1120. static inline void mptcp_join_cookie_init(void) {}
  1121. #endif
  1122. #endif /* __MPTCP_PROTOCOL_H */