TABLE OF CONTENTS

1. OpenSM/Unicast Manager
2. OpenSM: Unicast Manager/osm_ucast_mgr_t
3. OpenSM: Unicast Manager/osm_ucast_mgr_construct
4. OpenSM: Unicast Manager/osm_ucast_mgr_destroy
5. OpenSM: Unicast Manager/osm_ucast_mgr_init
6. OpenSM: Unicast Manager/osm_ucast_mgr_process

OpenSM/Unicast Manager

    Unicast Manager

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

    The Unicast 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: Unicast Manager/osm_ucast_mgr_t

    osm_ucast_mgr_t

    Unicast Manager structure.

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

typedef struct _osm_ucast_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_ucast_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.

    Unicast Manager object

OpenSM: Unicast Manager/osm_ucast_mgr_construct

    osm_ucast_mgr_construct

    This function constructs a Unicast Manager object.

void
osm_ucast_mgr_construct(
    IN osm_ucast_mgr_t* const p_mgr );

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

    This function does not return a value.

    Allows osm_ucast_mgr_destroy

    Calling osm_ucast_mgr_construct is a prerequisite to calling any other
    method except osm_ucast_mgr_init.

    Unicast Manager object, osm_ucast_mgr_init,
    osm_ucast_mgr_destroy

OpenSM: Unicast Manager/osm_ucast_mgr_destroy

    osm_ucast_mgr_destroy

    The osm_ucast_mgr_destroy function destroys the object, releasing
    all resources.

void
osm_ucast_mgr_destroy(
    IN osm_ucast_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
    Unicast Manager object.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to
    osm_ucast_mgr_construct or osm_ucast_mgr_init.

    Unicast Manager object, osm_ucast_mgr_construct,
    osm_ucast_mgr_init

OpenSM: Unicast Manager/osm_ucast_mgr_init

    osm_ucast_mgr_init

    The osm_ucast_mgr_init function initializes a
    Unicast Manager object for use.

ib_api_status_t
osm_ucast_mgr_init(
    IN osm_ucast_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_ucast_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 Unicast Manager object was initialized
    successfully.

    Allows calling other Unicast Manager methods.

    Unicast Manager object, osm_ucast_mgr_construct,
    osm_ucast_mgr_destroy

OpenSM: Unicast Manager/osm_ucast_mgr_process

    osm_ucast_mgr_process

    Process and configure the subnet's unicast forwarding tables.

osm_signal_t
osm_ucast_mgr_process(
    IN osm_ucast_mgr_t* const p_mgr );

    p_mgr
        [in] Pointer to an osm_ucast_mgr_t object.

    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.

    This function processes the subnet, configuring switch
    unicast forwarding tables.

    Unicast Manager, Node Info Response Controller