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
  20 FILE_LICENCE ( GPL2_OR_LATER );
  21
  22 #include <stdint.h>
  23 #include <string.h>
  24 #include <byteswap.h>
  25 #include <errno.h>
  26 #include <ipxe/list.h>
  27 #include <ipxe/infiniband.h>
  28 #include <ipxe/ib_mi.h>
  29 #include <ipxe/ib_mcast.h>
  30
  31 /** @file
  32  *
  33  * Infiniband multicast groups
  34  *
  35  */
  36
  37 /**
  38  * Generate multicast membership MAD
  39  *
  40  * @v ibdev             Infiniband device
  41  * @v gid               Multicast GID
  42  * @v join              Join (rather than leave) group
  43  * @v mad               MAD to fill in
  44  */
  45 static void ib_mcast_mad ( struct ib_device *ibdev, union ib_gid *gid,
  46                            int join, union ib_mad *mad ) {
  47         struct ib_mad_sa *sa = &mad->sa;
  48
  49         /* Construct multicast membership record request */
  50         memset ( sa, 0, sizeof ( *sa ) );
  51         sa->mad_hdr.mgmt_class = IB_MGMT_CLASS_SUBN_ADM;
  52         sa->mad_hdr.class_version = IB_SA_CLASS_VERSION;
  53         sa->mad_hdr.method =
  54                 ( join ? IB_MGMT_METHOD_SET : IB_MGMT_METHOD_DELETE );
  55         sa->mad_hdr.attr_id = htons ( IB_SA_ATTR_MC_MEMBER_REC );
  56         sa->sa_hdr.comp_mask[1] =
  57                 htonl ( IB_SA_MCMEMBER_REC_MGID | IB_SA_MCMEMBER_REC_PORT_GID |
  58                         IB_SA_MCMEMBER_REC_JOIN_STATE );
  59         sa->sa_data.mc_member_record.scope__join_state = 1;
  60         memcpy ( &sa->sa_data.mc_member_record.mgid, gid,
  61                  sizeof ( sa->sa_data.mc_member_record.mgid ) );
  62         memcpy ( &sa->sa_data.mc_member_record.port_gid, &ibdev->gid,
  63                  sizeof ( sa->sa_data.mc_member_record.port_gid ) );
  64 }
  65
  66 /**
  67  * Handle multicast membership record join response
  68  *
  69  * @v ibdev             Infiniband device
  70  * @v mi                Management interface
  71  * @v madx              Management transaction
  72  * @v rc                Status code
  73  * @v mad               Received MAD (or NULL on error)
  74  * @v av                Source address vector (or NULL on error)
  75  */
  76 static void ib_mcast_complete ( struct ib_device *ibdev,
  77                                 struct ib_mad_interface *mi __unused,
  78                                 struct ib_mad_transaction *madx,
  79                                 int rc, union ib_mad *mad,
  80                                 struct ib_address_vector *av __unused ) {
  81         struct ib_mc_membership *membership = ib_madx_get_ownerdata ( madx );
  82         struct ib_queue_pair *qp = membership->qp;
  83         union ib_gid *gid = &membership->gid;
  84         struct ib_mc_member_record *mc_member_record =
  85                 &mad->sa.sa_data.mc_member_record;
  86         int joined;
  87         unsigned long qkey;
  88
  89         /* Report failures */
  90         if ( ( rc == 0 ) && ( mad->hdr.status != htons ( IB_MGMT_STATUS_OK ) ))
  91                 rc = -ENOTCONN;
  92         if ( rc != 0 ) {
  93                 DBGC ( ibdev, "IBDEV %p QPN %lx join failed: %s\n",
  94                        ibdev, qp->qpn, strerror ( rc ) );
  95                 goto out;
  96         }
  97
  98         /* Extract values from MAD */
  99         joined = ( mad->hdr.method == IB_MGMT_METHOD_GET_RESP );
 100         qkey = ntohl ( mc_member_record->qkey );
 101         DBGC ( ibdev, "IBDEV %p QPN %lx %s " IB_GID_FMT " qkey %lx\n",
 102                ibdev, qp->qpn, ( joined ? "joined" : "left" ),
 103                IB_GID_ARGS ( gid ), qkey );
 104
 105         /* Set queue key */
 106         qp->qkey = qkey;
 107         if ( ( rc = ib_modify_qp ( ibdev, qp ) ) != 0 ) {
 108                 DBGC ( ibdev, "IBDEV %p QPN %lx could not modify qkey: %s\n",
 109                        ibdev, qp->qpn, strerror ( rc ) );
 110                 goto out;
 111         }
 112
 113  out:
 114         /* Destroy the completed transaction */
 115         ib_destroy_madx ( ibdev, mi, madx );
 116         membership->madx = NULL;
 117
 118         /* Hand off to upper completion handler */
 119         membership->complete ( ibdev, qp, membership, rc, mad );
 120 }
 121
 122 /** Multicast membership management transaction completion operations */
 123 static struct ib_mad_transaction_operations ib_mcast_op = {
 124         .complete = ib_mcast_complete,
 125 };
 126
 127 /**
 128  * Join multicast group
 129  *
 130  * @v ibdev             Infiniband device
 131  * @v qp                Queue pair
 132  * @v membership        Multicast group membership
 133  * @v gid               Multicast GID to join
 134  * @v joined            Join completion handler
 135  * @ret rc              Return status code
 136  */
 137 int ib_mcast_join ( struct ib_device *ibdev, struct ib_queue_pair *qp,
 138                     struct ib_mc_membership *membership, union ib_gid *gid,
 139                     void ( * complete ) ( struct ib_device *ibdev,
 140                                           struct ib_queue_pair *qp,
 141                                           struct ib_mc_membership *membership,
 142                                           int rc, union ib_mad *mad ) ) {
 143         union ib_mad mad;
 144         int rc;
 145
 146         DBGC ( ibdev, "IBDEV %p QPN %lx joining " IB_GID_FMT "\n",
 147                ibdev, qp->qpn, IB_GID_ARGS ( gid ) );
 148
 149         /* Initialise structure */
 150         membership->qp = qp;
 151         memcpy ( &membership->gid, gid, sizeof ( membership->gid ) );
 152         membership->complete = complete;
 153
 154         /* Attach queue pair to multicast GID */
 155         if ( ( rc = ib_mcast_attach ( ibdev, qp, gid ) ) != 0 ) {
 156                 DBGC ( ibdev, "IBDEV %p QPN %lx could not attach: %s\n",
 157                        ibdev, qp->qpn, strerror ( rc ) );
 158                 goto err_mcast_attach;
 159         }
 160
 161         /* Initiate multicast membership join */
 162         ib_mcast_mad ( ibdev, gid, 1, &mad );
 163         membership->madx = ib_create_madx ( ibdev, ibdev->gsi, &mad, NULL,
 164                                             &ib_mcast_op );
 165         if ( ! membership->madx ) {
 166                 DBGC ( ibdev, "IBDEV %p QPN %lx could not create join "
 167                        "transaction\n", ibdev, qp->qpn );
 168                 rc = -ENOMEM;
 169                 goto err_create_madx;
 170         }
 171         ib_madx_set_ownerdata ( membership->madx, membership );
 172
 173         return 0;
 174
 175         ib_destroy_madx ( ibdev, ibdev->gsi, membership->madx );
 176  err_create_madx:
 177         ib_mcast_detach ( ibdev, qp, gid );
 178  err_mcast_attach:
 179         return rc;
 180 }
 181
 182 /**
 183  * Leave multicast group
 184  *
 185  * @v ibdev             Infiniband device
 186  * @v qp                Queue pair
 187  * @v membership        Multicast group membership
 188  */
 189 void ib_mcast_leave ( struct ib_device *ibdev, struct ib_queue_pair *qp,
 190                       struct ib_mc_membership *membership ) {
 191         union ib_gid *gid = &membership->gid;
 192         union ib_mad mad;
 193         int rc;
 194
 195         DBGC ( ibdev, "IBDEV %p QPN %lx leaving " IB_GID_FMT "\n",
 196                ibdev, qp->qpn, IB_GID_ARGS ( gid ) );
 197
 198         /* Detach from multicast GID */
 199         ib_mcast_detach ( ibdev, qp, &membership->gid );
 200
 201         /* Cancel multicast membership join, if applicable */
 202         if ( membership->madx ) {
 203                 ib_destroy_madx ( ibdev, ibdev->gsi, membership->madx );
 204                 membership->madx = NULL;
 205         }
 206
 207         /* Send a single group leave MAD */
 208         ib_mcast_mad ( ibdev, &membership->gid, 0, &mad );
 209         if ( ( rc = ib_mi_send ( ibdev, ibdev->gsi, &mad, NULL ) ) != 0 ) {
 210                 DBGC ( ibdev, "IBDEV %p QPN %lx could not send leave request: "
 211                        "%s\n", ibdev, qp->qpn, strerror ( rc ) );
 212         }
 213 }