rds.h 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. /*
  2. * Copyright (c) 2008 Oracle. All rights reserved.
  3. *
  4. * This software is available to you under a choice of one of two
  5. * licenses. You may choose to be licensed under the terms of the GNU
  6. * General Public License (GPL) Version 2, available from the file
  7. * COPYING in the main directory of this source tree, or the
  8. * OpenIB.org BSD license below:
  9. *
  10. * Redistribution and use in source and binary forms, with or
  11. * without modification, are permitted provided that the following
  12. * conditions are met:
  13. *
  14. * - Redistributions of source code must retain the above
  15. * copyright notice, this list of conditions and the following
  16. * disclaimer.
  17. *
  18. * - Redistributions in binary form must reproduce the above
  19. * copyright notice, this list of conditions and the following
  20. * disclaimer in the documentation and/or other materials
  21. * provided with the distribution.
  22. *
  23. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30. * SOFTWARE.
  31. *
  32. */
  33. #ifndef _LINUX_RDS_H
  34. #define _LINUX_RDS_H
  35. #include <linux/types.h>
  36. #define RDS_IB_ABI_VERSION 0x301
  37. #define SOL_RDS 276
  38. /*
  39. * setsockopt/getsockopt for SOL_RDS
  40. */
  41. #define RDS_CANCEL_SENT_TO 1
  42. #define RDS_GET_MR 2
  43. #define RDS_FREE_MR 3
  44. /* deprecated: RDS_BARRIER 4 */
  45. #define RDS_RECVERR 5
  46. #define RDS_CONG_MONITOR 6
  47. #define RDS_GET_MR_FOR_DEST 7
  48. #define SO_RDS_TRANSPORT 8
  49. /* supported values for SO_RDS_TRANSPORT */
  50. #define RDS_TRANS_IB 0
  51. #define RDS_TRANS_IWARP 1
  52. #define RDS_TRANS_TCP 2
  53. #define RDS_TRANS_COUNT 3
  54. #define RDS_TRANS_NONE (~0)
  55. /*
  56. * Control message types for SOL_RDS.
  57. *
  58. * CMSG_RDMA_ARGS (sendmsg)
  59. * Request a RDMA transfer to/from the specified
  60. * memory ranges.
  61. * The cmsg_data is a struct rds_rdma_args.
  62. * RDS_CMSG_RDMA_DEST (recvmsg, sendmsg)
  63. * Kernel informs application about intended
  64. * source/destination of a RDMA transfer
  65. * RDS_CMSG_RDMA_MAP (sendmsg)
  66. * Application asks kernel to map the given
  67. * memory range into a IB MR, and send the
  68. * R_Key along in an RDS extension header.
  69. * The cmsg_data is a struct rds_get_mr_args,
  70. * the same as for the GET_MR setsockopt.
  71. * RDS_CMSG_RDMA_STATUS (recvmsg)
  72. * Returns the status of a completed RDMA operation.
  73. */
  74. #define RDS_CMSG_RDMA_ARGS 1
  75. #define RDS_CMSG_RDMA_DEST 2
  76. #define RDS_CMSG_RDMA_MAP 3
  77. #define RDS_CMSG_RDMA_STATUS 4
  78. #define RDS_CMSG_CONG_UPDATE 5
  79. #define RDS_CMSG_ATOMIC_FADD 6
  80. #define RDS_CMSG_ATOMIC_CSWP 7
  81. #define RDS_CMSG_MASKED_ATOMIC_FADD 8
  82. #define RDS_CMSG_MASKED_ATOMIC_CSWP 9
  83. #define RDS_INFO_FIRST 10000
  84. #define RDS_INFO_COUNTERS 10000
  85. #define RDS_INFO_CONNECTIONS 10001
  86. /* 10002 aka RDS_INFO_FLOWS is deprecated */
  87. #define RDS_INFO_SEND_MESSAGES 10003
  88. #define RDS_INFO_RETRANS_MESSAGES 10004
  89. #define RDS_INFO_RECV_MESSAGES 10005
  90. #define RDS_INFO_SOCKETS 10006
  91. #define RDS_INFO_TCP_SOCKETS 10007
  92. #define RDS_INFO_IB_CONNECTIONS 10008
  93. #define RDS_INFO_CONNECTION_STATS 10009
  94. #define RDS_INFO_IWARP_CONNECTIONS 10010
  95. #define RDS_INFO_LAST 10010
  96. struct rds_info_counter {
  97. uint8_t name[32];
  98. uint64_t value;
  99. } __attribute__((packed));
  100. #define RDS_INFO_CONNECTION_FLAG_SENDING 0x01
  101. #define RDS_INFO_CONNECTION_FLAG_CONNECTING 0x02
  102. #define RDS_INFO_CONNECTION_FLAG_CONNECTED 0x04
  103. #define TRANSNAMSIZ 16
  104. struct rds_info_connection {
  105. uint64_t next_tx_seq;
  106. uint64_t next_rx_seq;
  107. __be32 laddr;
  108. __be32 faddr;
  109. uint8_t transport[TRANSNAMSIZ]; /* null term ascii */
  110. uint8_t flags;
  111. } __attribute__((packed));
  112. #define RDS_INFO_MESSAGE_FLAG_ACK 0x01
  113. #define RDS_INFO_MESSAGE_FLAG_FAST_ACK 0x02
  114. struct rds_info_message {
  115. uint64_t seq;
  116. uint32_t len;
  117. __be32 laddr;
  118. __be32 faddr;
  119. __be16 lport;
  120. __be16 fport;
  121. uint8_t flags;
  122. } __attribute__((packed));
  123. struct rds_info_socket {
  124. uint32_t sndbuf;
  125. __be32 bound_addr;
  126. __be32 connected_addr;
  127. __be16 bound_port;
  128. __be16 connected_port;
  129. uint32_t rcvbuf;
  130. uint64_t inum;
  131. } __attribute__((packed));
  132. struct rds_info_tcp_socket {
  133. __be32 local_addr;
  134. __be16 local_port;
  135. __be32 peer_addr;
  136. __be16 peer_port;
  137. uint64_t hdr_rem;
  138. uint64_t data_rem;
  139. uint32_t last_sent_nxt;
  140. uint32_t last_expected_una;
  141. uint32_t last_seen_una;
  142. } __attribute__((packed));
  143. #define RDS_IB_GID_LEN 16
  144. struct rds_info_rdma_connection {
  145. __be32 src_addr;
  146. __be32 dst_addr;
  147. uint8_t src_gid[RDS_IB_GID_LEN];
  148. uint8_t dst_gid[RDS_IB_GID_LEN];
  149. uint32_t max_send_wr;
  150. uint32_t max_recv_wr;
  151. uint32_t max_send_sge;
  152. uint32_t rdma_mr_max;
  153. uint32_t rdma_mr_size;
  154. };
  155. /*
  156. * Congestion monitoring.
  157. * Congestion control in RDS happens at the host connection
  158. * level by exchanging a bitmap marking congested ports.
  159. * By default, a process sleeping in poll() is always woken
  160. * up when the congestion map is updated.
  161. * With explicit monitoring, an application can have more
  162. * fine-grained control.
  163. * The application installs a 64bit mask value in the socket,
  164. * where each bit corresponds to a group of ports.
  165. * When a congestion update arrives, RDS checks the set of
  166. * ports that are now uncongested against the list bit mask
  167. * installed in the socket, and if they overlap, we queue a
  168. * cong_notification on the socket.
  169. *
  170. * To install the congestion monitor bitmask, use RDS_CONG_MONITOR
  171. * with the 64bit mask.
  172. * Congestion updates are received via RDS_CMSG_CONG_UPDATE
  173. * control messages.
  174. *
  175. * The correspondence between bits and ports is
  176. * 1 << (portnum % 64)
  177. */
  178. #define RDS_CONG_MONITOR_SIZE 64
  179. #define RDS_CONG_MONITOR_BIT(port) (((unsigned int) port) % RDS_CONG_MONITOR_SIZE)
  180. #define RDS_CONG_MONITOR_MASK(port) (1ULL << RDS_CONG_MONITOR_BIT(port))
  181. /*
  182. * RDMA related types
  183. */
  184. /*
  185. * This encapsulates a remote memory location.
  186. * In the current implementation, it contains the R_Key
  187. * of the remote memory region, and the offset into it
  188. * (so that the application does not have to worry about
  189. * alignment).
  190. */
  191. typedef uint64_t rds_rdma_cookie_t;
  192. struct rds_iovec {
  193. uint64_t addr;
  194. uint64_t bytes;
  195. };
  196. struct rds_get_mr_args {
  197. struct rds_iovec vec;
  198. uint64_t cookie_addr;
  199. uint64_t flags;
  200. };
  201. struct rds_get_mr_for_dest_args {
  202. struct sockaddr_storage dest_addr;
  203. struct rds_iovec vec;
  204. uint64_t cookie_addr;
  205. uint64_t flags;
  206. };
  207. struct rds_free_mr_args {
  208. rds_rdma_cookie_t cookie;
  209. uint64_t flags;
  210. };
  211. struct rds_rdma_args {
  212. rds_rdma_cookie_t cookie;
  213. struct rds_iovec remote_vec;
  214. uint64_t local_vec_addr;
  215. uint64_t nr_local;
  216. uint64_t flags;
  217. uint64_t user_token;
  218. };
  219. struct rds_atomic_args {
  220. rds_rdma_cookie_t cookie;
  221. uint64_t local_addr;
  222. uint64_t remote_addr;
  223. union {
  224. struct {
  225. uint64_t compare;
  226. uint64_t swap;
  227. } cswp;
  228. struct {
  229. uint64_t add;
  230. } fadd;
  231. struct {
  232. uint64_t compare;
  233. uint64_t swap;
  234. uint64_t compare_mask;
  235. uint64_t swap_mask;
  236. } m_cswp;
  237. struct {
  238. uint64_t add;
  239. uint64_t nocarry_mask;
  240. } m_fadd;
  241. };
  242. uint64_t flags;
  243. uint64_t user_token;
  244. };
  245. struct rds_rdma_notify {
  246. uint64_t user_token;
  247. int32_t status;
  248. };
  249. #define RDS_RDMA_SUCCESS 0
  250. #define RDS_RDMA_REMOTE_ERROR 1
  251. #define RDS_RDMA_CANCELED 2
  252. #define RDS_RDMA_DROPPED 3
  253. #define RDS_RDMA_OTHER_ERROR 4
  254. /*
  255. * Common set of flags for all RDMA related structs
  256. */
  257. #define RDS_RDMA_READWRITE 0x0001
  258. #define RDS_RDMA_FENCE 0x0002 /* use FENCE for immediate send */
  259. #define RDS_RDMA_INVALIDATE 0x0004 /* invalidate R_Key after freeing MR */
  260. #define RDS_RDMA_USE_ONCE 0x0008 /* free MR after use */
  261. #define RDS_RDMA_DONTWAIT 0x0010 /* Don't wait in SET_BARRIER */
  262. #define RDS_RDMA_NOTIFY_ME 0x0020 /* Notify when operation completes */
  263. #define RDS_RDMA_SILENT 0x0040 /* Do not interrupt remote */
  264. #endif /* IB_RDS_H */