TABLE OF CONTENTS

1. OpenSM/Partition
2. OpenSM: Partition/osm_prtn_t
3. OpenSM: Partition/osm_prtn_construct
4. OpenSM: Partition/osm_prtn_destroy
5. OpenSM: Partition/osm_prtn_init
6. OpenSM: Partition/osm_prtn_is_inited
7. OpenSM: Partition/osm_prtn_is_guid
8. OpenSM: Partition/osm_prtn_get_pkey

OpenSM/Partition

    Partition

    The Partition object encapsulates the information needed by the
    OpenSM to manage Partitions.  The OpenSM allocates one Partition
    object per Partition in the IBA subnet.

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

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

    Steve King, Intel

OpenSM: Partition/osm_prtn_t

    osm_prtn_t

    Partition structure.

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

typedef struct _osm_prtn
{
    uint16_t                        pkey;
    cl_map                          port_guid_tbl;

} osm_prtn_t;

    base
        OpenSM base object.

    pkey
        The IBA defined P_KEY of this Partition.

    port_guid_tbl
        Container of pointers to all Port objects in the Partition,
        indexed by port GUID.

    Partition

OpenSM: Partition/osm_prtn_construct

    osm_prtn_construct

    This function constructs a Partition.

void osm_prtn_construct(
    IN osm_prtn_t* const p_prtn );

    p_prtn
        [in] Pointer to a Partition to construct.

    This function does not return a value.

    Allows calling osm_prtn_init, osm_prtn_destroy, and osm_prtn_is_inited.

    Calling osm_prtn_construct is a prerequisite to calling any other
    method except osm_prtn_init.

    Partition, osm_prtn_init, osm_prtn_destroy, osm_prtn_is_inited

OpenSM: Partition/osm_prtn_destroy

    osm_prtn_destroy

    The osm_prtn_destroy function destroys a Partition, releasing
    all resources.

void osm_prtn_destroy(
    IN osm_prtn_t* const p_prtn );

    p_prtn
        [in] Pointer to a Partition to destroy.

    This function does not return a value.

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

    Partition, osm_prtn_construct, osm_prtn_init

OpenSM: Partition/osm_prtn_init

    osm_prtn_init

    The osm_prtn_init function initializes a Partition for use.

ib_api_status_t osm_prtn_init(
    IN osm_prtn_t* const p_prtn );

    p_prtn
        [in] Pointer to an osm_prtn_t object to initialize.

    CL_SUCCESS if initialization was successful.

    Allows calling other Partition methods.

    Partition, osm_prtn_construct, osm_prtn_destroy,
    osm_prtn_is_inited

OpenSM: Partition/osm_prtn_is_inited

    osm_prtn_is_inited

    Indicates if the object has been initialized with osm_prtn_init.

boolean_t osm_ptrn_is_inited(
    IN const osm_prtn_t* const p_prtn );

    p_prtn
        [in] Pointer to an osm_prtn_t object.

    TRUE if the object was initialized successfully,
    FALSE otherwise.

    The osm_prtn_construct or osm_prtn_init must be called before using
    this function.

    Partition, osm_prtn_construct, osm_prtn_init

OpenSM: Partition/osm_prtn_is_guid

    osm_prtn_is_guid

    Indicates if a port is a member of the partition.

boolean_t osm_prtn_is_guid(
    IN const osm_prtn_t* const p_prtn,
    IN const uint64 guid );

    p_prtn
        [in] Pointer to an osm_prtn_t object.

    guid
        [in] Port GUID.

    TRUE if the specified port GUID is a member of the partition,
    FALSE otherwise.

OpenSM: Partition/osm_prtn_get_pkey

    osm_prtn_get_pkey

    Gets the IBA defined P_KEY value for this Partition.

uint16_t osm_prtn_get_pkey(
    IN const osm_prtn_t* const p_prtn );

    p_prtn
        [in] Pointer to an osm_prtn_t object.

    P_KEY value for this Partition.