rds.h 31 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007
  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. struct timeval 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_iov_vector {
  334. struct rds_iovec *iov;
  335. int len;
  336. };
  337. struct rds_iov_vector_arr {
  338. struct rds_iov_vector *vec;
  339. int len;
  340. int indx;
  341. int incr;
  342. };
  343. struct rds_message {
  344. refcount_t m_refcount;
  345. struct list_head m_sock_item;
  346. struct list_head m_conn_item;
  347. struct rds_incoming m_inc;
  348. u64 m_ack_seq;
  349. struct in6_addr m_daddr;
  350. unsigned long m_flags;
  351. /* Never access m_rs without holding m_rs_lock.
  352. * Lock nesting is
  353. * rm->m_rs_lock
  354. * -> rs->rs_lock
  355. */
  356. spinlock_t m_rs_lock;
  357. wait_queue_head_t m_flush_wait;
  358. struct rds_sock *m_rs;
  359. /* cookie to send to remote, in rds header */
  360. rds_rdma_cookie_t m_rdma_cookie;
  361. unsigned int m_used_sgs;
  362. unsigned int m_total_sgs;
  363. void *m_final_op;
  364. struct {
  365. struct rm_atomic_op {
  366. int op_type;
  367. union {
  368. struct {
  369. uint64_t compare;
  370. uint64_t swap;
  371. uint64_t compare_mask;
  372. uint64_t swap_mask;
  373. } op_m_cswp;
  374. struct {
  375. uint64_t add;
  376. uint64_t nocarry_mask;
  377. } op_m_fadd;
  378. };
  379. u32 op_rkey;
  380. u64 op_remote_addr;
  381. unsigned int op_notify:1;
  382. unsigned int op_recverr:1;
  383. unsigned int op_mapped:1;
  384. unsigned int op_silent:1;
  385. unsigned int op_active:1;
  386. struct scatterlist *op_sg;
  387. struct rds_notifier *op_notifier;
  388. struct rds_mr *op_rdma_mr;
  389. } atomic;
  390. struct rm_rdma_op {
  391. u32 op_rkey;
  392. u64 op_remote_addr;
  393. unsigned int op_write:1;
  394. unsigned int op_fence:1;
  395. unsigned int op_notify:1;
  396. unsigned int op_recverr:1;
  397. unsigned int op_mapped:1;
  398. unsigned int op_silent:1;
  399. unsigned int op_active:1;
  400. unsigned int op_bytes;
  401. unsigned int op_nents;
  402. unsigned int op_count;
  403. struct scatterlist *op_sg;
  404. struct rds_notifier *op_notifier;
  405. struct rds_mr *op_rdma_mr;
  406. } rdma;
  407. struct rm_data_op {
  408. unsigned int op_active:1;
  409. unsigned int op_notify:1;
  410. unsigned int op_nents;
  411. unsigned int op_count;
  412. unsigned int op_dmasg;
  413. unsigned int op_dmaoff;
  414. struct rds_znotifier *op_mmp_znotifier;
  415. struct scatterlist *op_sg;
  416. } data;
  417. };
  418. struct rds_conn_path *m_conn_path;
  419. };
  420. /*
  421. * The RDS notifier is used (optionally) to tell the application about
  422. * completed RDMA operations. Rather than keeping the whole rds message
  423. * around on the queue, we allocate a small notifier that is put on the
  424. * socket's notifier_list. Notifications are delivered to the application
  425. * through control messages.
  426. */
  427. struct rds_notifier {
  428. struct list_head n_list;
  429. uint64_t n_user_token;
  430. int n_status;
  431. };
  432. /* Available as part of RDS core, so doesn't need to participate
  433. * in get_preferred transport etc
  434. */
  435. #define RDS_TRANS_LOOP 3
  436. /**
  437. * struct rds_transport - transport specific behavioural hooks
  438. *
  439. * @xmit: .xmit is called by rds_send_xmit() to tell the transport to send
  440. * part of a message. The caller serializes on the send_sem so this
  441. * doesn't need to be reentrant for a given conn. The header must be
  442. * sent before the data payload. .xmit must be prepared to send a
  443. * message with no data payload. .xmit should return the number of
  444. * bytes that were sent down the connection, including header bytes.
  445. * Returning 0 tells the caller that it doesn't need to perform any
  446. * additional work now. This is usually the case when the transport has
  447. * filled the sending queue for its connection and will handle
  448. * triggering the rds thread to continue the send when space becomes
  449. * available. Returning -EAGAIN tells the caller to retry the send
  450. * immediately. Returning -ENOMEM tells the caller to retry the send at
  451. * some point in the future.
  452. *
  453. * @conn_shutdown: conn_shutdown stops traffic on the given connection. Once
  454. * it returns the connection can not call rds_recv_incoming().
  455. * This will only be called once after conn_connect returns
  456. * non-zero success and will The caller serializes this with
  457. * the send and connecting paths (xmit_* and conn_*). The
  458. * transport is responsible for other serialization, including
  459. * rds_recv_incoming(). This is called in process context but
  460. * should try hard not to block.
  461. */
  462. struct rds_transport {
  463. char t_name[TRANSNAMSIZ];
  464. struct list_head t_item;
  465. struct module *t_owner;
  466. unsigned int t_prefer_loopback:1,
  467. t_mp_capable:1;
  468. unsigned int t_type;
  469. int (*laddr_check)(struct net *net, const struct in6_addr *addr,
  470. __u32 scope_id);
  471. int (*conn_alloc)(struct rds_connection *conn, gfp_t gfp);
  472. void (*conn_free)(void *data);
  473. int (*conn_path_connect)(struct rds_conn_path *cp);
  474. void (*conn_path_shutdown)(struct rds_conn_path *conn);
  475. void (*xmit_path_prepare)(struct rds_conn_path *cp);
  476. void (*xmit_path_complete)(struct rds_conn_path *cp);
  477. int (*xmit)(struct rds_connection *conn, struct rds_message *rm,
  478. unsigned int hdr_off, unsigned int sg, unsigned int off);
  479. int (*xmit_rdma)(struct rds_connection *conn, struct rm_rdma_op *op);
  480. int (*xmit_atomic)(struct rds_connection *conn, struct rm_atomic_op *op);
  481. int (*recv_path)(struct rds_conn_path *cp);
  482. int (*inc_copy_to_user)(struct rds_incoming *inc, struct iov_iter *to);
  483. void (*inc_free)(struct rds_incoming *inc);
  484. int (*cm_handle_connect)(struct rdma_cm_id *cm_id,
  485. struct rdma_cm_event *event, bool isv6);
  486. int (*cm_initiate_connect)(struct rdma_cm_id *cm_id, bool isv6);
  487. void (*cm_connect_complete)(struct rds_connection *conn,
  488. struct rdma_cm_event *event);
  489. unsigned int (*stats_info_copy)(struct rds_info_iterator *iter,
  490. unsigned int avail);
  491. void (*exit)(void);
  492. void *(*get_mr)(struct scatterlist *sg, unsigned long nr_sg,
  493. struct rds_sock *rs, u32 *key_ret,
  494. struct rds_connection *conn);
  495. void (*sync_mr)(void *trans_private, int direction);
  496. void (*free_mr)(void *trans_private, int invalidate);
  497. void (*flush_mrs)(void);
  498. bool (*t_unloading)(struct rds_connection *conn);
  499. };
  500. /* Bind hash table key length. It is the sum of the size of a struct
  501. * in6_addr, a scope_id and a port.
  502. */
  503. #define RDS_BOUND_KEY_LEN \
  504. (sizeof(struct in6_addr) + sizeof(__u32) + sizeof(__be16))
  505. struct rds_sock {
  506. struct sock rs_sk;
  507. u64 rs_user_addr;
  508. u64 rs_user_bytes;
  509. /*
  510. * bound_addr used for both incoming and outgoing, no INADDR_ANY
  511. * support.
  512. */
  513. struct rhash_head rs_bound_node;
  514. u8 rs_bound_key[RDS_BOUND_KEY_LEN];
  515. struct sockaddr_in6 rs_bound_sin6;
  516. #define rs_bound_addr rs_bound_sin6.sin6_addr
  517. #define rs_bound_addr_v4 rs_bound_sin6.sin6_addr.s6_addr32[3]
  518. #define rs_bound_port rs_bound_sin6.sin6_port
  519. #define rs_bound_scope_id rs_bound_sin6.sin6_scope_id
  520. struct in6_addr rs_conn_addr;
  521. #define rs_conn_addr_v4 rs_conn_addr.s6_addr32[3]
  522. __be16 rs_conn_port;
  523. struct rds_transport *rs_transport;
  524. /*
  525. * rds_sendmsg caches the conn it used the last time around.
  526. * This helps avoid costly lookups.
  527. */
  528. struct rds_connection *rs_conn;
  529. /* flag indicating we were congested or not */
  530. int rs_congested;
  531. /* seen congestion (ENOBUFS) when sending? */
  532. int rs_seen_congestion;
  533. /* rs_lock protects all these adjacent members before the newline */
  534. spinlock_t rs_lock;
  535. struct list_head rs_send_queue;
  536. u32 rs_snd_bytes;
  537. int rs_rcv_bytes;
  538. struct list_head rs_notify_queue; /* currently used for failed RDMAs */
  539. /* Congestion wake_up. If rs_cong_monitor is set, we use cong_mask
  540. * to decide whether the application should be woken up.
  541. * If not set, we use rs_cong_track to find out whether a cong map
  542. * update arrived.
  543. */
  544. uint64_t rs_cong_mask;
  545. uint64_t rs_cong_notify;
  546. struct list_head rs_cong_list;
  547. unsigned long rs_cong_track;
  548. /*
  549. * rs_recv_lock protects the receive queue, and is
  550. * used to serialize with rds_release.
  551. */
  552. rwlock_t rs_recv_lock;
  553. struct list_head rs_recv_queue;
  554. /* just for stats reporting */
  555. struct list_head rs_item;
  556. /* these have their own lock */
  557. spinlock_t rs_rdma_lock;
  558. struct rb_root rs_rdma_keys;
  559. /* Socket options - in case there will be more */
  560. unsigned char rs_recverr,
  561. rs_cong_monitor;
  562. u32 rs_hash_initval;
  563. /* Socket receive path trace points*/
  564. u8 rs_rx_traces;
  565. u8 rs_rx_trace[RDS_MSG_RX_DGRAM_TRACE_MAX];
  566. struct rds_msg_zcopy_queue rs_zcookie_queue;
  567. };
  568. static inline struct rds_sock *rds_sk_to_rs(const struct sock *sk)
  569. {
  570. return container_of(sk, struct rds_sock, rs_sk);
  571. }
  572. static inline struct sock *rds_rs_to_sk(struct rds_sock *rs)
  573. {
  574. return &rs->rs_sk;
  575. }
  576. /*
  577. * The stack assigns sk_sndbuf and sk_rcvbuf to twice the specified value
  578. * to account for overhead. We don't account for overhead, we just apply
  579. * the number of payload bytes to the specified value.
  580. */
  581. static inline int rds_sk_sndbuf(struct rds_sock *rs)
  582. {
  583. return rds_rs_to_sk(rs)->sk_sndbuf / 2;
  584. }
  585. static inline int rds_sk_rcvbuf(struct rds_sock *rs)
  586. {
  587. return rds_rs_to_sk(rs)->sk_rcvbuf / 2;
  588. }
  589. struct rds_statistics {
  590. uint64_t s_conn_reset;
  591. uint64_t s_recv_drop_bad_checksum;
  592. uint64_t s_recv_drop_old_seq;
  593. uint64_t s_recv_drop_no_sock;
  594. uint64_t s_recv_drop_dead_sock;
  595. uint64_t s_recv_deliver_raced;
  596. uint64_t s_recv_delivered;
  597. uint64_t s_recv_queued;
  598. uint64_t s_recv_immediate_retry;
  599. uint64_t s_recv_delayed_retry;
  600. uint64_t s_recv_ack_required;
  601. uint64_t s_recv_rdma_bytes;
  602. uint64_t s_recv_ping;
  603. uint64_t s_send_queue_empty;
  604. uint64_t s_send_queue_full;
  605. uint64_t s_send_lock_contention;
  606. uint64_t s_send_lock_queue_raced;
  607. uint64_t s_send_immediate_retry;
  608. uint64_t s_send_delayed_retry;
  609. uint64_t s_send_drop_acked;
  610. uint64_t s_send_ack_required;
  611. uint64_t s_send_queued;
  612. uint64_t s_send_rdma;
  613. uint64_t s_send_rdma_bytes;
  614. uint64_t s_send_pong;
  615. uint64_t s_page_remainder_hit;
  616. uint64_t s_page_remainder_miss;
  617. uint64_t s_copy_to_user;
  618. uint64_t s_copy_from_user;
  619. uint64_t s_cong_update_queued;
  620. uint64_t s_cong_update_received;
  621. uint64_t s_cong_send_error;
  622. uint64_t s_cong_send_blocked;
  623. uint64_t s_recv_bytes_added_to_socket;
  624. uint64_t s_recv_bytes_removed_from_socket;
  625. };
  626. /* af_rds.c */
  627. void rds_sock_addref(struct rds_sock *rs);
  628. void rds_sock_put(struct rds_sock *rs);
  629. void rds_wake_sk_sleep(struct rds_sock *rs);
  630. static inline void __rds_wake_sk_sleep(struct sock *sk)
  631. {
  632. wait_queue_head_t *waitq = sk_sleep(sk);
  633. if (!sock_flag(sk, SOCK_DEAD) && waitq)
  634. wake_up(waitq);
  635. }
  636. extern wait_queue_head_t rds_poll_waitq;
  637. /* bind.c */
  638. int rds_bind(struct socket *sock, struct sockaddr *uaddr, int addr_len);
  639. void rds_remove_bound(struct rds_sock *rs);
  640. struct rds_sock *rds_find_bound(const struct in6_addr *addr, __be16 port,
  641. __u32 scope_id);
  642. int rds_bind_lock_init(void);
  643. void rds_bind_lock_destroy(void);
  644. /* cong.c */
  645. int rds_cong_get_maps(struct rds_connection *conn);
  646. void rds_cong_add_conn(struct rds_connection *conn);
  647. void rds_cong_remove_conn(struct rds_connection *conn);
  648. void rds_cong_set_bit(struct rds_cong_map *map, __be16 port);
  649. void rds_cong_clear_bit(struct rds_cong_map *map, __be16 port);
  650. int rds_cong_wait(struct rds_cong_map *map, __be16 port, int nonblock, struct rds_sock *rs);
  651. void rds_cong_queue_updates(struct rds_cong_map *map);
  652. void rds_cong_map_updated(struct rds_cong_map *map, uint64_t);
  653. int rds_cong_updated_since(unsigned long *recent);
  654. void rds_cong_add_socket(struct rds_sock *);
  655. void rds_cong_remove_socket(struct rds_sock *);
  656. void rds_cong_exit(void);
  657. struct rds_message *rds_cong_update_alloc(struct rds_connection *conn);
  658. /* connection.c */
  659. extern u32 rds_gen_num;
  660. int rds_conn_init(void);
  661. void rds_conn_exit(void);
  662. struct rds_connection *rds_conn_create(struct net *net,
  663. const struct in6_addr *laddr,
  664. const struct in6_addr *faddr,
  665. struct rds_transport *trans, gfp_t gfp,
  666. int dev_if);
  667. struct rds_connection *rds_conn_create_outgoing(struct net *net,
  668. const struct in6_addr *laddr,
  669. const struct in6_addr *faddr,
  670. struct rds_transport *trans,
  671. gfp_t gfp, int dev_if);
  672. void rds_conn_shutdown(struct rds_conn_path *cpath);
  673. void rds_conn_destroy(struct rds_connection *conn);
  674. void rds_conn_drop(struct rds_connection *conn);
  675. void rds_conn_path_drop(struct rds_conn_path *cpath, bool destroy);
  676. void rds_conn_connect_if_down(struct rds_connection *conn);
  677. void rds_conn_path_connect_if_down(struct rds_conn_path *cp);
  678. void rds_for_each_conn_info(struct socket *sock, unsigned int len,
  679. struct rds_info_iterator *iter,
  680. struct rds_info_lengths *lens,
  681. int (*visitor)(struct rds_connection *, void *),
  682. u64 *buffer,
  683. size_t item_len);
  684. __printf(2, 3)
  685. void __rds_conn_path_error(struct rds_conn_path *cp, const char *, ...);
  686. #define rds_conn_path_error(cp, fmt...) \
  687. __rds_conn_path_error(cp, KERN_WARNING "RDS: " fmt)
  688. static inline int
  689. rds_conn_path_transition(struct rds_conn_path *cp, int old, int new)
  690. {
  691. return atomic_cmpxchg(&cp->cp_state, old, new) == old;
  692. }
  693. static inline int
  694. rds_conn_transition(struct rds_connection *conn, int old, int new)
  695. {
  696. WARN_ON(conn->c_trans->t_mp_capable);
  697. return rds_conn_path_transition(&conn->c_path[0], old, new);
  698. }
  699. static inline int
  700. rds_conn_path_state(struct rds_conn_path *cp)
  701. {
  702. return atomic_read(&cp->cp_state);
  703. }
  704. static inline int
  705. rds_conn_state(struct rds_connection *conn)
  706. {
  707. WARN_ON(conn->c_trans->t_mp_capable);
  708. return rds_conn_path_state(&conn->c_path[0]);
  709. }
  710. static inline int
  711. rds_conn_path_up(struct rds_conn_path *cp)
  712. {
  713. return atomic_read(&cp->cp_state) == RDS_CONN_UP;
  714. }
  715. static inline int
  716. rds_conn_up(struct rds_connection *conn)
  717. {
  718. WARN_ON(conn->c_trans->t_mp_capable);
  719. return rds_conn_path_up(&conn->c_path[0]);
  720. }
  721. static inline int
  722. rds_conn_path_connecting(struct rds_conn_path *cp)
  723. {
  724. return atomic_read(&cp->cp_state) == RDS_CONN_CONNECTING;
  725. }
  726. static inline int
  727. rds_conn_connecting(struct rds_connection *conn)
  728. {
  729. WARN_ON(conn->c_trans->t_mp_capable);
  730. return rds_conn_path_connecting(&conn->c_path[0]);
  731. }
  732. /* message.c */
  733. struct rds_message *rds_message_alloc(unsigned int nents, gfp_t gfp);
  734. struct scatterlist *rds_message_alloc_sgs(struct rds_message *rm, int nents);
  735. int rds_message_copy_from_user(struct rds_message *rm, struct iov_iter *from,
  736. bool zcopy);
  737. struct rds_message *rds_message_map_pages(unsigned long *page_addrs, unsigned int total_len);
  738. void rds_message_populate_header(struct rds_header *hdr, __be16 sport,
  739. __be16 dport, u64 seq);
  740. int rds_message_add_extension(struct rds_header *hdr,
  741. unsigned int type, const void *data, unsigned int len);
  742. int rds_message_next_extension(struct rds_header *hdr,
  743. unsigned int *pos, void *buf, unsigned int *buflen);
  744. int rds_message_add_rdma_dest_extension(struct rds_header *hdr, u32 r_key, u32 offset);
  745. int rds_message_inc_copy_to_user(struct rds_incoming *inc, struct iov_iter *to);
  746. void rds_message_inc_free(struct rds_incoming *inc);
  747. void rds_message_addref(struct rds_message *rm);
  748. void rds_message_put(struct rds_message *rm);
  749. void rds_message_wait(struct rds_message *rm);
  750. void rds_message_unmapped(struct rds_message *rm);
  751. void rds_notify_msg_zcopy_purge(struct rds_msg_zcopy_queue *info);
  752. static inline void rds_message_make_checksum(struct rds_header *hdr)
  753. {
  754. hdr->h_csum = 0;
  755. hdr->h_csum = ip_fast_csum((void *) hdr, sizeof(*hdr) >> 2);
  756. }
  757. static inline int rds_message_verify_checksum(const struct rds_header *hdr)
  758. {
  759. return !hdr->h_csum || ip_fast_csum((void *) hdr, sizeof(*hdr) >> 2) == 0;
  760. }
  761. /* page.c */
  762. int rds_page_remainder_alloc(struct scatterlist *scat, unsigned long bytes,
  763. gfp_t gfp);
  764. void rds_page_exit(void);
  765. /* recv.c */
  766. void rds_inc_init(struct rds_incoming *inc, struct rds_connection *conn,
  767. struct in6_addr *saddr);
  768. void rds_inc_path_init(struct rds_incoming *inc, struct rds_conn_path *conn,
  769. struct in6_addr *saddr);
  770. void rds_inc_put(struct rds_incoming *inc);
  771. void rds_recv_incoming(struct rds_connection *conn, struct in6_addr *saddr,
  772. struct in6_addr *daddr,
  773. struct rds_incoming *inc, gfp_t gfp);
  774. int rds_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
  775. int msg_flags);
  776. void rds_clear_recv_queue(struct rds_sock *rs);
  777. int rds_notify_queue_get(struct rds_sock *rs, struct msghdr *msg);
  778. void rds_inc_info_copy(struct rds_incoming *inc,
  779. struct rds_info_iterator *iter,
  780. __be32 saddr, __be32 daddr, int flip);
  781. void rds6_inc_info_copy(struct rds_incoming *inc,
  782. struct rds_info_iterator *iter,
  783. struct in6_addr *saddr, struct in6_addr *daddr,
  784. int flip);
  785. /* send.c */
  786. int rds_sendmsg(struct socket *sock, struct msghdr *msg, size_t payload_len);
  787. void rds_send_path_reset(struct rds_conn_path *conn);
  788. int rds_send_xmit(struct rds_conn_path *cp);
  789. struct sockaddr_in;
  790. void rds_send_drop_to(struct rds_sock *rs, struct sockaddr_in6 *dest);
  791. typedef int (*is_acked_func)(struct rds_message *rm, uint64_t ack);
  792. void rds_send_drop_acked(struct rds_connection *conn, u64 ack,
  793. is_acked_func is_acked);
  794. void rds_send_path_drop_acked(struct rds_conn_path *cp, u64 ack,
  795. is_acked_func is_acked);
  796. void rds_send_ping(struct rds_connection *conn, int cp_index);
  797. int rds_send_pong(struct rds_conn_path *cp, __be16 dport);
  798. /* rdma.c */
  799. void rds_rdma_unuse(struct rds_sock *rs, u32 r_key, int force);
  800. int rds_get_mr(struct rds_sock *rs, char __user *optval, int optlen);
  801. int rds_get_mr_for_dest(struct rds_sock *rs, char __user *optval, int optlen);
  802. int rds_free_mr(struct rds_sock *rs, char __user *optval, int optlen);
  803. void rds_rdma_drop_keys(struct rds_sock *rs);
  804. int rds_rdma_extra_size(struct rds_rdma_args *args,
  805. struct rds_iov_vector *iov);
  806. int rds_cmsg_rdma_dest(struct rds_sock *rs, struct rds_message *rm,
  807. struct cmsghdr *cmsg);
  808. int rds_cmsg_rdma_args(struct rds_sock *rs, struct rds_message *rm,
  809. struct cmsghdr *cmsg,
  810. struct rds_iov_vector *vec);
  811. int rds_cmsg_rdma_map(struct rds_sock *rs, struct rds_message *rm,
  812. struct cmsghdr *cmsg);
  813. void rds_rdma_free_op(struct rm_rdma_op *ro);
  814. void rds_atomic_free_op(struct rm_atomic_op *ao);
  815. void rds_rdma_send_complete(struct rds_message *rm, int wc_status);
  816. void rds_atomic_send_complete(struct rds_message *rm, int wc_status);
  817. int rds_cmsg_atomic(struct rds_sock *rs, struct rds_message *rm,
  818. struct cmsghdr *cmsg);
  819. void __rds_put_mr_final(struct rds_mr *mr);
  820. static inline void rds_mr_put(struct rds_mr *mr)
  821. {
  822. if (refcount_dec_and_test(&mr->r_refcount))
  823. __rds_put_mr_final(mr);
  824. }
  825. static inline bool rds_destroy_pending(struct rds_connection *conn)
  826. {
  827. return !check_net(rds_conn_net(conn)) ||
  828. (conn->c_trans->t_unloading && conn->c_trans->t_unloading(conn));
  829. }
  830. /* stats.c */
  831. DECLARE_PER_CPU_SHARED_ALIGNED(struct rds_statistics, rds_stats);
  832. #define rds_stats_inc_which(which, member) do { \
  833. per_cpu(which, get_cpu()).member++; \
  834. put_cpu(); \
  835. } while (0)
  836. #define rds_stats_inc(member) rds_stats_inc_which(rds_stats, member)
  837. #define rds_stats_add_which(which, member, count) do { \
  838. per_cpu(which, get_cpu()).member += count; \
  839. put_cpu(); \
  840. } while (0)
  841. #define rds_stats_add(member, count) rds_stats_add_which(rds_stats, member, count)
  842. int rds_stats_init(void);
  843. void rds_stats_exit(void);
  844. void rds_stats_info_copy(struct rds_info_iterator *iter,
  845. uint64_t *values, const char *const *names,
  846. size_t nr);
  847. /* sysctl.c */
  848. int rds_sysctl_init(void);
  849. void rds_sysctl_exit(void);
  850. extern unsigned long rds_sysctl_sndbuf_min;
  851. extern unsigned long rds_sysctl_sndbuf_default;
  852. extern unsigned long rds_sysctl_sndbuf_max;
  853. extern unsigned long rds_sysctl_reconnect_min_jiffies;
  854. extern unsigned long rds_sysctl_reconnect_max_jiffies;
  855. extern unsigned int rds_sysctl_max_unacked_packets;
  856. extern unsigned int rds_sysctl_max_unacked_bytes;
  857. extern unsigned int rds_sysctl_ping_enable;
  858. extern unsigned long rds_sysctl_trace_flags;
  859. extern unsigned int rds_sysctl_trace_level;
  860. /* threads.c */
  861. int rds_threads_init(void);
  862. void rds_threads_exit(void);
  863. extern struct workqueue_struct *rds_wq;
  864. void rds_queue_reconnect(struct rds_conn_path *cp);
  865. void rds_connect_worker(struct work_struct *);
  866. void rds_shutdown_worker(struct work_struct *);
  867. void rds_send_worker(struct work_struct *);
  868. void rds_recv_worker(struct work_struct *);
  869. void rds_connect_path_complete(struct rds_conn_path *conn, int curr);
  870. void rds_connect_complete(struct rds_connection *conn);
  871. int rds_addr_cmp(const struct in6_addr *a1, const struct in6_addr *a2);
  872. /* transport.c */
  873. void rds_trans_register(struct rds_transport *trans);
  874. void rds_trans_unregister(struct rds_transport *trans);
  875. struct rds_transport *rds_trans_get_preferred(struct net *net,
  876. const struct in6_addr *addr,
  877. __u32 scope_id);
  878. void rds_trans_put(struct rds_transport *trans);
  879. unsigned int rds_trans_stats_info_copy(struct rds_info_iterator *iter,
  880. unsigned int avail);
  881. struct rds_transport *rds_trans_get(int t_type);
  882. int rds_trans_init(void);
  883. void rds_trans_exit(void);
  884. #endif