BroadView™ API Guide and Reference Manual: public/bst.h File Reference

#include "broadview.h"
#include "asic.h"
#include "sbplugin.h"

Data Structures
struct	_bst_asic_data_snapshot_

struct	_bst_config_

struct	_bst_cpu_q_

struct	_bst_cpu_q_threshold_

struct	_bst_device_

struct	_bst_device_threshold_

struct	_bst_e_mcq_

struct	_bst_e_mcq_threshold_

struct	_bst_e_p_sp_

struct	_bst_e_sp_

struct	_bst_e_sp_threshold_

struct	_bst_e_ucq_

struct	_bst_e_ucq_threshold_

struct	_bst_e_ucqg_

struct	_bst_e_ucqg_threshold_

struct	_bst_ep_sp_threshold_

struct	_bst_i_p_pg_

struct	_bst_i_p_pg_threshold_

struct	_bst_i_p_sp_

struct	_bst_i_p_sp_threshold_

struct	_bst_i_sp_

struct	_bst_i_sp_threshold_

struct	_bst_rqe_q_

struct	_bst_rqe_q_threshold_

struct	_bst_trigger_info_

struct	_bst_cpu_q_::_cpuq_data_

struct	_bst_e_mcq_::_emcq_data_

struct	_bst_e_p_sp_::_epsp_data_

struct	_bst_e_sp_::_esp_data_

struct	_bst_e_ucq_::_eucq_data_

struct	_bst_e_ucqg_::_eucqg_data_

struct	_bst_i_p_pg_::_ippg_data_

struct	_bst_i_p_sp_::_ipsp_data_

struct	_bst_i_sp_::_isp_data_

struct	_bst_rqe_q_::_rqeq_data_

Macros
#define	BVIEW_BST_CPU_MASK (1<<CPU_COUNTER)

#define	BVIEW_BST_DEVICE_MASK (1<<DEVICE_COUNTER)

#define	BVIEW_BST_DEVICE_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_CPU_QUEUE_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_CPU_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_MC_QG_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_MC_QUEUE_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_MC_SQG_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_MC_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_RQE_QUEUE_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_RQE_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_SP_MC_SQ_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_SP_MC_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_SP_UM_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_UC_GRP_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_E_UC_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_EGRESS_CPU_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_EGRESS_RQE_QUEUE_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_EGRESS_UC_GRP_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_EGRESS_UC_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_EPSP_MC_SQ_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_EPSP_MC_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_EPSP_UC_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_EPSP_UM_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_IPPG_HDRM_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_IPPG_SHRD_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_IPSP_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_ISP_THRESHOLD_CHECK(_p)

#define	BVIEW_BST_MC_MASK (1<<MC_COUNTER)

#define	BVIEW_BST_MCQUEUE_MASK (1<<MCQUEUE_COUNTER)

#define	BVIEW_BST_MCSHARE_MASK (1<<MCSHARE_COUNTER)

#define	BVIEW_BST_MCSHARE_QUEUE_MASK (1<<MCSHARE_QUEUE_COUNTER)

#define	BVIEW_BST_PG_MASK (1<<BVIEW_BST_PG_POS)

#define	BVIEW_BST_PG_POS (BVIEW_BST_REALM_MAX+3)

#define	BVIEW_BST_PORT_MASK (1<<BVIEW_BST_PORT_POS)

#define	BVIEW_BST_PORT_POS (BVIEW_BST_REALM_MAX+1)

#define	BVIEW_BST_QUEUE_GRP_MASK (1<<BVIEW_BST_QUEUE_GRP_POS)

#define	BVIEW_BST_QUEUE_GRP_POS (BVIEW_BST_REALM_MAX+5)

#define	BVIEW_BST_QUEUE_MASK (1<<BVIEW_BST_QUEUE_POS)

#define	BVIEW_BST_QUEUE_POS (BVIEW_BST_REALM_MAX+4)

#define	BVIEW_BST_REALM_MAX RQE_COUNTER

#define	BVIEW_BST_RQE_MASK (1<<RQE_COUNTER)

#define	BVIEW_BST_SP_MASK (1<<BVIEW_BST_SP_POS)

#define	BVIEW_BST_SP_POS (BVIEW_BST_REALM_MAX+2)

#define	BVIEW_BST_UC_MASK (1<<UC_COUNTER)

#define	BVIEW_BST_UCSHARE_MASK (1<<UCSHARE_COUNTER)

#define	BVIEW_BST_UMHEADROOM_MASK (1<<UMHEADROOM_COUNTER)

#define	BVIEW_BST_UMSHARE_MASK (1<<UMSHARE_COUNTER)

#define	BVIEW_MAX_STRING_NAME_LEN 256

Typedefs
typedef struct _bst_asic_data_snapshot_	BVIEW_BST_ASIC_SNAPSHOT_DATA_t

typedef enum _bst_collection_mode_	BVIEW_BST_COLLECTION_MODE

typedef struct _bst_config_	BVIEW_BST_CONFIG_t

typedef enum _threshold_fields_	BVIEW_BST_COUNTER_t

typedef struct _bst_device_	BVIEW_BST_DEVICE_DATA_t

typedef struct _bst_device_threshold_	BVIEW_BST_DEVICE_THRESHOLD_t

typedef struct _bst_cpu_q_	BVIEW_BST_EGRESS_CPU_QUEUE_DATA_t

typedef struct _bst_cpu_q_threshold_	BVIEW_BST_EGRESS_CPU_QUEUE_THRESHOLD_t

typedef struct _bst_e_mcq_	BVIEW_BST_EGRESS_MC_QUEUE_DATA_t

typedef struct _bst_e_mcq_threshold_	BVIEW_BST_EGRESS_MC_QUEUE_THRESHOLD_t

typedef struct _bst_e_p_sp_	BVIEW_BST_EGRESS_PORT_SP_DATA_t

typedef struct _bst_ep_sp_threshold_	BVIEW_BST_EGRESS_PORT_SP_THRESHOLD_t

typedef struct _bst_rqe_q_	BVIEW_BST_EGRESS_RQE_QUEUE_DATA_t

typedef struct _bst_rqe_q_threshold_	BVIEW_BST_EGRESS_RQE_QUEUE_THRESHOLD_t

typedef struct _bst_e_sp_	BVIEW_BST_EGRESS_SP_DATA_t

typedef struct _bst_e_sp_threshold_	BVIEW_BST_EGRESS_SP_THRESHOLD_t

typedef struct _bst_e_ucq_	BVIEW_BST_EGRESS_UC_QUEUE_DATA_t

typedef struct _bst_e_ucq_threshold_	BVIEW_BST_EGRESS_UC_QUEUE_THRESHOLD_t

typedef struct _bst_e_ucqg_	BVIEW_BST_EGRESS_UC_QUEUEGROUPS_DATA_t

typedef struct _bst_e_ucqg_threshold_	BVIEW_BST_EGRESS_UC_QUEUEGROUPS_THRESHOLD_t

typedef struct _bst_i_p_pg_	BVIEW_BST_INGRESS_PORT_PG_DATA_t

typedef struct _bst_i_p_pg_threshold_	BVIEW_BST_INGRESS_PORT_PG_THRESHOLD_t

typedef struct _bst_i_p_sp_	BVIEW_BST_INGRESS_PORT_SP_DATA_t

typedef struct _bst_i_p_sp_threshold_	BVIEW_BST_INGRESS_PORT_SP_THRESHOLD_t

typedef struct _bst_i_sp_	BVIEW_BST_INGRESS_SP_DATA_t

typedef struct _bst_i_sp_threshold_	BVIEW_BST_INGRESS_SP_THRESHOLD_t

typedef BVIEW_STATUS(*	BVIEW_BST_TRIGGER_CALLBACK_t )(int asic, void cookie, BVIEW_BST_TRIGGER_INFO_t triggerInfo)

typedef struct _bst_trigger_info_	BVIEW_BST_TRIGGER_INFO_t

typedef enum _bst_trigger_type_	BVIEW_BST_TRIGGER_TYPE

Enumerations
enum	_bst_collection_mode_ { BVIEW_BST_MODE_CURRENT = 1, BVIEW_BST_MODE_PEAK }

enum	_bst_trigger_type_ { BVIEW_BST_TRIGGER_DEVICE = (0x1 << 0), BVIEW_BST_TRIGGER_INGRESS = (0x1 << 1), BVIEW_BST_TRIGGER_EGRESS = (0x1 << 2) }

enum	_threshold_fields_ { DEVICE_COUNTER = 0, UMSHARE_COUNTER, UMHEADROOM_COUNTER, UCSHARE_COUNTER, MCSHARE_COUNTER, MCSHARE_QUEUE_COUNTER, UC_COUNTER, MCQUEUE_COUNTER, MC_COUNTER, CPU_COUNTER, RQE_COUNTER }

Functions
BVIEW_STATUS	bst_app_config_init (unsigned int num_units)
	: function to initializes bst structures to default values

BVIEW_STATUS	bst_app_main (void)
	: bst main application function which does processing of messages

void	bst_app_uninit ()
	: function to clean up bst application

BVIEW_STATUS	bst_cancel_request (unsigned int unit, unsigned int id)

BVIEW_STATUS	bst_main ()
	: function to creathe the bst application thread.

Data Structures

Macros

Typedefs

Enumerations

Functions