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