007b4d1ac711b984df25b169abe0783d2265835d
[people/sha0/gpxe.git] / src / net / infiniband / ib_sma.c
1 /*
2  * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 FILE_LICENCE ( GPL2_OR_LATER );
20
21 #include <stdint.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <stdio.h>
26 #include <unistd.h>
27 #include <byteswap.h>
28 #include <gpxe/infiniband.h>
29 #include <gpxe/iobuf.h>
30 #include <gpxe/ib_sma.h>
31
32 /**
33  * @file
34  *
35  * Infiniband Subnet Management Agent
36  *
37  */
38
39 /**
40  * Get node information
41  *
42  * @v sma               Subnet management agent
43  * @v get               Attribute to get
44  */
45 static void ib_sma_get_node_info ( struct ib_sma *sma,
46                                    union ib_smp_data *get ) {
47         struct ib_device *ibdev = sma->ibdev;
48         struct ib_node_info *node_info = &get->node_info;
49
50         memset ( node_info, 0, sizeof ( *node_info ) );
51         node_info->base_version = IB_MGMT_BASE_VERSION;
52         node_info->class_version = IB_SMP_CLASS_VERSION;
53         node_info->node_type = IB_NODE_TYPE_HCA;
54         node_info->num_ports = ib_get_hca_info ( ibdev, &node_info->sys_guid );
55         memcpy ( &node_info->node_guid, &node_info->sys_guid,
56                  sizeof ( node_info->node_guid ) );
57         memcpy ( &node_info->port_guid, &ibdev->gid.u.half[1],
58                  sizeof ( node_info->port_guid ) );
59         node_info->partition_cap = htons ( 1 );
60         node_info->local_port_num = ibdev->port;
61 }
62
63 /**
64  * Get node description
65  *
66  * @v sma               Subnet management agent
67  * @v get               Attribute to get
68  */
69 static void ib_sma_get_node_desc ( struct ib_sma *sma,
70                                    union ib_smp_data *get ) {
71         struct ib_device *ibdev = sma->ibdev;
72         struct ib_node_desc *node_desc = &get->node_desc;
73         struct ib_gid_half *guid = &ibdev->gid.u.half[1];
74
75         memset ( node_desc, 0, sizeof ( *node_desc ) );
76         snprintf ( node_desc->node_string, sizeof ( node_desc->node_string ),
77                    "gPXE %02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x (%s)",
78                    guid->bytes[0], guid->bytes[1], guid->bytes[2],
79                    guid->bytes[3], guid->bytes[4], guid->bytes[5],
80                    guid->bytes[6], guid->bytes[7], ibdev->dev->name );
81 }
82
83 /**
84  * Get GUID information
85  *
86  * @v sma               Subnet management agent
87  * @v get               Attribute to get
88  */
89 static void ib_sma_get_guid_info ( struct ib_sma *sma,
90                                    union ib_smp_data *get ) {
91         struct ib_device *ibdev = sma->ibdev;
92         struct ib_guid_info *guid_info = &get->guid_info;
93
94         memset ( guid_info, 0, sizeof ( *guid_info ) );
95         memcpy ( guid_info->guid[0], &ibdev->gid.u.half[1],
96                  sizeof ( guid_info->guid[0] ) );
97 }
98
99 /**
100  * Get port information
101  *
102  * @v sma               Subnet management agent
103  * @v get               Attribute to get
104  */
105 static void ib_sma_get_port_info ( struct ib_sma *sma,
106                                    union ib_smp_data *get ) {
107         struct ib_device *ibdev = sma->ibdev;
108         struct ib_port_info *port_info = &get->port_info;
109
110         memset ( port_info, 0, sizeof ( *port_info ) );
111         memcpy ( port_info->gid_prefix, &ibdev->gid.u.half[0],
112                  sizeof ( port_info->gid_prefix ) );
113         port_info->lid = ntohs ( ibdev->lid );
114         port_info->mastersm_lid = ntohs ( ibdev->sm_lid );
115         port_info->local_port_num = ibdev->port;
116         port_info->link_width_enabled = ibdev->link_width;
117         port_info->link_width_supported = ibdev->link_width;
118         port_info->link_width_active = ibdev->link_width;
119         port_info->link_speed_supported__port_state =
120                 ( ( ibdev->link_speed << 4 ) | ibdev->port_state );
121         port_info->port_phys_state__link_down_def_state =
122                 ( ( IB_PORT_PHYS_STATE_POLLING << 4 ) |
123                   IB_PORT_PHYS_STATE_POLLING );
124         port_info->link_speed_active__link_speed_enabled =
125                 ( ( ibdev->link_speed << 4 ) | ibdev->link_speed );
126         port_info->neighbour_mtu__mastersm_sl =
127                 ( ( IB_MTU_2048 << 4 ) | ibdev->sm_sl );
128         port_info->vl_cap__init_type = ( IB_VL_0 << 4 );
129         port_info->init_type_reply__mtu_cap = IB_MTU_2048;
130         port_info->operational_vls__enforcement = ( IB_VL_0 << 4 );
131         port_info->guid_cap = 1;
132 }
133
134 /**
135  * Set port information
136  *
137  * @v sma               Subnet management agent
138  * @v set               Attribute to set
139  * @ret rc              Return status code
140  */
141 static int ib_sma_set_port_info ( struct ib_sma *sma,
142                                   const union ib_smp_data *set ) {
143         struct ib_device *ibdev = sma->ibdev;
144         const struct ib_port_info *port_info = &set->port_info;
145
146         memcpy ( &ibdev->gid.u.half[0], port_info->gid_prefix,
147                  sizeof ( ibdev->gid.u.half[0] ) );
148         ibdev->lid = ntohs ( port_info->lid );
149         ibdev->sm_lid = ntohs ( port_info->mastersm_lid );
150         ibdev->sm_sl = ( port_info->neighbour_mtu__mastersm_sl & 0xf );
151
152         if ( ! sma->op->set_port_info ) {
153                 /* Not an error; we just ignore all other settings */
154                 return 0;
155         }
156
157         return sma->op->set_port_info ( ibdev, port_info );
158 }
159
160 /**
161  * Get partition key table
162  *
163  * @v sma               Subnet management agent
164  * @v get               Attribute to get
165  */
166 static void ib_sma_get_pkey_table ( struct ib_sma *sma,
167                                     union ib_smp_data *get ) {
168         struct ib_device *ibdev = sma->ibdev;
169         struct ib_pkey_table *pkey_table = &get->pkey_table;
170
171         memset ( pkey_table, 0, sizeof ( *pkey_table ) );
172         pkey_table->pkey[0] = htons ( ibdev->pkey );
173 }
174
175 /**
176  * Set partition key table
177  *
178  * @v sma               Subnet management agent
179  * @v set               Attribute to set
180  */
181 static int ib_sma_set_pkey_table ( struct ib_sma *sma,
182                                    const union ib_smp_data *get ) {
183         struct ib_device *ibdev = sma->ibdev;
184         const struct ib_pkey_table *pkey_table = &get->pkey_table;
185
186         ibdev->pkey = ntohs ( pkey_table->pkey[0] );
187         return 0;
188 }
189
190 /** An attribute handler */
191 struct ib_sma_handler {
192         /** Attribute (in network byte order) */
193         uint16_t attr_id;
194         /** Get attribute
195          *
196          * @v sma       Subnet management agent
197          * @v get       Attribute to get
198          * @ret rc      Return status code
199          */
200         void ( * get ) ( struct ib_sma *sma, union ib_smp_data *get );
201         /** Set attribute
202          *
203          * @v sma       Subnet management agent
204          * @v set       Attribute to set
205          * @ret rc      Return status code
206          */
207         int ( * set ) ( struct ib_sma *sma, const union ib_smp_data *set );
208 };
209
210 /** List of attribute handlers */
211 static struct ib_sma_handler ib_sma_handlers[] = {
212         { htons ( IB_SMP_ATTR_NODE_DESC ),
213           ib_sma_get_node_desc, NULL },
214         { htons ( IB_SMP_ATTR_NODE_INFO ),
215           ib_sma_get_node_info, NULL },
216         { htons ( IB_SMP_ATTR_GUID_INFO ),
217           ib_sma_get_guid_info, NULL },
218         { htons ( IB_SMP_ATTR_PORT_INFO ),
219           ib_sma_get_port_info, ib_sma_set_port_info },
220         { htons ( IB_SMP_ATTR_PKEY_TABLE ),
221           ib_sma_get_pkey_table, ib_sma_set_pkey_table },
222 };
223
224 /**
225  * Identify attribute handler
226  *
227  * @v attr_id           Attribute ID (in network byte order)
228  * @ret handler         Attribute handler (or NULL)
229  */
230 static struct ib_sma_handler * ib_sma_handler ( uint16_t attr_id ) {
231         struct ib_sma_handler *handler;
232         unsigned int i;
233
234         for ( i = 0 ; i < ( sizeof ( ib_sma_handlers ) /
235                             sizeof ( ib_sma_handlers[0] ) ) ; i++ ) {
236                 handler = &ib_sma_handlers[i];
237                 if ( handler->attr_id == attr_id )
238                         return handler;
239         }
240
241         return NULL;
242 }
243
244 /**
245  * Respond to management datagram
246  *
247  * @v sma               Subnet management agent
248  * @v mad               Management datagram
249  * @ret rc              Return status code
250  */
251 static int ib_sma_mad ( struct ib_sma *sma, union ib_mad *mad ) {
252         struct ib_device *ibdev = sma->ibdev;
253         struct ib_mad_hdr *hdr = &mad->hdr;
254         struct ib_mad_smp *smp = &mad->smp;
255         struct ib_sma_handler *handler = NULL;
256         unsigned int hop_pointer;
257         unsigned int hop_count;
258         int rc;
259
260         DBGC ( sma, "SMA %p received SMP with bv=%02x mc=%02x cv=%02x "
261                "meth=%02x attr=%04x mod=%08x\n", sma, hdr->base_version,
262                hdr->mgmt_class, hdr->class_version, hdr->method,
263                ntohs ( hdr->attr_id ), ntohl ( hdr->attr_mod ) );
264         DBGC2_HDA ( sma, 0, mad, sizeof ( *mad ) );
265
266         /* Sanity checks */
267         if ( hdr->base_version != IB_MGMT_BASE_VERSION ) {
268                 DBGC ( sma, "SMA %p unsupported base version %x\n",
269                        sma, hdr->base_version );
270                 return -ENOTSUP;
271         }
272         if ( ( hdr->mgmt_class != IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE ) &&
273              ( hdr->mgmt_class != IB_MGMT_CLASS_SUBN_LID_ROUTED ) ) {
274                 DBGC ( sma, "SMA %p unsupported management class %x\n",
275                        sma, hdr->mgmt_class );
276                 return -ENOTSUP;
277         }
278         if ( hdr->class_version != IB_SMP_CLASS_VERSION ) {
279                 DBGC ( sma, "SMA %p unsupported class version %x\n",
280                        sma, hdr->class_version );
281                 return -ENOTSUP;
282         }
283         if ( ( hdr->method != IB_MGMT_METHOD_GET ) &&
284              ( hdr->method != IB_MGMT_METHOD_SET ) ) {
285                 DBGC ( sma, "SMA %p unsupported method %x\n",
286                        sma, hdr->method );
287                 return -ENOTSUP;
288         }
289
290         /* Identify handler */
291         if ( ! ( handler = ib_sma_handler ( hdr->attr_id ) ) ) {
292                 DBGC ( sma, "SMA %p unsupported attribute %x\n",
293                        sma, ntohs ( hdr->attr_id ) );
294                 hdr->status = htons ( IB_MGMT_STATUS_UNSUPPORTED_METHOD_ATTR );
295                 goto respond_without_data;
296         }
297
298         /* Set attribute (if applicable) */
299         if ( hdr->method != IB_MGMT_METHOD_SET ) {
300                 hdr->status = htons ( IB_MGMT_STATUS_OK );
301                 goto respond;
302         }
303         if ( ! handler->set ) {
304                 DBGC ( sma, "SMA %p attribute %x is unsettable\n",
305                        sma, ntohs ( hdr->attr_id ) );
306                 hdr->status = htons ( IB_MGMT_STATUS_UNSUPPORTED_METHOD_ATTR );
307                 goto respond;
308         }
309         if ( ( rc = handler->set ( sma, &smp->smp_data ) ) != 0 ) {
310                 DBGC ( sma, "SMA %p could not set attribute %x: %s\n",
311                        sma, ntohs ( hdr->attr_id ), strerror ( rc ) );
312                 hdr->status = htons ( IB_MGMT_STATUS_UNSUPPORTED_METHOD_ATTR );
313                 goto respond;
314         }
315
316         hdr->status = htons ( IB_MGMT_STATUS_OK );
317
318  respond:
319         /* Get attribute */
320         handler->get ( sma, &smp->smp_data );
321
322  respond_without_data:
323
324         /* Set method to "Get Response" */
325         hdr->method = IB_MGMT_METHOD_GET_RESP;
326
327         /* Set response fields for directed route SMPs */
328         if ( hdr->mgmt_class == IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE ) {
329                 hdr->status |= htons ( IB_SMP_STATUS_D_INBOUND );
330                 hop_pointer = smp->mad_hdr.class_specific.smp.hop_pointer;
331                 hop_count = smp->mad_hdr.class_specific.smp.hop_count;
332                 assert ( hop_count == hop_pointer );
333                 if ( hop_pointer < ( sizeof ( smp->return_path.hops ) /
334                                      sizeof ( smp->return_path.hops[0] ) ) ) {
335                         smp->return_path.hops[hop_pointer] = ibdev->port;
336                 } else {
337                         DBGC ( sma, "SMA %p invalid hop pointer %d\n",
338                                sma, hop_pointer );
339                         return -EINVAL;
340                 }
341         }
342
343         DBGC ( sma, "SMA %p responding with status=%04x\n",
344                sma, ntohs ( hdr->status ) );
345         DBGC2_HDA ( sma, 0, mad, sizeof ( *mad ) );
346
347         return 0;
348 }
349
350 /**
351  * Complete SMA send
352  *
353  *
354  * @v ibdev             Infiniband device
355  * @v qp                Queue pair
356  * @v iobuf             I/O buffer
357  * @v rc                Completion status code
358  */
359 static void ib_sma_complete_send ( struct ib_device *ibdev __unused,
360                                    struct ib_queue_pair *qp,
361                                    struct io_buffer *iobuf, int rc ) {
362         struct ib_sma *sma = ib_qp_get_ownerdata ( qp );
363
364         if ( rc != 0 ) {
365                 DBGC ( sma, "SMA %p send completion error: %s\n",
366                        sma, strerror ( rc ) );
367         }
368         free_iob ( iobuf );
369 }
370
371 /**
372  * Complete SMA receive
373  *
374  *
375  * @v ibdev             Infiniband device
376  * @v qp                Queue pair
377  * @v av                Address vector
378  * @v iobuf             I/O buffer
379  * @v rc                Completion status code
380  */
381 static void ib_sma_complete_recv ( struct ib_device *ibdev,
382                                    struct ib_queue_pair *qp,
383                                    struct ib_address_vector *av,
384                                    struct io_buffer *iobuf, int rc ) {
385         struct ib_sma *sma = ib_qp_get_ownerdata ( qp );
386         union ib_mad *mad;
387
388         /* Ignore errors */
389         if ( rc != 0 ) {
390                 DBGC ( sma, "SMA %p RX error: %s\n", sma, strerror ( rc ) );
391                 goto err;
392         }
393
394         /* Sanity check */
395         if ( iob_len ( iobuf ) != sizeof ( *mad ) ) {
396                 DBGC ( sma, "SMA %p RX bad size (%zd bytes)\n",
397                        sma, iob_len ( iobuf ) );
398                 goto err;
399         }
400         mad = iobuf->data;
401
402         /* Construct MAD response */
403         if ( ( rc = ib_sma_mad ( sma, mad ) ) != 0 ) {
404                 DBGC ( sma, "SMA %p could not construct MAD response: %s\n",
405                        sma, strerror ( rc ) );
406                 goto err;
407         }
408
409         /* Send MAD response */
410         if ( ( rc = ib_post_send ( ibdev, qp, av, iobuf ) ) != 0 ) {
411                 DBGC ( sma, "SMA %p could not send MAD response: %s\n",
412                        sma, strerror ( rc ) );
413                 goto err;
414         }
415
416         return;
417
418  err:
419         free_iob ( iobuf );
420 }
421
422 /** SMA completion operations */
423 static struct ib_completion_queue_operations ib_sma_completion_ops = {
424         .complete_send = ib_sma_complete_send,
425         .complete_recv = ib_sma_complete_recv,
426 };
427
428 /**
429  * Create SMA
430  *
431  * @v sma               Subnet management agent
432  * @v ibdev             Infiniband device
433  * @v op                Subnet management operations
434  * @ret rc              Return status code
435  */
436 int ib_create_sma ( struct ib_sma *sma, struct ib_device *ibdev,
437                     struct ib_sma_operations *op ) {
438         int rc;
439
440         /* Initialise fields */
441         memset ( sma, 0, sizeof ( *sma ) );
442         sma->ibdev = ibdev;
443         sma->op = op;
444
445         /* Create completion queue */
446         sma->cq = ib_create_cq ( ibdev, IB_SMA_NUM_CQES,
447                                  &ib_sma_completion_ops );
448         if ( ! sma->cq ) {
449                 rc = -ENOMEM;
450                 goto err_create_cq;
451         }
452
453         /* Create queue pair */
454         sma->qp = ib_create_qp ( ibdev, IB_SMA_NUM_SEND_WQES, sma->cq,
455                                  IB_SMA_NUM_RECV_WQES, sma->cq, 0 );
456         if ( ! sma->qp ) {
457                 rc = -ENOMEM;
458                 goto err_create_qp;
459         }
460         ib_qp_set_ownerdata ( sma->qp, sma );
461
462         /* If we don't get QP0, we can't function */
463         if ( sma->qp->qpn != IB_QPN_SMA ) {
464                 DBGC ( sma, "SMA %p on QPN %lx, needs to be on QPN 0\n",
465                        sma, sma->qp->qpn );
466                 rc = -ENOTSUP;
467                 goto err_not_qp0;
468         }
469
470         /* Fill receive ring */
471         ib_refill_recv ( ibdev, sma->qp );
472         return 0;
473
474  err_not_qp0:
475         ib_destroy_qp ( ibdev, sma->qp );
476  err_create_qp:
477         ib_destroy_cq ( ibdev, sma->cq );
478  err_create_cq:
479         return rc;
480 }
481
482 /**
483  * Destroy SMA
484  *
485  * @v sma               Subnet management agent
486  */
487 void ib_destroy_sma ( struct ib_sma *sma ) {
488         struct ib_device *ibdev = sma->ibdev;
489
490         ib_destroy_qp ( ibdev, sma->qp );
491         ib_destroy_cq ( ibdev, sma->cq );
492 }