TABLE OF CONTENTS

1. OpenSM/Multicast Group
2. OpenSM: Multicast Group/osm_mgrp_t
3. OpenSM: Multicast Group/osm_mgrp_construct
4. OpenSM: Multicast Group/osm_mgrp_destroy
5. OpenSM: Multicast Group/osm_mgrp_init
6. OpenSM: Multicast Group/osm_mgrp_is_inited
7. OpenSM: Multicast Group/osm_mgrp_is_guid
8. OpenSM: Multicast Group/osm_mgrp_get_mlid

OpenSM/Multicast Group

    Multicast Group

    The Multicast Group encapsulates the information needed by the
    OpenSM to manage Multicast Groups.  The OpenSM allocates one
    Multicast Group object per Multicast Group in the IBA subnet.

    The Multicast Group 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: Multicast Group/osm_mgrp_t

    osm_mgrp_t

    Multicast Group structure.

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

typedef struct _osm_mgrp_t
{
    uint16_t                        mlid;
    cl_map_t                        port_guid_tbl;

} osm_mgrp_t;

    base
        OpenSM base object.

    mlid
        The LID of this Multicast Group (must be greater than 0xBFFF).

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

    Multicast Group

OpenSM: Multicast Group/osm_mgrp_construct

    osm_mgrp_construct

    This function constructs a Multicast Group.

void osm_mgrp_construct(
    IN osm_mgrp_t* const p_mgrp );

    p_mgrp
        [in] Pointer to a Multicast Group to construct.

    This function does not return a value.

    Allows calling osm_mgrp_init, osm_mgrp_destroy, and osm_mgrp_is_inited.

    Calling osm_mgrp_construct is a prerequisite to calling any other
    method except osm_mgrp_init.

    Multicast Group, osm_mgrp_init, osm_mgrp_destroy, osm_mgrp_is_inited

OpenSM: Multicast Group/osm_mgrp_destroy

    osm_mgrp_destroy

    The osm_mgrp_destroy function destroys a Multicast Group, releasing
    all resources.

void osm_mgrp_destroy(
    IN osm_mgrp_t* const p_mgrp );

    p_mgrp
        [in] Pointer to a Muticast Group to destroy.

    This function does not return a value.

    Performs any necessary cleanup of the specified Multicast Group.
    Further operations should not be attempted on the destroyed object.
    This function should only be called after a call to osm_mgrp_construct or
    osm_mgrp_init.

    Multicast Group, osm_mgrp_construct, osm_mgrp_init

OpenSM: Multicast Group/osm_mgrp_init

    osm_mgrp_init

    The osm_mgrp_init function initializes a Multicast Group for use.

ib_api_status_t osm_mgrp_init(
    IN osm_mgrp_t* const p_mgrp );

    p_mgrp
        [in] Pointer to an osm_mgrp_t object to initialize.

    CL_SUCCESS if initialization was successful.

    Allows calling other Multicast Group methods.

    Multicast Group, osm_mgrp_construct, osm_mgrp_destroy,
    osm_mgrp_is_inited

OpenSM: Multicast Group/osm_mgrp_is_inited

    osm_mgrp_is_inited

    Indicates if the object has been initialized with osm_mgrp_init.

boolean_t osm_mgrp_is_inited(
    IN const osm_mgrp_t* const p_mgrp );

    p_mgrp
        [in] Pointer to an osm_mgrp_t object.

    TRUE if the object was initialized successfully,
    FALSE otherwise.

    The osm_mgrp_construct or osm_mgrp_init must be called before using
    this function.

    Multicast Group, osm_mgrp_construct, osm_mgrp_init

OpenSM: Multicast Group/osm_mgrp_is_guid

    osm_mgrp_is_guid

    Indicates if the specified port GUID is a member of the Multicast Group.

boolean_t osm_mgrp_is_guid(
    IN const osm_mgrp_t* const p_mgrp,
    IN const uint64 port_guid );

    p_mgrp
        [in] Pointer to an osm_mgrp_t object.

    port_guid
        [in] Port GUID.

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

    Multicast Group

OpenSM: Multicast Group/osm_mgrp_get_mlid

    osm_mgrp_get_mlid

    The osm_mgrp_get_mlid function returns the multicast LID of this group.

uint16_t osm_mgrp_get_mlid(
    IN const osm_mgrp_t* const p_mgrp );

    p_mgrp
        [in] Pointer to an osm_mgrp_t object.

    MLID of the Multicast Group.

    Multicast Group