TABLE OF CONTENTS

1. OpenSM/SM Info Get Controller
2. OpenSM: SM Info Get Controller/osm_smi_get_ctrl_t
3. OpenSM: SM Info Get Controller/osm_smi_get_ctrl_construct
4. OpenSM: SM Info Get Controller/osm_smi_get_ctrl_destroy
5. OpenSM: SM Info Get Controller/osm_smi_get_ctrl_init
6. OpenSM: SM Info Get Controller/osm_smi_get_ctrl_is_inited
7. OpenSM: SM Info Get Controller/osm_smi_get_ctrl_process

OpenSM/SM Info Get Controller

    SM Info Get Controller

    The SM Info Get Controller object encapsulates the information
    needed to handle the SwitchInfo query from a node.

    The SM Info Get Controller 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 Info Get Controller/osm_smi_get_ctrl_t

    osm_smi_get_ctrl_t

    SM Info Get Controller structure.

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

typedef struct _osm_smi_get_ctrl
{
    osm_sminfo_t                *p_smi;
    osm_mad_pool_t              *p_pool;
    osm_log_t                   *p_log;
    cl_plock_t                  *p_lock;
    cl_dispatcher_t             *p_disp;

} osm_smi_get_ctrl_t;

    base
        OpenSM base object.

    p_smi
        Pointer to the SM Info object of the SM.

    p_pool
        Pointer to the MAD pool.

    p_log
        Pointer to the log object.

    p_lock
        Pointer to the serializing lock.

    p_disp
        Pointer to the Dispatcher.

    SM Info Get Controller object

OpenSM: SM Info Get Controller/osm_smi_get_ctrl_construct

    osm_smi_get_ctrl_construct

    This function constructs a SM Info Get Controller object.

void osm_smi_get_ctrl_construct(
    IN osm_smi_get_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to a SM Info Get Controller object to construct.

    This function does not return a value.

    Allows calling osm_smi_get_ctrl_init, osm_smi_get_ctrl_destroy,
    and osm_smi_get_ctrl_is_inited.

    Calling osm_smi_get_ctrl_construct is a prerequisite to calling any other
    method except osm_smi_get_ctrl_init.

    SM Info Get Controller object, osm_smi_get_ctrl_init,
    osm_smi_get_ctrl_destroy, osm_smi_get_ctrl_is_inited

OpenSM: SM Info Get Controller/osm_smi_get_ctrl_destroy

    osm_smi_get_ctrl_destroy

    The osm_smi_get_ctrl_destroy function destroys the object, releasing
    all resources.

void osm_smi_get_ctrl_destroy(
    IN osm_smi_get_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to the object to destroy.

    This function does not return a value.

    Performs any necessary cleanup of the specified
    SM Info Get Controller object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_smi_get_ctrl_construct or osm_smi_get_ctrl_init.

    SM Info Get Controller object, osm_smi_get_ctrl_construct,
    osm_smi_get_ctrl_init

OpenSM: SM Info Get Controller/osm_smi_get_ctrl_init

    osm_smi_get_ctrl_init

    The osm_smi_get_ctrl_init function initializes a
    SM Info Get Controller object for use.

ib_api_status_t osm_smi_get_ctrl_init(
    IN osm_smi_get_ctrl_t* const p_ctrl,
    IN osm_sminfo_t* const p_smi,
    IN osm_mad_pool_t* const p_mad_pool,
    IN osm_log_t* const p_log,
    IN cl_plock_t* const p_lock,
    IN cl_dispatcher_t* const p_disp );

    p_ctrl
        [in] Pointer to an osm_smi_get_ctrl_t object to initialize.

    p_smi
        [in] Pointer to the SMInfo object of the SM.

    p_mad_pool
        [in] Pointer to the MAD pool.

    p_log
        [in] Pointer to the log object.

    p_lock
        [in] Pointer to the OpenSM serializing lock.

    p_disp
        [in] Pointer to the OpenSM central Dispatcher.

    CL_SUCCESS if the SM Info Get Controller object was initialized
    successfully.

    Allows calling other SM Info Get Controller methods.

    SM Info Get Controller object, osm_smi_get_ctrl_construct,
    osm_smi_get_ctrl_destroy, osm_smi_get_ctrl_is_inited

OpenSM: SM Info Get Controller/osm_smi_get_ctrl_is_inited

    osm_smi_get_ctrl_is_inited

    Indicates if the object has been initialized with osm_smi_get_ctrl_init.

boolean_t osm_smi_get_ctrl_is_inited(
    IN const osm_smi_get_ctrl_t* const p_ctrl );

    p_ctrl
        [in] Pointer to an osm_smi_get_ctrl_t object.

    TRUE if the object was initialized successfully,
    FALSE otherwise.

    The osm_smi_get_ctrl_construct or osm_smi_get_ctrl_init must be
    called before using this function.

    SM Info Get Controller object, osm_smi_get_ctrl_construct,
    osm_smi_get_ctrl_init

OpenSM: SM Info Get Controller/osm_smi_get_ctrl_process

    osm_smi_get_ctrl_process

    Process the SwitchInfo attribute.

ib_api_status_t osm_smi_get_ctrl_process(
    IN const osm_smi_get_ctrl_t* const p_ctrl,
    IN osm_madw_t* const p_madw );

    p_ctrl
        [in] Pointer to an osm_smi_get_ctrl_t object.

    p_madw
        [in] Pointer to the MAD Wrapper containing the MAD
        that contains the node's SwitchInfo attribute.

    CL_SUCCESS if the SwitchInfo processing was successful.

    This function processes a SwitchInfo attribute.

    SM Info Get Controller, SM Info Response Controller