2 * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA
19 * You can also choose to distribute this program under the terms of
20 * the Unmodified Binary Distribution Licence (as given in the file
21 * COPYING.UBDL), provided that you have satisfied its requirements.
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
30 #include <ipxe/list.h>
31 #include <ipxe/infiniband.h>
32 #include <ipxe/ib_mi.h>
33 #include <ipxe/ib_mcast.h>
37 * Infiniband multicast groups
42 * Generate multicast membership MAD
44 * @v ibdev Infiniband device
45 * @v gid Multicast GID
46 * @v join Join (rather than leave) group
47 * @v mad MAD to fill in
49 static void ib_mcast_mad ( struct ib_device *ibdev, union ib_gid *gid,
50 int join, union ib_mad *mad ) {
51 struct ib_mad_sa *sa = &mad->sa;
53 /* Construct multicast membership record request */
54 memset ( sa, 0, sizeof ( *sa ) );
55 sa->mad_hdr.mgmt_class = IB_MGMT_CLASS_SUBN_ADM;
56 sa->mad_hdr.class_version = IB_SA_CLASS_VERSION;
58 ( join ? IB_MGMT_METHOD_SET : IB_MGMT_METHOD_DELETE );
59 sa->mad_hdr.attr_id = htons ( IB_SA_ATTR_MC_MEMBER_REC );
60 sa->sa_hdr.comp_mask[1] =
61 htonl ( IB_SA_MCMEMBER_REC_MGID | IB_SA_MCMEMBER_REC_PORT_GID |
62 IB_SA_MCMEMBER_REC_JOIN_STATE );
63 sa->sa_data.mc_member_record.scope__join_state = 1;
64 memcpy ( &sa->sa_data.mc_member_record.mgid, gid,
65 sizeof ( sa->sa_data.mc_member_record.mgid ) );
66 memcpy ( &sa->sa_data.mc_member_record.port_gid, &ibdev->gid,
67 sizeof ( sa->sa_data.mc_member_record.port_gid ) );
71 * Handle multicast membership record join response
73 * @v ibdev Infiniband device
74 * @v mi Management interface
75 * @v madx Management transaction
77 * @v mad Received MAD (or NULL on error)
78 * @v av Source address vector (or NULL on error)
80 static void ib_mcast_complete ( struct ib_device *ibdev,
81 struct ib_mad_interface *mi __unused,
82 struct ib_mad_transaction *madx,
83 int rc, union ib_mad *mad,
84 struct ib_address_vector *av __unused ) {
85 struct ib_mc_membership *membership = ib_madx_get_ownerdata ( madx );
86 struct ib_queue_pair *qp = membership->qp;
87 union ib_gid *gid = &membership->gid;
88 struct ib_mc_member_record *mc_member_record =
89 &mad->sa.sa_data.mc_member_record;
94 if ( ( rc == 0 ) && ( mad->hdr.status != htons ( IB_MGMT_STATUS_OK ) ))
97 DBGC ( ibdev, "IBDEV %p QPN %lx join failed: %s\n",
98 ibdev, qp->qpn, strerror ( rc ) );
102 /* Extract values from MAD */
103 joined = ( mad->hdr.method == IB_MGMT_METHOD_GET_RESP );
104 qkey = ntohl ( mc_member_record->qkey );
105 DBGC ( ibdev, "IBDEV %p QPN %lx %s " IB_GID_FMT " qkey %lx\n",
106 ibdev, qp->qpn, ( joined ? "joined" : "left" ),
107 IB_GID_ARGS ( gid ), qkey );
111 if ( ( rc = ib_modify_qp ( ibdev, qp ) ) != 0 ) {
112 DBGC ( ibdev, "IBDEV %p QPN %lx could not modify qkey: %s\n",
113 ibdev, qp->qpn, strerror ( rc ) );
118 /* Destroy the completed transaction */
119 ib_destroy_madx ( ibdev, mi, madx );
120 membership->madx = NULL;
122 /* Hand off to upper completion handler */
123 membership->complete ( ibdev, qp, membership, rc, mad );
126 /** Multicast membership management transaction completion operations */
127 static struct ib_mad_transaction_operations ib_mcast_op = {
128 .complete = ib_mcast_complete,
132 * Join multicast group
134 * @v ibdev Infiniband device
136 * @v membership Multicast group membership
137 * @v gid Multicast GID to join
138 * @v joined Join completion handler
139 * @ret rc Return status code
141 int ib_mcast_join ( struct ib_device *ibdev, struct ib_queue_pair *qp,
142 struct ib_mc_membership *membership, union ib_gid *gid,
143 void ( * complete ) ( struct ib_device *ibdev,
144 struct ib_queue_pair *qp,
145 struct ib_mc_membership *membership,
146 int rc, union ib_mad *mad ) ) {
150 DBGC ( ibdev, "IBDEV %p QPN %lx joining " IB_GID_FMT "\n",
151 ibdev, qp->qpn, IB_GID_ARGS ( gid ) );
154 assert ( qp != NULL );
156 /* Initialise structure */
158 memcpy ( &membership->gid, gid, sizeof ( membership->gid ) );
159 membership->complete = complete;
161 /* Attach queue pair to multicast GID */
162 if ( ( rc = ib_mcast_attach ( ibdev, qp, gid ) ) != 0 ) {
163 DBGC ( ibdev, "IBDEV %p QPN %lx could not attach: %s\n",
164 ibdev, qp->qpn, strerror ( rc ) );
165 goto err_mcast_attach;
168 /* Initiate multicast membership join */
169 ib_mcast_mad ( ibdev, gid, 1, &mad );
170 membership->madx = ib_create_madx ( ibdev, ibdev->gsi, &mad, NULL,
172 if ( ! membership->madx ) {
173 DBGC ( ibdev, "IBDEV %p QPN %lx could not create join "
174 "transaction\n", ibdev, qp->qpn );
176 goto err_create_madx;
178 ib_madx_set_ownerdata ( membership->madx, membership );
182 ib_destroy_madx ( ibdev, ibdev->gsi, membership->madx );
184 ib_mcast_detach ( ibdev, qp, gid );
190 * Leave multicast group
192 * @v ibdev Infiniband device
194 * @v membership Multicast group membership
196 void ib_mcast_leave ( struct ib_device *ibdev, struct ib_queue_pair *qp,
197 struct ib_mc_membership *membership ) {
198 union ib_gid *gid = &membership->gid;
202 DBGC ( ibdev, "IBDEV %p QPN %lx leaving " IB_GID_FMT "\n",
203 ibdev, qp->qpn, IB_GID_ARGS ( gid ) );
206 assert ( qp != NULL );
208 /* Detach from multicast GID */
209 ib_mcast_detach ( ibdev, qp, &membership->gid );
211 /* Cancel multicast membership join, if applicable */
212 if ( membership->madx ) {
213 ib_destroy_madx ( ibdev, ibdev->gsi, membership->madx );
214 membership->madx = NULL;
217 /* Send a single group leave MAD */
218 ib_mcast_mad ( ibdev, &membership->gid, 0, &mad );
219 if ( ( rc = ib_mi_send ( ibdev, ibdev->gsi, &mad, NULL ) ) != 0 ) {
220 DBGC ( ibdev, "IBDEV %p QPN %lx could not send leave request: "
221 "%s\n", ibdev, qp->qpn, strerror ( rc ) );