sx_api_flow_counter.h File Reference

Go to the source code of this file.

Macros
#define	__SX_API_FLOW_COUNTER_H__sdk

Functions
sx_status_t	sx_api_flow_counter_log_verbosity_level_set (const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, const sx_verbosity_level_t module_verbosity_level, const sx_verbosity_level_t api_verbosity_level)
sx_status_t	sx_api_flow_counter_log_verbosity_level_get (const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, sx_verbosity_level_t *module_verbosity_level_p, sx_verbosity_level_t *api_verbosity_level_p)
sx_status_t	sx_api_flow_counter_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_flow_counter_type_t counter_type, sx_flow_counter_id_t *counter_id_p)
sx_status_t	sx_api_flow_counter_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_flow_counter_id_t counter_id, sx_flow_counter_set_t *counter_set_p)
sx_status_t	sx_api_flow_counter_iter_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_flow_counter_id_t counter_id_key, sx_flow_counter_filter_t *counter_filter_p, sx_flow_counter_id_t *counter_id_list_p, uint32_t *counter_id_cnt_p)
sx_status_t	sx_api_flow_counter_clear_set (const sx_api_handle_t handle, const sx_flow_counter_id_t counter_id)

Macro Definition Documentation

__SX_API_FLOW_COUNTER_H__sdk

#define __SX_API_FLOW_COUNTER_H__sdk

Function Documentation

sx_api_flow_counter_log_verbosity_level_set()

sx_status_t sx_api_flow_counter_log_verbosity_level_set	(	const sx_api_handle_t	handle,
		const sx_log_verbosity_target_t	verbosity_target,
		const sx_verbosity_level_t	module_verbosity_level,
		const sx_verbosity_level_t	api_verbosity_level
	)

This function sets the log verbosity level of FLOW COUNTER MODULE Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- set verbosity of : API / MODULE / BOTH
[in]	module_verbosity_level	- FLOW COUNTER module verbosity level
[in]	api_verbosity_level	- FLOW COUNTER API verbosity level

Returns

SX_STATUS_SUCCESS if operation completes successfully SX_STATUS_PARAM_ERROR if any input parameters is invalid SX_STATUS_ERROR general error

sx_api_flow_counter_log_verbosity_level_get()

sx_status_t sx_api_flow_counter_log_verbosity_level_get	(	const sx_api_handle_t	handle,
		const sx_log_verbosity_target_t	verbosity_target,
		sx_verbosity_level_t *	module_verbosity_level_p,
		sx_verbosity_level_t *	api_verbosity_level_p
	)

This function gets the log verbosity level of FLOW COUNTER MODULE Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- get verbosity of : API / MODULE / BOTH
[out]	module_verbosity_level_p	- FLOW COUNTER module verbosity level
[out]	api_verbosity_level_p	- FLOW COUNTER API verbosity level

Returns

SX_STATUS_SUCCESS if operation completes successfully SX_STATUS_PARAM_ERROR if any input parameters is invalid SX_STATUS_ERROR general error

sx_api_flow_counter_set()

sx_status_t sx_api_flow_counter_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_flow_counter_type_t	counter_type,
		sx_flow_counter_id_t *	counter_id_p
	)

This function is used to create packets/bytes counter. for creation use command CREATE and supply counter_type. flow_counter_id is returned on successful creation. for destroying an flow counter it is required that the flow counter is not bound to an ACL and the flow_counter_id should be provided. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- CREATE / DESTROY
[in]	counter_type	- counter type used
[in,out]	counter_id_p	- Flow counter ID as described above

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL or SX_STATUS_PARAM_EXCEEDS_RANGE if any input parameter is invalid

SX_STATUS_NO_RESOURCES if no Flow counter is available to create

SX_STATUS_CMD_UNSUPPORTED if unsupported command is requested

SX_STATUS_INVALID_HANDLE if called Invalid Handle

SX_STATUS_ENTRY_NOT_FOUND if called with DESTROY command and counter does not exist

sx_api_flow_counter_get()

sx_status_t sx_api_flow_counter_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_flow_counter_id_t	counter_id,
		sx_flow_counter_set_t *	counter_set_p
	)

This function retrieves the Flow Counter. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	counter_id	- Flow counter ID
[out]	counter_val_p	- counter value.

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE: event mode out of range.

SX_STATUS_MESSAGE_SIZE_ZERO: Message size error.

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT: Message size error.

SX_STATUS_COMM_ERROR: Communication error - send fail.

SX_STATUS_INVALID_HANDLE: Invalid Handle.

sx_api_flow_counter_iter_get()

sx_status_t sx_api_flow_counter_iter_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_flow_counter_id_t	counter_id_key,
		sx_flow_counter_filter_t *	counter_filter_p,
		sx_flow_counter_id_t *	counter_id_list_p,
		uint32_t *	counter_id_cnt_p
	)

This function gets a list of Flow counters Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	GET/GET_NEXT/GET_FIRST
[in]	counter_id_key	- Flow counter ID to use and key.
[in]	counter_filter_p	- Filter to use (not supported yet)
[out]	counter_id_list_p	- pointer to the list of Flow counter IDs returned.
[in,out]	counter_id_cnt_p	[in] number of entries to retrieve; [out] retrieved number of entries.

The following use case scenarios apply with different input parameters X = don't-care

• 1) cmd = SX_ACCESS_CMD_GET, key = X, Filter = X, list = X, Count =0: In this case the API will return the total number of flow counters in the Internal db
• 2) cmd = SX_ACCESS_CMD_GET, key = valid/invalid, Filter = X, list = Valid, Count = 1: In this case the API will check if the specified key exists. if it does the key will be returned in the list along with a count of 1. If the key does not exist an empty list will be returned with count = 0
• 3) cmd = SX_ACCESS_CMD_GET, key = valid, Filter = X, list is Valid, Count > 1: A count >1 will be treated as a count of 1 and the behaviour will be same as earlier GET use cases.
• 5) cmd = SX_ACCESS_CMD_GET_FIRST/SX_ACCESS_CMD_GETNEXT, key = X, Filter = X, hist_list = Null, Count =0: For either SX_ACCESS_CMD_GET_FIRST/SX_ACCESS_CMD_GETNEXT a zero count will return an empty list.
• 6) cmd = SX_ACCESS_CMD_GET_FIRST, key = X, Filter = X, list = Valid, Count > 0: In this case the API will return the first flow counters starting from the head of the database. The total elements fetched will be returned as the return count. Note: return count may be less than or equal to the requested count. The key is dont-care but a non-Null return list pointer must be provided
• 7) cmd = SX_ACCESS_CMD_GETNEXT, key = valid/invalid, Filter = X , list = Valid, Count > 0: In this case the API will return the next set of counters starting from the next valid counter after the specified key. The total elements fetched will be returned as the return count. Note: return count may be less than or equal to the requested count. If no valid next counter exists in the db (key = end of list, or invalid key specified, or key too large), an empty list will be returned.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_EXCEEDS_RANGE if parameters exceed range.

SX_STATUS_PARAM_ERROR if parameter is invalid.

SX_STATUS_CMD_UNSUPPORTED if command is not supported

SX_STATUS_INVALID_HANDLE if handle in invalid

SX_STATUS_ERROR general error.

sx_api_flow_counter_clear_set()

sx_status_t sx_api_flow_counter_clear_set	(	const sx_api_handle_t	handle,
		const sx_flow_counter_id_t	counter_id
	)

This function clear a specific Flow Counter. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	counter_id	- Flow counter ID to clear

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE: event mode out of range.

SX_STATUS_MESSAGE_SIZE_ZERO: Message size error.

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT: Message size error.

SX_STATUS_COMM_ERROR: Communication error - send fail.

SX_STATUS_INVALID_HANDLE: Invalid Handle.

SX_STATUS_ENTRY_NOT_FOUND: Clear an invalid counter.