LXR linux/include/rdma/ib

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