[infiniband] Generate more specific errors in response to failure MADs
[people/peper/gpxe.git] / src / net / infiniband / ib_cm.c
1 /*
2  * Copyright (C) 2009 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 <byteswap.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include <gpxe/infiniband.h>
28 #include <gpxe/ib_mi.h>
29 #include <gpxe/ib_pathrec.h>
30 #include <gpxe/ib_cm.h>
31
32 /**
33  * @file
34  *
35  * Infiniband communication management
36  *
37  */
38
39 /** List of connections */
40 static LIST_HEAD ( ib_cm_conns );
41
42 /**
43  * Send "ready to use" response
44  *
45  * @v ibdev             Infiniband device
46  * @v mi                Management interface
47  * @v conn              Connection
48  * @v av                Address vector
49  * @ret rc              Return status code
50  */
51 static int ib_cm_send_rtu ( struct ib_device *ibdev,
52                             struct ib_mad_interface *mi,
53                             struct ib_connection *conn,
54                             struct ib_address_vector *av ) {
55         union ib_mad mad;
56         struct ib_cm_ready_to_use *ready =
57                 &mad.cm.cm_data.ready_to_use;
58         int rc;
59
60         /* Construct "ready to use" response */
61         memset ( &mad, 0, sizeof ( mad ) );
62         mad.hdr.mgmt_class = IB_MGMT_CLASS_CM;
63         mad.hdr.class_version = IB_CM_CLASS_VERSION;
64         mad.hdr.method = IB_MGMT_METHOD_SEND;
65         mad.hdr.attr_id = htons ( IB_CM_ATTR_READY_TO_USE );
66         ready->local_id = htonl ( conn->local_id );
67         ready->remote_id = htonl ( conn->remote_id );
68         if ( ( rc = ib_mi_send ( ibdev, mi, &mad, av ) ) != 0 ){
69                 DBGC ( conn, "CM %p could not send RTU: %s\n",
70                        conn, strerror ( rc ) );
71                 return rc;
72         }
73
74         return 0;
75 }
76
77 /**
78  * Handle duplicate connection replies
79  *
80  * @v ibdev             Infiniband device
81  * @v mi                Management interface
82  * @v mad               Received MAD
83  * @v av                Source address vector
84  * @ret rc              Return status code
85  *
86  * If a "ready to use" MAD is lost, the peer may resend the connection
87  * reply.  We have to respond to these with duplicate "ready to use"
88  * MADs, otherwise the peer may time out and drop the connection.
89  */
90 static void ib_cm_connect_rep ( struct ib_device *ibdev,
91                                 struct ib_mad_interface *mi,
92                                 union ib_mad *mad,
93                                 struct ib_address_vector *av ) {
94         struct ib_cm_connect_reply *connect_rep =
95                 &mad->cm.cm_data.connect_reply;
96         struct ib_connection *conn;
97         int rc;
98
99         /* Identify connection */
100         list_for_each_entry ( conn, &ib_cm_conns, list ) {
101                 if ( ntohl ( connect_rep->remote_id ) != conn->local_id )
102                         continue;
103                 /* Try to send "ready to use" reply */
104                 if ( ( rc = ib_cm_send_rtu ( ibdev, mi, conn, av ) ) != 0 ) {
105                         /* Ignore errors */
106                         return;
107                 }
108                 return;
109         }
110
111         DBG ( "CM unidentified connection %08x\n",
112               ntohl ( connect_rep->remote_id ) );
113 }
114
115 /** Communication management agents */
116 struct ib_mad_agent ib_cm_agent[] __ib_mad_agent = {
117         {
118                 .mgmt_class = IB_MGMT_CLASS_CM,
119                 .class_version = IB_CM_CLASS_VERSION,
120                 .attr_id = htons ( IB_CM_ATTR_CONNECT_REPLY ),
121                 .handle = ib_cm_connect_rep,
122         },
123 };
124
125 /**
126  * Handle connection request transaction completion
127  *
128  * @v ibdev             Infiniband device
129  * @v mi                Management interface
130  * @v madx              Management transaction
131  * @v rc                Status code
132  * @v mad               Received MAD (or NULL on error)
133  * @v av                Source address vector (or NULL on error)
134  */
135 static void ib_cm_req_complete ( struct ib_device *ibdev,
136                                  struct ib_mad_interface *mi,
137                                  struct ib_mad_transaction *madx,
138                                  int rc, union ib_mad *mad,
139                                  struct ib_address_vector *av ) {
140         struct ib_connection *conn = ib_madx_get_ownerdata ( madx );
141         struct ib_queue_pair *qp = conn->qp;
142         struct ib_cm_common *common = &mad->cm.cm_data.common;
143         struct ib_cm_connect_reply *connect_rep =
144                 &mad->cm.cm_data.connect_reply;
145         struct ib_cm_connect_reject *connect_rej =
146                 &mad->cm.cm_data.connect_reject;
147         void *private_data = NULL;
148         size_t private_data_len = 0;
149
150         /* Report failures */
151         if ( ( rc == 0 ) && ( mad->hdr.status != htons ( IB_MGMT_STATUS_OK ) ))
152                 rc = -EIO;
153         if ( rc != 0 ) {
154                 DBGC ( conn, "CM %p connection request failed: %s\n",
155                        conn, strerror ( rc ) );
156                 goto out;
157         }
158
159         /* Record remote communication ID */
160         conn->remote_id = ntohl ( common->local_id );
161
162         /* Handle response */
163         switch ( mad->hdr.attr_id ) {
164
165         case htons ( IB_CM_ATTR_CONNECT_REPLY ) :
166                 /* Extract fields */
167                 qp->av.qpn = ( ntohl ( connect_rep->local_qpn ) >> 8 );
168                 qp->send.psn = ( ntohl ( connect_rep->starting_psn ) >> 8 );
169                 private_data = &connect_rep->private_data;
170                 private_data_len = sizeof ( connect_rep->private_data );
171                 DBGC ( conn, "CM %p connected to QPN %lx PSN %x\n",
172                        conn, qp->av.qpn, qp->send.psn );
173
174                 /* Modify queue pair */
175                 if ( ( rc = ib_modify_qp ( ibdev, qp ) ) != 0 ) {
176                         DBGC ( conn, "CM %p could not modify queue pair: %s\n",
177                                conn, strerror ( rc ) );
178                         goto out;
179                 }
180
181                 /* Send "ready to use" reply */
182                 if ( ( rc = ib_cm_send_rtu ( ibdev, mi, conn, av ) ) != 0 ) {
183                         /* Treat as non-fatal */
184                         rc = 0;
185                 }
186                 break;
187
188         case htons ( IB_CM_ATTR_CONNECT_REJECT ) :
189                 /* Extract fields */
190                 DBGC ( conn, "CM %p connection rejected (reason %d)\n",
191                        conn, ntohs ( connect_rej->reason ) );
192                 private_data = &connect_rej->private_data;
193                 private_data_len = sizeof ( connect_rej->private_data );
194                 rc = -ENOTCONN;
195                 break;
196
197         default:
198                 DBGC ( conn, "CM %p unexpected response (attribute %04x)\n",
199                        conn, ntohs ( mad->hdr.attr_id ) );
200                 rc = -ENOTSUP;
201                 break;
202         }
203
204  out:
205         /* Destroy the completed transaction */
206         ib_destroy_madx ( ibdev, ibdev->gsi, madx );
207         conn->madx = NULL;
208
209         /* Hand off to the upper completion handler */
210         conn->op->changed ( ibdev, qp, conn, rc, private_data,
211                             private_data_len );
212 }
213
214 /** Connection request operations */
215 static struct ib_mad_transaction_operations ib_cm_req_op = {
216         .complete = ib_cm_req_complete,
217 };
218
219 /**
220  * Handle connection path transaction completion
221  *
222  * @v ibdev             Infiniband device
223  * @v path              Path
224  * @v rc                Status code
225  * @v av                Address vector, or NULL on error
226  */
227 static void ib_cm_path_complete ( struct ib_device *ibdev,
228                                   struct ib_path *path, int rc,
229                                   struct ib_address_vector *av ) {
230         struct ib_connection *conn = ib_path_get_ownerdata ( path );
231         struct ib_queue_pair *qp = conn->qp;
232         union ib_mad mad;
233         struct ib_cm_connect_request *connect_req =
234                 &mad.cm.cm_data.connect_request;
235         size_t private_data_len;
236
237         /* Report failures */
238         if ( rc != 0 ) {
239                 DBGC ( conn, "CM %p path lookup failed: %s\n",
240                        conn, strerror ( rc ) );
241                 conn->op->changed ( ibdev, qp, conn, rc, NULL, 0 );
242                 goto out;
243         }
244
245         /* Update queue pair peer path */
246         memcpy ( &qp->av, av, sizeof ( qp->av ) );
247
248         /* Construct connection request */
249         memset ( &mad, 0, sizeof ( mad ) );
250         mad.hdr.mgmt_class = IB_MGMT_CLASS_CM;
251         mad.hdr.class_version = IB_CM_CLASS_VERSION;
252         mad.hdr.method = IB_MGMT_METHOD_SEND;
253         mad.hdr.attr_id = htons ( IB_CM_ATTR_CONNECT_REQUEST );
254         connect_req->local_id = htonl ( conn->local_id );
255         memcpy ( &connect_req->service_id, &conn->service_id,
256                  sizeof ( connect_req->service_id ) );
257         ib_get_hca_info ( ibdev, &connect_req->local_ca );
258         connect_req->local_qpn__responder_resources =
259                 htonl ( ( qp->qpn << 8 ) | 1 );
260         connect_req->local_eecn__initiator_depth = htonl ( ( 0 << 8 ) | 1 );
261         connect_req->remote_eecn__remote_timeout__service_type__ee_flow_ctrl =
262                 htonl ( ( 0x14 << 3 ) | ( IB_CM_TRANSPORT_RC << 1 ) |
263                         ( 0 << 0 ) );
264         connect_req->starting_psn__local_timeout__retry_count =
265                 htonl ( ( qp->recv.psn << 8 ) | ( 0x14 << 3 ) |
266                         ( 0x07 << 0 ) );
267         connect_req->pkey = htons ( ibdev->pkey );
268         connect_req->payload_mtu__rdc_exists__rnr_retry =
269                 ( ( IB_MTU_2048 << 4 ) | ( 1 << 3 ) | ( 0x07 << 0 ) );
270         connect_req->max_cm_retries__srq =
271                 ( ( 0x0f << 4 ) | ( 0 << 3 ) );
272         connect_req->primary.local_lid = htons ( ibdev->lid );
273         connect_req->primary.remote_lid = htons ( conn->qp->av.lid );
274         memcpy ( &connect_req->primary.local_gid, &ibdev->gid,
275                  sizeof ( connect_req->primary.local_gid ) );
276         memcpy ( &connect_req->primary.remote_gid, &conn->qp->av.gid,
277                  sizeof ( connect_req->primary.remote_gid ) );
278         connect_req->primary.flow_label__rate =
279                 htonl ( ( 0 << 12 ) | ( conn->qp->av.rate << 0 ) );
280         connect_req->primary.hop_limit = 0;
281         connect_req->primary.sl__subnet_local =
282                 ( ( conn->qp->av.sl << 4 ) | ( 1 << 3 ) );
283         connect_req->primary.local_ack_timeout = ( 0x13 << 3 );
284         private_data_len = conn->private_data_len;
285         if ( private_data_len > sizeof ( connect_req->private_data ) )
286                 private_data_len = sizeof ( connect_req->private_data );
287         memcpy ( &connect_req->private_data, &conn->private_data,
288                  private_data_len );
289
290         /* Create connection request */
291         conn->madx = ib_create_madx ( ibdev, ibdev->gsi, &mad, NULL,
292                                       &ib_cm_req_op );
293         if ( ! conn->madx ) {
294                 DBGC ( conn, "CM %p could not create connection request\n",
295                        conn );
296                 conn->op->changed ( ibdev, qp, conn, rc, NULL, 0 );
297                 goto out;
298         }
299         ib_madx_set_ownerdata ( conn->madx, conn );
300
301  out:
302         /* Destroy the completed transaction */
303         ib_destroy_path ( ibdev, path );
304         conn->path = NULL;
305 }
306
307 /** Connection path operations */
308 static struct ib_path_operations ib_cm_path_op = {
309         .complete = ib_cm_path_complete,
310 };
311
312 /**
313  * Create connection to remote QP
314  *
315  * @v ibdev             Infiniband device
316  * @v qp                Queue pair
317  * @v dgid              Target GID
318  * @v service_id        Target service ID
319  * @v private_data      Connection request private data
320  * @v private_data_len  Length of connection request private data
321  * @v op                Connection operations
322  * @ret conn            Connection
323  */
324 struct ib_connection *
325 ib_create_conn ( struct ib_device *ibdev, struct ib_queue_pair *qp,
326                  struct ib_gid *dgid, struct ib_gid_half *service_id,
327                  void *private_data, size_t private_data_len,
328                  struct ib_connection_operations *op ) {
329         struct ib_connection *conn;
330
331         /* Allocate and initialise request */
332         conn = zalloc ( sizeof ( *conn ) + private_data_len );
333         if ( ! conn )
334                 goto err_alloc_conn;
335         conn->ibdev = ibdev;
336         conn->qp = qp;
337         memset ( &qp->av, 0, sizeof ( qp->av ) );
338         qp->av.gid_present = 1;
339         memcpy ( &qp->av.gid, dgid, sizeof ( qp->av.gid ) );
340         conn->local_id = random();
341         memcpy ( &conn->service_id, service_id, sizeof ( conn->service_id ) );
342         conn->op = op;
343         conn->private_data_len = private_data_len;
344         memcpy ( &conn->private_data, private_data, private_data_len );
345
346         /* Create path */
347         conn->path = ib_create_path ( ibdev, &qp->av, &ib_cm_path_op );
348         if ( ! conn->path )
349                 goto err_create_path;
350         ib_path_set_ownerdata ( conn->path, conn );
351
352         /* Add to list of connections */
353         list_add ( &conn->list, &ib_cm_conns );
354
355         DBGC ( conn, "CM %p created for IBDEV %p QPN %lx\n",
356                conn, ibdev, qp->qpn );
357         DBGC ( conn, "CM %p connecting to %08x:%08x:%08x:%08x %08x:%08x\n",
358                conn, ntohl ( dgid->u.dwords[0] ), ntohl ( dgid->u.dwords[1] ),
359                ntohl ( dgid->u.dwords[2] ), ntohl ( dgid->u.dwords[3] ),
360                ntohl ( service_id->u.dwords[0] ),
361                ntohl ( service_id->u.dwords[1] ) );
362
363         return conn;
364
365         ib_destroy_path ( ibdev, conn->path );
366  err_create_path:
367         free ( conn );
368  err_alloc_conn:
369         return NULL;
370 }
371
372 /**
373  * Destroy connection to remote QP
374  *
375  * @v ibdev             Infiniband device
376  * @v qp                Queue pair
377  * @v conn              Connection
378  */
379 void ib_destroy_conn ( struct ib_device *ibdev,
380                        struct ib_queue_pair *qp __unused,
381                        struct ib_connection *conn ) {
382
383         list_del ( &conn->list );
384         if ( conn->madx )
385                 ib_destroy_madx ( ibdev, ibdev->gsi, conn->madx );
386         if ( conn->path )
387                 ib_destroy_path ( ibdev, conn->path );
388         free ( conn );
389 }