OpenNSL API Guide and Reference Manual: include/opennsl/mplsX.h File Reference

#include <opennsl/types.h>
#include <opennsl/vlan.h>
#include <opennsl/switch.h>

Data Structures
struct	opennsl_mpls_egress_label_s
	opennsl_mpls_egress_label_s More...

struct	opennsl_mpls_entropy_identifier_s
	MPLS Entropy identifier Config Structure. More...

struct	opennsl_mpls_exp_map_s
	MPLS EXP Map Structure. More...

struct	opennsl_mpls_port_s
	MPLS port type. More...

struct	opennsl_mpls_range_action_s
	MPLS range action. More...

struct	opennsl_mpls_tunnel_switch_s
	MPLS tunnel switch structure. More...

struct	opennsl_mpls_vpn_config_s
	MPLS VPN Config Structure. More...

Macros
#define	OPENNSL_MPLS_EGRESS_LABEL_ACTION_VALID 0x00002000
	When set action is taken from action field.

#define	OPENNSL_MPLS_EGRESS_LABEL_REPLACE 0x00004000
	Replace existing entry.

#define	OPENNSL_MPLS_EGRESS_LABEL_TTL_COPY 0x00000002

#define	OPENNSL_MPLS_EGRESS_LABEL_TTL_DECREMENT 0x00000004

#define	OPENNSL_MPLS_EGRESS_LABEL_TTL_SET 0x00000001

#define	OPENNSL_MPLS_EGRESS_LABEL_WITH_ID 0x00008000
	Add using the specified ID.

#define	OPENNSL_MPLS_SWITCH_INNER_TTL 0x00000100
	(POP/PHP) Get TTL from header following popped label.

#define	OPENNSL_MPLS_SWITCH_TTL_DECREMENT 0x00000200
	Decrement the TTL value by 1.

#define	OPENNSL_MPLS_VPN_L3 0x00000001

#define	OPENNSL_MPLS_VPN_REPLACE 0x00000008

#define	OPENNSL_MPLS_VPN_VPLS 0x00000004

#define	OPENNSL_MPLS_VPN_VPWS 0x00000002

#define	OPENNSL_MPLS_VPN_WITH_ID 0x00000010

Typedefs
typedef enum opennsl_mpls_egress_action_e	opennsl_mpls_egress_action_t
	MPLS label egress actions.

typedef struct opennsl_mpls_egress_label_s	opennsl_mpls_egress_label_t
	opennsl_mpls_egress_label_s

typedef struct opennsl_mpls_entropy_identifier_s	opennsl_mpls_entropy_identifier_t
	MPLS Entropy identifier Config Structure.

typedef int(*	opennsl_mpls_entropy_identifier_traverse_cb )(int unit, opennsl_mpls_entropy_identifier_t info, void user_data)

typedef struct opennsl_mpls_exp_map_s	opennsl_mpls_exp_map_t
	MPLS EXP Map Structure.

typedef enum opennsl_mpls_port_control_channel_type_e	opennsl_mpls_port_control_channel_type_t
	VCCV Control Channel Type.

typedef enum opennsl_mpls_port_match_e	opennsl_mpls_port_match_t
	MPLS port match criteria.

typedef enum opennsl_mpls_port_stat_e	opennsl_mpls_port_stat_t
	Types of statistics that are maintained per MPLS gport.

typedef struct opennsl_mpls_port_s	opennsl_mpls_port_t
	MPLS port type.

typedef struct opennsl_mpls_range_action_s	opennsl_mpls_range_action_t
	MPLS range action.

typedef enum opennsl_mpls_stat_e	opennsl_mpls_stat_t
	MPLS statistics counters.

typedef enum opennsl_mpls_switch_action_e	opennsl_mpls_switch_action_t
	MPLS label actions.

typedef struct opennsl_mpls_tunnel_switch_s	opennsl_mpls_tunnel_switch_t
	MPLS tunnel switch structure.

typedef int(*	opennsl_mpls_tunnel_switch_traverse_cb )(int unit, opennsl_mpls_tunnel_switch_t info, void user_data)

typedef struct opennsl_mpls_vpn_config_s	opennsl_mpls_vpn_config_t
	MPLS VPN Config Structure.

typedef int(*	opennsl_mpls_vpn_traverse_cb )(int unit, opennsl_mpls_vpn_config_t info, void user_data)

Enumerations
enum	opennsl_mpls_egress_action_e { OPENNSL_MPLS_EGRESS_ACTION_SWAP = 0, OPENNSL_MPLS_EGRESS_ACTION_PHP = 1, OPENNSL_MPLS_EGRESS_ACTION_PUSH = 2, OPENNSL_MPLS_EGRESS_ACTION_NOP = 3, OPENNSL_MPLS_EGRESS_ACTION_SWAP_OR_PUSH = 4 }
	MPLS label egress actions. More...

enum	opennsl_mpls_port_control_channel_type_e { opennslMplsPortControlChannelNone = 0, opennslMplsPortControlChannelAch = 1, opennslMplsPortControlChannelRouterAlert = 2, opennslMplsPortControlChannelTtl = 3, opennslMplsPortControlChannelGalUnderPw = 4 }
	VCCV Control Channel Type. More...

enum	opennsl_mpls_port_match_e { OPENNSL_MPLS_PORT_MATCH_INVALID = 0, OPENNSL_MPLS_PORT_MATCH_NONE = 1, OPENNSL_MPLS_PORT_MATCH_PORT = 2, OPENNSL_MPLS_PORT_MATCH_PORT_VLAN = 3, OPENNSL_MPLS_PORT_MATCH_PORT_INNER_VLAN = 4, OPENNSL_MPLS_PORT_MATCH_PORT_VLAN_STACKED = 5, OPENNSL_MPLS_PORT_MATCH_VLAN_PRI = 6, OPENNSL_MPLS_PORT_MATCH_LABEL = 7, OPENNSL_MPLS_PORT_MATCH_LABEL_PORT = 8, OPENNSL_MPLS_PORT_MATCH_LABEL_VLAN = 9, OPENNSL_MPLS_PORT_MATCH_PORT_SUBPORT_PKT_VID = 10, OPENNSL_MPLS_PORT_MATCH_PORT_SUBPORT_PKT_VID_OUTER_VLAN = 11, OPENNSL_MPLS_PORT_MATCH_PORT_SUBPORT_PKT_VID_INNER_VLAN = 12, OPENNSL_MPLS_PORT_MATCH_SHARE = 13, OPENNSL_MPLS_PORT_MATCH_PORT_VLAN_TAG = 14, OPENNSL_MPLS_PORT_MATCH_PORT_INNER_VLAN_TAG = 15, OPENNSL_MPLS_PORT_MATCH_COUNT = 16 }
	MPLS port match criteria. More...

enum	opennsl_mpls_port_stat_e { opennslMplsPortStatUnicastPackets = 0, opennslMplsPortStatUnicastBytes = 1, opennslMplsPortStatNonUnicastPackets = 2, opennslMplsPortStatNonUnicastBytes = 3, opennslMplsPortStatDropPackets = 4, opennslMplsPortStatDropBytes = 5, opennslMplsPortStatFloodPackets = 6, opennslMplsPortStatFloodBytes = 7, opennslMplsPortStatFloodDropPackets = 8, opennslMplsPortStatFloodDropBytes = 9, opennslMplsPortStatGreenPackets = 10, opennslMplsPortStatGreenBytes = 11, opennslMplsPortStatYellowPackets = 12, opennslMplsPortStatYellowBytes = 13, opennslMplsPortStatRedPackets = 14, opennslMplsPortStatRedBytes = 15 }
	Types of statistics that are maintained per MPLS gport. More...

enum	opennsl_mpls_stat_e { opennslMplsInBytes = 0, opennslMplsOutBytes = 1, opennslMplsInPkts = 2, opennslMplsOutPkts = 3 }
	MPLS statistics counters. More...

enum	opennsl_mpls_switch_action_e { OPENNSL_MPLS_SWITCH_ACTION_SWAP = 0, OPENNSL_MPLS_SWITCH_ACTION_PHP = 1, OPENNSL_MPLS_SWITCH_ACTION_POP = 2, OPENNSL_MPLS_SWITCH_ACTION_POP_DIRECT = 3, OPENNSL_MPLS_SWITCH_ACTION_NOP = 4, OPENNSL_MPLS_SWITCH_EGRESS_ACTION_PUSH = 5, OPENNSL_MPLS_SWITCH_ACTION_INVALID = 6 }
	MPLS label actions. More...

Functions
int	opennsl_mpls_cleanup (int unit) LIB_DLL_EXPORTED
	Detach the MPLS software module.

void	opennsl_mpls_egress_label_t_init (opennsl_mpls_egress_label_t *label) LIB_DLL_EXPORTED
	Initialize the MPLS egress label structure.

int	opennsl_mpls_entropy_identifier_add (int unit, uint32 options, opennsl_mpls_entropy_identifier_t *info) LIB_DLL_EXPORTED
	Add an MPLS Entropy Label Identifier.

int	opennsl_mpls_entropy_identifier_delete (int unit, opennsl_mpls_entropy_identifier_t *info) LIB_DLL_EXPORTED
	Delete an MPLS Entropy Label Identifier.

int	opennsl_mpls_entropy_identifier_delete_all (int unit) LIB_DLL_EXPORTED
	Delete all MPLS Entropy Label Identifiers.

int	opennsl_mpls_entropy_identifier_get (int unit, opennsl_mpls_entropy_identifier_t *info) LIB_DLL_EXPORTED
	Get information about an MPLS Entropy Label Identifier.

void	opennsl_mpls_entropy_identifier_t_init (opennsl_mpls_entropy_identifier_t *info) LIB_DLL_EXPORTED
	Initialize MPLS Entropy label identifier structure.

int	opennsl_mpls_entropy_identifier_traverse (int unit, opennsl_mpls_entropy_identifier_traverse_cb cb, void *user_data) LIB_DLL_EXPORTED
	Traverse all valid MPLS entropy label identifier entries and call the supplied callback routine.

int	opennsl_mpls_exp_map_create (int unit, uint32 flags, int *exp_map_id) LIB_DLL_EXPORTED
	Create an MPLS EXP map instance.

int	opennsl_mpls_exp_map_destroy (int unit, int exp_map_id) LIB_DLL_EXPORTED
	Destroy an MPLS EXP map instance.

int	opennsl_mpls_exp_map_get (int unit, int exp_map_id, opennsl_mpls_exp_map_t *exp_map) LIB_DLL_EXPORTED
	Get the EXP mapping parameters for the specified EXP map.

int	opennsl_mpls_exp_map_set (int unit, int exp_map_id, opennsl_mpls_exp_map_t *exp_map) LIB_DLL_EXPORTED
	Set the EXP mapping parameters for the specified EXP map.

void	opennsl_mpls_exp_map_t_init (opennsl_mpls_exp_map_t *exp_map) LIB_DLL_EXPORTED
	Initialize the MPLS EXP map structure.

int	opennsl_mpls_init (int unit) LIB_DLL_EXPORTED
	Initialize the OPENNSL MPLS subsystem.

int	opennsl_mpls_label_stat_attach (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, uint32 stat_counter_id) LIB_DLL_EXPORTED
	Attach counters entries to the given MPLS label and gport.

int	opennsl_mpls_label_stat_clear (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat) LIB_DLL_EXPORTED
	Clear MPLS Stats.

int	opennsl_mpls_label_stat_counter_get (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Get counter statistic values for specific MPLS label and gport.

int	opennsl_mpls_label_stat_counter_set (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Set counter statistic values for specific MPLS label and gport.

int	opennsl_mpls_label_stat_counter_sync_get (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Force an immediate counter update and retrieve counter statistic values for specific MPLS label and gport.

int	opennsl_mpls_label_stat_detach (int unit, opennsl_mpls_label_t label, opennsl_gport_t port) LIB_DLL_EXPORTED
	Detach counters entries to the given MPLS label and gport.

int	opennsl_mpls_label_stat_enable_set (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, int enable) LIB_DLL_EXPORTED
	Enable/disable statistics collection for MPLS label or MPLS gport.

int	opennsl_mpls_label_stat_get (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint64 *val) LIB_DLL_EXPORTED
	Get MPLS Stats.

int	opennsl_mpls_label_stat_get32 (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 *val) LIB_DLL_EXPORTED
	Get MPLS Stats.

int	opennsl_mpls_label_stat_id_get (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 *stat_counter_id) LIB_DLL_EXPORTED
	Get stat counter ID associated with given MPLS label and gport.

int	opennsl_mpls_label_stat_sync_get (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint64 *val) LIB_DLL_EXPORTED
	Force an immediate counter update and retrieve MPLS Stats.

int	opennsl_mpls_label_stat_sync_get32 (int unit, opennsl_mpls_label_t label, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 *val) LIB_DLL_EXPORTED
	Force an immediate counter update and retrieve MPLS Stats.

int	opennsl_mpls_port_add (int unit, opennsl_vpn_t vpn, opennsl_mpls_port_t *mpls_port) LIB_DLL_EXPORTED
	Add an MPLS port to an L2 VPN.

int	opennsl_mpls_port_delete (int unit, opennsl_vpn_t vpn, opennsl_gport_t mpls_port_id) LIB_DLL_EXPORTED
	Delete an MPLS port from an L2 VPN.

int	opennsl_mpls_port_delete_all (int unit, opennsl_vpn_t vpn) LIB_DLL_EXPORTED
	Delete an MPLS port from an L2 VPN.

int	opennsl_mpls_port_get (int unit, opennsl_vpn_t vpn, opennsl_mpls_port_t *mpls_port) LIB_DLL_EXPORTED
	Get an MPLS port from an L2 VPN.

int	opennsl_mpls_port_get_all (int unit, opennsl_vpn_t vpn, int port_max, opennsl_mpls_port_t port_array, int port_count) LIB_DLL_EXPORTED
	Get all MPLS ports from an L2 VPN.

int	opennsl_mpls_port_stat_attach (int unit, opennsl_vpn_t vpn, opennsl_gport_t port, uint32 stat_counter_id) LIB_DLL_EXPORTED
	Attach counters entries to the given MPLS gport and vpn.

int	opennsl_mpls_port_stat_counter_get (int unit, opennsl_vpn_t vpn, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Get counter statistic values for specific vpn and gport.

int	opennsl_mpls_port_stat_counter_set (int unit, opennsl_vpn_t vpn, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Set counter statistic values for specific vpn and gport.

int	opennsl_mpls_port_stat_counter_sync_get (int unit, opennsl_vpn_t vpn, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Force an immediate counter update and retrieve get counter statistic values for specific vpn and gport.

int	opennsl_mpls_port_stat_detach (int unit, opennsl_vpn_t vpn, opennsl_gport_t port) LIB_DLL_EXPORTED
	Detach counters entries to the given MPLS port and vpn.

int	opennsl_mpls_port_stat_enable_set (int unit, opennsl_gport_t mpls_port, int enable) LIB_DLL_EXPORTED
	Enable or disable collection of MPLS port statistics.

int	opennsl_mpls_port_stat_get (int unit, opennsl_gport_t mpls_port, opennsl_cos_t cos, opennsl_mpls_port_stat_t stat, uint64 *val) LIB_DLL_EXPORTED
	Get the specified statistics per MPLS/MEF port.

int	opennsl_mpls_port_stat_get32 (int unit, opennsl_gport_t mpls_port, opennsl_cos_t cos, opennsl_mpls_port_stat_t stat, uint32 *val) LIB_DLL_EXPORTED
	Get the specified statistics per MPLS/MEF port.

int	opennsl_mpls_port_stat_id_get (int unit, opennsl_vpn_t vpn, opennsl_gport_t port, opennsl_mpls_stat_t stat, uint32 *stat_counter_id) LIB_DLL_EXPORTED
	Get stat counter ID associated with given MPLS gport and VPN.

int	opennsl_mpls_port_stat_set (int unit, opennsl_gport_t mpls_port, opennsl_cos_t cos, opennsl_mpls_port_stat_t stat, uint64 val) LIB_DLL_EXPORTED
	Set the specified statistic to the indicated value.

int	opennsl_mpls_port_stat_set32 (int unit, opennsl_gport_t mpls_port, opennsl_cos_t cos, opennsl_mpls_port_stat_t stat, uint32 val) LIB_DLL_EXPORTED

void	opennsl_mpls_port_t_init (opennsl_mpls_port_t *mpls_port) LIB_DLL_EXPORTED
	Initialize the MPLS port structure.

int	opennsl_mpls_range_action_add (int unit, opennsl_mpls_label_t label_low, opennsl_mpls_label_t label_high, opennsl_mpls_range_action_t *action) LIB_DLL_EXPORTED
	Set range of labels per in lif.

int	opennsl_mpls_range_action_get (int unit, opennsl_mpls_label_t label_low, opennsl_mpls_label_t label_high, opennsl_mpls_range_action_t *action) LIB_DLL_EXPORTED
	Get range of labels per in lif.

int	opennsl_mpls_range_action_remove (int unit, opennsl_mpls_label_t label_low, opennsl_mpls_label_t label_high) LIB_DLL_EXPORTED
	Remove range of labels per in lif.

void	opennsl_mpls_range_action_t_init (opennsl_mpls_range_action_t *label) LIB_DLL_EXPORTED
	Initialize the MPLS range action structure.

int	opennsl_mpls_tunnel_initiator_clear (int unit, opennsl_if_t intf) LIB_DLL_EXPORTED
	Clear the MPLS tunnel initiator parameters for an L3 interface.

int	opennsl_mpls_tunnel_initiator_clear_all (int unit) LIB_DLL_EXPORTED
	Clear all MPLS tunnel initiator information.

int	opennsl_mpls_tunnel_initiator_create (int unit, opennsl_if_t intf, int num_labels, opennsl_mpls_egress_label_t *label_array) LIB_DLL_EXPORTED

int	opennsl_mpls_tunnel_initiator_get (int unit, opennsl_if_t intf, int label_max, opennsl_mpls_egress_label_t label_array, int label_count) LIB_DLL_EXPORTED
	Get the MPLS tunnel initiator parameters from an L3 interface.

int	opennsl_mpls_tunnel_initiator_set (int unit, opennsl_if_t intf, int num_labels, opennsl_mpls_egress_label_t *label_array) LIB_DLL_EXPORTED
	Set the MPLS tunnel initiator parameters for an L3 interface.

int	opennsl_mpls_tunnel_stat_attach (int unit, opennsl_if_t intf_id, uint32 stat_counter_id) LIB_DLL_EXPORTED
	Attach statistics entity to the MPLS tunnel derived from the given L3 Egress interface.

int	opennsl_mpls_tunnel_stat_counter_get (int unit, opennsl_if_t intf_id, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Get counter value for the specified MPLS statistic type and Tunnel interface derived from the given L3 interface ID.

int	opennsl_mpls_tunnel_stat_counter_set (int unit, opennsl_if_t intf_id, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Set the counter value for the specified MPLS statistic type and Tunnel interface derived derived from the given L3 Interface ID.

int	opennsl_mpls_tunnel_stat_counter_sync_get (int unit, opennsl_if_t intf_id, opennsl_mpls_stat_t stat, uint32 num_entries, uint32 counter_indexes, opennsl_stat_value_t counter_values) LIB_DLL_EXPORTED
	Force an immediate counter update and retrieve the specified counter statistic for a MPLS tunnel.

int	opennsl_mpls_tunnel_stat_detach (int unit, opennsl_if_t intf_id) LIB_DLL_EXPORTED
	Detach statistics entity to the MPLS tunnel derived from the given L3 Egress interface.

int	opennsl_mpls_tunnel_stat_id_get (int unit, opennsl_if_t intf_id, opennsl_mpls_stat_t stat, uint32 *stat_counter_id) LIB_DLL_EXPORTED
	Get stat counter ID associated with the MPLS tunnel derived from the given L3 interface ID.

int	opennsl_mpls_tunnel_switch_add (int unit, opennsl_mpls_tunnel_switch_t *info) LIB_DLL_EXPORTED
	Add an MPLS label entry.

int	opennsl_mpls_tunnel_switch_create (int unit, opennsl_mpls_tunnel_switch_t *info) LIB_DLL_EXPORTED
	Add an MPLS label entry.

int	opennsl_mpls_tunnel_switch_delete (int unit, opennsl_mpls_tunnel_switch_t *info) LIB_DLL_EXPORTED
	Delete an MPLS label entry.

int	opennsl_mpls_tunnel_switch_delete_all (int unit) LIB_DLL_EXPORTED
	Delete all MPLS label entries.

int	opennsl_mpls_tunnel_switch_get (int unit, opennsl_mpls_tunnel_switch_t *info) LIB_DLL_EXPORTED
	Get an MPLS label entry.

void	opennsl_mpls_tunnel_switch_t_init (opennsl_mpls_tunnel_switch_t *info) LIB_DLL_EXPORTED
	Initialize the MPLS tunnel switch structure.

int	opennsl_mpls_tunnel_switch_traverse (int unit, opennsl_mpls_tunnel_switch_traverse_cb cb, void *user_data) LIB_DLL_EXPORTED
	Traverse all valid MPLS label entries and call the supplied callback routine.

void	opennsl_mpls_vpn_config_t_init (opennsl_mpls_vpn_config_t *info) LIB_DLL_EXPORTED
	Initialize the MPLS VPN config structure.

int	opennsl_mpls_vpn_id_create (int unit, opennsl_mpls_vpn_config_t *info) LIB_DLL_EXPORTED
	Create an MPLS VPN.

int	opennsl_mpls_vpn_id_destroy (int unit, opennsl_vpn_t vpn) LIB_DLL_EXPORTED
	Destroy an MPLS VPN.

int	opennsl_mpls_vpn_id_destroy_all (int unit) LIB_DLL_EXPORTED
	Destroy an MPLS VPN.

int	opennsl_mpls_vpn_id_get (int unit, opennsl_vpn_t vpn, opennsl_mpls_vpn_config_t *info) LIB_DLL_EXPORTED
	Get an MPLS VPN.

int	opennsl_mpls_vpn_traverse (int unit, opennsl_mpls_vpn_traverse_cb cb, void *user_data) LIB_DLL_EXPORTED
	Traverse all valid MPLS VPN entries and call the supplied callback routine.

Data Structures

Macros

Typedefs

Enumerations

Functions