ib_sa.h 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609
  1. /* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
  2. /*
  3. * Copyright (c) 2004 Topspin Communications. All rights reserved.
  4. * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
  5. * Copyright (c) 2006 Intel Corporation. All rights reserved.
  6. */
  7. #ifndef IB_SA_H
  8. #define IB_SA_H
  9. #include <linux/completion.h>
  10. #include <linux/compiler.h>
  11. #include <linux/atomic.h>
  12. #include <linux/netdevice.h>
  13. #include <rdma/ib_verbs.h>
  14. #include <rdma/ib_mad.h>
  15. #include <rdma/ib_addr.h>
  16. #include <rdma/opa_addr.h>
  17. enum {
  18. IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */
  19. IB_SA_METHOD_GET_TABLE = 0x12,
  20. IB_SA_METHOD_GET_TABLE_RESP = 0x92,
  21. IB_SA_METHOD_DELETE = 0x15,
  22. IB_SA_METHOD_DELETE_RESP = 0x95,
  23. IB_SA_METHOD_GET_MULTI = 0x14,
  24. IB_SA_METHOD_GET_MULTI_RESP = 0x94,
  25. IB_SA_METHOD_GET_TRACE_TBL = 0x13
  26. };
  27. #define OPA_SA_CLASS_VERSION 0x80
  28. enum {
  29. IB_SA_ATTR_CLASS_PORTINFO = 0x01,
  30. IB_SA_ATTR_NOTICE = 0x02,
  31. IB_SA_ATTR_INFORM_INFO = 0x03,
  32. IB_SA_ATTR_NODE_REC = 0x11,
  33. IB_SA_ATTR_PORT_INFO_REC = 0x12,
  34. IB_SA_ATTR_SL2VL_REC = 0x13,
  35. IB_SA_ATTR_SWITCH_REC = 0x14,
  36. IB_SA_ATTR_LINEAR_FDB_REC = 0x15,
  37. IB_SA_ATTR_RANDOM_FDB_REC = 0x16,
  38. IB_SA_ATTR_MCAST_FDB_REC = 0x17,
  39. IB_SA_ATTR_SM_INFO_REC = 0x18,
  40. IB_SA_ATTR_LINK_REC = 0x20,
  41. IB_SA_ATTR_GUID_INFO_REC = 0x30,
  42. IB_SA_ATTR_SERVICE_REC = 0x31,
  43. IB_SA_ATTR_PARTITION_REC = 0x33,
  44. IB_SA_ATTR_PATH_REC = 0x35,
  45. IB_SA_ATTR_VL_ARB_REC = 0x36,
  46. IB_SA_ATTR_MC_MEMBER_REC = 0x38,
  47. IB_SA_ATTR_TRACE_REC = 0x39,
  48. IB_SA_ATTR_MULTI_PATH_REC = 0x3a,
  49. IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b,
  50. IB_SA_ATTR_INFORM_INFO_REC = 0xf3
  51. };
  52. enum ib_sa_selector {
  53. IB_SA_GT = 0,
  54. IB_SA_LT = 1,
  55. IB_SA_EQ = 2,
  56. /*
  57. * The meaning of "best" depends on the attribute: for
  58. * example, for MTU best will return the largest available
  59. * MTU, while for packet life time, best will return the
  60. * smallest available life time.
  61. */
  62. IB_SA_BEST = 3
  63. };
  64. /*
  65. * There are 4 types of join states:
  66. * FullMember, NonMember, SendOnlyNonMember, SendOnlyFullMember.
  67. * The order corresponds to JoinState bits in MCMemberRecord.
  68. */
  69. enum ib_sa_mc_join_states {
  70. FULLMEMBER_JOIN,
  71. NONMEMBER_JOIN,
  72. SENDONLY_NONMEBER_JOIN,
  73. SENDONLY_FULLMEMBER_JOIN,
  74. NUM_JOIN_MEMBERSHIP_TYPES,
  75. };
  76. #define IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT BIT(12)
  77. /*
  78. * Structures for SA records are named "struct ib_sa_xxx_rec." No
  79. * attempt is made to pack structures to match the physical layout of
  80. * SA records in SA MADs; all packing and unpacking is handled by the
  81. * SA query code.
  82. *
  83. * For a record with structure ib_sa_xxx_rec, the naming convention
  84. * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
  85. * never use different abbreviations or otherwise change the spelling
  86. * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
  87. *
  88. * Reserved rows are indicated with comments to help maintainability.
  89. */
  90. #define IB_SA_PATH_REC_SERVICE_ID (IB_SA_COMP_MASK( 0) |\
  91. IB_SA_COMP_MASK( 1))
  92. #define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2)
  93. #define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3)
  94. #define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4)
  95. #define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5)
  96. #define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6)
  97. /* reserved: 7 */
  98. #define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8)
  99. #define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9)
  100. #define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10)
  101. #define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11)
  102. #define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12)
  103. #define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13)
  104. #define IB_SA_PATH_REC_QOS_CLASS IB_SA_COMP_MASK(14)
  105. #define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15)
  106. #define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16)
  107. #define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17)
  108. #define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18)
  109. #define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19)
  110. #define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20)
  111. #define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21)
  112. #define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22)
  113. enum sa_path_rec_type {
  114. SA_PATH_REC_TYPE_IB,
  115. SA_PATH_REC_TYPE_ROCE_V1,
  116. SA_PATH_REC_TYPE_ROCE_V2,
  117. SA_PATH_REC_TYPE_OPA
  118. };
  119. struct sa_path_rec_ib {
  120. __be16 dlid;
  121. __be16 slid;
  122. u8 raw_traffic;
  123. };
  124. /**
  125. * struct sa_path_rec_roce - RoCE specific portion of the path record entry
  126. * @route_resolved: When set, it indicates that this route is already
  127. * resolved for this path record entry.
  128. * @dmac: Destination mac address for the given DGID entry
  129. * of the path record entry.
  130. */
  131. struct sa_path_rec_roce {
  132. bool route_resolved;
  133. u8 dmac[ETH_ALEN];
  134. };
  135. struct sa_path_rec_opa {
  136. __be32 dlid;
  137. __be32 slid;
  138. u8 raw_traffic;
  139. u8 l2_8B;
  140. u8 l2_10B;
  141. u8 l2_9B;
  142. u8 l2_16B;
  143. u8 qos_type;
  144. u8 qos_priority;
  145. };
  146. struct sa_path_rec {
  147. union ib_gid dgid;
  148. union ib_gid sgid;
  149. __be64 service_id;
  150. /* reserved */
  151. __be32 flow_label;
  152. u8 hop_limit;
  153. u8 traffic_class;
  154. u8 reversible;
  155. u8 numb_path;
  156. __be16 pkey;
  157. __be16 qos_class;
  158. u8 sl;
  159. u8 mtu_selector;
  160. u8 mtu;
  161. u8 rate_selector;
  162. u8 rate;
  163. u8 packet_life_time_selector;
  164. u8 packet_life_time;
  165. u8 preference;
  166. union {
  167. struct sa_path_rec_ib ib;
  168. struct sa_path_rec_roce roce;
  169. struct sa_path_rec_opa opa;
  170. };
  171. enum sa_path_rec_type rec_type;
  172. u32 flags;
  173. };
  174. static inline enum ib_gid_type
  175. sa_conv_pathrec_to_gid_type(struct sa_path_rec *rec)
  176. {
  177. switch (rec->rec_type) {
  178. case SA_PATH_REC_TYPE_ROCE_V1:
  179. return IB_GID_TYPE_ROCE;
  180. case SA_PATH_REC_TYPE_ROCE_V2:
  181. return IB_GID_TYPE_ROCE_UDP_ENCAP;
  182. default:
  183. return IB_GID_TYPE_IB;
  184. }
  185. }
  186. static inline enum sa_path_rec_type
  187. sa_conv_gid_to_pathrec_type(enum ib_gid_type type)
  188. {
  189. switch (type) {
  190. case IB_GID_TYPE_ROCE:
  191. return SA_PATH_REC_TYPE_ROCE_V1;
  192. case IB_GID_TYPE_ROCE_UDP_ENCAP:
  193. return SA_PATH_REC_TYPE_ROCE_V2;
  194. default:
  195. return SA_PATH_REC_TYPE_IB;
  196. }
  197. }
  198. static inline void path_conv_opa_to_ib(struct sa_path_rec *ib,
  199. struct sa_path_rec *opa)
  200. {
  201. if ((be32_to_cpu(opa->opa.dlid) >=
  202. be16_to_cpu(IB_MULTICAST_LID_BASE)) ||
  203. (be32_to_cpu(opa->opa.slid) >=
  204. be16_to_cpu(IB_MULTICAST_LID_BASE))) {
  205. /* Create OPA GID and zero out the LID */
  206. ib->dgid.global.interface_id
  207. = OPA_MAKE_ID(be32_to_cpu(opa->opa.dlid));
  208. ib->dgid.global.subnet_prefix
  209. = opa->dgid.global.subnet_prefix;
  210. ib->sgid.global.interface_id
  211. = OPA_MAKE_ID(be32_to_cpu(opa->opa.slid));
  212. ib->dgid.global.subnet_prefix
  213. = opa->dgid.global.subnet_prefix;
  214. ib->ib.dlid = 0;
  215. ib->ib.slid = 0;
  216. } else {
  217. ib->ib.dlid = htons(ntohl(opa->opa.dlid));
  218. ib->ib.slid = htons(ntohl(opa->opa.slid));
  219. }
  220. ib->service_id = opa->service_id;
  221. ib->ib.raw_traffic = opa->opa.raw_traffic;
  222. }
  223. static inline void path_conv_ib_to_opa(struct sa_path_rec *opa,
  224. struct sa_path_rec *ib)
  225. {
  226. __be32 slid, dlid;
  227. if ((ib_is_opa_gid(&ib->sgid)) ||
  228. (ib_is_opa_gid(&ib->dgid))) {
  229. slid = htonl(opa_get_lid_from_gid(&ib->sgid));
  230. dlid = htonl(opa_get_lid_from_gid(&ib->dgid));
  231. } else {
  232. slid = htonl(ntohs(ib->ib.slid));
  233. dlid = htonl(ntohs(ib->ib.dlid));
  234. }
  235. opa->opa.slid = slid;
  236. opa->opa.dlid = dlid;
  237. opa->service_id = ib->service_id;
  238. opa->opa.raw_traffic = ib->ib.raw_traffic;
  239. }
  240. /* Convert from OPA to IB path record */
  241. static inline void sa_convert_path_opa_to_ib(struct sa_path_rec *dest,
  242. struct sa_path_rec *src)
  243. {
  244. if (src->rec_type != SA_PATH_REC_TYPE_OPA)
  245. return;
  246. *dest = *src;
  247. dest->rec_type = SA_PATH_REC_TYPE_IB;
  248. path_conv_opa_to_ib(dest, src);
  249. }
  250. /* Convert from IB to OPA path record */
  251. static inline void sa_convert_path_ib_to_opa(struct sa_path_rec *dest,
  252. struct sa_path_rec *src)
  253. {
  254. if (src->rec_type != SA_PATH_REC_TYPE_IB)
  255. return;
  256. /* Do a structure copy and overwrite the relevant fields */
  257. *dest = *src;
  258. dest->rec_type = SA_PATH_REC_TYPE_OPA;
  259. path_conv_ib_to_opa(dest, src);
  260. }
  261. #define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0)
  262. #define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1)
  263. #define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2)
  264. #define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3)
  265. #define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4)
  266. #define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5)
  267. #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6)
  268. #define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7)
  269. #define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8)
  270. #define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9)
  271. #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10)
  272. #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11)
  273. #define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12)
  274. #define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13)
  275. #define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14)
  276. #define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15)
  277. #define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16)
  278. #define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17)
  279. struct ib_sa_mcmember_rec {
  280. union ib_gid mgid;
  281. union ib_gid port_gid;
  282. __be32 qkey;
  283. __be16 mlid;
  284. u8 mtu_selector;
  285. u8 mtu;
  286. u8 traffic_class;
  287. __be16 pkey;
  288. u8 rate_selector;
  289. u8 rate;
  290. u8 packet_life_time_selector;
  291. u8 packet_life_time;
  292. u8 sl;
  293. __be32 flow_label;
  294. u8 hop_limit;
  295. u8 scope;
  296. u8 join_state;
  297. u8 proxy_join;
  298. };
  299. /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */
  300. #define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0)
  301. #define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1)
  302. #define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2)
  303. /* reserved: 3 */
  304. #define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4)
  305. #define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5)
  306. #define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6)
  307. #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7)
  308. #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8)
  309. #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9)
  310. #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10)
  311. #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11)
  312. #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12)
  313. #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13)
  314. #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14)
  315. #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15)
  316. #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16)
  317. #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17)
  318. #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18)
  319. #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19)
  320. #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20)
  321. #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21)
  322. #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22)
  323. #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23)
  324. #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24)
  325. #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25)
  326. #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26)
  327. #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27)
  328. #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28)
  329. #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29)
  330. #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30)
  331. #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31)
  332. #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32)
  333. #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33)
  334. #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34)
  335. #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35)
  336. #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36)
  337. #define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF
  338. #define IB_SA_GUIDINFO_REC_LID IB_SA_COMP_MASK(0)
  339. #define IB_SA_GUIDINFO_REC_BLOCK_NUM IB_SA_COMP_MASK(1)
  340. #define IB_SA_GUIDINFO_REC_RES1 IB_SA_COMP_MASK(2)
  341. #define IB_SA_GUIDINFO_REC_RES2 IB_SA_COMP_MASK(3)
  342. #define IB_SA_GUIDINFO_REC_GID0 IB_SA_COMP_MASK(4)
  343. #define IB_SA_GUIDINFO_REC_GID1 IB_SA_COMP_MASK(5)
  344. #define IB_SA_GUIDINFO_REC_GID2 IB_SA_COMP_MASK(6)
  345. #define IB_SA_GUIDINFO_REC_GID3 IB_SA_COMP_MASK(7)
  346. #define IB_SA_GUIDINFO_REC_GID4 IB_SA_COMP_MASK(8)
  347. #define IB_SA_GUIDINFO_REC_GID5 IB_SA_COMP_MASK(9)
  348. #define IB_SA_GUIDINFO_REC_GID6 IB_SA_COMP_MASK(10)
  349. #define IB_SA_GUIDINFO_REC_GID7 IB_SA_COMP_MASK(11)
  350. struct ib_sa_guidinfo_rec {
  351. __be16 lid;
  352. u8 block_num;
  353. /* reserved */
  354. u8 res1;
  355. __be32 res2;
  356. u8 guid_info_list[64];
  357. };
  358. struct ib_sa_client {
  359. atomic_t users;
  360. struct completion comp;
  361. };
  362. /**
  363. * ib_sa_register_client - Register an SA client.
  364. */
  365. void ib_sa_register_client(struct ib_sa_client *client);
  366. /**
  367. * ib_sa_unregister_client - Deregister an SA client.
  368. * @client: Client object to deregister.
  369. */
  370. void ib_sa_unregister_client(struct ib_sa_client *client);
  371. struct ib_sa_query;
  372. void ib_sa_cancel_query(int id, struct ib_sa_query *query);
  373. int ib_sa_path_rec_get(struct ib_sa_client *client, struct ib_device *device,
  374. u32 port_num, struct sa_path_rec *rec,
  375. ib_sa_comp_mask comp_mask, unsigned long timeout_ms,
  376. gfp_t gfp_mask,
  377. void (*callback)(int status, struct sa_path_rec *resp,
  378. int num_prs, void *context),
  379. void *context, struct ib_sa_query **query);
  380. struct ib_sa_multicast {
  381. struct ib_sa_mcmember_rec rec;
  382. ib_sa_comp_mask comp_mask;
  383. int (*callback)(int status,
  384. struct ib_sa_multicast *multicast);
  385. void *context;
  386. };
  387. /**
  388. * ib_sa_join_multicast - Initiates a join request to the specified multicast
  389. * group.
  390. * @client: SA client
  391. * @device: Device associated with the multicast group.
  392. * @port_num: Port on the specified device to associate with the multicast
  393. * group.
  394. * @rec: SA multicast member record specifying group attributes.
  395. * @comp_mask: Component mask indicating which group attributes of %rec are
  396. * valid.
  397. * @gfp_mask: GFP mask for memory allocations.
  398. * @callback: User callback invoked once the join operation completes.
  399. * @context: User specified context stored with the ib_sa_multicast structure.
  400. *
  401. * This call initiates a multicast join request with the SA for the specified
  402. * multicast group. If the join operation is started successfully, it returns
  403. * an ib_sa_multicast structure that is used to track the multicast operation.
  404. * Users must free this structure by calling ib_free_multicast, even if the
  405. * join operation later fails. (The callback status is non-zero.)
  406. *
  407. * If the join operation fails; status will be non-zero, with the following
  408. * failures possible:
  409. * -ETIMEDOUT: The request timed out.
  410. * -EIO: An error occurred sending the query.
  411. * -EINVAL: The MCMemberRecord values differed from the existing group's.
  412. * -ENETRESET: Indicates that an fatal error has occurred on the multicast
  413. * group, and the user must rejoin the group to continue using it.
  414. */
  415. struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client,
  416. struct ib_device *device,
  417. u32 port_num,
  418. struct ib_sa_mcmember_rec *rec,
  419. ib_sa_comp_mask comp_mask, gfp_t gfp_mask,
  420. int (*callback)(int status,
  421. struct ib_sa_multicast
  422. *multicast),
  423. void *context);
  424. /**
  425. * ib_free_multicast - Frees the multicast tracking structure, and releases
  426. * any reference on the multicast group.
  427. * @multicast: Multicast tracking structure allocated by ib_join_multicast.
  428. *
  429. * This call blocks until the multicast identifier is destroyed. It may
  430. * not be called from within the multicast callback; however, returning a non-
  431. * zero value from the callback will result in destroying the multicast
  432. * tracking structure.
  433. */
  434. void ib_sa_free_multicast(struct ib_sa_multicast *multicast);
  435. /**
  436. * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and
  437. * returns it if found.
  438. * @device: Device associated with the multicast group.
  439. * @port_num: Port on the specified device to associate with the multicast
  440. * group.
  441. * @mgid: MGID of multicast group.
  442. * @rec: Location to copy SA multicast member record.
  443. */
  444. int ib_sa_get_mcmember_rec(struct ib_device *device, u32 port_num,
  445. union ib_gid *mgid, struct ib_sa_mcmember_rec *rec);
  446. /**
  447. * ib_init_ah_from_mcmember - Initialize address handle attributes based on
  448. * an SA multicast member record.
  449. */
  450. int ib_init_ah_from_mcmember(struct ib_device *device, u32 port_num,
  451. struct ib_sa_mcmember_rec *rec,
  452. struct net_device *ndev,
  453. enum ib_gid_type gid_type,
  454. struct rdma_ah_attr *ah_attr);
  455. int ib_init_ah_attr_from_path(struct ib_device *device, u32 port_num,
  456. struct sa_path_rec *rec,
  457. struct rdma_ah_attr *ah_attr,
  458. const struct ib_gid_attr *sgid_attr);
  459. /**
  460. * ib_sa_pack_path - Conert a path record from struct ib_sa_path_rec
  461. * to IB MAD wire format.
  462. */
  463. void ib_sa_pack_path(struct sa_path_rec *rec, void *attribute);
  464. /**
  465. * ib_sa_unpack_path - Convert a path record from MAD format to struct
  466. * ib_sa_path_rec.
  467. */
  468. void ib_sa_unpack_path(void *attribute, struct sa_path_rec *rec);
  469. /* Support GuidInfoRecord */
  470. int ib_sa_guid_info_rec_query(struct ib_sa_client *client,
  471. struct ib_device *device, u32 port_num,
  472. struct ib_sa_guidinfo_rec *rec,
  473. ib_sa_comp_mask comp_mask, u8 method,
  474. unsigned long timeout_ms, gfp_t gfp_mask,
  475. void (*callback)(int status,
  476. struct ib_sa_guidinfo_rec *resp,
  477. void *context),
  478. void *context, struct ib_sa_query **sa_query);
  479. static inline bool sa_path_is_roce(struct sa_path_rec *rec)
  480. {
  481. return ((rec->rec_type == SA_PATH_REC_TYPE_ROCE_V1) ||
  482. (rec->rec_type == SA_PATH_REC_TYPE_ROCE_V2));
  483. }
  484. static inline bool sa_path_is_opa(struct sa_path_rec *rec)
  485. {
  486. return (rec->rec_type == SA_PATH_REC_TYPE_OPA);
  487. }
  488. static inline void sa_path_set_slid(struct sa_path_rec *rec, u32 slid)
  489. {
  490. if (rec->rec_type == SA_PATH_REC_TYPE_IB)
  491. rec->ib.slid = cpu_to_be16(slid);
  492. else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
  493. rec->opa.slid = cpu_to_be32(slid);
  494. }
  495. static inline void sa_path_set_dlid(struct sa_path_rec *rec, u32 dlid)
  496. {
  497. if (rec->rec_type == SA_PATH_REC_TYPE_IB)
  498. rec->ib.dlid = cpu_to_be16(dlid);
  499. else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
  500. rec->opa.dlid = cpu_to_be32(dlid);
  501. }
  502. static inline void sa_path_set_raw_traffic(struct sa_path_rec *rec,
  503. u8 raw_traffic)
  504. {
  505. if (rec->rec_type == SA_PATH_REC_TYPE_IB)
  506. rec->ib.raw_traffic = raw_traffic;
  507. else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
  508. rec->opa.raw_traffic = raw_traffic;
  509. }
  510. static inline __be32 sa_path_get_slid(struct sa_path_rec *rec)
  511. {
  512. if (rec->rec_type == SA_PATH_REC_TYPE_IB)
  513. return htonl(ntohs(rec->ib.slid));
  514. else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
  515. return rec->opa.slid;
  516. return 0;
  517. }
  518. static inline __be32 sa_path_get_dlid(struct sa_path_rec *rec)
  519. {
  520. if (rec->rec_type == SA_PATH_REC_TYPE_IB)
  521. return htonl(ntohs(rec->ib.dlid));
  522. else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
  523. return rec->opa.dlid;
  524. return 0;
  525. }
  526. static inline u8 sa_path_get_raw_traffic(struct sa_path_rec *rec)
  527. {
  528. if (rec->rec_type == SA_PATH_REC_TYPE_IB)
  529. return rec->ib.raw_traffic;
  530. else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
  531. return rec->opa.raw_traffic;
  532. return 0;
  533. }
  534. static inline void sa_path_set_dmac(struct sa_path_rec *rec, u8 *dmac)
  535. {
  536. if (sa_path_is_roce(rec))
  537. memcpy(rec->roce.dmac, dmac, ETH_ALEN);
  538. }
  539. static inline void sa_path_set_dmac_zero(struct sa_path_rec *rec)
  540. {
  541. if (sa_path_is_roce(rec))
  542. eth_zero_addr(rec->roce.dmac);
  543. }
  544. static inline u8 *sa_path_get_dmac(struct sa_path_rec *rec)
  545. {
  546. if (sa_path_is_roce(rec))
  547. return rec->roce.dmac;
  548. return NULL;
  549. }
  550. #endif /* IB_SA_H */