[mirror_frr.git] / isisd / isis_te.h

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * IS-IS Rout(e)ing protocol - isis_te.c
 *
 * This is an implementation of RFC5305, RFC 5307 and RFC 7810
 *
 * Author: Olivier Dugeon <olivier.dugeon@orange.com>
 *
 * Copyright (C) 2014 - 2019 Orange Labs http://www.orange.com
 */

#ifndef _ZEBRA_ISIS_MPLS_TE_H
#define _ZEBRA_ISIS_MPLS_TE_H

/*
 * Traffic Engineering information are transport through LSP:
 *  - Extended IS Reachability          TLV = 22
 *  - Traffic Engineering Router ID     TLV = 134
 *  - Extended IP Reachability          TLV = 135
 *  - Inter-AS Reachability Information TLV = 141
 *
 *  and support following sub-TLV:
 *
 * Name                           Value   Status
 * _________________________________________________
 * Administartive group (color)       3   RFC5305
 * Link Local/Remote Identifiers      4   RFC5307
 * IPv4 interface address             6   RFC5305
 * IPv4 neighbor address              8   RFC5305
 * Maximum link bandwidth             9   RFC5305
 * Reservable link bandwidth         10   RFC5305
 * Unreserved bandwidth              11   RFC5305
 * TE Default metric                 18   RFC5305
 * Link Protection Type              20   RFC5307
 * Interface Switching Capability    21   RFC5307
 * Remote AS number                  24   RFC5316
 * IPv4 Remote ASBR identifier       25   RFC5316
 *
 * NOTE: RFC5316 is not fully supported in this version
 * only subTLVs decoding is provided
 */

/* Following define the type of TE link regarding the various RFC */
#define STD_TE			0x01
#define GMPLS			0x02
#define INTER_AS 		0x04
#define FLOOD_L1		0x10
#define FLOOD_L2		0x20
#define FLOOD_AS                0x40
#define EMULATED		0x80

#define IS_STD_TE(x) 		(x & STD_TE)
#define IS_INTER_AS(x) 		(x & INTER_AS)
#define IS_EMULATED(x)		(x & EMULATED)
#define IS_FLOOD_L1(x)		(x & FLOOD_L1)
#define IS_FLOOD_L2(x)		(x & FLOOD_L2)
#define IS_FLOOD_AS(x)          (x & FLOOD_AS)
#define IS_INTER_AS_EMU(x) 	(x & INTER_AS & EMULATED)
#define IS_INTER_AS_AS(x)	(x & INTER_AS & FLOOD_AS)

/*
 * Note (since release 7.2), subTLVs definition, serialization
 * and de-serialization have mode to isis_tlvs.[c,h]
 */

/* Following declaration concerns the MPLS-TE and LINk-TE management */
typedef enum _status_t { disable, enable, learn } status_t;

/* Mode for Inter-AS LSP */ /* TODO: Check how if LSP is flooded in RFC5316 */
typedef enum _interas_mode_t { off, region, as, emulate } interas_mode_t;

#define IS_EXT_TE(e)    (e && e->status != 0			\
			   && e->status != EXT_ADJ_SID		\
			   && e->status != EXT_LAN_ADJ_SID)
#define IS_MPLS_TE(a)	(a && a->status == enable)
#define IS_EXPORT_TE(a) (a->export)

/* Per area MPLS-TE parameters */
struct ls_ted;
struct mpls_te_area {
	/* Status of MPLS-TE: enable or disable */
	status_t status;

	/* L1, L1-L2, L2-Only */
	uint8_t level;

	/* RFC5316 */
	interas_mode_t inter_as;
	struct in_addr interas_areaid;

	/* MPLS_TE IPv4 & IPv6 Router IDs */
	struct in_addr router_id;
	struct in6_addr router_id_ipv6;

	/* Link State Database */
	struct ls_ted *ted;
	bool export;
};

/* Structure to provide parameters to lsp iterate callback function */
struct isis_te_args {
	struct ls_ted *ted;
	struct ls_vertex *vertex;
	bool export;
};

enum lsp_event { LSP_UNKNOWN, LSP_ADD, LSP_UPD, LSP_DEL, LSP_INC, LSP_TICK };

/* Prototypes. */
void isis_mpls_te_init(void);
void isis_mpls_te_create(struct isis_area *area);
void isis_mpls_te_disable(struct isis_area *area);
void isis_mpls_te_term(struct isis_area *area);
void isis_link_params_update(struct isis_circuit *, struct interface *);
int isis_mpls_te_update(struct interface *);
void isis_te_lsp_event(struct isis_lsp *lsp, enum lsp_event event);
int isis_te_sync_ted(struct zapi_opaque_reg_info dst);
void isis_te_init_ted(struct isis_area *area);

#endif /* _ZEBRA_ISIS_MPLS_TE_H */
Commit	Line	Data
acddc0ed	1	// SPDX-License-Identifier: GPL-2.0-or-later
f8c06e2c OD	2	/*
	3	* IS-IS Rout(e)ing protocol - isis_te.c
	4	*
68558b13	5	* This is an implementation of RFC5305, RFC 5307 and RFC 7810
f8c06e2c	6	*
1b3f47d0 OD	7	* Author: Olivier Dugeon <olivier.dugeon@orange.com>
	8	*
	9	* Copyright (C) 2014 - 2019 Orange Labs http://www.orange.com
f8c06e2c OD	10	*/
	11
	12	#ifndef _ZEBRA_ISIS_MPLS_TE_H
	13	#define _ZEBRA_ISIS_MPLS_TE_H
	14
	15	/*
	16	* Traffic Engineering information are transport through LSP:
	17	* - Extended IS Reachability TLV = 22
	18	* - Traffic Engineering Router ID TLV = 134
	19	* - Extended IP Reachability TLV = 135
	20	* - Inter-AS Reachability Information TLV = 141
	21	*
	22	* and support following sub-TLV:
	23	*
	24	* Name Value Status
	25	* _________________________________________________
	26	* Administartive group (color) 3 RFC5305
	27	* Link Local/Remote Identifiers 4 RFC5307
	28	* IPv4 interface address 6 RFC5305
	29	* IPv4 neighbor address 8 RFC5305
	30	* Maximum link bandwidth 9 RFC5305
	31	* Reservable link bandwidth 10 RFC5305
	32	* Unreserved bandwidth 11 RFC5305
	33	* TE Default metric 18 RFC5305
	34	* Link Protection Type 20 RFC5307
	35	* Interface Switching Capability 21 RFC5307
	36	* Remote AS number 24 RFC5316
	37	* IPv4 Remote ASBR identifier 25 RFC5316
	38	*
1b3f47d0 OD	39	* NOTE: RFC5316 is not fully supported in this version
1b3f47d0 OD	40	* only subTLVs decoding is provided
f8c06e2c OD	41	*/
f8c06e2c OD	42
f8c06e2c OD	43	/* Following define the type of TE link regarding the various RFC */
	44	#define STD_TE 0x01
	45	#define GMPLS 0x02
	46	#define INTER_AS 0x04
	47	#define FLOOD_L1 0x10
	48	#define FLOOD_L2 0x20
	49	#define FLOOD_AS 0x40
	50	#define EMULATED 0x80
	51
	52	#define IS_STD_TE(x) (x & STD_TE)
	53	#define IS_INTER_AS(x) (x & INTER_AS)
	54	#define IS_EMULATED(x) (x & EMULATED)
	55	#define IS_FLOOD_L1(x) (x & FLOOD_L1)
	56	#define IS_FLOOD_L2(x) (x & FLOOD_L2)
	57	#define IS_FLOOD_AS(x) (x & FLOOD_AS)
	58	#define IS_INTER_AS_EMU(x) (x & INTER_AS & EMULATED)
	59	#define IS_INTER_AS_AS(x) (x & INTER_AS & FLOOD_AS)
	60
	61	/*
1b3f47d0 OD	62	* Note (since release 7.2), subTLVs definition, serialization
1b3f47d0 OD	63	* and de-serialization have mode to isis_tlvs.[c,h]
f8c06e2c	64	*/
f8c06e2c OD	65
	66	/* Following declaration concerns the MPLS-TE and LINk-TE management */
	67	typedef enum _status_t { disable, enable, learn } status_t;
	68
	69	/* Mode for Inter-AS LSP / / TODO: Check how if LSP is flooded in RFC5316 */
	70	typedef enum _interas_mode_t { off, region, as, emulate } interas_mode_t;
	71
1b3f47d0 OD	72	#define IS_EXT_TE(e) (e && e->status != 0 \
	73	&& e->status != EXT_ADJ_SID \
	74	&& e->status != EXT_LAN_ADJ_SID)
	75	#define IS_MPLS_TE(a) (a && a->status == enable)
ed6189a9	76	#define IS_EXPORT_TE(a) (a->export)
f8c06e2c	77
2e2a8b91	78	/* Per area MPLS-TE parameters */
ed6189a9	79	struct ls_ted;
2e2a8b91	80	struct mpls_te_area {
d62a17ae	81	/* Status of MPLS-TE: enable or disable */
d62a17ae	82	status_t status;
f8c06e2c	83
d62a17ae	84	/* L1, L1-L2, L2-Only */
d7c0a89a	85	uint8_t level;
f8c06e2c	86
d62a17ae	87	/* RFC5316 */
	88	interas_mode_t inter_as;
	89	struct in_addr interas_areaid;
f8c06e2c	90
173f8887	91	/* MPLS_TE IPv4 & IPv6 Router IDs */
d62a17ae	92	struct in_addr router_id;
173f8887	93	struct in6_addr router_id_ipv6;
ed6189a9 OD	94
	95	/* Link State Database */
	96	struct ls_ted *ted;
	97	bool export;
	98	};
	99
	100	/* Structure to provide parameters to lsp iterate callback function */
	101	struct isis_te_args {
	102	struct ls_ted *ted;
	103	struct ls_vertex *vertex;
	104	bool export;
f8c06e2c OD	105	};
f8c06e2c OD	106
ed6189a9 OD	107	enum lsp_event { LSP_UNKNOWN, LSP_ADD, LSP_UPD, LSP_DEL, LSP_INC, LSP_TICK };
ed6189a9 OD	108
f8c06e2c	109	/* Prototypes. */
d62a17ae	110	void isis_mpls_te_init(void);
1fa63850 OD	111	void isis_mpls_te_create(struct isis_area *area);
	112	void isis_mpls_te_disable(struct isis_area *area);
	113	void isis_mpls_te_term(struct isis_area *area);
f8c06e2c	114	void isis_link_params_update(struct isis_circuit , struct interface );
1b3f47d0	115	int isis_mpls_te_update(struct interface *);
ed6189a9 OD	116	void isis_te_lsp_event(struct isis_lsp *lsp, enum lsp_event event);
	117	int isis_te_sync_ted(struct zapi_opaque_reg_info dst);
	118	void isis_te_init_ted(struct isis_area *area);
f8c06e2c OD	119
f8c06e2c OD	120	#endif /* _ZEBRA_ISIS_MPLS_TE_H */