qemu/roms/ipxe/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., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301, USA.
  18  *
  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.
  22  */
  23
  24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
  25
  26 #include <stdint.h>
  27 #include <string.h>
  28 #include <byteswap.h>
  29 #include <errno.h>
  30 #include <ipxe/list.h>
  31 #include <ipxe/infiniband.h>
  32 #include <ipxe/ib_mi.h>
  33 #include <ipxe/ib_mcast.h>
  34
  35 /** @file
  36  *
  37  * Infiniband multicast groups
  38  *
  39  */
  40
  41 /**
  42  * Generate multicast membership MAD
  43  *
  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
  48  */
  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;
  52
  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;
  57         sa->mad_hdr.method =
  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 ) );
  68 }
  69
  70 /**
  71  * Handle multicast membership record join response
  72  *
  73  * @v ibdev             Infiniband device
  74  * @v mi                Management interface
  75  * @v madx              Management transaction
  76  * @v rc                Status code
  77  * @v mad               Received MAD (or NULL on error)
  78  * @v av                Source address vector (or NULL on error)
  79  */
  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;
  90         int joined;
  91         unsigned long qkey;
  92
  93         /* Report failures */
  94         if ( ( rc == 0 ) && ( mad->hdr.status != htons ( IB_MGMT_STATUS_OK ) ))
  95                 rc = -ENOTCONN;
  96         if ( rc != 0 ) {
  97                 DBGC ( ibdev, "IBDEV %p QPN %lx join failed: %s\n",
  98                        ibdev, qp->qpn, strerror ( rc ) );
  99                 goto out;
 100         }
 101
 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 );
 108
 109         /* Set queue key */
 110         qp->qkey = 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 ) );
 114                 goto out;
 115         }
 116
 117  out:
 118         /* Destroy the completed transaction */
 119         ib_destroy_madx ( ibdev, mi, madx );
 120         membership->madx = NULL;
 121
 122         /* Hand off to upper completion handler */
 123         membership->complete ( ibdev, qp, membership, rc, mad );
 124 }
 125
 126 /** Multicast membership management transaction completion operations */
 127 static struct ib_mad_transaction_operations ib_mcast_op = {
 128         .complete = ib_mcast_complete,
 129 };
 130
 131 /**
 132  * Join multicast group
 133  *
 134  * @v ibdev             Infiniband device
 135  * @v qp                Queue pair
 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
 140  */
 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 ) ) {
 147         union ib_mad mad;
 148         int rc;
 149
 150         DBGC ( ibdev, "IBDEV %p QPN %lx joining " IB_GID_FMT "\n",
 151                ibdev, qp->qpn, IB_GID_ARGS ( gid ) );
 152
 153         /* Sanity check */
 154         assert ( qp != NULL );
 155
 156         /* Initialise structure */
 157         membership->qp = qp;
 158         memcpy ( &membership->gid, gid, sizeof ( membership->gid ) );
 159         membership->complete = complete;
 160
 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;
 166         }
 167
 168         /* Initiate multicast membership join */
 169         ib_mcast_mad ( ibdev, gid, 1, &mad );
 170         membership->madx = ib_create_madx ( ibdev, ibdev->gsi, &mad, NULL,
 171                                             &ib_mcast_op );
 172         if ( ! membership->madx ) {
 173                 DBGC ( ibdev, "IBDEV %p QPN %lx could not create join "
 174                        "transaction\n", ibdev, qp->qpn );
 175                 rc = -ENOMEM;
 176                 goto err_create_madx;
 177         }
 178         ib_madx_set_ownerdata ( membership->madx, membership );
 179
 180         return 0;
 181
 182         ib_destroy_madx ( ibdev, ibdev->gsi, membership->madx );
 183  err_create_madx:
 184         ib_mcast_detach ( ibdev, qp, gid );
 185  err_mcast_attach:
 186         return rc;
 187 }
 188
 189 /**
 190  * Leave multicast group
 191  *
 192  * @v ibdev             Infiniband device
 193  * @v qp                Queue pair
 194  * @v membership        Multicast group membership
 195  */
 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;
 199         union ib_mad mad;
 200         int rc;
 201
 202         DBGC ( ibdev, "IBDEV %p QPN %lx leaving " IB_GID_FMT "\n",
 203                ibdev, qp->qpn, IB_GID_ARGS ( gid ) );
 204
 205         /* Sanity check */
 206         assert ( qp != NULL );
 207
 208         /* Detach from multicast GID */
 209         ib_mcast_detach ( ibdev, qp, &membership->gid );
 210
 211         /* Cancel multicast membership join, if applicable */
 212         if ( membership->madx ) {
 213                 ib_destroy_madx ( ibdev, ibdev->gsi, membership->madx );
 214                 membership->madx = NULL;
 215         }
 216
 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 ) );
 222         }
 223 }