58e555aded8abfadc9edb777466841aa687d881e
[people/lynusvaz/gpxe.git] / src / net / infiniband / ib_mcast.c
1 /*
2  * Copyright (C) 2007 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 <string.h>
23 #include <byteswap.h>
24 #include <errno.h>
25 #include <gpxe/list.h>
26 #include <gpxe/infiniband.h>
27 #include <gpxe/ib_gma.h>
28 #include <gpxe/ib_mcast.h>
29
30 /** @file
31  *
32  * Infiniband multicast groups
33  *
34  */
35
36 /**
37  * Transmit multicast group membership request
38  *
39  * @v gma               General management agent
40  * @v gid               Multicast GID
41  * @v join              Join (rather than leave) group
42  * @ret rc              Return status code
43  */
44 static int ib_mc_member_request ( struct ib_gma *gma, struct ib_gid *gid,
45                                   int join ) {
46         union ib_mad mad;
47         struct ib_mad_sa *sa = &mad.sa;
48         int rc;
49
50         /* Construct multicast membership record request */
51         memset ( sa, 0, sizeof ( *sa ) );
52         sa->mad_hdr.base_version = IB_MGMT_BASE_VERSION;
53         sa->mad_hdr.mgmt_class = IB_MGMT_CLASS_SUBN_ADM;
54         sa->mad_hdr.class_version = IB_SA_CLASS_VERSION;
55         sa->mad_hdr.method =
56                 ( join ? IB_MGMT_METHOD_SET : IB_MGMT_METHOD_DELETE );
57         sa->mad_hdr.attr_id = htons ( IB_SA_ATTR_MC_MEMBER_REC );
58         sa->sa_hdr.comp_mask[1] =
59                 htonl ( IB_SA_MCMEMBER_REC_MGID | IB_SA_MCMEMBER_REC_PORT_GID |
60                         IB_SA_MCMEMBER_REC_JOIN_STATE );
61         sa->sa_data.mc_member_record.scope__join_state = 1;
62         memcpy ( &sa->sa_data.mc_member_record.mgid, gid,
63                  sizeof ( sa->sa_data.mc_member_record.mgid ) );
64         memcpy ( &sa->sa_data.mc_member_record.port_gid, &gma->ibdev->gid,
65                  sizeof ( sa->sa_data.mc_member_record.port_gid ) );
66
67         /* Issue multicast membership record request */
68         if ( ( rc = ib_gma_request ( gma, &mad, NULL, join ) ) != 0 ) {
69                 DBGC ( gma, "GMA %p could not join group: %s\n",
70                        gma, strerror ( rc ) );
71                 return rc;
72         }
73
74         return 0;
75 }
76
77 /**
78  * Join multicast group
79  *
80  * @v ibdev             Infiniband device
81  * @v qp                Queue pair
82  * @v gid               Multicast GID
83  * @ret rc              Return status code
84  */
85 int ib_mcast_join ( struct ib_device *ibdev, struct ib_queue_pair *qp,
86                     struct ib_gid *gid ) {
87         struct ib_gma *gma = ibdev->gma;
88         int rc;
89
90         DBGC ( gma, "GMA %p QPN %lx joining %08x:%08x:%08x:%08x\n",
91                gma, qp->qpn, ntohl ( gid->u.dwords[0] ),
92                ntohl ( gid->u.dwords[1] ), ntohl ( gid->u.dwords[2] ),
93                ntohl ( gid->u.dwords[3] ) );
94
95         /* Attach queue pair to multicast GID */
96         if ( ( rc = ib_mcast_attach ( ibdev, qp, gid ) ) != 0 ) {
97                 DBGC ( gma, "GMA %p could not attach: %s\n",
98                        gma, strerror ( rc ) );
99                 goto err_mcast_attach;
100         }
101
102         /* Initiate multicast membership join */
103         if ( ( rc = ib_mc_member_request ( gma, gid, 1 ) ) != 0 )
104                 goto err_mc_member_record;
105
106         return 0;
107
108  err_mc_member_record:
109         ib_mcast_detach ( ibdev, qp, gid );
110  err_mcast_attach:
111         return rc;
112 }
113
114 /**
115  * Leave multicast group
116  *
117  * @v ibdev             Infiniband device
118  * @v qp                Queue pair
119  * @v gid               Multicast GID
120  */
121 void ib_mcast_leave ( struct ib_device *ibdev, struct ib_queue_pair *qp,
122                       struct ib_gid *gid ) {
123         struct ib_gma *gma = ibdev->gma;
124
125         DBGC ( gma, "GMA %p QPN %lx leaving %08x:%08x:%08x:%08x\n",
126                gma, qp->qpn, ntohl ( gid->u.dwords[0] ),
127                ntohl ( gid->u.dwords[1] ), ntohl ( gid->u.dwords[2] ),
128                ntohl ( gid->u.dwords[3] ) );
129
130         /* Detach queue pair from multicast GID */
131         ib_mcast_detach ( ibdev, qp, gid );
132
133         /* Initiate multicast membership leave */
134         ib_mc_member_request ( gma, gid, 0 );
135 }
136
137 /**
138  * Handle multicast membership record join response
139  *
140  * @v gma               General management agent
141  * @v mad               MAD
142  * @ret mad             MAD response
143  */
144 static union ib_mad * ib_handle_mc_member_join ( struct ib_gma *gma,
145                                                  union ib_mad *mad ) {
146         struct ib_device *ibdev = gma->ibdev;
147         struct ib_mc_member_record *mc_member_record =
148                 &mad->sa.sa_data.mc_member_record;
149         struct ib_queue_pair *qp;
150         struct ib_gid *gid;
151         unsigned long qkey;
152         int rc;
153
154         /* Ignore if not a success */
155         if ( mad->hdr.status != htons ( IB_MGMT_STATUS_OK ) ) {
156                 DBGC ( gma, "GMA %p join failed with status %04x\n",
157                        gma, ntohs ( mad->hdr.status ) );
158                 return NULL;
159         }
160
161         /* Extract MAD parameters */
162         gid = &mc_member_record->mgid;
163         qkey = ntohl ( mc_member_record->qkey );
164
165         /* Locate matching queue pair */
166         qp = ib_find_qp_mgid ( ibdev, gid );
167         if ( ! qp ) {
168                 DBGC ( gma, "GMA %p has no QP to join %08x:%08x:%08x:%08x\n",
169                        gma, ntohl ( gid->u.dwords[0] ),
170                        ntohl ( gid->u.dwords[1] ),
171                        ntohl ( gid->u.dwords[2] ),
172                        ntohl ( gid->u.dwords[3] ) );
173                 return NULL;
174         }
175         DBGC ( gma, "GMA %p QPN %lx joined %08x:%08x:%08x:%08x qkey %lx\n",
176                gma, qp->qpn, ntohl ( gid->u.dwords[0] ),
177                ntohl ( gid->u.dwords[1] ), ntohl ( gid->u.dwords[2] ),
178                ntohl ( gid->u.dwords[3] ), qkey );
179
180         /* Set queue key */
181         qp->qkey = qkey;
182         if ( ( rc = ib_modify_qp ( ibdev, qp ) ) != 0 ) {
183                 DBGC ( gma, "GMA %p QPN %lx could not modify qkey: %s\n",
184                        gma, qp->qpn, strerror ( rc ) );
185                 return NULL;
186         }
187
188         return NULL;
189 }
190
191 /**
192  * Handle multicast membership record leave response
193  *
194  * @v gma               General management agent
195  * @v mad               MAD
196  * @v response          MAD response
197  */
198 static union ib_mad * ib_handle_mc_member_leave ( struct ib_gma *gma,
199                                                   union ib_mad *mad ) {
200         struct ib_mc_member_record *mc_member_record =
201                 &mad->sa.sa_data.mc_member_record;
202         struct ib_gid *gid;
203
204         /* Ignore if not a success */
205         if ( mad->hdr.status != htons ( IB_MGMT_STATUS_OK ) ) {
206                 DBGC ( gma, "GMA %p leave failed with status %04x\n",
207                        gma, ntohs ( mad->hdr.status ) );
208                 return NULL;
209         }
210
211         /* Extract MAD parameters */
212         gid = &mc_member_record->mgid;
213         DBGC ( gma, "GMA %p left %08x:%08x:%08x:%08x\n", gma,
214                ntohl ( gid->u.dwords[0] ), ntohl ( gid->u.dwords[1] ),
215                ntohl ( gid->u.dwords[2] ), ntohl ( gid->u.dwords[3] ) );
216
217         return NULL;
218 }
219
220 /** Multicast membership record response handler */
221 struct ib_gma_handler ib_mc_member_record_handlers[] __ib_gma_handler = {
222         {
223                 .mgmt_class = IB_MGMT_CLASS_SUBN_ADM,
224                 .class_version = IB_SA_CLASS_VERSION,
225                 .method = IB_MGMT_METHOD_GET_RESP,
226                 .attr_id = htons ( IB_SA_ATTR_MC_MEMBER_REC ),
227                 .handle = ib_handle_mc_member_join,
228         },
229         {
230                 .mgmt_class = IB_MGMT_CLASS_SUBN_ADM,
231                 .class_version = IB_SA_CLASS_VERSION,
232                 .method = IB_SA_METHOD_DELETE_RESP,
233                 .attr_id = htons ( IB_SA_ATTR_MC_MEMBER_REC ),
234                 .handle = ib_handle_mc_member_leave,
235         },
236 };