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