sx_api_policer.h File Reference

Go to the source code of this file.

Functions
sx_status_t	sx_api_policer_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_policer_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_policer_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_policer_attributes_t *policer_attr_p, sx_policer_id_t *policer_id_p)
sx_status_t	sx_api_policer_get (const sx_api_handle_t handle, const sx_policer_id_t policer_id, sx_policer_attributes_t *policer_attr_p)
sx_status_t	sx_api_policer_iter_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_policer_id_t policer_id_key, sx_policer_id_filter_t *policer_id_filter_p, sx_policer_id_t *policer_id_list_p, uint32_t *policer_id_cnt_p)
sx_status_t	sx_api_policer_counters_clear_set (const sx_api_handle_t handle, const sx_policer_id_t policer_id, const sx_policer_counters_clear_t *clear_counters_p)
sx_status_t	sx_api_policer_counters_get (const sx_api_handle_t handle, const sx_policer_id_t policer_id, sx_policer_counters_t *policer_counters_p)

Function Documentation

sx_api_policer_log_verbosity_level_set()

sx_status_t sx_api_policer_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 POLICER MODULE Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- set verbosity of : API / MODULE / BOTH
[in]	module_verbosity_level	- POLICER module verbosity level
[in]	api_verbosity_level	- POLICER 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_policer_log_verbosity_level_get()

sx_status_t sx_api_policer_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 POLICER 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	- POLICER module verbosity level
[out]	api_verbosity_level_p	- POLICER 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_policer_set()

sx_status_t sx_api_policer_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_policer_attributes_t *	policer_attr_p,
		sx_policer_id_t *	policer_id_p
	)

This function creates/destroy/edit a policer in the system. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_CREATE: create a new policer and returns a policer ID in policer_id_p SX_ACCESS_CMD_DESTROY: destroy an existing policer (according to policer_id_p) SX_ACCESS_CMD_EDIT: edit configuration parameters of an existing policer. only CIR, EIR, EBS, CBS, yellow action and red action can be edited
[in]	policer_attr_p	- policer attributes. Ignored when cmd is DESTROY.
[in,out]	policer_id_p	- policer ID

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_CMD_UNSUPPORTED if cmd is SX_ACCESS_CMD_DESTROY or any other unsupported command

SX_STATUS_PARAM_ERROR if any of the input parameters is invalid

SX_STATUS_ERROR general error

SX_STATUS_NO_RESOURCES if there are no more resources

SX_STATUS_RESOURCE_IN_USE if trying to destroy a bound policer

SX_STATUS_WRONG_POLICER_TYPE if wrong policer_type was supplied

sx_api_policer_get()

sx_status_t sx_api_policer_get	(	const sx_api_handle_t	handle,
		const sx_policer_id_t	policer_id,
		sx_policer_attributes_t *	policer_attr_p
	)

This function gets policer attributes. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	policer_id	- policer ID
[out]	policer_attr_p	- pointer to policer attributes

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any other input error

SX_STATUS_ERROR general error

sx_api_policer_iter_get()

sx_status_t sx_api_policer_iter_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_policer_id_t	policer_id_key,
		sx_policer_id_filter_t *	policer_id_filter_p,
		sx_policer_id_t *	policer_id_list_p,
		uint32_t *	policer_id_cnt_p
	)

This function retrieves a list of Policer IDs. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	GET/GET_NEXT/GET_FIRST.
[in]	policer_id_key	- Policer ID to use as key.
[in]	policer_filter_p	- Filter to use (not supported yet).
[out]	policer_id_list_p	- pointer to the list of Policer IDs returned.
[in,out]	policer_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 policers 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, 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 policer IDs 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 IDs starting from the next valid policer 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_ERROR if parameter is invalid.

SX_STATUS_CMD_UNSUPPORTED if command is not supported.

SX_STATUS_INVALID_HANDLE if handle is invalid.

SX_STATUS_ERROR general error.

sx_api_policer_counters_clear_set()

sx_status_t sx_api_policer_counters_clear_set	(	const sx_api_handle_t	handle,
		const sx_policer_id_t	policer_id,
		const sx_policer_counters_clear_t *	clear_counters_p
	)

This function clears policer counters values. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	policer_id	- policer ID
[in]	clear_counters	- which counters to clear

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any other input error

SX_STATUS_ERROR general error

sx_api_policer_counters_get()

sx_status_t sx_api_policer_counters_get	(	const sx_api_handle_t	handle,
		const sx_policer_id_t	policer_id,
		sx_policer_counters_t *	policer_counters_p
	)

This function retrieves policer counters values. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	policer_id	- policer ID
[out]	policer_counters_p	- pointer to a policer counter struct.

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any other input error

SX_STATUS_ERROR general error