Generated from osm_lid_mgr.h with ROBODoc vunknown on Wed Aug 07 15:31:42 2002
TABLE OF CONTENTS
- OpenSM/LID Manager
- OpenSM: LID Manager/osm_lid_mgr_t
- OpenSM: LID Manager/osm_lid_mgr_construct
- OpenSM: LID Manager/osm_lid_mgr_destroy
- OpenSM: LID Manager/osm_lid_mgr_init
- OpenSM: LID Manager/osm_lid_mgr_process
NAME
LID Manager
DESCRIPTION
The LID Manager object encapsulates the information
needed to control LID assignments on the subnet.
The LID Manager object is thread safe.
This object should be treated as opaque and should be
manipulated only through the provided functions.
AUTHOR
Steve King, Intel
NAME
osm_lid_mgr_t
DESCRIPTION
LID Manager structure.
This object should be treated as opaque and should
be manipulated only through the provided functions.
SYNOPSIS
typedef struct _osm_lid_mgr
{
osm_subn_t *p_subn;
osm_req_t *p_req;
osm_log_t *p_log;
cl_plock_t *p_lock;
cl_list_t unassigned_list;
cl_list_t conflict_list;
cl_list_t foreign_list;
} osm_lid_mgr_t;
FIELDS
base
OpenSM base object.
p_subn
Pointer to the Subnet object for this subnet.
p_req
Pointer to the Requester object sending SMPs.
p_log
Pointer to the log object.
p_lock
Pointer to the serializing lock.
unassigned_list
Working list for ports that do not yet have a LID assignment.
conflict_list
Working list for ports that have a conflicting LID assignment.
foreign_list
Working list for ports that have a foreign LID assignment.
SEE ALSO
LID Manager object
NAME
osm_lid_mgr_construct
DESCRIPTION
This function constructs a LID Manager object.
SYNOPSIS
void
osm_lid_mgr_construct(
IN osm_lid_mgr_t* const p_mgr );
PARAMETERS
p_mgr
[in] Pointer to a LID Manager object to construct.
RETURN VALUE
This function does not return a value.
NOTES
Allows osm_lid_mgr_destroy
Calling osm_lid_mgr_construct is a prerequisite to calling any other
method except osm_lid_mgr_init.
SEE ALSO
LID Manager object, osm_lid_mgr_init,
osm_lid_mgr_destroy
NAME
osm_lid_mgr_destroy
DESCRIPTION
The osm_lid_mgr_destroy function destroys the object, releasing
all resources.
SYNOPSIS
void
osm_lid_mgr_destroy(
IN osm_lid_mgr_t* const p_mgr );
PARAMETERS
p_mgr
[in] Pointer to the object to destroy.
RETURN VALUE
This function does not return a value.
NOTES
Performs any necessary cleanup of the specified
LID Manager object.
Further operations should not be attempted on the destroyed object.
This function should only be called after a call to
osm_lid_mgr_construct or osm_lid_mgr_init.
SEE ALSO
LID Manager object, osm_lid_mgr_construct,
osm_lid_mgr_init
NAME
osm_lid_mgr_init
DESCRIPTION
The osm_lid_mgr_init function initializes a
LID Manager object for use.
SYNOPSIS
ib_api_status_t
osm_lid_mgr_init(
IN osm_lid_mgr_t* const p_mgr,
IN osm_req_t* const p_req,
IN osm_subn_t* const p_subn,
IN osm_log_t* const p_log,
IN cl_plock_t* const p_lock );
PARAMETERS
p_mgr
[in] Pointer to an osm_lid_mgr_t object to initialize.
p_req
[in] Pointer to the attribute Requester object.
p_subn
[in] Pointer to the Subnet object for this subnet.
p_log
[in] Pointer to the log object.
p_lock
[in] Pointer to the OpenSM serializing lock.
RETURN VALUES
CL_SUCCESS if the LID Manager object was initialized
successfully.
NOTES
Allows calling other LID Manager methods.
SEE ALSO
LID Manager object, osm_lid_mgr_construct,
osm_lid_mgr_destroy
NAME
osm_lid_mgr_process
DESCRIPTION
Process the NodeInfo attribute.
SYNOPSIS
osm_signal_t
osm_lid_mgr_process(
IN osm_lid_mgr_t* const p_mgr );
PARAMETERS
p_mgr
[in] Pointer to an osm_lid_mgr_t object.
RETURN VALUES
Returns the appropriate signal to the caller:
OSM_SIGNAL_DONE - operation is complete
OSM_SIGNAL_DONE_PENDING - local operations are complete, but
transactions are still pending on the wire.
NOTES
SEE ALSO
LID Manager