TABLE OF CONTENTS

1. OpenSM/OpenSM
2. OpenSM: SM/osm_opensm_t
3. OpenSM: SM/osm_opensm_construct
4. OpenSM: SM/osm_opensm_destroy
5. OpenSM: SM/osm_opensm_init
6. OpenSM: SM/osm_opensm_sweep
7. OpenSM: SM/osm_opensm_bind

OpenSM/OpenSM

    OpenSM

    The OpenSM object encapsulates the information needed by the
    OpenSM to govern itself.  The OpenSM is one OpenSM object.

    The OpenSM object is thread safe.

    This object should be treated as opaque and should
    be manipulated only through the provided functions.

    Steve King, Intel

OpenSM: SM/osm_opensm_t

    osm_opensm_t

    OpenSM structure.

    This object should be treated as opaque and should
    be manipulated only through the provided functions.

typedef struct _osm_opensm_t
{
    osm_subn_t                  subn;
    osm_sm_t                    sm;
    osm_sa_t                    sa;
    osm_mad_pool_t              mad_pool;
    osm_vendor_t                *p_vendor;
    osm_vl15_t                  vl15;
    osm_log_t                   log;
    cl_dispatcher_t             disp;
    cl_plock_t                  lock;
    osm_stats_t                 stats;

} osm_opensm_t;

    subn
        Subnet object for this subnet.

    sm
        The Subnet Manger (SM) object for this subnet.

    sa
        The Subnet Administrator (SA) object for this subnet.

    mad_pool
        Pool of Management Datagram (MAD) objects.

    p_vendor
        Pointer to the Vendor specific adapter for various
        transport interfaces, such as UMADT, AL, etc.  The
        particular interface is set at compile time.

    vl15
        The VL15 interface.

    log
        Log facility used by all OpenSM components.

    disp
        Central dispatcher containing the OpenSM worker threads.

    lock
        Shared lock guarding most OpenSM structures.

    stats
        Open SM statistics block

OpenSM: SM/osm_opensm_construct

    osm_opensm_construct

    This function constructs an OpenSM object.

void osm_opensm_construct(
    IN osm_opensm_t* const p_osm );

    p_osm
        [in] Pointer to a OpenSM object to construct.

    This function does not return a value.

    Allows calling osm_opensm_init, osm_opensm_destroy, and osm_opensm_is_inited.

    Calling osm_opensm_construct is a prerequisite to calling any other
    method except osm_opensm_init.

    SM object, osm_opensm_init, osm_opensm_destroy, osm_opensm_is_inited

OpenSM: SM/osm_opensm_destroy

    osm_opensm_destroy

    The osm_opensm_destroy function destroys an SM, releasing
    all resources.

void osm_opensm_destroy(
    IN osm_opensm_t* const p_osm );

    p_osm
        [in] Pointer to a OpenSM object to destroy.

    This function does not return a value.

    Performs any necessary cleanup of the specified OpenSM object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to osm_opensm_construct or
    osm_opensm_init.

    SM object, osm_opensm_construct, osm_opensm_init

OpenSM: SM/osm_opensm_init

    osm_opensm_init

    The osm_opensm_init function initializes a OpenSM object for use.

ib_api_status_t
osm_opensm_init(
    IN osm_opensm_t* const p_osm );

    p_osm
        [in] Pointer to an osm_opensm_t object to initialize.

    CL_SUCCESS if the OpenSM object was initialized successfully.

    Allows calling other OpenSM methods.

    SM object, osm_opensm_construct, osm_opensm_destroy,
    osm_opensm_is_inited

OpenSM: SM/osm_opensm_sweep

    osm_opensm_sweep

    Initiates a subnet sweep.

 void
osm_opensm_sweep(
    IN osm_opensm_t* const p_osm );

    p_osm
        [in] Pointer to an osm_opensm_t object on which to 
        initiate a sweep.

    None

    If the OpenSM object is not bound to a port, this function
    does nothing.

OpenSM: SM/osm_opensm_bind

    osm_opensm_bind

    Binds the opensm object to a port guid.

ib_api_status_t
osm_opensm_bind(
    IN osm_opensm_t* const p_osm,
    IN const ib_net64_t guid );

    p_osm
        [in] Pointer to an osm_opensm_t object to bind.

    guid
        [in] Local port GUID with which to bind.

    None

    A given opensm object can only be bound to one port at a time.