TABLE OF CONTENTS

1. OpenSM/Subnet
2. OpenSM: Subnet/osm_subn_t
3. OpenSM: Subnet/osm_subn_construct
4. OpenSM: Subnet/osm_subn_destroy
5. OpenSM: Subnet/osm_subn_init

OpenSM/Subnet

    Subnet

    The Subnet object encapsulates the information needed by the
    OpenSM to manage a subnet.  The OpenSM allocates one Subnet object
    per IBA subnet.

    The Subnet object is not thread safe, thus callers must provide
    serialization.

    This object is essentially a container for the various components
    of a subnet.  Callers may directly access the member variables.

    Steve King, Intel

OpenSM: Subnet/osm_subn_t

    osm_subn_t

    Subnet structure.  Callers may directly access member components,
    after grabbing a lock.

 TO DO
    This structure should probably be volatile.

typedef struct _osm_subn
{
    cl_qmap_t                       sw_guid_tbl;
    cl_qmap_t                       node_guid_tbl;
    cl_qmap_t                       port_guid_tbl;
    cl_qmap_t                       rtr_guid_tbl;
    cl_ptr_vector_t                 sw_lid_tbl;
    cl_ptr_vector_t                 node_lid_tbl;
    cl_ptr_vector_t                 port_lid_tbl;
    cl_ptr_vector_t                 rtr_lid_tbl;
    cl_qmap_t                       prtn_pkey_tbl;
    cl_qmap_t                       mgrp_mlid_tbl;
    ib_net64_t                      m_key;
    ib_net64_t                      subnet_prefix;
    ib_net16_t                      master_sm_base_lid;
    ib_net16_t                      m_key_lease_period;
    ib_net64_t                      sm_port_guid;
    uint8_t                         lmc;

} osm_subn_t;

    sw_guid_tbl
        Container of pointers to all Switch objects in the subent.
        Indexed by node GUID.

    node_guid_tbl
        Container of pointers to all Node objects in the subent.
        Indexed by node GUID.

    port_guid_tbl
        Container of pointers to all Port objects in the subent.
        Indexed by port GUID.

    rtr_guid_tbl
        Container of pointers to all Router objects in the subent.
        Indexed by node GUID.

    sw_lid_tbl
        Container of pointers to all Switch objects in the subent.
        Indexed by node LID.

    node_lid_tbl
        Container of pointers to all Node objects in the subent.
        Indexed by node LID.

    port_ptr_tbl
        Container of pointers to all Port objects in the subent.
        Indexed by port LID.

    rtr_lid_tbl
        Container of pointers to all Router objects in the subent.
        Indexed by node LID.

    prtn_pkey_tbl
        Container of pointers to all Partition objects in the subnet.
        Indexed by P_KEY.

    mgrp_mlid_tbl
        Container of pointers to all Multicast Group objects in the subnet.
        Indexed by MLID.

    sm_node_guid
        The SM's own node GUID.

    lmc
        The LMC value used on this subnet.

    Subnet object

OpenSM: Subnet/osm_subn_construct

    osm_subn_construct

    This function constructs a Subnet object.

void
osm_subn_construct(
    IN osm_subn_t* const p_subn );

    p_subn
        [in] Pointer to a Subnet object to construct.

    This function does not return a value.

    Allows calling osm_subn_init, osm_subn_destroy, and osm_subn_is_inited.

    Calling osm_subn_construct is a prerequisite to calling any other
    method except osm_subn_init.

    Subnet object, osm_subn_init, osm_subn_destroy, osm_subn_is_inited

OpenSM: Subnet/osm_subn_destroy

    osm_subn_destroy

    The osm_subn_destroy function destroys a subnet, releasing
    all resources.

void
osm_subn_destroy(
    IN osm_subn_t* const p_subn );

    p_subn
        [in] Pointer to a Subnet object to destroy.

    This function does not return a value.

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

    Subnet object, osm_subn_construct, osm_subn_init

OpenSM: Subnet/osm_subn_init

    osm_subn_init

    The osm_subn_init function initializes a Subnet object for use.

ib_api_status_t
osm_subn_init(
    IN osm_subn_t* const p_subn,
    IN const ib_net64_t m_key,
    IN const ib_net64_t subnet_prefix,
    IN const uint8_t lmc );

    p_subn
        [in] Pointer to an osm_subn_t object to initialize.

    p_subn
        [in] The LMC value to use on this subnet.

    IB_SUCCESS if the Subnet object was initialized successfully.

    Allows calling other Subnet methods.

    Subnet object, osm_subn_construct, osm_subn_destroy,
    osm_subn_is_inited