TABLE OF CONTENTS

1. OpenSM/Node
2. OpenSM: Node/osm_node_t
3. OpenSM: Node/osm_node_destroy
4. OpenSM: Node/osm_node_new
5. OpenSM: Node/osm_node_is_lid
6. OpenSM: Node/osm_node_get_physp_ptr
7. OpenSM: Node/osm_node_get_any_path
8. OpenSM: Node/osm_node_get_type
9. OpenSM: Node/osm_node_get_remote_node
10. OpenSM: Node/osm_node_get_base_lid
11. OpenSM: Node/osm_node_get_remote_base_lid
12. OpenSM: Node/osm_node_get_remote_type
13. OpenSM: Node/osm_node_get_lmc
14. OpenSM: Node/osm_node_init_physp
15. OpenSM: Node/osm_node_get_discovery_count
16. OpenSM: Node/osm_node_reset_discovery_count
17. OpenSM: Node/osm_node_discovery_count_inc
18. OpenSM: Node/osm_node_get_node_guid
19. OpenSM: Node/osm_node_get_num_phys_ports
20. OpenSM: Node/osm_node_link
21. OpenSM: Node/osm_node_link_exists
22. OpenSM: Node/osm_node_has_any_link
23. OpenSM: Node/osm_node_link_has_valid_ports

OpenSM/Node

    Node

    The Node object encapsulates the information needed by the
    OpenSM to manage nodes.  The OpenSM allocates one Node object
    per node in the IBA subnet.

    The Node object 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: Node/osm_node_t

    osm_node_t

    Node structure.

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

typedef struct _osm_node
{
    cl_map_item_t               map_item;
    ib_node_info_t              node_info;
    ib_node_desc_t              node_desc;
    uint32_t                    discovery_count;
    uint8_t                     port_tbl_size;
    osm_physp_t                 physp_table[1];

} osm_node_t;

    map_item
        Linkage structure for cl_qmap.  MUST BE FIRST MEMBER!

    base
        OpenSM base object.

    node_info
        The IBA defined NodeInfo data for this node.

    node_desc
        The IBA defined NodeDescription data for this node.

    discovery_count
        The number of times this switch has been discovered
        during the current fabric sweep.  This number is reset
        to zero at the start of a sweep.

    port_tbl_size
        The size of the port_table array.  This value is one greater
        than the number of ports in the node, since port numbers
        start with 1 for some bizzare reason.

    port_table
        Array of physical port objects belonging to this node.
        Index is contiguous by local port number.
        For switches, port 0 is the always the managment port. (14.2.5.6)
        MUST BE LAST MEMBER!

    Node object

OpenSM: Node/osm_node_destroy

    osm_node_destroy

    The osm_node_destroy function destroys a node, releasing
    all resources.

void osm_node_delete(
    IN OUT osm_node_t** const p_node );

    p_node
        [in][out] Pointer to a Pointer a Node object to destroy.
        On return, the pointer to set to NULL.

    This function does not return a value.

    Performs any necessary cleanup of the specified Node object.
    This function should only be called after a call to osm_node_new.

    Node object, osm_node_new

OpenSM: Node/osm_node_new

    osm_node_new

    The osm_node_new function initializes a Node object for use.

osm_node_t*
osm_node_new(
    IN const osm_madw_t* const p_madw );

    p_madw
        [in] Pointer to a osm_madw_t object containing a mad with
        the node's NodeInfo attribute.  The caller may discard the
        osm_madw_t structure after calling osm_node_new.

    On success, a pointer to the new initialized osm_node_t structure.
    NULL otherwise.

    Node object

OpenSM: Node/osm_node_is_lid

    osm_node_is_lid

    Indicates if the specified LID belongs to this node.

boolean_t osm_node_is_lid(
    IN const osm_node_t* const p_node,
    IN const uint16_t lid );

    p_node
        [in] Pointer to an osm_node_t object.

    lid
        [in] LID value.

    TRUE if the specified LID belongs to the node,
    FALSE otherwise.

    Node object

OpenSM: Node/osm_node_get_physp_ptr

    osm_node_get_physp_ptr

    Returns a pointer to the physical port object at the
    specified local port number.

 osm_physp_t*
osm_node_get_physp_ptr(
    IN const osm_node_t* const p_node,
    IN const uint32_t port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Local port number.

    Returns a pointer to the physical port object at the
    specified local port number.
    A return value of zero means the port number was out of range.

    Node object

OpenSM: Node/osm_node_get_any_path

    osm_node_get_any_path

    Returns a pointer to the physical port object at the
    specified local port number.

 osm_dr_path_t*
osm_node_get_any_dr_path_ptr(
    IN const osm_node_t* const p_node );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Local port number.

    Returns a pointer to the physical port object at the
    specified local port number.
    A return value of zero means the port number was out of range.

    Node object

OpenSM: Node/osm_node_get_type

    osm_node_get_type

    Returns the type of this node.

 uint8_t
osm_node_get_type(
    IN const osm_node_t* const p_node );

    p_node
        [in] Pointer to an osm_node_t object.

    Returns the IBA defined type of this node.

    Node object

OpenSM: Node/osm_node_get_remote_node

    osm_node_get_remote_node

    Returns a pointer to the node on the other end of the
    specified port.
    Returns NULL if no remote node exists.

osm_node_t*
osm_node_get_remote_node(
    IN const osm_node_t* const p_node,
    IN const uint8_t port_num,
    OUT uint8_t *p_remote_port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Port number in p_node through which to get the remote node.

    p_remote_port_num
        [out] Port number in the remote's node through which this
        link exists.  The caller may specify NULL for this pointer
        if the port number isn't needed.

    Returns a pointer to the node on the other end of the
    specified port.
    Returns NULL if no remote node exists.

    Node object

OpenSM: Node/osm_node_get_base_lid

    osm_node_get_base_lid

    Returns the LID value of the specified port on this node.

 ib_net16_t
osm_node_get_base_lid(
    IN const osm_node_t* const p_node,
    IN const uint32_t port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Local port number.

    Returns a pointer to the physical port object at the
    specified local port number.
    A return value of zero means the port number was out of range.

    Node object

OpenSM: Node/osm_node_get_remote_base_lid

    osm_node_get_remote_base_lid

    Returns the base LID value of the port on the other side
    of the wire from the specified port on this node.

ib_net16_t
osm_node_get_remote_base_lid(
    IN const osm_node_t* const p_node,
    IN const uint32_t port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Local port number.

    Returns a pointer to the physical port object at the
    specified local port number.
    A return value of zero means the port number was out of range.

    Node object

OpenSM: Node/osm_node_get_remote_type

    osm_node_get_remote_type

    Returns the type of the node on the other side
    of the wire from the specified port on this node.
    The remote node must exist.

 uint8_t
osm_node_get_remote_type(
    IN const osm_node_t* const p_node,
    IN const uint8_t port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Local port number.

    Returns the type of the node on the other side
    of the wire from the specified port on this node.

    Node object

OpenSM: Node/osm_node_get_lmc

    osm_node_get_lmc

    Returns the LMC value of the specified port on this node.

 uint8_t
osm_node_get_lmc(
    IN const osm_node_t* const p_node,
    IN const uint32_t port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Local port number.

    Returns the LMC value of the specified port on this node.

    Node object

OpenSM: Node/osm_node_init_physp

    osm_node_init_physp

    Initializes a physical port for the given node.

void
osm_node_init_physp(
    IN osm_node_t* const p_node,
    IN const osm_madw_t* const p_madw );

    p_node
        [in] Pointer to an osm_node_t object.

    p_madw
        [in] Pointer to a osm_madw_t object containing a mad with
        the node's NodeInfo attribute as discovered through the
        Physical Port to add to the node.  The caller may discard the
        osm_madw_t structure after calling osm_node_new.

    None.

    Node object, Physical Port object.

OpenSM: Node/osm_node_get_discovery_count

    osm_node_get_discovery_count

    Returns a pointer to the physical port object at the
    specified local port number.

 uint32_t
osm_node_get_discovery_count(
    IN const osm_node_t* const p_node );

    p_node
        [in] Pointer to an osm_node_t object.

    Returns the discovery count for this node.

    Node object

OpenSM: Node/osm_node_reset_discovery_count

    osm_node_reset_discovery_count

    Resets the discovery count for this node to zero.
    This operation should be performed at the start of a sweep.

 void
osm_node_reset_discovery_count(
    IN osm_node_t* const p_node );

    p_node
        [in] Pointer to an osm_node_t object.

    None.

    Node object

OpenSM: Node/osm_node_discovery_count_inc

    osm_node_discovery_count_inc

    Increments the discovery count for this node.

 void
osm_node_discovery_count_inc(
    IN osm_node_t* const p_node );

    p_node
        [in] Pointer to an osm_node_t object.

    None.

    Node object

OpenSM: Node/osm_node_get_node_guid

    osm_node_get_node_guid

    Returns the node GUID of this node.

 ib_net64_t
osm_node_get_node_guid(
    IN const osm_node_t* const p_node );

    p_node
        [in] Pointer to an osm_node_t object.

    Returns the node GUID of this node.

    Node object

OpenSM: Node/osm_node_get_num_phys_ports

    osm_node_get_num_phys_ports

    Returns the number of physical ports on this node.

 uint8_t
osm_node_get_num_phys_ports(
    IN const osm_node_t* const p_node );

    p_node
        [in] Pointer to an osm_node_t object.

    Returns the number of physical nodes on this port.

    Node object

OpenSM: Node/osm_node_link

    osm_node_link

    Logically connects a node to another node through the specified port.

void
osm_node_link(
    IN osm_node_t* const p_node,
    IN const uint8_t port_num,
    IN osm_node_t* const p_remote_node,
    IN const uint8_t remote_port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Port number in p_node through which to create the link.

    p_remote_node
        [in] Pointer to the remote port object.

    remote_port_num
        [in] Port number in the remote's node through which to
        create this link.

    None.

    Node object

OpenSM: Node/osm_node_link_exists

    osm_node_link_exists

    Return TRUE if a link exists between the specified nodes on
    the specified ports.
    Returns FALSE otherwise.

boolean_t
osm_node_link_exists(
    IN osm_node_t* const p_node,
    IN const uint8_t port_num,
    IN osm_node_t* const p_remote_node,
    IN const uint8_t remote_port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Port number in p_node through which to check the link.

    p_remote_node
        [in] Pointer to the remote port object.

    remote_port_num
        [in] Port number in the remote's node through which to
        check this link.

    Return TRUE if a link exists between the specified nodes on
    the specified ports.
    Returns FALSE otherwise.

    Node object

OpenSM: Node/osm_node_has_any_link

    osm_node_has_any_link

    Return TRUE if a any link exists from the specified nodes on
    the specified port.
    Returns FALSE otherwise.

boolean_t
osm_node_has_any_link(
    IN osm_node_t* const p_node,
    IN const uint8_t port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Port number in p_node through which to check the link.

    Return TRUE if a any link exists from the specified nodes on
    the specified port.
    Returns FALSE otherwise.

    Node object

OpenSM: Node/osm_node_link_has_valid_ports

    osm_node_link_has_valid_ports

    Return TRUE if both ports in the link are valid (initialized).
    Returns FALSE otherwise.

boolean_t
osm_node_link_has_valid_ports(
    IN osm_node_t* const p_node,
    IN const uint8_t port_num,
    IN osm_node_t* const p_remote_node,
    IN const uint8_t remote_port_num );

    p_node
        [in] Pointer to an osm_node_t object.

    port_num
        [in] Port number in p_node through which to check the link.

    Return TRUE if both ports in the link are valid (initialized).
    Returns FALSE otherwise.

    Node object