ib_mcast.c File Reference

Infiniband multicast groups. More...

#include <stdint.h>
#include <string.h>
#include <byteswap.h>
#include <errno.h>
#include <gpxe/list.h>
#include <gpxe/infiniband.h>
#include <gpxe/ib_mi.h>
#include <gpxe/ib_mcast.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER)
static void	ib_mcast_mad (struct ib_device *ibdev, struct ib_gid *gid, int join, union ib_mad *mad)
	Generate multicast membership MAD.
static void	ib_mcast_complete (struct ib_device *ibdev, struct ib_mad_interface *mi __unused, struct ib_mad_transaction *madx, int rc, union ib_mad *mad, struct ib_address_vector *av __unused)
	Handle multicast membership record join response.
int	ib_mcast_join (struct ib_device *ibdev, struct ib_queue_pair *qp, struct ib_mc_membership *membership, struct ib_gid *gid, void(*complete)(struct ib_device *ibdev, struct ib_queue_pair *qp, struct ib_mc_membership *membership, int rc, union ib_mad *mad))
	Join multicast group.
void	ib_mcast_leave (struct ib_device *ibdev, struct ib_queue_pair *qp, struct ib_mc_membership *membership)
	Leave multicast group.
Variables
static struct ib_mad_transaction_operations	ib_mcast_op
	Multicast membership management transaction completion operations.

---

Detailed Description

Infiniband multicast groups.

Definition in file ib_mcast.c.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

static void ib_mcast_mad	(	struct ib_device *	ibdev,
		struct ib_gid *	gid,
		int	join,
		union ib_mad *	mad
	)			[static]

Generate multicast membership MAD.

Parameters:

	ibdev	Infiniband device
	gid	Multicast GID
	join	Join (rather than leave) group
	mad	MAD to fill in

Definition at line 44 of file ib_mcast.c.

References ib_mad_hdr::attr_id, ib_mad_hdr::class_version, ib_sa_hdr::comp_mask, ib_device::gid, htonl, htons, IB_MGMT_CLASS_SUBN_ADM, IB_MGMT_METHOD_DELETE, IB_MGMT_METHOD_SET, IB_SA_ATTR_MC_MEMBER_REC, IB_SA_CLASS_VERSION, IB_SA_MCMEMBER_REC_JOIN_STATE, IB_SA_MCMEMBER_REC_MGID, IB_SA_MCMEMBER_REC_PORT_GID, ib_mad_sa::mad_hdr, ib_sa_data::mc_member_record, memcpy, memset(), ib_mad_hdr::method, ib_mc_member_record::mgid, ib_mad_hdr::mgmt_class, ib_mc_member_record::port_gid, ib_mad::sa, ib_mad_sa::sa_data, ib_mad_sa::sa_hdr, and ib_mc_member_record::scope__join_state.

Referenced by ib_mcast_join(), and ib_mcast_leave().

                                                         {
        struct ib_mad_sa *sa = &mad->sa;

        /* Construct multicast membership record request */
        memset ( sa, 0, sizeof ( *sa ) );
        sa->mad_hdr.mgmt_class = IB_MGMT_CLASS_SUBN_ADM;
        sa->mad_hdr.class_version = IB_SA_CLASS_VERSION;
        sa->mad_hdr.method =
                ( join ? IB_MGMT_METHOD_SET : IB_MGMT_METHOD_DELETE );
        sa->mad_hdr.attr_id = htons ( IB_SA_ATTR_MC_MEMBER_REC );
        sa->sa_hdr.comp_mask[1] =
                htonl ( IB_SA_MCMEMBER_REC_MGID | IB_SA_MCMEMBER_REC_PORT_GID |
                        IB_SA_MCMEMBER_REC_JOIN_STATE );
        sa->sa_data.mc_member_record.scope__join_state = 1;
        memcpy ( &sa->sa_data.mc_member_record.mgid, gid,
                 sizeof ( sa->sa_data.mc_member_record.mgid ) );
        memcpy ( &sa->sa_data.mc_member_record.port_gid, &ibdev->gid,
                 sizeof ( sa->sa_data.mc_member_record.port_gid ) );
}

static void ib_mcast_complete	(	struct ib_device *	ibdev,
		struct ib_mad_interface *mi	__unused,
		struct ib_mad_transaction *	madx,
		int	rc,
		union ib_mad *	mad,
		struct ib_address_vector *av	__unused
	)			[static]

Handle multicast membership record join response.

Parameters:

	ibdev	Infiniband device
	mi	Management interface
	madx	Management transaction
	rc	Status code
	mad	Received MAD (or NULL on error)
	av	Source address vector (or NULL on error)

Definition at line 75 of file ib_mcast.c.

References ib_mc_membership::complete, DBGC, ib_gid::dwords, ENOTCONN, ib_mc_membership::gid, ib_mad::hdr, htons, ib_destroy_madx(), ib_madx_get_ownerdata(), IB_MGMT_METHOD_GET_RESP, IB_MGMT_STATUS_OK, ib_modify_qp(), ib_mc_membership::madx, ib_sa_data::mc_member_record, ib_mad_hdr::method, ntohl, NULL, ib_queue_pair::qkey, ib_mc_member_record::qkey, ib_mc_membership::qp, ib_queue_pair::qpn, ib_mad::sa, ib_mad_sa::sa_data, ib_mad_hdr::status, strerror(), and ib_gid::u.

                                                                        {
        struct ib_mc_membership *membership = ib_madx_get_ownerdata ( madx );
        struct ib_queue_pair *qp = membership->qp;
        struct ib_gid *gid = &membership->gid;
        struct ib_mc_member_record *mc_member_record =
                &mad->sa.sa_data.mc_member_record;
        int joined;
        unsigned long qkey;

        /* Report failures */
        if ( ( rc == 0 ) && ( mad->hdr.status != htons ( IB_MGMT_STATUS_OK ) ))
                rc = -ENOTCONN;
        if ( rc != 0 ) {
                DBGC ( ibdev, "IBDEV %p QPN %lx join failed: %s\n",
                       ibdev, qp->qpn, strerror ( rc ) );
                goto out;
        }

        /* Extract values from MAD */
        joined = ( mad->hdr.method == IB_MGMT_METHOD_GET_RESP );
        qkey = ntohl ( mc_member_record->qkey );
        DBGC ( ibdev, "IBDEV %p QPN %lx %s %08x:%08x:%08x:%08x qkey %lx\n",
               ibdev, qp->qpn, ( joined ? "joined" : "left" ),
               ntohl ( gid->u.dwords[0] ), ntohl ( gid->u.dwords[1] ),
               ntohl ( gid->u.dwords[2] ), ntohl ( gid->u.dwords[3] ),
               qkey );

        /* Set queue key */
        qp->qkey = qkey;
        if ( ( rc = ib_modify_qp ( ibdev, qp ) ) != 0 ) {
                DBGC ( ibdev, "IBDEV %p QPN %lx could not modify qkey: %s\n",
                       ibdev, qp->qpn, strerror ( rc ) );
                goto out;
        }

 out:
        /* Destroy the completed transaction */
        ib_destroy_madx ( ibdev, mi, madx );
        membership->madx = NULL;

        /* Hand off to upper completion handler */
        membership->complete ( ibdev, qp, membership, rc, mad );
}

int ib_mcast_join	(	struct ib_device *	ibdev,
		struct ib_queue_pair *	qp,
		struct ib_mc_membership *	membership,
		struct ib_gid *	gid,
		void(*)(struct ib_device *ibdev, struct ib_queue_pair *qp, struct ib_mc_membership *membership, int rc, union ib_mad *mad)	complete
	)

Join multicast group.

Parameters:

	ibdev	Infiniband device
	qp	Queue pair
	membership	Multicast group membership
	gid	Multicast GID to join
	joined	Join completion handler

Return values:

rc

Return status code

Definition at line 138 of file ib_mcast.c.

References ib_mc_membership::complete, DBGC, ib_gid::dwords, ENOMEM, ib_mc_membership::gid, ib_device::gsi, ib_create_madx(), ib_destroy_madx(), ib_madx_set_ownerdata(), ib_mcast_attach(), ib_mcast_detach(), ib_mcast_mad(), ib_mc_membership::madx, memcpy, ntohl, NULL, ib_mc_membership::qp, ib_queue_pair::qpn, strerror(), and ib_gid::u.

Referenced by ipoib_join_broadcast_group().

                                                                        {
        union ib_mad mad;
        int rc;

        DBGC ( ibdev, "IBDEV %p QPN %lx joining %08x:%08x:%08x:%08x\n",
               ibdev, qp->qpn, ntohl ( gid->u.dwords[0] ),
               ntohl ( gid->u.dwords[1] ), ntohl ( gid->u.dwords[2] ),
               ntohl ( gid->u.dwords[3] ) );

        /* Initialise structure */
        membership->qp = qp;
        memcpy ( &membership->gid, gid, sizeof ( membership->gid ) );
        membership->complete = complete;

        /* Attach queue pair to multicast GID */
        if ( ( rc = ib_mcast_attach ( ibdev, qp, gid ) ) != 0 ) {
                DBGC ( ibdev, "IBDEV %p QPN %lx could not attach: %s\n",
                       ibdev, qp->qpn, strerror ( rc ) );
                goto err_mcast_attach;
        }

        /* Initiate multicast membership join */
        ib_mcast_mad ( ibdev, gid, 1, &mad );
        membership->madx = ib_create_madx ( ibdev, ibdev->gsi, &mad, NULL,
                                            &ib_mcast_op );
        if ( ! membership->madx ) {
                DBGC ( ibdev, "IBDEV %p QPN %lx could not create join "
                       "transaction\n", ibdev, qp->qpn );
                rc = -ENOMEM;
                goto err_create_madx;
        }
        ib_madx_set_ownerdata ( membership->madx, membership );

        return 0;

        ib_destroy_madx ( ibdev, ibdev->gsi, membership->madx );
 err_create_madx:
        ib_mcast_detach ( ibdev, qp, gid );
 err_mcast_attach:
        return rc;
}

void ib_mcast_leave	(	struct ib_device *	ibdev,
		struct ib_queue_pair *	qp,
		struct ib_mc_membership *	membership
	)

Leave multicast group.

Parameters:

	ibdev	Infiniband device
	qp	Queue pair
	membership	Multicast group membership

Definition at line 192 of file ib_mcast.c.

References DBGC, ib_gid::dwords, ib_mc_membership::gid, ib_device::gsi, ib_destroy_madx(), ib_mcast_detach(), ib_mcast_mad(), ib_mi_send(), ib_mc_membership::madx, ntohl, NULL, ib_queue_pair::qpn, strerror(), and ib_gid::u.

Referenced by ipoib_leave_broadcast_group().

                                                            {
        struct ib_gid *gid = &membership->gid;
        union ib_mad mad;
        int rc;

        DBGC ( ibdev, "IBDEV %p QPN %lx leaving %08x:%08x:%08x:%08x\n",
               ibdev, qp->qpn, ntohl ( gid->u.dwords[0] ),
               ntohl ( gid->u.dwords[1] ), ntohl ( gid->u.dwords[2] ),
               ntohl ( gid->u.dwords[3] ) );

        /* Detach from multicast GID */
        ib_mcast_detach ( ibdev, qp, &membership->gid );

        /* Cancel multicast membership join, if applicable */
        if ( membership->madx ) {
                ib_destroy_madx ( ibdev, ibdev->gsi, membership->madx );
                membership->madx = NULL;
        }

        /* Send a single group leave MAD */
        ib_mcast_mad ( ibdev, &membership->gid, 0, &mad );
        if ( ( rc = ib_mi_send ( ibdev, ibdev->gsi, &mad, NULL ) ) != 0 ) {
                DBGC ( ibdev, "IBDEV %p QPN %lx could not send leave request: "
                       "%s\n", ibdev, qp->qpn, strerror ( rc ) );
        }
}

---

Variable Documentation

struct ib_mad_transaction_operations ib_mcast_op [static]

Initial value:

 {
        .complete = ib_mcast_complete,
}

Multicast membership management transaction completion operations.

Definition at line 124 of file ib_mcast.c.