1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3 *
4 * Copyright (c) 2004 Topspin Communications. All rights reserved.
5 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
6 * Copyright (c) 2006 Intel Corporation. All rights reserved.
7 *
8 * This software is available to you under a choice of one of two
9 * licenses. You may choose to be licensed under the terms of the GNU
10 * General Public License (GPL) Version 2, available from the file
11 * COPYING in the main directory of this source tree, or the
12 * OpenIB.org BSD license below:
13 *
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
16 * conditions are met:
17 *
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer.
21 *
22 * - Redistributions in binary form must reproduce the above
23 * copyright notice, this list of conditions and the following
24 * disclaimer in the documentation and/or other materials
25 * provided with the distribution.
26 *
27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
29 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
31 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
32 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
33 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 * SOFTWARE.
35 *
36 * $FreeBSD$
37 */
38
39 #ifndef IB_SA_H
40 #define IB_SA_H
41
42 #include <linux/completion.h>
43 #include <linux/compiler.h>
44 #include <linux/netdevice.h>
45
46 #include <rdma/ib_addr_freebsd.h>
47 #include <rdma/ib_verbs.h>
48 #include <rdma/ib_mad.h>
49
50 enum {
51 IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */
52
53 IB_SA_METHOD_GET_TABLE = 0x12,
54 IB_SA_METHOD_GET_TABLE_RESP = 0x92,
55 IB_SA_METHOD_DELETE = 0x15,
56 IB_SA_METHOD_DELETE_RESP = 0x95,
57 IB_SA_METHOD_GET_MULTI = 0x14,
58 IB_SA_METHOD_GET_MULTI_RESP = 0x94,
59 IB_SA_METHOD_GET_TRACE_TBL = 0x13
60 };
61
62 enum {
63 IB_SA_ATTR_CLASS_PORTINFO = 0x01,
64 IB_SA_ATTR_NOTICE = 0x02,
65 IB_SA_ATTR_INFORM_INFO = 0x03,
66 IB_SA_ATTR_NODE_REC = 0x11,
67 IB_SA_ATTR_PORT_INFO_REC = 0x12,
68 IB_SA_ATTR_SL2VL_REC = 0x13,
69 IB_SA_ATTR_SWITCH_REC = 0x14,
70 IB_SA_ATTR_LINEAR_FDB_REC = 0x15,
71 IB_SA_ATTR_RANDOM_FDB_REC = 0x16,
72 IB_SA_ATTR_MCAST_FDB_REC = 0x17,
73 IB_SA_ATTR_SM_INFO_REC = 0x18,
74 IB_SA_ATTR_LINK_REC = 0x20,
75 IB_SA_ATTR_GUID_INFO_REC = 0x30,
76 IB_SA_ATTR_SERVICE_REC = 0x31,
77 IB_SA_ATTR_PARTITION_REC = 0x33,
78 IB_SA_ATTR_PATH_REC = 0x35,
79 IB_SA_ATTR_VL_ARB_REC = 0x36,
80 IB_SA_ATTR_MC_MEMBER_REC = 0x38,
81 IB_SA_ATTR_TRACE_REC = 0x39,
82 IB_SA_ATTR_MULTI_PATH_REC = 0x3a,
83 IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b,
84 IB_SA_ATTR_INFORM_INFO_REC = 0xf3
85 };
86
87 enum ib_sa_selector {
88 IB_SA_GT = 0,
89 IB_SA_LT = 1,
90 IB_SA_EQ = 2,
91 /*
92 * The meaning of "best" depends on the attribute: for
93 * example, for MTU best will return the largest available
94 * MTU, while for packet life time, best will return the
95 * smallest available life time.
96 */
97 IB_SA_BEST = 3
98 };
99
100 /*
101 * There are 4 types of join states:
102 * FullMember, NonMember, SendOnlyNonMember, SendOnlyFullMember.
103 * The order corresponds to JoinState bits in MCMemberRecord.
104 */
105 enum ib_sa_mc_join_states {
106 FULLMEMBER_JOIN,
107 NONMEMBER_JOIN,
108 SENDONLY_NONMEBER_JOIN,
109 SENDONLY_FULLMEMBER_JOIN,
110 NUM_JOIN_MEMBERSHIP_TYPES,
111 };
112
113 #define IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT BIT(12)
114
115 /*
116 * Structures for SA records are named "struct ib_sa_xxx_rec." No
117 * attempt is made to pack structures to match the physical layout of
118 * SA records in SA MADs; all packing and unpacking is handled by the
119 * SA query code.
120 *
121 * For a record with structure ib_sa_xxx_rec, the naming convention
122 * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
123 * never use different abbreviations or otherwise change the spelling
124 * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
125 *
126 * Reserved rows are indicated with comments to help maintainability.
127 */
128
129 #define IB_SA_PATH_REC_SERVICE_ID (IB_SA_COMP_MASK( 0) |\
130 IB_SA_COMP_MASK( 1))
131 #define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2)
132 #define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3)
133 #define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4)
134 #define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5)
135 #define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6)
136 /* reserved: 7 */
137 #define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8)
138 #define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9)
139 #define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10)
140 #define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11)
141 #define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12)
142 #define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13)
143 #define IB_SA_PATH_REC_QOS_CLASS IB_SA_COMP_MASK(14)
144 #define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15)
145 #define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16)
146 #define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17)
147 #define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18)
148 #define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19)
149 #define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20)
150 #define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21)
151 #define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22)
152
153 struct ib_sa_path_rec {
154 __be64 service_id;
155 union ib_gid dgid;
156 union ib_gid sgid;
157 __be16 dlid;
158 __be16 slid;
159 int raw_traffic;
160 /* reserved */
161 __be32 flow_label;
162 u8 hop_limit;
163 u8 traffic_class;
164 int reversible;
165 u8 numb_path;
166 __be16 pkey;
167 __be16 qos_class;
168 u8 sl;
169 u8 mtu_selector;
170 u8 mtu;
171 u8 rate_selector;
172 u8 rate;
173 u8 packet_life_time_selector;
174 u8 packet_life_time;
175 u8 preference;
176 u8 dmac[ETH_ALEN];
177 /* ignored in IB */
178 int ifindex;
179 /* ignored in IB */
180 struct vnet *net;
181 enum ib_gid_type gid_type;
182 };
183
184 static inline struct ifnet *ib_get_ndev_from_path(struct ib_sa_path_rec *rec)
185 {
186 #ifdef VIMAGE
187 if (rec->net == NULL)
188 return NULL;
189 #endif
190 return dev_get_by_index(rec->net, rec->ifindex);
191 }
192
193 #define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0)
194 #define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1)
195 #define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2)
196 #define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3)
197 #define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4)
198 #define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5)
199 #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6)
200 #define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7)
201 #define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8)
202 #define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9)
203 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10)
204 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11)
205 #define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12)
206 #define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13)
207 #define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14)
208 #define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15)
209 #define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16)
210 #define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17)
211
212 struct ib_sa_mcmember_rec {
213 union ib_gid mgid;
214 union ib_gid port_gid;
215 __be32 qkey;
216 __be16 mlid;
217 u8 mtu_selector;
218 u8 mtu;
219 u8 traffic_class;
220 __be16 pkey;
221 u8 rate_selector;
222 u8 rate;
223 u8 packet_life_time_selector;
224 u8 packet_life_time;
225 u8 sl;
226 __be32 flow_label;
227 u8 hop_limit;
228 u8 scope;
229 u8 join_state;
230 int proxy_join;
231 };
232
233 /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */
234 #define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0)
235 #define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1)
236 #define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2)
237 /* reserved: 3 */
238 #define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4)
239 #define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5)
240 #define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6)
241 #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7)
242 #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8)
243 #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9)
244 #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10)
245 #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11)
246 #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12)
247 #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13)
248 #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14)
249 #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15)
250 #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16)
251 #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17)
252 #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18)
253 #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19)
254 #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20)
255 #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21)
256 #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22)
257 #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23)
258 #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24)
259 #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25)
260 #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26)
261 #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27)
262 #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28)
263 #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29)
264 #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30)
265 #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31)
266 #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32)
267 #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33)
268 #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34)
269 #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35)
270 #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36)
271
272 #define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF
273
274 struct ib_sa_service_rec {
275 u64 id;
276 union ib_gid gid;
277 __be16 pkey;
278 /* reserved */
279 u32 lease;
280 u8 key[16];
281 u8 name[64];
282 u8 data8[16];
283 u16 data16[8];
284 u32 data32[4];
285 u64 data64[2];
286 };
287
288 #define IB_SA_GUIDINFO_REC_LID IB_SA_COMP_MASK(0)
289 #define IB_SA_GUIDINFO_REC_BLOCK_NUM IB_SA_COMP_MASK(1)
290 #define IB_SA_GUIDINFO_REC_RES1 IB_SA_COMP_MASK(2)
291 #define IB_SA_GUIDINFO_REC_RES2 IB_SA_COMP_MASK(3)
292 #define IB_SA_GUIDINFO_REC_GID0 IB_SA_COMP_MASK(4)
293 #define IB_SA_GUIDINFO_REC_GID1 IB_SA_COMP_MASK(5)
294 #define IB_SA_GUIDINFO_REC_GID2 IB_SA_COMP_MASK(6)
295 #define IB_SA_GUIDINFO_REC_GID3 IB_SA_COMP_MASK(7)
296 #define IB_SA_GUIDINFO_REC_GID4 IB_SA_COMP_MASK(8)
297 #define IB_SA_GUIDINFO_REC_GID5 IB_SA_COMP_MASK(9)
298 #define IB_SA_GUIDINFO_REC_GID6 IB_SA_COMP_MASK(10)
299 #define IB_SA_GUIDINFO_REC_GID7 IB_SA_COMP_MASK(11)
300
301 struct ib_sa_guidinfo_rec {
302 __be16 lid;
303 u8 block_num;
304 /* reserved */
305 u8 res1;
306 __be32 res2;
307 u8 guid_info_list[64];
308 };
309
310 struct ib_sa_client {
311 atomic_t users;
312 struct completion comp;
313 };
314
315 /**
316 * ib_sa_register_client - Register an SA client.
317 */
318 void ib_sa_register_client(struct ib_sa_client *client);
319
320 /**
321 * ib_sa_unregister_client - Deregister an SA client.
322 * @client: Client object to deregister.
323 */
324 void ib_sa_unregister_client(struct ib_sa_client *client);
325
326 struct ib_sa_query;
327
328 void ib_sa_cancel_query(int id, struct ib_sa_query *query);
329
330 int ib_sa_path_rec_get(struct ib_sa_client *client,
331 struct ib_device *device, u8 port_num,
332 struct ib_sa_path_rec *rec,
333 ib_sa_comp_mask comp_mask,
334 int timeout_ms, gfp_t gfp_mask,
335 void (*callback)(int status,
336 struct ib_sa_path_rec *resp,
337 void *context),
338 void *context,
339 struct ib_sa_query **query);
340
341 int ib_sa_service_rec_query(struct ib_sa_client *client,
342 struct ib_device *device, u8 port_num,
343 u8 method,
344 struct ib_sa_service_rec *rec,
345 ib_sa_comp_mask comp_mask,
346 int timeout_ms, gfp_t gfp_mask,
347 void (*callback)(int status,
348 struct ib_sa_service_rec *resp,
349 void *context),
350 void *context,
351 struct ib_sa_query **sa_query);
352
353 struct ib_sa_multicast {
354 struct ib_sa_mcmember_rec rec;
355 ib_sa_comp_mask comp_mask;
356 int (*callback)(int status,
357 struct ib_sa_multicast *multicast);
358 void *context;
359 };
360
361 /**
362 * ib_sa_join_multicast - Initiates a join request to the specified multicast
363 * group.
364 * @client: SA client
365 * @device: Device associated with the multicast group.
366 * @port_num: Port on the specified device to associate with the multicast
367 * group.
368 * @rec: SA multicast member record specifying group attributes.
369 * @comp_mask: Component mask indicating which group attributes of %rec are
370 * valid.
371 * @gfp_mask: GFP mask for memory allocations.
372 * @callback: User callback invoked once the join operation completes.
373 * @context: User specified context stored with the ib_sa_multicast structure.
374 *
375 * This call initiates a multicast join request with the SA for the specified
376 * multicast group. If the join operation is started successfully, it returns
377 * an ib_sa_multicast structure that is used to track the multicast operation.
378 * Users must free this structure by calling ib_free_multicast, even if the
379 * join operation later fails. (The callback status is non-zero.)
380 *
381 * If the join operation fails; status will be non-zero, with the following
382 * failures possible:
383 * -ETIMEDOUT: The request timed out.
384 * -EIO: An error occurred sending the query.
385 * -EINVAL: The MCMemberRecord values differed from the existing group's.
386 * -ENETRESET: Indicates that an fatal error has occurred on the multicast
387 * group, and the user must rejoin the group to continue using it.
388 */
389 struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client,
390 struct ib_device *device, u8 port_num,
391 struct ib_sa_mcmember_rec *rec,
392 ib_sa_comp_mask comp_mask, gfp_t gfp_mask,
393 int (*callback)(int status,
394 struct ib_sa_multicast
395 *multicast),
396 void *context);
397
398 /**
399 * ib_free_multicast - Frees the multicast tracking structure, and releases
400 * any reference on the multicast group.
401 * @multicast: Multicast tracking structure allocated by ib_join_multicast.
402 *
403 * This call blocks until the multicast identifier is destroyed. It may
404 * not be called from within the multicast callback; however, returning a non-
405 * zero value from the callback will result in destroying the multicast
406 * tracking structure.
407 */
408 void ib_sa_free_multicast(struct ib_sa_multicast *multicast);
409
410 /**
411 * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and
412 * returns it if found.
413 * @device: Device associated with the multicast group.
414 * @port_num: Port on the specified device to associate with the multicast
415 * group.
416 * @mgid: MGID of multicast group.
417 * @rec: Location to copy SA multicast member record.
418 */
419 int ib_sa_get_mcmember_rec(struct ib_device *device, u8 port_num,
420 union ib_gid *mgid, struct ib_sa_mcmember_rec *rec);
421
422 /**
423 * ib_init_ah_from_mcmember - Initialize address handle attributes based on
424 * an SA multicast member record.
425 */
426 int ib_init_ah_from_mcmember(struct ib_device *device, u8 port_num,
427 struct ib_sa_mcmember_rec *rec,
428 struct ifnet *ndev,
429 enum ib_gid_type gid_type,
430 struct ib_ah_attr *ah_attr);
431
432 /**
433 * ib_init_ah_from_path - Initialize address handle attributes based on an SA
434 * path record.
435 */
436 int ib_init_ah_from_path(struct ib_device *device, u8 port_num,
437 struct ib_sa_path_rec *rec,
438 struct ib_ah_attr *ah_attr);
439
440 /**
441 * ib_sa_pack_path - Conert a path record from struct ib_sa_path_rec
442 * to IB MAD wire format.
443 */
444 void ib_sa_pack_path(struct ib_sa_path_rec *rec, void *attribute);
445
446 /**
447 * ib_sa_unpack_path - Convert a path record from MAD format to struct
448 * ib_sa_path_rec.
449 */
450 void ib_sa_unpack_path(void *attribute, struct ib_sa_path_rec *rec);
451
452 /* Support GuidInfoRecord */
453 int ib_sa_guid_info_rec_query(struct ib_sa_client *client,
454 struct ib_device *device, u8 port_num,
455 struct ib_sa_guidinfo_rec *rec,
456 ib_sa_comp_mask comp_mask, u8 method,
457 int timeout_ms, gfp_t gfp_mask,
458 void (*callback)(int status,
459 struct ib_sa_guidinfo_rec *resp,
460 void *context),
461 void *context,
462 struct ib_sa_query **sa_query);
463
464 /* Support get SA ClassPortInfo */
465 int ib_sa_classport_info_rec_query(struct ib_sa_client *client,
466 struct ib_device *device, u8 port_num,
467 int timeout_ms, gfp_t gfp_mask,
468 void (*callback)(int status,
469 struct ib_class_port_info *resp,
470 void *context),
471 void *context,
472 struct ib_sa_query **sa_query);
473
474 #endif /* IB_SA_H */
Cache object: df80fcb968abb06e7ca38db822da8e30
|