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