Generated from osm_base.h with ROBODoc vunknown on Wed Aug 07 15:31:41 2002

TABLE OF CONTENTS

  1. OpenSM/Constants
  2. OpenSM/Base
  3. OpenSM: Base/OSM_DEFAULT_M_KEY
  4. OpenSM: Base/OSM_DEFAULT_LMC
  5. OpenSM: Base/OSM_SM_DEFAULT_SWEEP_INTERVAL_SECS
  6. OpenSM: Base/OSM_SM_DEFAULT_QP0_RCV_SIZE
  7. OpenSM: Base/OSM_SM_DEFAULT_QP0_SEND_SIZE
  8. OpenSM: Base/OSM_SM_DEFAULT_QP1_RCV_SIZE
  9. OpenSM: Base/OSM_SM_DEFAULT_QP1_SEND_SIZE
  10. OpenSM: Base/osm_thread_state_t
  11. OpenSM: Base/osm_sm_state_t
  12. OpenSM: Base/osm_signal_t

OpenSM/Constants

NAME
    Constants

DESCRIPTION
    The following constants are used throughout the OpenSM.

AUTHOR
    Steve King, Intel


OpenSM/Base

NAME
    Base

DESCRIPTION
    The Base object encapsulates basic information needed by the
    OpenSM to manage objects.  Each OpenSM object includes the
    Base object as the first member.

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

AUTHOR
    Steve King, Intel


OpenSM: Base/OSM_DEFAULT_M_KEY

NAME
    OSM_DEFAULT_M_KEY

DESCRIPTION
    Managment key value used by the OpenSM.

SYNOPSIS
#define OSM_DEFAULT_M_KEY 0

OpenSM: Base/OSM_DEFAULT_LMC

NAME
    OSM_DEFAULT_LMC

DESCRIPTION
    Default LMC value used by the OpenSM.

SYNOPSIS
#define OSM_DEFAULT_LMC 0

OpenSM: Base/OSM_SM_DEFAULT_SWEEP_INTERVAL_SECS

NAME
    OSM_SM_DEFAULT_SWEEP_INTERVAL_SECS

DESCRIPTION
    Specifies the default number of seconds between subnet sweeps.

SYNOPSIS
#define OSM_SM_DEFAULT_SWEEP_INTERVAL_SECS 30

OpenSM: Base/OSM_SM_DEFAULT_QP0_RCV_SIZE

NAME
    OSM_SM_DEFAULT_QP0_RCV_SIZE

DESCRIPTION
    Specifies the default size (in MADs) of the QP0 receive queue

SYNOPSIS
#define OSM_SM_DEFAULT_QP0_RCV_SIZE 256

OpenSM: Base/OSM_SM_DEFAULT_QP0_SEND_SIZE

NAME
    OSM_SM_DEFAULT_QP0_SEND_SIZE

DESCRIPTION
    Specifies the default size (in MADs) of the QP0 send queue

SYNOPSIS
#define OSM_SM_DEFAULT_QP0_SEND_SIZE 256

OpenSM: Base/OSM_SM_DEFAULT_QP1_RCV_SIZE


OpenSM: Base/OSM_SM_DEFAULT_QP1_SEND_SIZE


OpenSM: Base/osm_thread_state_t

NAME
    osm_thread_state_t

DESCRIPTION
    Enumerates the possible states of worker threads, such
    as the subnet sweeper.

SYNOPSIS
typedef enum _osm_thread_state
{
    OSM_THREAD_STATE_NONE = 0,
    OSM_THREAD_STATE_INIT,
    OSM_THREAD_STATE_RUN,
    OSM_THREAD_STATE_EXIT

} osm_thread_state_t;

OpenSM: Base/osm_sm_state_t

NAME
    osm_sm_state_t

DESCRIPTION
    Enumerates the possible states of the SM object.

SYNOPSIS
typedef enum _osm_sm_state
{
    OSM_SM_STATE_NO_STATE = 0,
    OSM_SM_STATE_INIT,
    OSM_SM_STATE_IDLE,      
    OSM_SM_STATE_SWEEP,
    OSM_SM_STATE_SWEEP_NEW,
    OSM_SM_STATE_SET_UCAST_LIDS,
    OSM_SM_STATE_SET_UCAST_LIDS_WAIT,
    OSM_SM_STATE_SET_UCAST_TABLES,
    OSM_SM_STATE_SET_UCAST_TABLES_WAIT,
    OSM_SM_STATE_SET_ARMED,
    OSM_SM_STATE_SET_ARMED_WAIT,
    OSM_SM_STATE_SET_ACTIVE,
    OSM_SM_STATE_SET_ACTIVE_WAIT,
    OSM_SM_STATE_SET_MCAST_TABLES

} osm_sm_state_t;

OpenSM: Base/osm_signal_t

NAME
    osm_signal_t

DESCRIPTION
    Enumerates the possible signal codes used by the SM managers
    This cannot be an enum type, since conversion to and from
    integral types is necessary when passing signals through
    the dispatcher.

SYNOPSIS
#define OSM_SIGNAL_NONE                         0
#define OSM_SIGNAL_SWEEP                        1
#define OSM_SIGNAL_CHANGE_DETECTED              2
#define OSM_SIGNAL_NO_PENDING_TRANSACTIONS      3
#define OSM_SIGNAL_DONE                         4
#define OSM_SIGNAL_DONE_PENDING                 5
#define OSM_SIGNAL_MAX                          6

typedef uint32_t osm_signal_t;