/*

 * Copyright (c) 2004-2009 Voltaire, Inc. All rights reserved.

 * Copyright (c) 2002-2011 Mellanox Technologies LTD. All rights reserved.

 * Copyright (c) 1996-2003 Intel Corporation. All rights reserved.

 * Copyright (c) 2009 Sun Microsystems, Inc. All rights reserved.

 *

 * This software is available to you under a choice of one of two

 * licenses.  You may choose to be licensed under the terms of the GNU

 * General Public License (GPL) Version 2, available from the file

 * COPYING in the main directory of this source tree, or the

 * OpenIB.org BSD license below:

 *

 *     Redistribution and use in source and binary forms, with or

 *     without modification, are permitted provided that the following

 *     conditions are met:

 *

 *      - Redistributions of source code must retain the above

 *        copyright notice, this list of conditions and the following

 *        disclaimer.

 *

 *      - Redistributions in binary form must reproduce the above

 *        copyright notice, this list of conditions and the following

 *        disclaimer in the documentation and/or other materials

 *        provided with the distribution.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

 * SOFTWARE.

 *

 */

/*

 * Abstract:

 * 	Basic OpenSM definitions.

 */

#ifndef _OSM_BASE_H_

#define _OSM_BASE_H_

#if HAVE_CONFIG_H

#  include <config.h>

#endif				/* HAVE_CONFIG_H */

#ifdef __WIN__

#include <vendor/winosm_common.h>

#endif

#include <iba/ib_types.h>

#ifdef __cplusplus

#  define BEGIN_C_DECLS extern "C" {

#  define END_C_DECLS   }

#else				/* !__cplusplus */

#  define BEGIN_C_DECLS

#  define END_C_DECLS

#endif				/* __cplusplus */

BEGIN_C_DECLS

/****h* OpenSM/Constants

* NAME

*	Constants

*

* DESCRIPTION

*	The following constants are used throughout the OpenSM.

*

* AUTHOR

*	Steve King, Intel

*

*********/

/****d* OpenSM: OSM_DEFAULT_M_KEY

* NAME

*	OSM_DEFAULT_M_KEY

*

* DESCRIPTION

*	Managment key value used by the OpenSM.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_M_KEY 0

/********/

/****d* OpenSM: OSM_DEFAULT_SM_KEY

* NAME

*	OSM_DEFAULT_SM_KEY

*

* DESCRIPTION

*	Subnet Manager key value used by the OpenSM.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SM_KEY CL_HTON64(1)

/********/

/****d* OpenSM: OSM_DEFAULT_SA_KEY

* NAME

*	OSM_DEFAULT_SA_KEY

*

* DESCRIPTION

*	Subnet Adminstration key value.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SA_KEY OSM_DEFAULT_SM_KEY

/********/

/****d* OpenSM: OSM_DEFAULT_LMC

* NAME

*	OSM_DEFAULT_LMC

*

* DESCRIPTION

*	Default LMC value used by the OpenSM.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_LMC 0

/********/

/****d* OpenSM: OSM_DEFAULT_MAX_OP_VLS

* NAME

*	OSM_DEFAULT_MAX_OP_VLS

*

* DESCRIPTION

*	Default Maximal Operational VLs to be initialized on

*  the link ports PortInfo by the OpenSM.

*  Default value provides backward compatibility.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_MAX_OP_VLS 5

/********/

/****d* OpenSM: OSM_DEFAULT_SL

* NAME

*	OSM_DEFAULT_SL

*

* DESCRIPTION

*	Default SL value used by the OpenSM.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SL 0

/********/

/****d* OpenSM: OSM_DEFAULT_SCATTER_PORTS

* NAME

*	OSM_DEFAULT_SCATTER_PORTS

*

* DESCRIPTION

*	Default Scatter Ports value used by OpenSM.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SCATTER_PORTS 0

/********/

/****d* OpenSM: OSM_DEFAULT_SM_PRIORITY

* NAME

*	OSM_DEFAULT_SM_PRIORITY

*

* DESCRIPTION

*	Default SM priority value used by the OpenSM,

*	as defined in the SMInfo attribute.  0 is the lowest priority.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SM_PRIORITY 0

/********/

/****d* OpenSM: OSM_DEFAULT_TMP_DIR

* NAME

*	OSM_DEFAULT_TMP_DIR

*

* DESCRIPTION

*	Specifies the default temporary directory for the log file,

*  osm-subnet.lst, and other log files.

*

* SYNOPSIS

*/

#ifdef __WIN__

#define OSM_DEFAULT_TMP_DIR "%TEMP%\\"

#else

#define OSM_DEFAULT_TMP_DIR "/var/log/"

#endif

/***********/

/****d* OpenSM: OSM_DEFAULT_CACHE_DIR

* NAME

*	OSM_DEFAULT_CACHE_DIR

*

* DESCRIPTION

*	Specifies the default cache directory for the db files.

*

* SYNOPSIS

*/

#ifdef __WIN__

#define OSM_DEFAULT_CACHE_DIR "%TEMP%"

#else

#define OSM_DEFAULT_CACHE_DIR "/var/cache/opensm"

#endif

/***********/

/****d* OpenSM: OSM_DEFAULT_LOG_FILE

* NAME

*	OSM_DEFAULT_LOG_FILE

*

* DESCRIPTION

*	Specifies the default log file name

*

* SYNOPSIS

*/

#ifdef __WIN__

#define OSM_DEFAULT_LOG_FILE OSM_DEFAULT_TMP_DIR "osm.log"

#else

#define OSM_DEFAULT_LOG_FILE "/var/log/opensm.log"

#endif

/***********/

/****d* OpenSM: OSM_DEFAULT_CONFIG_FILE

* NAME

*	OSM_DEFAULT_CONFIG_FILE

*

* DESCRIPTION

*	Specifies the default OpenSM config file name

*

* SYNOPSIS

*/

#if defined(HAVE_DEFAULT_OPENSM_CONFIG_FILE)

#define OSM_DEFAULT_CONFIG_FILE HAVE_DEFAULT_OPENSM_CONFIG_FILE

#elif defined (OPENSM_CONFIG_DIR)

#define OSM_DEFAULT_CONFIG_FILE OPENSM_CONFIG_DIR "/opensm.conf"

#else

#define OSM_DEFAULT_CONFIG_FILE "/etc/opensm/opensm.conf"

#endif

/***********/

/****d* OpenSM: OSM_DEFAULT_PARTITION_CONFIG_FILE

* NAME

*	OSM_DEFAULT_PARTITION_CONFIG_FILE

*

* DESCRIPTION

*	Specifies the default partition config file name

*

* SYNOPSIS

*/

#if defined(HAVE_DEFAULT_PARTITION_CONFIG_FILE)

#define OSM_DEFAULT_PARTITION_CONFIG_FILE HAVE_DEFAULT_PARTITION_CONFIG_FILE

#elif defined(OPENSM_CONFIG_DIR)

#define OSM_DEFAULT_PARTITION_CONFIG_FILE OPENSM_CONFIG_DIR "/partitions.conf"

#else

#define OSM_DEFAULT_PARTITION_CONFIG_FILE "/etc/opensm/partitions.conf"

#endif

/***********/

/****d* OpenSM: OSM_DEFAULT_QOS_POLICY_FILE

* NAME

*	OSM_DEFAULT_QOS_POLICY_FILE

*

* DESCRIPTION

*	Specifies the default QoS policy file name

*

* SYNOPSIS

*/

#if defined(HAVE_DEFAULT_QOS_POLICY_FILE)

#define OSM_DEFAULT_QOS_POLICY_FILE HAVE_DEFAULT_QOS_POLICY_FILE

#elif defined(OPENSM_CONFIG_DIR)

#define OSM_DEFAULT_QOS_POLICY_FILE OPENSM_CONFIG_DIR "/qos-policy.conf"

#else

#define OSM_DEFAULT_QOS_POLICY_FILE "/etc/opensm/qos-policy.conf"

#endif

/***********/

/****d* OpenSM: OSM_DEFAULT_TORUS_CONF_FILE

* NAME

*	OSM_DEFAULT_TORUS_CONF_FILE

*

* DESCRIPTION

*	Specifies the default file name for extra torus-2QoS configuration

*

* SYNOPSIS

*/

#ifdef __WIN__

#define OSM_DEFAULT_TORUS_CONF_FILE strcat(GetOsmCachePath(), "osm-torus-2QoS.conf")

#elif defined(OPENSM_CONFIG_DIR)

#define OSM_DEFAULT_TORUS_CONF_FILE OPENSM_CONFIG_DIR "/torus-2QoS.conf"

#else

#define OSM_DEFAULT_TORUS_CONF_FILE "/etc/opensm/torus-2QoS.conf"

#endif /* __WIN__ */

/***********/

/****d* OpenSM: OSM_DEFAULT_PREFIX_ROUTES_FILE

* NAME

*	OSM_DEFAULT_PREFIX_ROUTES_FILE

*

* DESCRIPTION

*	Specifies the default prefix routes file name

*

* SYNOPSIS

*/

#if defined(HAVE_DEFAULT_PREFIX_ROUTES_FILE)

#define OSM_DEFAULT_PREFIX_ROUTES_FILE HAVE_DEFAULT_PREFIX_ROUTES_FILE

#elif defined(OPENSM_CONFIG_DIR)

#define OSM_DEFAULT_PREFIX_ROUTES_FILE OPENSM_CONFIG_DIR "/prefix-routes.conf"

#else

#define OSM_DEFAULT_PREFIX_ROUTES_FILE "/etc/opensm/prefix-routes.conf"

#endif

/***********/

/****d* OpenSM: OSM_DEFAULT_PER_MOD_LOGGING_CONF_FILE

* NAME

*	OSM_DEFAULT_PER_MOD_LOGGING_CONF_FILE

*

* DESCRIPTION

*	Specifies the default file name for per module logging configuration

*

* SYNOPSIS

*/

#ifdef __WIN__

#define OSM_DEFAULT_PER_MOD_LOGGING_CONF_FILE strcat(GetOsmCachePath(), "per-module-logging.conf")

#elif defined(OPENSM_CONFIG_DIR)

#define OSM_DEFAULT_PER_MOD_LOGGING_CONF_FILE OPENSM_CONFIG_DIR "/per-module-logging.conf"

#else

#define OSM_DEFAULT_PER_MOD_LOGGING_CONF_FILE "/etc/opensm/per-module-logging.conf"

#endif /* __WIN__ */

/***********/

/****d* OpenSM: OSM_DEFAULT_SWEEP_INTERVAL_SECS

* NAME

*	OSM_DEFAULT_SWEEP_INTERVAL_SECS

*

* DESCRIPTION

*	Specifies the default number of seconds between subnet sweeps.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SWEEP_INTERVAL_SECS 10

/***********/

/****d* OpenSM: OSM_DEFAULT_TRANS_TIMEOUT_MILLISEC

* NAME

*	OSM_DEFAULT_TRANS_TIMEOUT_MILLISEC

*

* DESCRIPTION

*	Specifies the default transaction timeout in milliseconds.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_TRANS_TIMEOUT_MILLISEC 200

/***********/

/****d* OpenSM: OSM_DEFAULT_LONG_TRANS_TIMEOUT_MILLISEC

* NAME

*       OSM_DEFAULT_LONG_TRANS_TIMEOUT_MILLISEC

*

* DESCRIPTION

*       Specifies the default "long" transaction timeout in milliseconds.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_LONG_TRANS_TIMEOUT_MILLISEC 500

/***********/

/****d* OpenSM: OSM_DEFAULT_SUBNET_TIMEOUT

* NAME

*	OSM_DEFAULT_SUBNET_TIMEOUT

*

* DESCRIPTION

*	Specifies the default subnet timeout.

*	timeout time = 4us * 2^timeout.

*  We use here ~1sec.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SUBNET_TIMEOUT 0x12

/***********/

/****d* OpenSM: OSM_DEFAULT_SWITCH_PACKET_LIFE

* NAME

*	OSM_DEFAULT_SWITCH_PACKET_LIFE

*

* DESCRIPTION

*	Specifies the default max life time for a pcket on the switch.

*	timeout time = 4us * 2^timeout.

*  We use here the value of ~1sec

*  A Value > 19dec disables this mechanism.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SWITCH_PACKET_LIFE 0x12

/***********/

/****d* OpenSM: OSM_DEFAULT_HEAD_OF_QUEUE_LIFE

* NAME

*	OSM_DEFAULT_HEAD_OF_QUEUE_LIFE

*

* DESCRIPTION

*	Sets the time a packet can live in the head of the VL Queue

*  We use here the value of ~1sec

*  A Value > 19dec disables this mechanism.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_HEAD_OF_QUEUE_LIFE 0x12

/***********/

/****d* OpenSM: OSM_DEFAULT_LEAF_HEAD_OF_QUEUE_LIFE

* NAME

*	OSM_DEFAULT_LEAF_HEAD_OF_QUEUE_LIFE

*

* DESCRIPTION

*	Sets the time a packet can live in the head of the VL Queue

*  of a port that drives a CA port.

*  We use here the value of ~256msec

*

* SYNOPSIS

*/

#define OSM_DEFAULT_LEAF_HEAD_OF_QUEUE_LIFE 0x10

/***********/

/****d* OpenSM: OSM_DEFAULT_VL_STALL_COUNT

* NAME

*	OSM_DEFAULT_LEAF_VL_COUNT

*

* DESCRIPTION

*	Sets the number of consecutive head of queue life time drops that

*  puts the VL into stalled state. In stalled state, the port is supposed

*  to drop everything for 8*(head of queue lifetime)

*

* SYNOPSIS

*/

#define OSM_DEFAULT_VL_STALL_COUNT 0x7

/***********/

/****d* OpenSM: OSM_DEFAULT_LEAF_VL_STALL_COUNT

* NAME

*	OSM_DEFAULT_LEAF_VL_STALL_COUNT

*

* DESCRIPTION

*	Sets the number of consecutive head of queue life time drops that

*  puts the VL into stalled state. In stalled state, the port is supposed

*  to drop everything for 8*(head of queue lifetime). This value is for

*  switch ports driving a CA port.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_LEAF_VL_STALL_COUNT 0x7

/***********/

/****d* OpenSM: OSM_DEFAULT_TRAP_SUPPRESSION_TIMEOUT

* NAME

*	OSM_DEFAULT_TRAP_SUPPRESSION_TIMEOUT

*

* DESCRIPTION

*	Specifies the default timeout for ignoring same trap.

*	timeout time = 5000000us

*  We use here ~5sec.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_TRAP_SUPPRESSION_TIMEOUT 5000000

#define OSM_DEFAULT_TRAP_SUPRESSION_TIMEOUT OSM_DEFAULT_TRAP_SUPPRESSION_TIMEOUT

/***********/

/****d* OpenSM: OSM_DEFAULT_UNHEALTHY_TIMEOUT

* NAME

*	OSM_DEFAULT_UNHEALTHY_TIMEOUT

*

* DESCRIPTION

*	Specifies the default timeout for setting port as unhealthy.

*	timeout time = 60000000us

*  We use here ~60sec.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_UNHEALTHY_TIMEOUT 60000000

/***********/

/****d* OpenSM: OSM_DEFAULT_ERROR_THRESHOLD

* NAME

*	OSM_DEFAULT_ERROR_THRESHOLD

*

* DESCRIPTION

*	Specifies default link error threshold to be set by SubnSet(PortInfo).

*

* SYNOPSIS

*/

#define OSM_DEFAULT_ERROR_THRESHOLD 0x08

/***********/

/****d* OpenSM: OSM_DEFAULT_SMP_MAX_ON_WIRE

* NAME

*	OSM_DEFAULT_SMP_MAX_ON_WIRE

*

* DESCRIPTION

*	Specifies the default number of VL15 SMP MADs allowed on

*	the wire at any one time.

*

* SYNOPSIS

*/

#define OSM_DEFAULT_SMP_MAX_ON_WIRE 4

/***********/

/****d* OpenSM: 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

/***********/

/****d* OpenSM: 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

/***********/

/****d* OpenSM: OSM_SM_DEFAULT_QP1_RCV_SIZE

* NAME

*   OSM_SM_DEFAULT_QP1_RCV_SIZE

*

* DESCRIPTION

*   Specifies the default size (in MADs) of the QP1 receive queue

*

* SYNOPSIS

*/

#define OSM_SM_DEFAULT_QP1_RCV_SIZE 256

/***********/

/****d* OpenSM: OSM_SM_DEFAULT_QP1_SEND_SIZE

* NAME

*   OSM_SM_DEFAULT_QP1_SEND_SIZE

*

* DESCRIPTION

*   Specifies the default size (in MADs) of the QP1 send queue

*

* SYNOPSIS

*/

#define OSM_SM_DEFAULT_QP1_SEND_SIZE 256

/****d* OpenSM: OSM_PM_DEFAULT_QP1_RCV_SIZE

* NAME

*   OSM_PM_DEFAULT_QP1_RCV_SIZE

*

* DESCRIPTION

*   Specifies the default size (in MADs) of the QP1 receive queue

*

* SYNOPSIS

*/

#define OSM_PM_DEFAULT_QP1_RCV_SIZE 256

/***********/

/****d* OpenSM: OSM_PM_DEFAULT_QP1_SEND_SIZE

* NAME

*   OSM_PM_DEFAULT_QP1_SEND_SIZE

*

* DESCRIPTION

*   Specifies the default size (in MADs) of the QP1 send queue

*

* SYNOPSIS

*/

#define OSM_PM_DEFAULT_QP1_SEND_SIZE 256

/****d* OpenSM: OSM_SM_DEFAULT_POLLING_TIMEOUT_MILLISECS

* NAME

*   OSM_SM_DEFAULT_POLLING_TIMEOUT_MILLISECS

*

* DESCRIPTION

*   Specifies the polling timeout (in miliseconds) - the timeout

*   between one poll to another.

*

* SYNOPSIS

*/

#define OSM_SM_DEFAULT_POLLING_TIMEOUT_MILLISECS 10000

/**********/

/****d* OpenSM: OSM_SM_DEFAULT_POLLING_RETRY_NUMBER

* NAME

*   OSM_SM_DEFAULT_POLLING_RETRY_NUMBER

*

* DESCRIPTION

*   Specifies the number of polling retries before the SM goes back

*   to DISCOVERY stage. So the default total time for handoff is 40 sec.

*

* SYNOPSIS

*/

#define OSM_SM_DEFAULT_POLLING_RETRY_NUMBER 4

/**********/

/****d* OpenSM: MC Member Record Receiver/OSM_DEFAULT_MGRP_MTU

* Name

*	OSM_DEFAULT_MGRP_MTU

*

* DESCRIPTION

*	Default MTU used for new MGRP creation (2048 bytes)

*  Note it includes the MTUSelector which is set to "Greater Than"

*

* SYNOPSIS

*/

#define OSM_DEFAULT_MGRP_MTU 0x04

/***********/

/****d* OpenSM: MC Member Record Receiver/OSM_DEFAULT_MGRP_RATE

* Name

*	OSM_DEFAULT_MGRP_RATE

*

* DESCRIPTION

*	Default RATE used for new MGRP creation (10Gb/sec)

*  Note it includes the RateSelector which is set to "Greater Than"

*

* SYNOPSIS

*/

#define OSM_DEFAULT_MGRP_RATE 0x03

/***********/

/****d* OpenSM: MC Member Record Receiver/OSM_DEFAULT_MGRP_SCOPE

* Name

*	OSM_DEFAULT_MGRP_SCOPE

*

* DESCRIPTION

*	Default SCOPE used for new MGRP creation (link local)

*

* SYNOPSIS

*/

#define OSM_DEFAULT_MGRP_SCOPE IB_MC_SCOPE_LINK_LOCAL

/***********/

/****d* OpenSM: OSM_DEFAULT_QOS_MAX_VLS

 * Name

 *       OSM_DEFAULT_QOS_MAX_VLS

 *

 * DESCRIPTION

 *       Default Maximum VLs used by the OpenSM.

 *

 * SYNOPSIS

 */

#define OSM_DEFAULT_QOS_MAX_VLS 15

/***********/

/****d* OpenSM: OSM_DEFAULT_QOS_HIGH_LIMIT

 * Name

 *       OSM_DEFAULT_QOS_HIGH_LIMIT

 *

 * DESCRIPTION

 *       Default Limit of High Priority in VL Arbitration used by OpenSM.

 *

 * SYNOPSIS

 */

#define OSM_DEFAULT_QOS_HIGH_LIMIT 0

/***********/

/****d* OpenSM: OSM_DEFAULT_QOS_VLARB_HIGH

 * Name

 *       OSM_DEFAULT_QOS_VLARB_HIGH

 *

 * DESCRIPTION

 *       Default High Priority VL Arbitration table used by the OpenSM.

 *

 * SYNOPSIS

 */

#define OSM_DEFAULT_QOS_VLARB_HIGH "0:4,1:0,2:0,3:0,4:0,5:0,6:0,7:0,8:0,9:0,10:0,11:0,12:0,13:0,14:0"

/***********/

/****d* OpenSM: OSM_DEFAULT_QOS_VLARB_LOW

 * Name

 *       OSM_DEFAULT_QOS_VLARB_LOW

 *

 * DESCRIPTION

 *       Default Low Priority VL Arbitration table used by the OpenSM.

 *

 * SYNOPSIS

 */

#define OSM_DEFAULT_QOS_VLARB_LOW "0:0,1:4,2:4,3:4,4:4,5:4,6:4,7:4,8:4,9:4,10:4,11:4,12:4,13:4,14:4"

/***********/

/****d* OpenSM: OSM_DEFAULT_QOS_SL2VL

 * Name

 *       OSM_DEFAULT_QOS_SL2VL

 *

 * DESCRIPTION

 *       Default QoS SL2VL Mapping Table used by the OpenSM.

 *

 * SYNOPSIS

 */

#define OSM_DEFAULT_QOS_SL2VL "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,7"

/***********/

/****d* OpenSM: OSM_NO_PATH

* NAME

*	OSM_NO_PATH

*

* DESCRIPTION

*	Value indicating there is no path to the given LID.

*

* SYNOPSIS

*/

#define OSM_NO_PATH			0xFF

/**********/

/****d* OpenSM: OSM_NODE_DESC_UNKNOWN

* NAME

*	OSM_NODE_DESC_UNKNOWN

*

* DESCRIPTION

*	Value indicating the Node Description is not set and is "unknown"

*

* SYNOPSIS

*/

#define OSM_NODE_DESC_UNKNOWN "<unknown>"

/**********/

/****d* OpenSM: 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;

/***********/

/*

 * OSM_CAP are from IBA 1.2.1 Table 117 and Table 188

 */

/****d* OpenSM: OSM_CAP_IS_TRAP_SUP

* Name

*	OSM_CAP_IS_SUBN_TRAP_SUP

*

* DESCRIPTION

*	Management class generates Trap() MADs

*

* SYNOPSIS

*/

#define OSM_CAP_IS_SUBN_TRAP_SUP (1 << 0)

/***********/

/****d* OpenSM: OSM_CAP_IS_GET_SET_NOTICE_SUP

* Name

*	OSM_CAP_IS_GET_SET_NOTICE_SUP

*

* DESCRIPTION

*       Management class supports Get/Set(Notice)

*

* SYNOPSIS

*/

#define OSM_CAP_IS_SUBN_GET_SET_NOTICE_SUP (1 << 1)

/***********/

/****d* OpenSM: OSM_CAP_IS_SUBN_OPT_RECS_SUP

* Name

*	OSM_CAP_IS_SUBN_OPT_RECS_SUP

*

* DESCRIPTION

*	Support all optional attributes except:

*  MCMemberRecord, TraceRecord, MultiPathRecord

*

* SYNOPSIS

*/

#define OSM_CAP_IS_SUBN_OPT_RECS_SUP (1 << 8)

/***********/

/****d* OpenSM: OSM_CAP_IS_UD_MCAST_SUP

* Name

*	OSM_CAP_IS_UD_MCAST_SUP

*

* DESCRIPTION

*	Multicast is supported

*

* SYNOPSIS

*/

#define OSM_CAP_IS_UD_MCAST_SUP (1 << 9)

/***********/

/****d* OpenSM: OSM_CAP_IS_MULTIPATH_SUP

* Name

*	OSM_CAP_IS_MULTIPATH_SUP

*

* DESCRIPTION

*	MultiPathRecord and TraceRecord are supported

*

* SYNOPSIS

*/

#define OSM_CAP_IS_MULTIPATH_SUP (1 << 10)

/***********/

/****d* OpenSM: OSM_CAP_IS_REINIT_SUP

* Name

*	OSM_CAP_IS_REINIT_SUP

*

* DESCRIPTION

*	SM/SA supports re-initialization supported

*

* SYNOPSIS

*/

#define OSM_CAP_IS_REINIT_SUP (1 << 11)

/***********/

/****d* OpenSM: OSM_CAP_IS_PORT_INFO_CAPMASK_MATCH_SUPPORTED

* Name

*	OSM_CAP_IS_PORT_INFO_CAPMASK_MATCH_SUPPORTED

*

* DESCRIPTION

*	SM/SA supports enhanced SA PortInfoRecord searches per 1.2 Errata:

*  ClassPortInfo:CapabilityMask.IsPortInfoCapMaskMatchSupported is 1,

*  then the AttributeModifier of the SubnAdmGet() and SubnAdmGetTable()

*  methods affects the matching behavior on the PortInfo:CapabilityMask

*  component. If the high-order bit (bit 31) of the AttributeModifier

*  is set to 1, matching on the CapabilityMask component will not be an

*  exact bitwise match as described in <ref to 15.4.4>.  Instead,

*  matching will only be performed on those bits which are set to 1 in

*  the PortInfo:CapabilityMask embedded in the query.

*

* SYNOPSIS

*/

#define OSM_CAP_IS_PORT_INFO_CAPMASK_MATCH_SUPPORTED (1 << 13)

/***********/

/****d* OpenSM: OSM_CAP2_IS_QOS_SUPPORTED

* Name

*	OSM_CAP2_IS_QOS_SUPPORTED

*

* DESCRIPTION

*	QoS is supported

*

* SYNOPSIS

*/

#define OSM_CAP2_IS_QOS_SUPPORTED (1 << 1)

/***********/

/****d* OpenSM: OSM_CAP2_IS_REVERSE_PATH_PKEY_SUPPPORTED

* Name

*	OSM_CAP2_IS_REVERSE_PATH_PKEY_SUPPPORTED

*

* DESCRIPTION

*	Reverse path PKeys indicate in PathRecord responses

*

* SYNOPSIS

*/

#define OSM_CAP2_IS_REVERSE_PATH_PKEY_SUPPPORTED (1 << 2)

/***********/

/****d* OpenSM: OSM_CAP2_IS_MCAST_TOP_SUPPORTED

* Name

*	OSM_CAP2_IS_MCAST_TOP_SUPPORTED

*

* DESCRIPTION

*       SwitchInfo.MulticastFDBTop is supported

*

* SYNOPSIS

*/

#define OSM_CAP2_IS_MCAST_TOP_SUPPORTED (1 << 3)

/***********/

/****d* OpenSM: OSM_CAP2_IS_HIERARCHY_SUPPORTED

* Name

*

* DESCRIPTION

*	Hierarchy info supported

*

* SYNOPSIS

*/

#define OSM_CAP2_IS_HIERARCHY_SUPPORTED (1 << 4)

/***********/

/****d* OpenSM: OSM_CAP2_IS_ALIAS_GUIDS_SUPPORTED

* Name

*

* DESCRIPTION

*	Alias GUIDs supported

*

* SYNOPSIS

*/

#define OSM_CAP2_IS_ALIAS_GUIDS_SUPPORTED (1 << 5)

/***********/

/****d* OpenSM: OSM_CAP2_IS_FULL_PORTINFO_REC_SUPPORTED

* Name

*	OSM_CAP2_IS_FULL_PORTINFO_REC_SUPPORTED

*

* DESCRIPTION

*	Full PortInfoRecords supported

*

* SYNOPSIS

*/

#define OSM_CAP2_IS_FULL_PORTINFO_REC_SUPPORTED (1 << 6)

/***********/

/****d* OpenSM: OSM_CAP2_IS_EXTENDED_SPEEDS_SUPPORTED

* Name

*	OSM_CAP2_IS_EXTENDED_SPEEDS_SUPPORTED

*

* DESCRIPTION

*	Extended Link Speeds supported

*

* SYNOPSIS

*/

#define OSM_CAP2_IS_EXTENDED_SPEEDS_SUPPORTED (1 << 7)

/***********/