TABLE OF CONTENTS

1. OpenSM/State Manager
2. OpenSM: State Manager/osm_state_mgr_t
3. OpenSM: State Manager/osm_state_mgr_construct
4. OpenSM: State Manager/osm_state_mgr_destroy
5. OpenSM: State Manager/osm_state_mgr_init
6. OpenSM: State Manager/osm_state_mgr_process

OpenSM/State Manager

    State Manager

    The State Manager object encapsulates the information
    needed to control subnet sweeps and configuration.

    The State 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: State Manager/osm_state_mgr_t

    osm_state_mgr_t

    State Manager structure.

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

typedef struct _osm_state_mgr
{
    osm_subn_t                  *p_subn;
    osm_log_t                   *p_log;
    osm_lid_mgr_t               *p_lid_mgr;
    osm_ucast_mgr_t             *p_ucast_mgr;
    osm_link_mgr_t              *p_link_mgr;
    osm_req_t                   *p_req;
    const osm_sm_mad_ctrl_t     *p_mad_ctrl;
    cl_spinlock_t               state_lock;
    osm_sm_state_t              state;

} osm_state_mgr_t;

    base
        OpenSM base object.

    p_subn
        Pointer to the Subnet object for this subnet.

    p_log
        Pointer to the log object.

    p_lid_mgr
        Pointer to the LID Manager object.

    p_ucast_mgr
        Pointer to the Unicast Manager object.

    p_link_mgr
        Pointer to the Link Manager object.

    p_req
        Pointer to the Requester object sending SMPs.

    p_mad_ctrl
        Pointer to the SM's MAD Controller object.

    state_lock
        Spinlock gaurding the state and processes.

    state
        State of the SM.

    State Manager object

OpenSM: State Manager/osm_state_mgr_construct

    osm_state_mgr_construct

    This function constructs a State Manager object.

void
osm_state_mgr_construct(
    IN osm_state_mgr_t* const p_mgr );

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

    This function does not return a value.

    Allows osm_state_mgr_destroy

    Calling osm_state_mgr_construct is a prerequisite to calling any other
    method except osm_state_mgr_init.

    State Manager object, osm_state_mgr_init,
    osm_state_mgr_destroy

OpenSM: State Manager/osm_state_mgr_destroy

    osm_state_mgr_destroy

    The osm_state_mgr_destroy function destroys the object, releasing
    all resources.

void
osm_state_mgr_destroy(
    IN osm_state_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
    State Manager object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_state_mgr_construct or osm_state_mgr_init.

    State Manager object, osm_state_mgr_construct,
    osm_state_mgr_init

OpenSM: State Manager/osm_state_mgr_init

    osm_state_mgr_init

    The osm_state_mgr_init function initializes a
    State Manager object for use.

ib_api_status_t
osm_state_mgr_init(
    IN osm_state_mgr_t* const p_mgr,
    IN osm_subn_t* const p_subn,
    IN osm_lid_mgr_t* const p_lid_mgr,
    IN osm_ucast_mgr_t* const p_ucast_mgr,
    IN osm_link_mgr_t* const p_link_mgr,
    IN osm_req_t* const p_req,
    IN const osm_sm_mad_ctrl_t* const p_mad_ctrl,
    IN osm_log_t* const p_log );

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

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

    p_lid_mgr
        [in] Pointer to the LID Manager object.

    p_ucast_mgr
        [in] Pointer to the Unicast Manager object.

    p_link_Mgr
        [in] Pointer to the Link Manager object.

    p_req
        [in] Pointer to the Request Controller object.

    p_mad_ctrl
        [in] Pointer to the SM's mad controller.

    p_log
        [in] Pointer to the log object.

    IB_SUCCESS if the State Manager object was initialized
    successfully.

    Allows calling other State Manager methods.

    State Manager object, osm_state_mgr_construct,
    osm_state_mgr_destroy

OpenSM: State Manager/osm_state_mgr_process

    osm_state_mgr_process

    Processes and maintains the states of the SM.

void
osm_state_mgr_process(
    IN osm_state_mgr_t* const p_mgr,
    IN osm_signal_t signal );

    p_mgr
        [in] Pointer to an osm_state_mgr_t object.

    signal
        [in] Signal to the state engine.

    None.

    State Manager