TABLE OF CONTENTS

1. OpenSM/Link Manager
2. OpenSM: Link Manager/osm_link_mgr_t
3. OpenSM: Link Manager/osm_link_mgr_construct
4. OpenSM: Link Manager/osm_link_mgr_destroy
5. OpenSM: Link Manager/osm_link_mgr_init
6. OpenSM: Link Manager/osm_link_mgr_process

OpenSM/Link Manager

    Link Manager

    The Link Manager object encapsulates the information
    needed to control unicast LID forwarding on the subnet.

    The Link Manager object is thread safe.

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

    Steve King, Intel

OpenSM: Link Manager/osm_link_mgr_t

    osm_link_mgr_t

    Link Manager structure.

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

typedef struct _osm_link_mgr
{
    osm_subn_t                  *p_subn;
    osm_req_t                   *p_req;
    osm_log_t                   *p_log;
    cl_plock_t                  *p_lock;
    cl_qmap_t                   *p_sw_guid_tbl;

} osm_link_mgr_t;

    base
        OpenSM base object.

    p_subn
        Pointer to the Subnet object for this subnet.

    p_req
        Pointer to the Requester object sending SMPs.

    p_log
        Pointer to the log object.

    p_lock
        Pointer to the serializing lock.

    p_sw_guid_tbl
        Pointer to the switch table.

    Link Manager object

OpenSM: Link Manager/osm_link_mgr_construct

    osm_link_mgr_construct

    This function constructs a Link Manager object.

void
osm_link_mgr_construct(
    IN osm_link_mgr_t* const p_mgr );

    p_mgr
        [in] Pointer to a Link Manager object to construct.

    This function does not return a value.

    Allows osm_link_mgr_destroy

    Calling osm_link_mgr_construct is a prerequisite to calling any other
    method except osm_link_mgr_init.

    Link Manager object, osm_link_mgr_init,
    osm_link_mgr_destroy

OpenSM: Link Manager/osm_link_mgr_destroy

    osm_link_mgr_destroy

    The osm_link_mgr_destroy function destroys the object, releasing
    all resources.

void
osm_link_mgr_destroy(
    IN osm_link_mgr_t* const p_mgr );

    p_mgr
        [in] Pointer to the object to destroy.

    This function does not return a value.

    Performs any necessary cleanup of the specified
    Link Manager object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_link_mgr_construct or osm_link_mgr_init.

    Link Manager object, osm_link_mgr_construct,
    osm_link_mgr_init

OpenSM: Link Manager/osm_link_mgr_init

    osm_link_mgr_init

    The osm_link_mgr_init function initializes a
    Link Manager object for use.

ib_api_status_t
osm_link_mgr_init(
    IN osm_link_mgr_t* const p_mgr,
    IN osm_req_t* const p_req,
    IN osm_subn_t* const p_subn,
    IN osm_log_t* const p_log,
    IN cl_plock_t* const p_lock );

    p_mgr
        [in] Pointer to an osm_link_mgr_t object to initialize.

    p_req
        [in] Pointer to the attribute Requester object.

    p_subn
        [in] Pointer to the Subnet object for this subnet.

    p_log
        [in] Pointer to the log object.

    p_lock
        [in] Pointer to the OpenSM serializing lock.

    IB_SUCCESS if the Link Manager object was initialized
    successfully.

    Allows calling other Link Manager methods.

    Link Manager object, osm_link_mgr_construct,
    osm_link_mgr_destroy

OpenSM: Link Manager/osm_link_mgr_process

    osm_link_mgr_process

    Processes all ports in the subnet per the link manager command.

osm_signal_t
osm_link_mgr_process(
    IN osm_link_mgr_t* const p_mgr,
    IN const osm_link_mgr_command_t cmd );

    p_mgr
        [in] Pointer to an osm_link_mgr_t object.

    cmd
        [in] Link Manager command

    Returns the appropriate signal to the caller:
        OSM_SIGNAL_DONE - operation is complete
        OSM_SIGNAL_DONE_PENDING - local operations are complete, but
            transactions are still pending on the wire.

    Link Manager, Node Info Response Controller