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