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