rsm_get_interconnect_topology man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]

RSM_GET_INTERCONNECT_TOPOLOGY(3RSM)	   RSM_GET_INTERCONNECT_TOPOLOGY(3RSM)

NAME
       rsm_get_interconnect_topology,  rsm_free_interconnect_topology - get or
       free interconnect topology

SYNOPSIS
       cc [ flag... ] file... -lrsm [ library... ]
       #include <rsmapi.h>

       int rsm_get_interconnect_topology(rsm_topology_t **topology_data);

       void rsm_free_interconnect_topology(rsm_topology_t *topology_data);

DESCRIPTION
       The    rsm_get_interconnect_topology(3RSM)    and    rsm_free_intercon‐
       nect_topology(3RSM)  functions  provide	for access to the interconnect
       controller and connection data. The key interconnect data required  for
       export  and  import  operations includes the respective cluster nodeids
       and the controller names. To facilitate applications in the  establish‐
       ment  of proper and efficient export and import policies, a delineation
       of the interconnect topology is provided by this	 interface.  The  data
       provided	 includes  local  nodeid,  local controller name, its hardware
       address, and remote connection specification for each local controller.
       An  application	component  exporting  memory  can thus find the set of
       existing local controllers and correctly	 assign	 controllers  for  the
       creation	 and  publishing  of  segments.	 Exported segments may also be
       efficiently distributed over the set of controllers consistent with the
       hardware	 interconnect  and application software. An application compo‐
       nent which is to import memory must be informed of  the	segment	 id(s)
       and  controller(s)  used	 in  the exporting of memory, this needs to be
       done using some out-of-band mechanism. The topology data structures are
       defined in the <rsmapi.h> header.

       The  rsm_get_interconnect_topology()  returns a pointer to the topology
       data in a location specified by the topology_data argument.

       The  rsm_free_interconnect_topology() frees the resources allocated  by
       rsm_get_interconnect_topology().

RETURN VALUES
       Upon  successful completion, rsm_get_interconnect_topology() returns 0.
       Otherwise, an error value is returned to indicate the error.

ERRORS
       The rsm_get_interconnect_topology() function can return	the  following
       errors:

       RSMERR_BAD_TOPOLOGY_PTR
				   Invalid topology pointer.

       RSMERR_INSUFFICIENT_MEM
				   Insufficient memory.

       RSMERR_BAD_ADDR
				   Bad address.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       ┌────────────────────┬─────────────────┐
       │  ATTRIBUTE TYPE    │ ATTRIBUTE VALUE │
       ├────────────────────┼─────────────────┤
       │Interface Stability │ Evolving	      │
       ├────────────────────┼─────────────────┤
       │MT-Level	    │ MT-Safe	      │
       └────────────────────┴─────────────────┘

SEE ALSO
       attributes(5)

				  Jun 8, 20RSM_GET_INTERCONNECT_TOPOLOGY(3RSM)
[top]

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net