ib_mi.h File Reference

Infiniband management interfaces. More...

#include <ipxe/list.h>
#include <ipxe/retry.h>
#include <ipxe/tables.h>
#include <ipxe/infiniband.h>

Go to the source code of this file.

Data Structures
struct	ib_mad_agent
	An Infiniband management agent. More...
struct	ib_mad_transaction_operations
	Infiniband management transaction operations. More...
struct	ib_mad_transaction
	An Infiniband management transaction. More...
struct	ib_mad_interface
	An Infiniband management interface. More...

Macros
#define	IB_MAD_AGENTS   __table ( struct ib_mad_agent, "ib_mad_agents" )
	Infiniband management agents. More...
#define	__ib_mad_agent   __table_entry ( IB_MAD_AGENTS, 01 )
	Declare an Infiniband management agent. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static __always_inline void	ib_madx_set_ownerdata (struct ib_mad_transaction *madx, void *priv)
	Set Infiniband management transaction owner-private data. More...
static __always_inline void *	ib_madx_get_ownerdata (struct ib_mad_transaction *madx)
	Get Infiniband management transaction owner-private data. More...
int	ib_mi_send (struct ib_device *ibdev, struct ib_mad_interface *mi, union ib_mad *mad, struct ib_address_vector *av)
	Transmit MAD. More...
struct ib_mad_transaction *	ib_create_madx (struct ib_device *ibdev, struct ib_mad_interface *mi, union ib_mad *mad, struct ib_address_vector *av, struct ib_mad_transaction_operations *op)
	Create management transaction. More...
void	ib_destroy_madx (struct ib_device *ibdev, struct ib_mad_interface *mi, struct ib_mad_transaction *madx)
int	ib_create_mi (struct ib_device *ibdev, enum ib_queue_pair_type type, struct ib_mad_interface **new_mi)
	Create management interface. More...
void	ib_destroy_mi (struct ib_device *ibdev, struct ib_mad_interface *mi)
	Destroy management interface. More...

Detailed Description

Infiniband management interfaces.

Definition in file ib_mi.h.

Macro Definition Documentation

IB_MAD_AGENTS

#define IB_MAD_AGENTS   __table ( struct ib_mad_agent, "ib_mad_agents" )

Infiniband management agents.

Definition at line 43 of file ib_mi.h.

__ib_mad_agent

#define __ib_mad_agent   __table_entry ( IB_MAD_AGENTS, 01 )

Declare an Infiniband management agent.

Definition at line 46 of file ib_mi.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

ib_madx_set_ownerdata()

static __always_inline void ib_madx_set_ownerdata ( struct ib_mad_transaction *  madx, void *  priv  )

inlinestatic

Set Infiniband management transaction owner-private data.

Parameters

madx	Management transaction
priv	Private data

Definition at line 106 of file ib_mi.h.

                                                                      {
        madx->owner_priv = priv;
}

References ib_mad_transaction::owner_priv, and priv.

Referenced by ib_cm_path_complete(), ib_create_path(), ib_mcast_join(), xsigo_discover(), and xsigo_xds_complete().

ib_madx_get_ownerdata()

static __always_inline void* ib_madx_get_ownerdata ( struct ib_mad_transaction *  madx )

inlinestatic

Get Infiniband management transaction owner-private data.

Parameters

madx	Management transaction

Return values

priv	Private data

Definition at line 117 of file ib_mi.h.

                                                          {
        return madx->owner_priv;
}

References ib_mad_transaction::owner_priv.

Referenced by ib_cm_req_complete(), ib_mcast_complete(), ib_path_complete(), xsigo_xcm_complete(), and xsigo_xds_complete().

ib_mi_send()

int ib_mi_send	(	struct ib_device *	ibdev,
		struct ib_mad_interface *	mi,
		union ib_mad *	mad,
		struct ib_address_vector *	av
	)

Transmit MAD.

Parameters

ibdev	Infiniband device
mi	Management interface
mad	MAD
av	Destination address vector

Return values

rc	Return status code

Definition at line 187 of file ib_mi.c.

                                                                   {
        struct ib_mad_hdr *hdr = &mad->hdr;
        struct io_buffer *iobuf;
        int rc;

        /* Set common fields */
        hdr->base_version = IB_MGMT_BASE_VERSION;
        if ( ( hdr->tid.high == 0 ) && ( hdr->tid.low == 0 ) ) {
                hdr->tid.high = htonl ( IB_MI_TID_MAGIC );
                hdr->tid.low = htonl ( ++next_tid );
        }
        DBGC ( mi, "MI %p TX TID %08x%08x (%02x,%02x,%02x,%04x) status "
               "%04x\n", mi, ntohl ( hdr->tid.high ), ntohl ( hdr->tid.low ),
               hdr->mgmt_class, hdr->class_version, hdr->method,
               ntohs ( hdr->attr_id ), ntohs ( hdr->status ) );
        DBGC2_HDA ( mi, 0, mad, sizeof ( *mad ) );

        /* Construct directed route portion of response, if necessary */
        if ( hdr->mgmt_class == IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE ) {
                struct ib_mad_smp *smp = &mad->smp;
                unsigned int hop_pointer;
                unsigned int hop_count;

                smp->mad_hdr.status |= htons ( IB_SMP_STATUS_D_INBOUND );
                hop_pointer = smp->mad_hdr.class_specific.smp.hop_pointer;
                hop_count = smp->mad_hdr.class_specific.smp.hop_count;
                assert ( hop_count == hop_pointer );
                if ( hop_pointer < ( sizeof ( smp->return_path.hops ) /
                                     sizeof ( smp->return_path.hops[0] ) ) ) {
                        smp->return_path.hops[hop_pointer] = ibdev->port;
                } else {
                        DBGC ( mi, "MI %p TX TID %08x%08x invalid hop pointer "
                               "%d\n", mi, ntohl ( hdr->tid.high ),
                               ntohl ( hdr->tid.low ), hop_pointer );
                        return -EINVAL;
                }
        }

        /* Construct I/O buffer */
        iobuf = alloc_iob ( sizeof ( *mad ) );
        if ( ! iobuf ) {
                DBGC ( mi, "MI %p could not allocate buffer for TID "
                       "%08x%08x\n",
                       mi, ntohl ( hdr->tid.high ), ntohl ( hdr->tid.low ) );
                return -ENOMEM;
        }
        memcpy ( iob_put ( iobuf, sizeof ( *mad ) ), mad, sizeof ( *mad ) );

        /* Send I/O buffer */
        if ( ( rc = ib_post_send ( ibdev, mi->qp, av, iobuf ) ) != 0 ) {
                DBGC ( mi, "MI %p TX TID %08x%08x failed: %s\n",
                       mi,  ntohl ( hdr->tid.high ), ntohl ( hdr->tid.low ),
                       strerror ( rc ) );
                free_iob ( iobuf );
                return rc;
        }

        return 0;
}

References alloc_iob(), assert(), DBGC, DBGC2_HDA, EINVAL, ENOMEM, free_iob(), ib_mad::hdr, hdr, hop_count, ib_smp_class_specific::hop_count, hop_pointer, ib_smp_class_specific::hop_pointer, htonl, htons, IB_MGMT_BASE_VERSION, IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE, IB_MI_TID_MAGIC, ib_post_send(), IB_SMP_STATUS_D_INBOUND, iob_put, mad, memcpy(), next_tid, ntohl, ntohs, ib_device::port, ib_mad_interface::qp, rc, smp, ib_mad::smp, and strerror().

Referenced by ib_cm_send_drep(), ib_cm_send_rtu(), ib_mcast_leave(), ib_mi_timer_expired(), ib_sma_guid_info(), ib_sma_node_desc(), ib_sma_node_info(), ib_sma_pkey_table(), and ib_sma_port_info().

ib_create_madx()

struct ib_mad_transaction* ib_create_madx	(	struct ib_device *	ibdev,
		struct ib_mad_interface *	mi,
		union ib_mad *	mad,
		struct ib_address_vector *	av,
		struct ib_mad_transaction_operations *	op
	)

Create management transaction.

Parameters

ibdev	Infiniband device
mi	Management interface
mad	MAD to send
av	Destination address, or NULL to use SM's GSI
op	Management transaction operations

Return values

madx	Management transaction, or NULL

Definition at line 287 of file ib_mi.c.

                                                            {
        struct ib_mad_transaction *madx;

        /* Allocate and initialise structure */
        madx = zalloc ( sizeof ( *madx ) );
        if ( ! madx )
                return NULL;
        timer_init ( &madx->timer, ib_mi_timer_expired, NULL );
        madx->mi = mi;
        madx->op = op;

        /* Determine address vector */
        if ( av ) {
                memcpy ( &madx->av, av, sizeof ( madx->av ) );
        } else {
                madx->av.lid = ibdev->sm_lid;
                madx->av.sl = ibdev->sm_sl;
                madx->av.qpn = IB_QPN_GSI;
                madx->av.qkey = IB_QKEY_GSI;
        }

        /* Copy MAD */
        memcpy ( &madx->mad, mad, sizeof ( madx->mad ) );

        /* Add to list and start timer to send initial MAD */
        list_add ( &madx->list, &mi->madx );
        start_timer_nodelay ( &madx->timer );

        return madx;
}

References ib_mad_transaction::av, ib_mi_timer_expired(), IB_QKEY_GSI, IB_QPN_GSI, ib_address_vector::lid, ib_mad_transaction::list, list_add, mad, ib_mad_transaction::mad, ib_mad_interface::madx, memcpy(), ib_mad_transaction::mi, NULL, ib_mad_transaction::op, op, ib_address_vector::qkey, ib_address_vector::qpn, ib_address_vector::sl, ib_device::sm_lid, ib_device::sm_sl, start_timer_nodelay(), ib_mad_transaction::timer, and zalloc().

Referenced by ib_cm_path_complete(), ib_create_path(), ib_create_service_madx(), ib_mcast_join(), and xsigo_xds_complete().

ib_destroy_madx()

void ib_destroy_madx	(	struct ib_device *	ibdev,
		struct ib_mad_interface *	mi,
		struct ib_mad_transaction *	madx
	)

ib_create_mi()

int ib_create_mi	(	struct ib_device *	ibdev,
		enum ib_queue_pair_type	type,
		struct ib_mad_interface **	new_mi
	)

Create management interface.

Parameters

ibdev	Infiniband device
type	Queue pair type
new_mi	New management interface to fill in

Return values

rc	Return status code

Definition at line 347 of file ib_mi.c.

                                                      {
        struct ib_mad_interface *mi;
        const char *name;
        int rc;

        /* Allocate and initialise fields */
        mi = zalloc ( sizeof ( *mi ) );
        if ( ! mi ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        mi->ibdev = ibdev;
        INIT_LIST_HEAD ( &mi->madx );

        /* Create completion queue */
        if ( ( rc = ib_create_cq ( ibdev, IB_MI_NUM_CQES, &ib_mi_completion_ops,
                                   &mi->cq ) ) != 0 ) {
                DBGC ( mi, "MI %p could not create completion queue: %s\n",
                       mi, strerror ( rc ) );
                goto err_create_cq;
        }

        /* Create queue pair */
        name = ( ( type == IB_QPT_SMI ) ? "SMI" : "GSI" );
        if ( ( rc = ib_create_qp ( ibdev, type, IB_MI_NUM_SEND_WQES, mi->cq,
                                   IB_MI_NUM_RECV_WQES, mi->cq,
                                   &ib_mi_queue_pair_ops, name, &mi->qp ) )!=0){
                DBGC ( mi, "MI %p could not create queue pair: %s\n",
                       mi, strerror ( rc ) );
                goto err_create_qp;
        }
        ib_qp_set_ownerdata ( mi->qp, mi );
        DBGC ( mi, "MI %p (%s) running on QPN %#lx\n",
               mi, mi->qp->name, mi->qp->qpn );

        /* Set queue key */
        mi->qp->qkey = ( ( type == IB_QPT_SMI ) ? IB_QKEY_SMI : IB_QKEY_GSI );
        if ( ( rc = ib_modify_qp ( ibdev, mi->qp ) ) != 0 ) {
                DBGC ( mi, "MI %p could not set queue key: %s\n",
                       mi, strerror ( rc ) );
                goto err_modify_qp;
        }

        /* Fill receive ring */
        ib_refill_recv ( ibdev, mi->qp );
        *new_mi = mi;
        return 0;

 err_modify_qp:
        ib_destroy_qp ( ibdev, mi->qp );
 err_create_qp:
        ib_destroy_cq ( ibdev, mi->cq );
 err_create_cq:
        free ( mi );
 err_alloc:
        return rc;
}

References ib_mad_interface::cq, DBGC, ENOMEM, free, ib_create_cq(), ib_create_qp(), ib_destroy_cq(), ib_destroy_qp(), ib_mi_completion_ops, IB_MI_NUM_CQES, IB_MI_NUM_RECV_WQES, IB_MI_NUM_SEND_WQES, ib_mi_queue_pair_ops, ib_modify_qp(), IB_QKEY_GSI, IB_QKEY_SMI, ib_qp_set_ownerdata(), IB_QPT_SMI, ib_refill_recv(), ib_mad_interface::ibdev, INIT_LIST_HEAD, ib_mad_interface::madx, ib_queue_pair::name, name, ib_queue_pair::qkey, ib_mad_interface::qp, ib_queue_pair::qpn, rc, strerror(), type, and zalloc().

Referenced by ib_open().

ib_destroy_mi()

void ib_destroy_mi	(	struct ib_device *	ibdev,
		struct ib_mad_interface *	mi
	)

Destroy management interface.

Parameters

mi	Management interface

Definition at line 411 of file ib_mi.c.

                                                                            {
        struct ib_mad_transaction *madx;
        struct ib_mad_transaction *tmp;

        /* Flush any outstanding requests */
        list_for_each_entry_safe ( madx, tmp, &mi->madx, list ) {
                DBGC ( mi, "MI %p destroyed while TID %08x%08x in progress\n",
                       mi, ntohl ( madx->mad.hdr.tid.high ),
                       ntohl ( madx->mad.hdr.tid.low ) );
                madx->op->complete ( ibdev, mi, madx, -ECANCELED, NULL, NULL );
        }

        ib_destroy_qp ( ibdev, mi->qp );
        ib_destroy_cq ( ibdev, mi->cq );
        free ( mi );
}

References ib_mad_transaction_operations::complete, ib_mad_interface::cq, DBGC, ECANCELED, free, ib_mad::hdr, ib_mad_tid::high, ib_destroy_cq(), ib_destroy_qp(), ib_mad_transaction::list, list_for_each_entry_safe, ib_mad_tid::low, ib_mad_transaction::mad, ib_mad_interface::madx, ib_mad_transaction::mi, ntohl, NULL, ib_mad_transaction::op, ib_mad_interface::qp, ib_mad_hdr::tid, and tmp.

Referenced by ib_close(), and ib_open().