rds.h 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef _RDS_RDS_H
  3. #define _RDS_RDS_H
  4. #include <net/sock.h>
  5. #include <linux/scatterlist.h>
  6. #include <linux/highmem.h>
  7. #include <rdma/rdma_cm.h>
  8. #include <linux/mutex.h>
  9. #include <linux/rds.h>
  10. #include <linux/rhashtable.h>
  11. #include <linux/refcount.h>
  12. #include <linux/in6.h>
  13. #include "info.h"
  14. /*
  15. * RDS Network protocol version
  16. */
  17. #define RDS_PROTOCOL_3_0 0x0300
  18. #define RDS_PROTOCOL_3_1 0x0301
  19. #define RDS_PROTOCOL_VERSION RDS_PROTOCOL_3_1
  20. #define RDS_PROTOCOL_MAJOR(v) ((v) >> 8)
  21. #define RDS_PROTOCOL_MINOR(v) ((v) & 255)
  22. #define RDS_PROTOCOL(maj, min) (((maj) << 8) | min)
  23. /* The following ports, 16385, 18634, 18635, are registered with IANA as
  24. * the ports to be used for RDS over TCP and UDP. Currently, only RDS over
  25. * TCP and RDS over IB/RDMA are implemented. 18634 is the historical value
  26. * used for the RDMA_CM listener port. RDS/TCP uses port 16385. After
  27. * IPv6 work, RDMA_CM also uses 16385 as the listener port. 18634 is kept
  28. * to ensure compatibility with older RDS modules. Those ports are defined
  29. * in each transport's header file.
  30. */
  31. #define RDS_PORT 18634
  32. #ifdef ATOMIC64_INIT
  33. #define KERNEL_HAS_ATOMIC64
  34. #endif
  35. #ifdef RDS_DEBUG
  36. #define rdsdebug(fmt, args...) pr_debug("%s(): " fmt, __func__ , ##args)
  37. #else
  38. /* sigh, pr_debug() causes unused variable warnings */
  39. static inline __printf(1, 2)
  40. void rdsdebug(char *fmt, ...)
  41. {
  42. }
  43. #endif
  44. /* XXX is there one of these somewhere? */
  45. #define ceil(x, y) \
  46. ({ unsigned long __x = (x), __y = (y); (__x + __y - 1) / __y; })
  47. #define RDS_FRAG_SHIFT 12
  48. #define RDS_FRAG_SIZE ((unsigned int)(1 << RDS_FRAG_SHIFT))
  49. /* Used to limit both RDMA and non-RDMA RDS message to 1MB */
  50. #define RDS_MAX_MSG_SIZE ((unsigned int)(1 << 20))
  51. #define RDS_CONG_MAP_BYTES (65536 / 8)
  52. #define RDS_CONG_MAP_PAGES (PAGE_ALIGN(RDS_CONG_MAP_BYTES) / PAGE_SIZE)
  53. #define RDS_CONG_MAP_PAGE_BITS (PAGE_SIZE * 8)
  54. struct rds_cong_map {
  55. struct rb_node m_rb_node;
  56. struct in6_addr m_addr;
  57. wait_queue_head_t m_waitq;
  58. struct list_head m_conn_list;
  59. unsigned long m_page_addrs[RDS_CONG_MAP_PAGES];
  60. };
  61. /*
  62. * This is how we will track the connection state:
  63. * A connection is always in one of the following
  64. * states. Updates to the state are atomic and imply
  65. * a memory barrier.
  66. */
  67. enum {
  68. RDS_CONN_DOWN = 0,
  69. RDS_CONN_CONNECTING,
  70. RDS_CONN_DISCONNECTING,
  71. RDS_CONN_UP,
  72. RDS_CONN_RESETTING,
  73. RDS_CONN_ERROR,
  74. };
  75. /* Bits for c_flags */
  76. #define RDS_LL_SEND_FULL 0
  77. #define RDS_RECONNECT_PENDING 1
  78. #define RDS_IN_XMIT 2
  79. #define RDS_RECV_REFILL 3
  80. #define RDS_DESTROY_PENDING 4
  81. /* Max number of multipaths per RDS connection. Must be a power of 2 */
  82. #define RDS_MPATH_WORKERS 8
  83. #define RDS_MPATH_HASH(rs, n) (jhash_1word((rs)->rs_bound_port, \
  84. (rs)->rs_hash_initval) & ((n) - 1))
  85. #define IS_CANONICAL(laddr, faddr) (htonl(laddr) < htonl(faddr))
  86. /* Per mpath connection state */
  87. struct rds_conn_path {
  88. struct rds_connection *cp_conn;
  89. struct rds_message *cp_xmit_rm;
  90. unsigned long cp_xmit_sg;
  91. unsigned int cp_xmit_hdr_off;
  92. unsigned int cp_xmit_data_off;
  93. unsigned int cp_xmit_atomic_sent;
  94. unsigned int cp_xmit_rdma_sent;
  95. unsigned int cp_xmit_data_sent;
  96. spinlock_t cp_lock; /* protect msg queues */
  97. u64 cp_next_tx_seq;
  98. struct list_head cp_send_queue;
  99. struct list_head cp_retrans;
  100. u64 cp_next_rx_seq;
  101. void *cp_transport_data;
  102. atomic_t cp_state;
  103. unsigned long cp_send_gen;
  104. unsigned long cp_flags;
  105. unsigned long cp_reconnect_jiffies;
  106. struct delayed_work cp_send_w;
  107. struct delayed_work cp_recv_w;
  108. struct delayed_work cp_conn_w;
  109. struct work_struct cp_down_w;
  110. struct mutex cp_cm_lock; /* protect cp_state & cm */
  111. wait_queue_head_t cp_waitq;
  112. unsigned int cp_unacked_packets;
  113. unsigned int cp_unacked_bytes;
  114. unsigned int cp_index;
  115. };
  116. /* One rds_connection per RDS address pair */
  117. struct rds_connection {
  118. struct hlist_node c_hash_node;
  119. struct in6_addr c_laddr;
  120. struct in6_addr c_faddr;
  121. int c_dev_if; /* ifindex used for this conn */
  122. int c_bound_if; /* ifindex of c_laddr */
  123. unsigned int c_loopback:1,
  124. c_isv6:1,
  125. c_ping_triggered:1,
  126. c_pad_to_32:29;
  127. int c_npaths;
  128. struct rds_connection *c_passive;
  129. struct rds_transport *c_trans;
  130. struct rds_cong_map *c_lcong;
  131. struct rds_cong_map *c_fcong;
  132. /* Protocol version */
  133. unsigned int c_version;
  134. possible_net_t c_net;
  135. struct list_head c_map_item;
  136. unsigned long c_map_queued;
  137. struct rds_conn_path *c_path;
  138. wait_queue_head_t c_hs_waitq; /* handshake waitq */
  139. u32 c_my_gen_num;
  140. u32 c_peer_gen_num;
  141. };
  142. static inline
  143. struct net *rds_conn_net(struct rds_connection *conn)
  144. {
  145. return read_pnet(&conn->c_net);
  146. }
  147. static inline
  148. void rds_conn_net_set(struct rds_connection *conn, struct net *net)
  149. {
  150. write_pnet(&conn->c_net, net);
  151. }
  152. #define RDS_FLAG_CONG_BITMAP 0x01
  153. #define RDS_FLAG_ACK_REQUIRED 0x02
  154. #define RDS_FLAG_RETRANSMITTED 0x04
  155. #define RDS_MAX_ADV_CREDIT 255
  156. /* RDS_FLAG_PROBE_PORT is the reserved sport used for sending a ping
  157. * probe to exchange control information before establishing a connection.
  158. * Currently the control information that is exchanged is the number of
  159. * supported paths. If the peer is a legacy (older kernel revision) peer,
  160. * it would return a pong message without additional control information
  161. * that would then alert the sender that the peer was an older rev.
  162. */
  163. #define RDS_FLAG_PROBE_PORT 1
  164. #define RDS_HS_PROBE(sport, dport) \
  165. ((sport == RDS_FLAG_PROBE_PORT && dport == 0) || \
  166. (sport == 0 && dport == RDS_FLAG_PROBE_PORT))
  167. /*
  168. * Maximum space available for extension headers.
  169. */
  170. #define RDS_HEADER_EXT_SPACE 16
  171. struct rds_header {
  172. __be64 h_sequence;
  173. __be64 h_ack;
  174. __be32 h_len;
  175. __be16 h_sport;
  176. __be16 h_dport;
  177. u8 h_flags;
  178. u8 h_credit;
  179. u8 h_padding[4];
  180. __sum16 h_csum;
  181. u8 h_exthdr[RDS_HEADER_EXT_SPACE];
  182. };
  183. /*
  184. * Reserved - indicates end of extensions
  185. */
  186. #define RDS_EXTHDR_NONE 0
  187. /*
  188. * This extension header is included in the very
  189. * first message that is sent on a new connection,
  190. * and identifies the protocol level. This will help
  191. * rolling updates if a future change requires breaking
  192. * the protocol.
  193. * NB: This is no longer true for IB, where we do a version
  194. * negotiation during the connection setup phase (protocol
  195. * version information is included in the RDMA CM private data).
  196. */
  197. #define RDS_EXTHDR_VERSION 1
  198. struct rds_ext_header_version {
  199. __be32 h_version;
  200. };
  201. /*
  202. * This extension header is included in the RDS message
  203. * chasing an RDMA operation.
  204. */
  205. #define RDS_EXTHDR_RDMA 2
  206. struct rds_ext_header_rdma {
  207. __be32 h_rdma_rkey;
  208. };
  209. /*
  210. * This extension header tells the peer about the
  211. * destination <R_Key,offset> of the requested RDMA
  212. * operation.
  213. */
  214. #define RDS_EXTHDR_RDMA_DEST 3
  215. struct rds_ext_header_rdma_dest {
  216. __be32 h_rdma_rkey;
  217. __be32 h_rdma_offset;
  218. };
  219. /* Extension header announcing number of paths.
  220. * Implicit length = 2 bytes.
  221. */
  222. #define RDS_EXTHDR_NPATHS 5
  223. #define RDS_EXTHDR_GEN_NUM 6
  224. #define __RDS_EXTHDR_MAX 16 /* for now */
  225. #define RDS_RX_MAX_TRACES (RDS_MSG_RX_DGRAM_TRACE_MAX + 1)
  226. #define RDS_MSG_RX_HDR 0
  227. #define RDS_MSG_RX_START 1
  228. #define RDS_MSG_RX_END 2
  229. #define RDS_MSG_RX_CMSG 3
  230. struct rds_incoming {
  231. refcount_t i_refcount;
  232. struct list_head i_item;
  233. struct rds_connection *i_conn;
  234. struct rds_conn_path *i_conn_path;
  235. struct rds_header i_hdr;
  236. unsigned long i_rx_jiffies;
  237. struct in6_addr i_saddr;
  238. rds_rdma_cookie_t i_rdma_cookie;
  239. ktime_t i_rx_tstamp;
  240. u64 i_rx_lat_trace[RDS_RX_MAX_TRACES];
  241. };
  242. struct rds_mr {
  243. struct rb_node r_rb_node;
  244. refcount_t r_refcount;
  245. u32 r_key;
  246. /* A copy of the creation flags */
  247. unsigned int r_use_once:1;
  248. unsigned int r_invalidate:1;
  249. unsigned int r_write:1;
  250. /* This is for RDS_MR_DEAD.
  251. * It would be nice & consistent to make this part of the above
  252. * bit field here, but we need to use test_and_set_bit.
  253. */
  254. unsigned long r_state;
  255. struct rds_sock *r_sock; /* back pointer to the socket that owns us */
  256. struct rds_transport *r_trans;
  257. void *r_trans_private;
  258. };
  259. /* Flags for mr->r_state */
  260. #define RDS_MR_DEAD 0
  261. static inline rds_rdma_cookie_t rds_rdma_make_cookie(u32 r_key, u32 offset)
  262. {
  263. return r_key | (((u64) offset) << 32);
  264. }
  265. static inline u32 rds_rdma_cookie_key(rds_rdma_cookie_t cookie)
  266. {
  267. return cookie;
  268. }
  269. static inline u32 rds_rdma_cookie_offset(rds_rdma_cookie_t cookie)
  270. {
  271. return cookie >> 32;
  272. }
  273. /* atomic operation types */
  274. #define RDS_ATOMIC_TYPE_CSWP 0
  275. #define RDS_ATOMIC_TYPE_FADD 1
  276. /*
  277. * m_sock_item and m_conn_item are on lists that are serialized under
  278. * conn->c_lock. m_sock_item has additional meaning in that once it is empty
  279. * the message will not be put back on the retransmit list after being sent.
  280. * messages that are canceled while being sent rely on this.
  281. *
  282. * m_inc is used by loopback so that it can pass an incoming message straight
  283. * back up into the rx path. It embeds a wire header which is also used by
  284. * the send path, which is kind of awkward.
  285. *
  286. * m_sock_item indicates the message's presence on a socket's send or receive
  287. * queue. m_rs will point to that socket.
  288. *
  289. * m_daddr is used by cancellation to prune messages to a given destination.
  290. *
  291. * The RDS_MSG_ON_SOCK and RDS_MSG_ON_CONN flags are used to avoid lock
  292. * nesting. As paths iterate over messages on a sock, or conn, they must
  293. * also lock the conn, or sock, to remove the message from those lists too.
  294. * Testing the flag to determine if the message is still on the lists lets
  295. * us avoid testing the list_head directly. That means each path can use
  296. * the message's list_head to keep it on a local list while juggling locks
  297. * without confusing the other path.
  298. *
  299. * m_ack_seq is an optional field set by transports who need a different
  300. * sequence number range to invalidate. They can use this in a callback
  301. * that they pass to rds_send_drop_acked() to see if each message has been
  302. * acked. The HAS_ACK_SEQ flag can be used to detect messages which haven't
  303. * had ack_seq set yet.
  304. */
  305. #define RDS_MSG_ON_SOCK 1
  306. #define RDS_MSG_ON_CONN 2
  307. #define RDS_MSG_HAS_ACK_SEQ 3
  308. #define RDS_MSG_ACK_REQUIRED 4
  309. #define RDS_MSG_RETRANSMITTED 5
  310. #define RDS_MSG_MAPPED 6
  311. #define RDS_MSG_PAGEVEC 7
  312. #define RDS_MSG_FLUSH 8
  313. struct rds_znotifier {
  314. struct mmpin z_mmp;
  315. u32 z_cookie;
  316. };
  317. struct rds_msg_zcopy_info {
  318. struct list_head rs_zcookie_next;
  319. union {
  320. struct rds_znotifier znotif;
  321. struct rds_zcopy_cookies zcookies;
  322. };
  323. };
  324. struct rds_msg_zcopy_queue {
  325. struct list_head zcookie_head;
  326. spinlock_t lock; /* protects zcookie_head queue */
  327. };
  328. static inline void rds_message_zcopy_queue_init(struct rds_msg_zcopy_queue *q)
  329. {
  330. spin_lock_init(&q->lock);
  331. INIT_LIST_HEAD(&q->zcookie_head);
  332. }
  333. struct rds_message {
  334. refcount_t m_refcount;
  335. struct list_head m_sock_item;
  336. struct list_head m_conn_item;
  337. struct rds_incoming m_inc;
  338. u64 m_ack_seq;
  339. struct in6_addr m_daddr;
  340. unsigned long m_flags;
  341. /* Never access m_rs without holding m_rs_lock.
  342. * Lock nesting is
  343. * rm->m_rs_lock
  344. * -> rs->rs_lock
  345. */
  346. spinlock_t m_rs_lock;
  347. wait_queue_head_t m_flush_wait;
  348. struct rds_sock *m_rs;
  349. /* cookie to send to remote, in rds header */
  350. rds_rdma_cookie_t m_rdma_cookie;
  351. unsigned int m_used_sgs;
  352. unsigned int m_total_sgs;
  353. void *m_final_op;
  354. struct {
  355. struct rm_atomic_op {
  356. int op_type;
  357. union {
  358. struct {
  359. uint64_t compare;
  360. uint64_t swap;
  361. uint64_t compare_mask;
  362. uint64_t swap_mask;
  363. } op_m_cswp;
  364. struct {
  365. uint64_t add;
  366. uint64_t nocarry_mask;
  367. } op_m_fadd;
  368. };
  369. u32 op_rkey;
  370. u64 op_remote_addr;
  371. unsigned int op_notify:1;
  372. unsigned int op_recverr:1;
  373. unsigned int op_mapped:1;
  374. unsigned int op_silent:1;
  375. unsigned int op_active:1;
  376. struct scatterlist *op_sg;
  377. struct rds_notifier *op_notifier;
  378. struct rds_mr *op_rdma_mr;
  379. } atomic;
  380. struct rm_rdma_op {
  381. u32 op_rkey;
  382. u64 op_remote_addr;
  383. unsigned int op_write:1;
  384. unsigned int op_fence:1;
  385. unsigned int op_notify:1;
  386. unsigned int op_recverr:1;
  387. unsigned int op_mapped:1;
  388. unsigned int op_silent:1;
  389. unsigned int op_active:1;
  390. unsigned int op_bytes;
  391. unsigned int op_nents;
  392. unsigned int op_count;
  393. struct scatterlist *op_sg;
  394. struct rds_notifier *op_notifier;
  395. struct rds_mr *op_rdma_mr;
  396. } rdma;
  397. struct rm_data_op {
  398. unsigned int op_active:1;
  399. unsigned int op_notify:1;
  400. unsigned int op_nents;
  401. unsigned int op_count;
  402. unsigned int op_dmasg;
  403. unsigned int op_dmaoff;
  404. struct rds_znotifier *op_mmp_znotifier;
  405. struct scatterlist *op_sg;
  406. } data;
  407. };
  408. struct rds_conn_path *m_conn_path;
  409. };
  410. /*
  411. * The RDS notifier is used (optionally) to tell the application about
  412. * completed RDMA operations. Rather than keeping the whole rds message
  413. * around on the queue, we allocate a small notifier that is put on the
  414. * socket's notifier_list. Notifications are delivered to the application
  415. * through control messages.
  416. */
  417. struct rds_notifier {
  418. struct list_head n_list;
  419. uint64_t n_user_token;
  420. int n_status;
  421. };
  422. /* Available as part of RDS core, so doesn't need to participate
  423. * in get_preferred transport etc
  424. */
  425. #define RDS_TRANS_LOOP 3
  426. /**
  427. * struct rds_transport - transport specific behavioural hooks
  428. *
  429. * @xmit: .xmit is called by rds_send_xmit() to tell the transport to send
  430. * part of a message. The caller serializes on the send_sem so this
  431. * doesn't need to be reentrant for a given conn. The header must be
  432. * sent before the data payload. .xmit must be prepared to send a
  433. * message with no data payload. .xmit should return the number of
  434. * bytes that were sent down the connection, including header bytes.
  435. * Returning 0 tells the caller that it doesn't need to perform any
  436. * additional work now. This is usually the case when the transport has
  437. * filled the sending queue for its connection and will handle
  438. * triggering the rds thread to continue the send when space becomes
  439. * available. Returning -EAGAIN tells the caller to retry the send
  440. * immediately. Returning -ENOMEM tells the caller to retry the send at
  441. * some point in the future.
  442. *
  443. * @conn_shutdown: conn_shutdown stops traffic on the given connection. Once
  444. * it returns the connection can not call rds_recv_incoming().
  445. * This will only be called once after conn_connect returns
  446. * non-zero success and will The caller serializes this with
  447. * the send and connecting paths (xmit_* and conn_*). The
  448. * transport is responsible for other serialization, including
  449. * rds_recv_incoming(). This is called in process context but
  450. * should try hard not to block.
  451. */
  452. struct rds_transport {
  453. char t_name[TRANSNAMSIZ];
  454. struct list_head t_item;
  455. struct module *t_owner;
  456. unsigned int t_prefer_loopback:1,
  457. t_mp_capable:1;
  458. unsigned int t_type;
  459. int (*laddr_check)(struct net *net, const struct in6_addr *addr,
  460. __u32 scope_id);
  461. int (*conn_alloc)(struct rds_connection *conn, gfp_t gfp);
  462. void (*conn_free)(void *data);
  463. int (*conn_path_connect)(struct rds_conn_path *cp);
  464. void (*conn_path_shutdown)(struct rds_conn_path *conn);
  465. void (*xmit_path_prepare)(struct rds_conn_path *cp);
  466. void (*xmit_path_complete)(struct rds_conn_path *cp);
  467. int (*xmit)(struct rds_connection *conn, struct rds_message *rm,
  468. unsigned int hdr_off, unsigned int sg, unsigned int off);
  469. int (*xmit_rdma)(struct rds_connection *conn, struct rm_rdma_op *op);
  470. int (*xmit_atomic)(struct rds_connection *conn, struct rm_atomic_op *op);
  471. int (*recv_path)(struct rds_conn_path *cp);
  472. int (*inc_copy_to_user)(struct rds_incoming *inc, struct iov_iter *to);
  473. void (*inc_free)(struct rds_incoming *inc);
  474. int (*cm_handle_connect)(struct rdma_cm_id *cm_id,
  475. struct rdma_cm_event *event, bool isv6);
  476. int (*cm_initiate_connect)(struct rdma_cm_id *cm_id, bool isv6);
  477. void (*cm_connect_complete)(struct rds_connection *conn,
  478. struct rdma_cm_event *event);
  479. unsigned int (*stats_info_copy)(struct rds_info_iterator *iter,
  480. unsigned int avail);
  481. void (*exit)(void);
  482. void *(*get_mr)(struct scatterlist *sg, unsigned long nr_sg,
  483. struct rds_sock *rs, u32 *key_ret,
  484. struct rds_connection *conn);
  485. void (*sync_mr)(void *trans_private, int direction);
  486. void (*free_mr)(void *trans_private, int invalidate);
  487. void (*flush_mrs)(void);
  488. bool (*t_unloading)(struct rds_connection *conn);
  489. };
  490. /* Bind hash table key length. It is the sum of the size of a struct
  491. * in6_addr, a scope_id and a port.
  492. */
  493. #define RDS_BOUND_KEY_LEN \
  494. (sizeof(struct in6_addr) + sizeof(__u32) + sizeof(__be16))
  495. struct rds_sock {
  496. struct sock rs_sk;
  497. u64 rs_user_addr;
  498. u64 rs_user_bytes;
  499. /*
  500. * bound_addr used for both incoming and outgoing, no INADDR_ANY
  501. * support.
  502. */
  503. struct rhash_head rs_bound_node;
  504. u8 rs_bound_key[RDS_BOUND_KEY_LEN];
  505. struct sockaddr_in6 rs_bound_sin6;
  506. #define rs_bound_addr rs_bound_sin6.sin6_addr
  507. #define rs_bound_addr_v4 rs_bound_sin6.sin6_addr.s6_addr32[3]
  508. #define rs_bound_port rs_bound_sin6.sin6_port
  509. #define rs_bound_scope_id rs_bound_sin6.sin6_scope_id
  510. struct in6_addr rs_conn_addr;
  511. #define rs_conn_addr_v4 rs_conn_addr.s6_addr32[3]
  512. __be16 rs_conn_port;
  513. struct rds_transport *rs_transport;
  514. /*
  515. * rds_sendmsg caches the conn it used the last time around.
  516. * This helps avoid costly lookups.
  517. */
  518. struct rds_connection *rs_conn;
  519. /* flag indicating we were congested or not */
  520. int rs_congested;
  521. /* seen congestion (ENOBUFS) when sending? */
  522. int rs_seen_congestion;
  523. /* rs_lock protects all these adjacent members before the newline */
  524. spinlock_t rs_lock;
  525. struct list_head rs_send_queue;
  526. u32 rs_snd_bytes;
  527. int rs_rcv_bytes;
  528. struct list_head rs_notify_queue; /* currently used for failed RDMAs */
  529. /* Congestion wake_up. If rs_cong_monitor is set, we use cong_mask
  530. * to decide whether the application should be woken up.
  531. * If not set, we use rs_cong_track to find out whether a cong map
  532. * update arrived.
  533. */
  534. uint64_t rs_cong_mask;
  535. uint64_t rs_cong_notify;
  536. struct list_head rs_cong_list;
  537. unsigned long rs_cong_track;
  538. /*
  539. * rs_recv_lock protects the receive queue, and is
  540. * used to serialize with rds_release.
  541. */
  542. rwlock_t rs_recv_lock;
  543. struct list_head rs_recv_queue;
  544. /* just for stats reporting */
  545. struct list_head rs_item;
  546. /* these have their own lock */
  547. spinlock_t rs_rdma_lock;
  548. struct rb_root rs_rdma_keys;
  549. /* Socket options - in case there will be more */
  550. unsigned char rs_recverr,
  551. rs_cong_monitor;
  552. u32 rs_hash_initval;
  553. /* Socket receive path trace points*/
  554. u8 rs_rx_traces;
  555. u8 rs_rx_trace[RDS_MSG_RX_DGRAM_TRACE_MAX];
  556. struct rds_msg_zcopy_queue rs_zcookie_queue;
  557. };
  558. static inline struct rds_sock *rds_sk_to_rs(const struct sock *sk)
  559. {
  560. return container_of(sk, struct rds_sock, rs_sk);
  561. }
  562. static inline struct sock *rds_rs_to_sk(struct rds_sock *rs)
  563. {
  564. return &rs->rs_sk;
  565. }
  566. /*
  567. * The stack assigns sk_sndbuf and sk_rcvbuf to twice the specified value
  568. * to account for overhead. We don't account for overhead, we just apply
  569. * the number of payload bytes to the specified value.
  570. */
  571. static inline int rds_sk_sndbuf(struct rds_sock *rs)
  572. {
  573. return rds_rs_to_sk(rs)->sk_sndbuf / 2;
  574. }
  575. static inline int rds_sk_rcvbuf(struct rds_sock *rs)
  576. {
  577. return rds_rs_to_sk(rs)->sk_rcvbuf / 2;
  578. }
  579. struct rds_statistics {
  580. uint64_t s_conn_reset;
  581. uint64_t s_recv_drop_bad_checksum;
  582. uint64_t s_recv_drop_old_seq;
  583. uint64_t s_recv_drop_no_sock;
  584. uint64_t s_recv_drop_dead_sock;
  585. uint64_t s_recv_deliver_raced;
  586. uint64_t s_recv_delivered;
  587. uint64_t s_recv_queued;
  588. uint64_t s_recv_immediate_retry;
  589. uint64_t s_recv_delayed_retry;
  590. uint64_t s_recv_ack_required;
  591. uint64_t s_recv_rdma_bytes;
  592. uint64_t s_recv_ping;
  593. uint64_t s_send_queue_empty;
  594. uint64_t s_send_queue_full;
  595. uint64_t s_send_lock_contention;
  596. uint64_t s_send_lock_queue_raced;
  597. uint64_t s_send_immediate_retry;
  598. uint64_t s_send_delayed_retry;
  599. uint64_t s_send_drop_acked;
  600. uint64_t s_send_ack_required;
  601. uint64_t s_send_queued;
  602. uint64_t s_send_rdma;
  603. uint64_t s_send_rdma_bytes;
  604. uint64_t s_send_pong;
  605. uint64_t s_page_remainder_hit;
  606. uint64_t s_page_remainder_miss;
  607. uint64_t s_copy_to_user;
  608. uint64_t s_copy_from_user;
  609. uint64_t s_cong_update_queued;
  610. uint64_t s_cong_update_received;
  611. uint64_t s_cong_send_error;
  612. uint64_t s_cong_send_blocked;
  613. uint64_t s_recv_bytes_added_to_socket;
  614. uint64_t s_recv_bytes_removed_from_socket;
  615. };
  616. /* af_rds.c */
  617. void rds_sock_addref(struct rds_sock *rs);
  618. void rds_sock_put(struct rds_sock *rs);
  619. void rds_wake_sk_sleep(struct rds_sock *rs);
  620. static inline void __rds_wake_sk_sleep(struct sock *sk)
  621. {
  622. wait_queue_head_t *waitq = sk_sleep(sk);
  623. if (!sock_flag(sk, SOCK_DEAD) && waitq)
  624. wake_up(waitq);
  625. }
  626. extern wait_queue_head_t rds_poll_waitq;
  627. /* bind.c */
  628. int rds_bind(struct socket *sock, struct sockaddr *uaddr, int addr_len);
  629. void rds_remove_bound(struct rds_sock *rs);
  630. struct rds_sock *rds_find_bound(const struct in6_addr *addr, __be16 port,
  631. __u32 scope_id);
  632. int rds_bind_lock_init(void);
  633. void rds_bind_lock_destroy(void);
  634. /* cong.c */
  635. int rds_cong_get_maps(struct rds_connection *conn);
  636. void rds_cong_add_conn(struct rds_connection *conn);
  637. void rds_cong_remove_conn(struct rds_connection *conn);
  638. void rds_cong_set_bit(struct rds_cong_map *map, __be16 port);
  639. void rds_cong_clear_bit(struct rds_cong_map *map, __be16 port);
  640. int rds_cong_wait(struct rds_cong_map *map, __be16 port, int nonblock, struct rds_sock *rs);
  641. void rds_cong_queue_updates(struct rds_cong_map *map);
  642. void rds_cong_map_updated(struct rds_cong_map *map, uint64_t);
  643. int rds_cong_updated_since(unsigned long *recent);
  644. void rds_cong_add_socket(struct rds_sock *);
  645. void rds_cong_remove_socket(struct rds_sock *);
  646. void rds_cong_exit(void);
  647. struct rds_message *rds_cong_update_alloc(struct rds_connection *conn);
  648. /* connection.c */
  649. extern u32 rds_gen_num;
  650. int rds_conn_init(void);
  651. void rds_conn_exit(void);
  652. struct rds_connection *rds_conn_create(struct net *net,
  653. const struct in6_addr *laddr,
  654. const struct in6_addr *faddr,
  655. struct rds_transport *trans, gfp_t gfp,
  656. int dev_if);
  657. struct rds_connection *rds_conn_create_outgoing(struct net *net,
  658. const struct in6_addr *laddr,
  659. const struct in6_addr *faddr,
  660. struct rds_transport *trans,
  661. gfp_t gfp, int dev_if);
  662. void rds_conn_shutdown(struct rds_conn_path *cpath);
  663. void rds_conn_destroy(struct rds_connection *conn);
  664. void rds_conn_drop(struct rds_connection *conn);
  665. void rds_conn_path_drop(struct rds_conn_path *cpath, bool destroy);
  666. void rds_conn_connect_if_down(struct rds_connection *conn);
  667. void rds_conn_path_connect_if_down(struct rds_conn_path *cp);
  668. void rds_for_each_conn_info(struct socket *sock, unsigned int len,
  669. struct rds_info_iterator *iter,
  670. struct rds_info_lengths *lens,
  671. int (*visitor)(struct rds_connection *, void *),
  672. u64 *buffer,
  673. size_t item_len);
  674. __printf(2, 3)
  675. void __rds_conn_path_error(struct rds_conn_path *cp, const char *, ...);
  676. #define rds_conn_path_error(cp, fmt...) \
  677. __rds_conn_path_error(cp, KERN_WARNING "RDS: " fmt)
  678. static inline int
  679. rds_conn_path_transition(struct rds_conn_path *cp, int old, int new)
  680. {
  681. return atomic_cmpxchg(&cp->cp_state, old, new) == old;
  682. }
  683. static inline int
  684. rds_conn_transition(struct rds_connection *conn, int old, int new)
  685. {
  686. WARN_ON(conn->c_trans->t_mp_capable);
  687. return rds_conn_path_transition(&conn->c_path[0], old, new);
  688. }
  689. static inline int
  690. rds_conn_path_state(struct rds_conn_path *cp)
  691. {
  692. return atomic_read(&cp->cp_state);
  693. }
  694. static inline int
  695. rds_conn_state(struct rds_connection *conn)
  696. {
  697. WARN_ON(conn->c_trans->t_mp_capable);
  698. return rds_conn_path_state(&conn->c_path[0]);
  699. }
  700. static inline int
  701. rds_conn_path_up(struct rds_conn_path *cp)
  702. {
  703. return atomic_read(&cp->cp_state) == RDS_CONN_UP;
  704. }
  705. static inline int
  706. rds_conn_up(struct rds_connection *conn)
  707. {
  708. WARN_ON(conn->c_trans->t_mp_capable);
  709. return rds_conn_path_up(&conn->c_path[0]);
  710. }
  711. static inline int
  712. rds_conn_path_connecting(struct rds_conn_path *cp)
  713. {
  714. return atomic_read(&cp->cp_state) == RDS_CONN_CONNECTING;
  715. }
  716. static inline int
  717. rds_conn_connecting(struct rds_connection *conn)
  718. {
  719. WARN_ON(conn->c_trans->t_mp_capable);
  720. return rds_conn_path_connecting(&conn->c_path[0]);
  721. }
  722. /* message.c */
  723. struct rds_message *rds_message_alloc(unsigned int nents, gfp_t gfp);
  724. struct scatterlist *rds_message_alloc_sgs(struct rds_message *rm, int nents);
  725. int rds_message_copy_from_user(struct rds_message *rm, struct iov_iter *from,
  726. bool zcopy);
  727. struct rds_message *rds_message_map_pages(unsigned long *page_addrs, unsigned int total_len);
  728. void rds_message_populate_header(struct rds_header *hdr, __be16 sport,
  729. __be16 dport, u64 seq);
  730. int rds_message_add_extension(struct rds_header *hdr,
  731. unsigned int type, const void *data, unsigned int len);
  732. int rds_message_next_extension(struct rds_header *hdr,
  733. unsigned int *pos, void *buf, unsigned int *buflen);
  734. int rds_message_add_rdma_dest_extension(struct rds_header *hdr, u32 r_key, u32 offset);
  735. int rds_message_inc_copy_to_user(struct rds_incoming *inc, struct iov_iter *to);
  736. void rds_message_inc_free(struct rds_incoming *inc);
  737. void rds_message_addref(struct rds_message *rm);
  738. void rds_message_put(struct rds_message *rm);
  739. void rds_message_wait(struct rds_message *rm);
  740. void rds_message_unmapped(struct rds_message *rm);
  741. void rds_notify_msg_zcopy_purge(struct rds_msg_zcopy_queue *info);
  742. static inline void rds_message_make_checksum(struct rds_header *hdr)
  743. {
  744. hdr->h_csum = 0;
  745. hdr->h_csum = ip_fast_csum((void *) hdr, sizeof(*hdr) >> 2);
  746. }
  747. static inline int rds_message_verify_checksum(const struct rds_header *hdr)
  748. {
  749. return !hdr->h_csum || ip_fast_csum((void *) hdr, sizeof(*hdr) >> 2) == 0;
  750. }
  751. /* page.c */
  752. int rds_page_remainder_alloc(struct scatterlist *scat, unsigned long bytes,
  753. gfp_t gfp);
  754. void rds_page_exit(void);
  755. /* recv.c */
  756. void rds_inc_init(struct rds_incoming *inc, struct rds_connection *conn,
  757. struct in6_addr *saddr);
  758. void rds_inc_path_init(struct rds_incoming *inc, struct rds_conn_path *conn,
  759. struct in6_addr *saddr);
  760. void rds_inc_put(struct rds_incoming *inc);
  761. void rds_recv_incoming(struct rds_connection *conn, struct in6_addr *saddr,
  762. struct in6_addr *daddr,
  763. struct rds_incoming *inc, gfp_t gfp);
  764. int rds_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
  765. int msg_flags);
  766. void rds_clear_recv_queue(struct rds_sock *rs);
  767. int rds_notify_queue_get(struct rds_sock *rs, struct msghdr *msg);
  768. void rds_inc_info_copy(struct rds_incoming *inc,
  769. struct rds_info_iterator *iter,
  770. __be32 saddr, __be32 daddr, int flip);
  771. void rds6_inc_info_copy(struct rds_incoming *inc,
  772. struct rds_info_iterator *iter,
  773. struct in6_addr *saddr, struct in6_addr *daddr,
  774. int flip);
  775. /* send.c */
  776. int rds_sendmsg(struct socket *sock, struct msghdr *msg, size_t payload_len);
  777. void rds_send_path_reset(struct rds_conn_path *conn);
  778. int rds_send_xmit(struct rds_conn_path *cp);
  779. struct sockaddr_in;
  780. void rds_send_drop_to(struct rds_sock *rs, struct sockaddr_in6 *dest);
  781. typedef int (*is_acked_func)(struct rds_message *rm, uint64_t ack);
  782. void rds_send_drop_acked(struct rds_connection *conn, u64 ack,
  783. is_acked_func is_acked);
  784. void rds_send_path_drop_acked(struct rds_conn_path *cp, u64 ack,
  785. is_acked_func is_acked);
  786. void rds_send_ping(struct rds_connection *conn, int cp_index);
  787. int rds_send_pong(struct rds_conn_path *cp, __be16 dport);
  788. /* rdma.c */
  789. void rds_rdma_unuse(struct rds_sock *rs, u32 r_key, int force);
  790. int rds_get_mr(struct rds_sock *rs, char __user *optval, int optlen);
  791. int rds_get_mr_for_dest(struct rds_sock *rs, char __user *optval, int optlen);
  792. int rds_free_mr(struct rds_sock *rs, char __user *optval, int optlen);
  793. void rds_rdma_drop_keys(struct rds_sock *rs);
  794. int rds_rdma_extra_size(struct rds_rdma_args *args);
  795. int rds_cmsg_rdma_args(struct rds_sock *rs, struct rds_message *rm,
  796. struct cmsghdr *cmsg);
  797. int rds_cmsg_rdma_dest(struct rds_sock *rs, struct rds_message *rm,
  798. struct cmsghdr *cmsg);
  799. int rds_cmsg_rdma_args(struct rds_sock *rs, struct rds_message *rm,
  800. struct cmsghdr *cmsg);
  801. int rds_cmsg_rdma_map(struct rds_sock *rs, struct rds_message *rm,
  802. struct cmsghdr *cmsg);
  803. void rds_rdma_free_op(struct rm_rdma_op *ro);
  804. void rds_atomic_free_op(struct rm_atomic_op *ao);
  805. void rds_rdma_send_complete(struct rds_message *rm, int wc_status);
  806. void rds_atomic_send_complete(struct rds_message *rm, int wc_status);
  807. int rds_cmsg_atomic(struct rds_sock *rs, struct rds_message *rm,
  808. struct cmsghdr *cmsg);
  809. void __rds_put_mr_final(struct rds_mr *mr);
  810. static inline void rds_mr_put(struct rds_mr *mr)
  811. {
  812. if (refcount_dec_and_test(&mr->r_refcount))
  813. __rds_put_mr_final(mr);
  814. }
  815. static inline bool rds_destroy_pending(struct rds_connection *conn)
  816. {
  817. return !check_net(rds_conn_net(conn)) ||
  818. (conn->c_trans->t_unloading && conn->c_trans->t_unloading(conn));
  819. }
  820. /* stats.c */
  821. DECLARE_PER_CPU_SHARED_ALIGNED(struct rds_statistics, rds_stats);
  822. #define rds_stats_inc_which(which, member) do { \
  823. per_cpu(which, get_cpu()).member++; \
  824. put_cpu(); \
  825. } while (0)
  826. #define rds_stats_inc(member) rds_stats_inc_which(rds_stats, member)
  827. #define rds_stats_add_which(which, member, count) do { \
  828. per_cpu(which, get_cpu()).member += count; \
  829. put_cpu(); \
  830. } while (0)
  831. #define rds_stats_add(member, count) rds_stats_add_which(rds_stats, member, count)
  832. int rds_stats_init(void);
  833. void rds_stats_exit(void);
  834. void rds_stats_info_copy(struct rds_info_iterator *iter,
  835. uint64_t *values, const char *const *names,
  836. size_t nr);
  837. /* sysctl.c */
  838. int rds_sysctl_init(void);
  839. void rds_sysctl_exit(void);
  840. extern unsigned long rds_sysctl_sndbuf_min;
  841. extern unsigned long rds_sysctl_sndbuf_default;
  842. extern unsigned long rds_sysctl_sndbuf_max;
  843. extern unsigned long rds_sysctl_reconnect_min_jiffies;
  844. extern unsigned long rds_sysctl_reconnect_max_jiffies;
  845. extern unsigned int rds_sysctl_max_unacked_packets;
  846. extern unsigned int rds_sysctl_max_unacked_bytes;
  847. extern unsigned int rds_sysctl_ping_enable;
  848. extern unsigned long rds_sysctl_trace_flags;
  849. extern unsigned int rds_sysctl_trace_level;
  850. /* threads.c */
  851. int rds_threads_init(void);
  852. void rds_threads_exit(void);
  853. extern struct workqueue_struct *rds_wq;
  854. void rds_queue_reconnect(struct rds_conn_path *cp);
  855. void rds_connect_worker(struct work_struct *);
  856. void rds_shutdown_worker(struct work_struct *);
  857. void rds_send_worker(struct work_struct *);
  858. void rds_recv_worker(struct work_struct *);
  859. void rds_connect_path_complete(struct rds_conn_path *conn, int curr);
  860. void rds_connect_complete(struct rds_connection *conn);
  861. int rds_addr_cmp(const struct in6_addr *a1, const struct in6_addr *a2);
  862. /* transport.c */
  863. void rds_trans_register(struct rds_transport *trans);
  864. void rds_trans_unregister(struct rds_transport *trans);
  865. struct rds_transport *rds_trans_get_preferred(struct net *net,
  866. const struct in6_addr *addr,
  867. __u32 scope_id);
  868. void rds_trans_put(struct rds_transport *trans);
  869. unsigned int rds_trans_stats_info_copy(struct rds_info_iterator *iter,
  870. unsigned int avail);
  871. struct rds_transport *rds_trans_get(int t_type);
  872. int rds_trans_init(void);
  873. void rds_trans_exit(void);
  874. #endif