[mirror_frr.git] / ospfd / ospf_sr.h

/*
 * This is an implementation of Segment Routing
 * as per RFC 8665 - OSPF Extensions for Segment Routing
 * and RFC 8476 - Signaling Maximum SID Depth (MSD) Using OSPF
 *
 * Module name: Segment Routing header definitions
 *
 * Author: Olivier Dugeon <olivier.dugeon@orange.com>
 * Author: Anselme Sawadogo <anselmesawadogo@gmail.com>
 *
 * Copyright (C) 2016 - 2020 Orange Labs http://www.orange.com
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _FRR_OSPF_SR_H
#define _FRR_OSPF_SR_H

/* macros and constants for segment routing */
#define SET_RANGE_SIZE_MASK             0xffffff00
#define GET_RANGE_SIZE_MASK             0x00ffffff
#define SET_LABEL_MASK                  0xffffff00
#define GET_LABEL_MASK                  0x00ffffff
#define SET_RANGE_SIZE(range_size) ((range_size << 8) & SET_RANGE_SIZE_MASK)
#define GET_RANGE_SIZE(range_size) ((range_size >> 8) & GET_RANGE_SIZE_MASK)
#define SET_LABEL(label) ((label << 8) & SET_LABEL_MASK)
#define GET_LABEL(label) ((label >> 8) & GET_LABEL_MASK)

#define OSPF_SR_DEFAULT_METRIC		1

/* Segment Routing TLVs as per RFC 8665 */

/* Segment ID could be a Label (3 bytes) or an Index (4 bytes) */
#define SID_LABEL	3
#define SID_LABEL_SIZE(U) (U - 1)
#define SID_INDEX	4
#define SID_INDEX_SIZE(U) (U)

/* Macro to log debug message */
#define osr_debug(...)                                                         \
	do {                                                                   \
		if (IS_DEBUG_OSPF_SR)                                          \
			zlog_debug(__VA_ARGS__);                               \
	} while (0)

/* Macro to check if SR Prefix has no valid route */
#define IS_NO_ROUTE(srp) ((srp->route == NULL) || (srp->route->paths == NULL)  \
			   || list_isempty(srp->route->paths))

/* SID/Label Sub TLV - section 2.1 */
#define SUBTLV_SID_LABEL		1
#define SUBTLV_SID_LABEL_SIZE		8
struct subtlv_sid_label {
	/* Length is 3 (20 rightmost bits MPLS label) or 4 (32 bits SID) */
	struct tlv_header header;
	uint32_t value;
};

/*
 * Following section defines Segment Routing TLV (tag, length, value)
 * structures, used in Router Information Opaque LSA.
 */

/* RI SR-Algorithm TLV - section 3.1 */
#define RI_SR_TLV_SR_ALGORITHM          8
struct ri_sr_tlv_sr_algorithm {
	struct tlv_header header;
#define SR_ALGORITHM_SPF         0
#define SR_ALGORITHM_STRICT_SPF  1
#define SR_ALGORITHM_UNSET       255
#define ALGORITHM_COUNT          4
	/* Only 4 algorithms supported in this code */
	uint8_t value[ALGORITHM_COUNT];
};

/* RI SID/Label Range TLV used for SRGB & SRLB - section 3.2 & 3.3 */
#define RI_SR_TLV_SRGB_LABEL_RANGE	9
#define RI_SR_TLV_SRLB_LABEL_RANGE	14
struct ri_sr_tlv_sid_label_range {
	struct tlv_header header;
/* Only 24 upper most bits are significant */
#define SID_RANGE_LABEL_LENGTH	3
	uint32_t size;
	/* A SID/Label sub-TLV will follow. */
	struct subtlv_sid_label lower;
};

/* RI Node/MSD TLV as per RFC 8476 */
#define RI_SR_TLV_NODE_MSD		12
struct ri_sr_tlv_node_msd {
	struct tlv_header header;
	uint8_t subtype; /* always = 1 */
	uint8_t value;
	uint16_t padding;
};

/*
 * Following section defines Segment Routing TLV (tag, length, value)
 * structures, used in Extended Prefix/Link Opaque LSA.
 */

/* Adj-SID and LAN-Ajd-SID subtlvs' flags */
#define EXT_SUBTLV_LINK_ADJ_SID_BFLG	0x80
#define EXT_SUBTLV_LINK_ADJ_SID_VFLG	0x40
#define EXT_SUBTLV_LINK_ADJ_SID_LFLG	0x20
#define EXT_SUBTLV_LINK_ADJ_SID_SFLG	0x10

/* Prefix SID subtlv Flags */
#define EXT_SUBTLV_PREFIX_SID_NPFLG	0x40
#define EXT_SUBTLV_PREFIX_SID_MFLG	0x20
#define EXT_SUBTLV_PREFIX_SID_EFLG	0x10
#define EXT_SUBTLV_PREFIX_SID_VFLG	0x08
#define EXT_SUBTLV_PREFIX_SID_LFLG	0x04

/* SID/Label Binding subtlv Flags */
#define EXT_SUBTLV_SID_BINDING_MFLG	0x80

/* Extended Prefix Range TLV - section 4 */
#define EXT_TLV_PREF_RANGE		2
#define EXT_SUBTLV_PREFIX_RANGE_SIZE	12
struct ext_tlv_prefix_range {
	struct tlv_header header;
	uint8_t pref_length;
	uint8_t af;
	uint16_t range_size;
	uint8_t flags;
	uint8_t reserved[3];
	struct in_addr address;
};

/* Prefix SID Sub-TLV - section 5 */
#define EXT_SUBTLV_PREFIX_SID		2
#define EXT_SUBTLV_PREFIX_SID_SIZE	8
struct ext_subtlv_prefix_sid {
	struct tlv_header header;
	uint8_t flags;
	uint8_t reserved;
	uint8_t mtid;
	uint8_t algorithm;
	uint32_t value;
};

/* Adj-SID Sub-TLV - section 6.1 */
#define EXT_SUBTLV_ADJ_SID		2
#define EXT_SUBTLV_ADJ_SID_SIZE		8
struct ext_subtlv_adj_sid {
	struct tlv_header header;
	uint8_t flags;
	uint8_t reserved;
	uint8_t mtid;
	uint8_t weight;
	uint32_t value;
};

/* LAN Adj-SID Sub-TLV - section 6.2 */
#define EXT_SUBTLV_LAN_ADJ_SID		3
#define EXT_SUBTLV_LAN_ADJ_SID_SIZE	12
struct ext_subtlv_lan_adj_sid {
	struct tlv_header header;
	uint8_t flags;
	uint8_t reserved;
	uint8_t mtid;
	uint8_t weight;
	struct in_addr neighbor_id;
	uint32_t value;
};

/*
 * Following section define structure used to manage Segment Routing
 * information and TLVs / SubTLVs
 */
/* Default min and size of SR Global Block label range */
#define DEFAULT_SRGB_LABEL        16000
#define DEFAULT_SRGB_SIZE         8000

/* Default min and size of SR Local Block label range */
#define DEFAULT_SRLB_LABEL        15000
#define DEFAULT_SRLB_SIZE         1000

/* Structure aggregating SR Range Block info retrieved from an lsa */
struct sr_block {
	uint32_t range_size;
	uint32_t lower_bound;
};

/* Segment Routing Global Block allocation */
struct sr_global_block {
	bool reserved;
	uint32_t start;
	uint32_t size;
};

/* Segment Routing Local Block allocation */
struct sr_local_block {
	bool reserved;
	uint32_t start;
	uint32_t end;
	uint32_t current;
	uint32_t max_block;
	uint64_t *used_mark;
};
#define SRLB_BLOCK_SIZE 64

/* SID type to make difference between loopback interfaces and others */
enum sid_type { PREF_SID, LOCAL_SID, ADJ_SID, LAN_ADJ_SID };

/* Status of Segment Routing: Off (Disable), On (Enable), (Up) Started */
enum sr_status { SR_OFF, SR_ON, SR_UP, SR_DOWN };

/* Structure aggregating all OSPF Segment Routing information for the node */
struct ospf_sr_db {
	/* Status of Segment Routing */
	enum sr_status status;

	/* Flooding Scope: Area = 10 or AS = 11 */
	uint8_t scope;

	/* FRR SR node */
	struct sr_node *self;

	/* List of neighbour SR nodes */
	struct hash *neighbors;

	/* List of SR prefix */
	struct route_table *prefix;

	/* Local SR info announced in Router Info LSA */

	/* Algorithms supported by the node */
	uint8_t algo[ALGORITHM_COUNT];
	/*
	 * Segment Routing Global Block i.e. label range
	 * Only one range supported in this code
	 */
	struct sr_global_block srgb;

	/* Segment Routing Local Block */
	struct sr_local_block srlb;

	/* Maximum SID Depth supported by the node */
	uint8_t msd;

	/* Thread timer to start Label Manager */
	struct thread *t_start_lm;
};

/* Structure aggregating all received SR info from LSAs by node */
struct sr_node {
	struct in_addr adv_router; /* used to identify sender of LSA */
	/* 24-bit Opaque-ID field value according to RFC 7684 specification */
	uint32_t instance;

	uint8_t algo[ALGORITHM_COUNT]; /* Algorithms supported by the node */
	struct sr_block srgb;          /* Segment Routing Global Block */
	struct sr_block srlb;          /* Segment Routing Local Block */
	uint8_t msd;                   /* Maximum SID Depth */

	/* List of Prefix & Link advertise by this node */
	struct list *ext_prefix; /* For Node SID */
	struct list *ext_link;   /* For Adj and LAN SID */

	/* Pointer to FRR SR-Node or NULL if it is not a neighbor */
	struct sr_node *neighbor;
};

/* Segment Routing - NHLFE info: support IPv4 Only */
struct sr_nhlfe {
	struct in_addr nexthop;
	ifindex_t ifindex;
	mpls_label_t label_in;
	mpls_label_t label_out;
};

/* Structure aggregating all Segment Routing Link information */
/* Link are generally advertised by pair: primary + backup */
struct sr_link {
	struct in_addr adv_router; /* used to identify sender of LSA */
	/* 24-bit Opaque-ID field value according to RFC 7684 specification */
	uint32_t instance;

	/* Interface address */
	struct in_addr itf_addr;

	/* Flags to manage this link parameters. */
	uint8_t flags[2];

	/* Segment Routing ID */
	uint32_t sid[2];
	enum sid_type type;

	/* SR NHLFE (Primary + Backup) for this link */
	struct sr_nhlfe nhlfe[2];

	/* Back pointer to SR Node which advertise this Link */
	struct sr_node *srn;
};

/* Structure aggregating all Segment Routing Prefix information */
struct sr_prefix {
	struct in_addr adv_router; /* used to identify sender of LSA */
	/* 24-bit Opaque-ID field value according to RFC 7684 specification */
	uint32_t instance;

	/* Prefix itself */
	struct prefix_ipv4 prefv4;

	/* Flags to manage this prefix parameters. */
	uint8_t flags;

	/* Segment Routing ID */
	uint32_t sid;
	enum sid_type type;

	/* Incoming label for this prefix */
	mpls_label_t label_in;

	/* Back pointer to OSPF Route for remote prefix */
	struct ospf_route *route;

	/* NHLFE for local prefix */
	struct sr_nhlfe nhlfe;

	/* Back pointer to SR Node which advertise this Prefix */
	struct sr_node *srn;
};

/* Prototypes definition */
/* Segment Routing initialisation functions */
extern int ospf_sr_init(void);
extern void ospf_sr_term(void);
extern void ospf_sr_finish(void);
/* Segment Routing label allocation functions */
extern mpls_label_t ospf_sr_local_block_request_label(void);
extern int ospf_sr_local_block_release_label(mpls_label_t label);
/* Segment Routing LSA update & delete functions */
extern void ospf_sr_ri_lsa_update(struct ospf_lsa *lsa);
extern void ospf_sr_ri_lsa_delete(struct ospf_lsa *lsa);
extern void ospf_sr_ext_link_lsa_update(struct ospf_lsa *lsa);
extern void ospf_sr_ext_link_lsa_delete(struct ospf_lsa *lsa);
extern void ospf_sr_ext_prefix_lsa_update(struct ospf_lsa *lsa);
extern void ospf_sr_ext_prefix_lsa_delete(struct ospf_lsa *lsa);
/* Segment Routing Extending Link management */
struct ext_itf;
extern void ospf_sr_ext_itf_add(struct ext_itf *exti);
extern void ospf_sr_ext_itf_delete(struct ext_itf *exti);
/* Segment Routing configuration functions */
extern void ospf_sr_config_write_router(struct vty *vty);
extern void ospf_sr_update_local_prefix(struct interface *ifp,
					struct prefix *p);
/* Segment Routing re-routing function */
extern void ospf_sr_update_task(struct ospf *ospf);
#endif /* _FRR_OSPF_SR_H */
Commit	Line	Data
cf9b9f77 OD	1	/*
cf9b9f77 OD	2	* This is an implementation of Segment Routing
6f751f14 OD	3	* as per RFC 8665 - OSPF Extensions for Segment Routing
6f751f14 OD	4	* and RFC 8476 - Signaling Maximum SID Depth (MSD) Using OSPF
cf9b9f77 OD	5	*
	6	* Module name: Segment Routing header definitions
	7	*
	8	* Author: Olivier Dugeon <olivier.dugeon@orange.com>
	9	* Author: Anselme Sawadogo <anselmesawadogo@gmail.com>
	10	*
6f751f14	11	* Copyright (C) 2016 - 2020 Orange Labs http://www.orange.com
cf9b9f77	12	*
7743f2f8 OD	13	* This program is free software; you can redistribute it and/or modify it
	14	* under the terms of the GNU General Public License as published by the Free
	15	* Software Foundation; either version 2 of the License, or (at your option)
	16	* any later version.
cf9b9f77	17	*
7743f2f8 OD	18	* This program is distributed in the hope that it will be useful, but WITHOUT
	19	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	20	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	21	* more details.
cf9b9f77	22	*
7743f2f8 OD	23	* You should have received a copy of the GNU General Public License along
	24	* with this program; see the file COPYING; if not, write to the Free Software
	25	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
cf9b9f77 OD	26	*/
	27
	28	#ifndef _FRR_OSPF_SR_H
	29	#define _FRR_OSPF_SR_H
	30
cf9b9f77 OD	31	/* macros and constants for segment routing */
	32	#define SET_RANGE_SIZE_MASK 0xffffff00
	33	#define GET_RANGE_SIZE_MASK 0x00ffffff
	34	#define SET_LABEL_MASK 0xffffff00
	35	#define GET_LABEL_MASK 0x00ffffff
	36	#define SET_RANGE_SIZE(range_size) ((range_size << 8) & SET_RANGE_SIZE_MASK)
	37	#define GET_RANGE_SIZE(range_size) ((range_size >> 8) & GET_RANGE_SIZE_MASK)
	38	#define SET_LABEL(label) ((label << 8) & SET_LABEL_MASK)
	39	#define GET_LABEL(label) ((label >> 8) & GET_LABEL_MASK)
	40
cf9b9f77 OD	41	#define OSPF_SR_DEFAULT_METRIC 1
cf9b9f77 OD	42
6f751f14	43	/* Segment Routing TLVs as per RFC 8665 */
cf9b9f77 OD	44
cf9b9f77 OD	45	/* Segment ID could be a Label (3 bytes) or an Index (4 bytes) */
cf9b9f77	46	#define SID_LABEL 3
d922605d	47	#define SID_LABEL_SIZE(U) (U - 1)
cf9b9f77	48	#define SID_INDEX 4
d922605d	49	#define SID_INDEX_SIZE(U) (U)
cf9b9f77	50
b37eb79c OD	51	/* Macro to log debug message */
	52	#define osr_debug(...) \
	53	do { \
	54	if (IS_DEBUG_OSPF_SR) \
	55	zlog_debug(__VA_ARGS__); \
	56	} while (0)
	57
43e7abb5 OD	58	/* Macro to check if SR Prefix has no valid route */
	59	#define IS_NO_ROUTE(srp) ((srp->route == NULL) \|\| (srp->route->paths == NULL) \
	60	\|\| list_isempty(srp->route->paths))
	61
cf9b9f77 OD	62	/* SID/Label Sub TLV - section 2.1 */
	63	#define SUBTLV_SID_LABEL 1
	64	#define SUBTLV_SID_LABEL_SIZE 8
	65	struct subtlv_sid_label {
	66	/* Length is 3 (20 rightmost bits MPLS label) or 4 (32 bits SID) */
	67	struct tlv_header header;
93f0a26e	68	uint32_t value;
cf9b9f77 OD	69	};
	70
	71	/*
	72	* Following section defines Segment Routing TLV (tag, length, value)
	73	* structures, used in Router Information Opaque LSA.
	74	*/
	75
	76	/* RI SR-Algorithm TLV - section 3.1 */
	77	#define RI_SR_TLV_SR_ALGORITHM 8
	78	struct ri_sr_tlv_sr_algorithm {
	79	struct tlv_header header;
	80	#define SR_ALGORITHM_SPF 0
	81	#define SR_ALGORITHM_STRICT_SPF 1
	82	#define SR_ALGORITHM_UNSET 255
	83	#define ALGORITHM_COUNT 4
	84	/* Only 4 algorithms supported in this code */
93f0a26e	85	uint8_t value[ALGORITHM_COUNT];
cf9b9f77 OD	86	};
cf9b9f77 OD	87
6f751f14 OD	88	/* RI SID/Label Range TLV used for SRGB & SRLB - section 3.2 & 3.3 */
	89	#define RI_SR_TLV_SRGB_LABEL_RANGE 9
	90	#define RI_SR_TLV_SRLB_LABEL_RANGE 14
cf9b9f77 OD	91	struct ri_sr_tlv_sid_label_range {
	92	struct tlv_header header;
	93	/* Only 24 upper most bits are significant */
	94	#define SID_RANGE_LABEL_LENGTH 3
93f0a26e	95	uint32_t size;
cf9b9f77 OD	96	/* A SID/Label sub-TLV will follow. */
	97	struct subtlv_sid_label lower;
	98	};
	99
6f751f14	100	/* RI Node/MSD TLV as per RFC 8476 */
cf9b9f77 OD	101	#define RI_SR_TLV_NODE_MSD 12
	102	struct ri_sr_tlv_node_msd {
	103	struct tlv_header header;
93f0a26e OD	104	uint8_t subtype; /* always = 1 */
	105	uint8_t value;
	106	uint16_t padding;
cf9b9f77 OD	107	};
	108
	109	/*
	110	* Following section defines Segment Routing TLV (tag, length, value)
	111	* structures, used in Extended Prefix/Link Opaque LSA.
	112	*/
	113
	114	/* Adj-SID and LAN-Ajd-SID subtlvs' flags */
	115	#define EXT_SUBTLV_LINK_ADJ_SID_BFLG 0x80
	116	#define EXT_SUBTLV_LINK_ADJ_SID_VFLG 0x40
	117	#define EXT_SUBTLV_LINK_ADJ_SID_LFLG 0x20
	118	#define EXT_SUBTLV_LINK_ADJ_SID_SFLG 0x10
	119
	120	/* Prefix SID subtlv Flags */
	121	#define EXT_SUBTLV_PREFIX_SID_NPFLG 0x40
	122	#define EXT_SUBTLV_PREFIX_SID_MFLG 0x20
	123	#define EXT_SUBTLV_PREFIX_SID_EFLG 0x10
	124	#define EXT_SUBTLV_PREFIX_SID_VFLG 0x08
	125	#define EXT_SUBTLV_PREFIX_SID_LFLG 0x04
	126
	127	/* SID/Label Binding subtlv Flags */
	128	#define EXT_SUBTLV_SID_BINDING_MFLG 0x80
	129
	130	/* Extended Prefix Range TLV - section 4 */
	131	#define EXT_TLV_PREF_RANGE 2
	132	#define EXT_SUBTLV_PREFIX_RANGE_SIZE 12
	133	struct ext_tlv_prefix_range {
	134	struct tlv_header header;
93f0a26e OD	135	uint8_t pref_length;
	136	uint8_t af;
	137	uint16_t range_size;
	138	uint8_t flags;
	139	uint8_t reserved[3];
cf9b9f77 OD	140	struct in_addr address;
	141	};
	142
	143	/* Prefix SID Sub-TLV - section 5 */
	144	#define EXT_SUBTLV_PREFIX_SID 2
	145	#define EXT_SUBTLV_PREFIX_SID_SIZE 8
	146	struct ext_subtlv_prefix_sid {
	147	struct tlv_header header;
93f0a26e OD	148	uint8_t flags;
	149	uint8_t reserved;
	150	uint8_t mtid;
	151	uint8_t algorithm;
	152	uint32_t value;
cf9b9f77 OD	153	};
	154
	155	/* Adj-SID Sub-TLV - section 6.1 */
	156	#define EXT_SUBTLV_ADJ_SID 2
	157	#define EXT_SUBTLV_ADJ_SID_SIZE 8
	158	struct ext_subtlv_adj_sid {
	159	struct tlv_header header;
93f0a26e OD	160	uint8_t flags;
	161	uint8_t reserved;
	162	uint8_t mtid;
	163	uint8_t weight;
	164	uint32_t value;
cf9b9f77 OD	165	};
	166
	167	/* LAN Adj-SID Sub-TLV - section 6.2 */
	168	#define EXT_SUBTLV_LAN_ADJ_SID 3
	169	#define EXT_SUBTLV_LAN_ADJ_SID_SIZE 12
	170	struct ext_subtlv_lan_adj_sid {
	171	struct tlv_header header;
93f0a26e OD	172	uint8_t flags;
	173	uint8_t reserved;
	174	uint8_t mtid;
	175	uint8_t weight;
cf9b9f77	176	struct in_addr neighbor_id;
93f0a26e	177	uint32_t value;
cf9b9f77 OD	178	};
	179
	180	/*
	181	* Following section define structure used to manage Segment Routing
	182	* information and TLVs / SubTLVs
	183	*/
6f751f14 OD	184	/* Default min and size of SR Global Block label range */
	185	#define DEFAULT_SRGB_LABEL 16000
	186	#define DEFAULT_SRGB_SIZE 8000
	187
	188	/* Default min and size of SR Local Block label range */
	189	#define DEFAULT_SRLB_LABEL 15000
	190	#define DEFAULT_SRLB_SIZE 1000
cf9b9f77	191
6f751f14 OD	192	/* Structure aggregating SR Range Block info retrieved from an lsa */
6f751f14 OD	193	struct sr_block {
93f0a26e OD	194	uint32_t range_size;
93f0a26e OD	195	uint32_t lower_bound;
cf9b9f77 OD	196	};
cf9b9f77 OD	197
6f751f14 OD	198	/* Segment Routing Global Block allocation */
	199	struct sr_global_block {
	200	bool reserved;
	201	uint32_t start;
	202	uint32_t size;
	203	};
	204
	205	/* Segment Routing Local Block allocation */
	206	struct sr_local_block {
	207	bool reserved;
	208	uint32_t start;
	209	uint32_t end;
	210	uint32_t current;
	211	uint32_t max_block;
	212	uint64_t *used_mark;
	213	};
	214	#define SRLB_BLOCK_SIZE 64
	215
cf9b9f77	216	/* SID type to make difference between loopback interfaces and others */
b37eb79c	217	enum sid_type { PREF_SID, LOCAL_SID, ADJ_SID, LAN_ADJ_SID };
cf9b9f77	218
d81b8e0e OD	219	/* Status of Segment Routing: Off (Disable), On (Enable), (Up) Started */
	220	enum sr_status { SR_OFF, SR_ON, SR_UP, SR_DOWN };
	221
cf9b9f77 OD	222	/* Structure aggregating all OSPF Segment Routing information for the node */
cf9b9f77 OD	223	struct ospf_sr_db {
d81b8e0e OD	224	/* Status of Segment Routing */
d81b8e0e OD	225	enum sr_status status;
cf9b9f77	226
cf9b9f77	227	/* Flooding Scope: Area = 10 or AS = 11 */
93f0a26e	228	uint8_t scope;
cf9b9f77 OD	229
	230	/* FRR SR node */
	231	struct sr_node *self;
	232
	233	/* List of neighbour SR nodes */
	234	struct hash *neighbors;
	235
	236	/* List of SR prefix */
	237	struct route_table *prefix;
	238
	239	/* Local SR info announced in Router Info LSA */
	240
	241	/* Algorithms supported by the node */
93f0a26e	242	uint8_t algo[ALGORITHM_COUNT];
cf9b9f77 OD	243	/*
	244	* Segment Routing Global Block i.e. label range
	245	* Only one range supported in this code
	246	*/
6f751f14	247	struct sr_global_block srgb;
d81b8e0e	248
6f751f14 OD	249	/* Segment Routing Local Block */
6f751f14 OD	250	struct sr_local_block srlb;
d81b8e0e	251
cf9b9f77	252	/* Maximum SID Depth supported by the node */
93f0a26e	253	uint8_t msd;
6f751f14 OD	254
	255	/* Thread timer to start Label Manager */
	256	struct thread *t_start_lm;
cf9b9f77 OD	257	};
	258
	259	/* Structure aggregating all received SR info from LSAs by node */
	260	struct sr_node {
	261	struct in_addr adv_router; /* used to identify sender of LSA */
	262	/* 24-bit Opaque-ID field value according to RFC 7684 specification */
93f0a26e	263	uint32_t instance;
cf9b9f77	264
93f0a26e	265	uint8_t algo[ALGORITHM_COUNT]; /* Algorithms supported by the node */
6f751f14 OD	266	struct sr_block srgb; /* Segment Routing Global Block */
	267	struct sr_block srlb; /* Segment Routing Local Block */
	268	uint8_t msd; /* Maximum SID Depth */
cf9b9f77 OD	269
	270	/* List of Prefix & Link advertise by this node */
	271	struct list ext_prefix; / For Node SID */
	272	struct list ext_link; / For Adj and LAN SID */
	273
	274	/* Pointer to FRR SR-Node or NULL if it is not a neighbor */
	275	struct sr_node *neighbor;
	276	};
	277
cf9b9f77 OD	278	/* Segment Routing - NHLFE info: support IPv4 Only */
cf9b9f77 OD	279	struct sr_nhlfe {
cf9b9f77 OD	280	struct in_addr nexthop;
	281	ifindex_t ifindex;
	282	mpls_label_t label_in;
	283	mpls_label_t label_out;
	284	};
	285
	286	/* Structure aggregating all Segment Routing Link information */
	287	/* Link are generally advertised by pair: primary + backup */
	288	struct sr_link {
	289	struct in_addr adv_router; /* used to identify sender of LSA */
	290	/* 24-bit Opaque-ID field value according to RFC 7684 specification */
93f0a26e	291	uint32_t instance;
cf9b9f77	292
b37eb79c OD	293	/* Interface address */
	294	struct in_addr itf_addr;
	295
cf9b9f77	296	/* Flags to manage this link parameters. */
7743f2f8	297	uint8_t flags[2];
cf9b9f77 OD	298
cf9b9f77 OD	299	/* Segment Routing ID */
93f0a26e	300	uint32_t sid[2];
cf9b9f77 OD	301	enum sid_type type;
cf9b9f77 OD	302
b37eb79c	303	/* SR NHLFE (Primary + Backup) for this link */
cf9b9f77 OD	304	struct sr_nhlfe nhlfe[2];
	305
	306	/* Back pointer to SR Node which advertise this Link */
	307	struct sr_node *srn;
	308	};
	309
	310	/* Structure aggregating all Segment Routing Prefix information */
	311	struct sr_prefix {
	312	struct in_addr adv_router; /* used to identify sender of LSA */
	313	/* 24-bit Opaque-ID field value according to RFC 7684 specification */
93f0a26e	314	uint32_t instance;
cf9b9f77	315
b37eb79c OD	316	/* Prefix itself */
	317	struct prefix_ipv4 prefv4;
	318
cf9b9f77	319	/* Flags to manage this prefix parameters. */
7743f2f8	320	uint8_t flags;
cf9b9f77 OD	321
cf9b9f77 OD	322	/* Segment Routing ID */
93f0a26e	323	uint32_t sid;
cf9b9f77 OD	324	enum sid_type type;
cf9b9f77 OD	325
b37eb79c OD	326	/* Incoming label for this prefix */
	327	mpls_label_t label_in;
	328
	329	/* Back pointer to OSPF Route for remote prefix */
b61264a8	330	struct ospf_route *route;
b37eb79c OD	331
b37eb79c OD	332	/* NHLFE for local prefix */
cf9b9f77 OD	333	struct sr_nhlfe nhlfe;
	334
	335	/* Back pointer to SR Node which advertise this Prefix */
	336	struct sr_node *srn;
cf9b9f77 OD	337	};
	338
	339	/* Prototypes definition */
	340	/* Segment Routing initialisation functions */
	341	extern int ospf_sr_init(void);
	342	extern void ospf_sr_term(void);
bcf4475e	343	extern void ospf_sr_finish(void);
6f751f14 OD	344	/* Segment Routing label allocation functions */
	345	extern mpls_label_t ospf_sr_local_block_request_label(void);
	346	extern int ospf_sr_local_block_release_label(mpls_label_t label);
cf9b9f77 OD	347	/* Segment Routing LSA update & delete functions */
	348	extern void ospf_sr_ri_lsa_update(struct ospf_lsa *lsa);
	349	extern void ospf_sr_ri_lsa_delete(struct ospf_lsa *lsa);
7743f2f8 OD	350	extern void ospf_sr_ext_link_lsa_update(struct ospf_lsa *lsa);
	351	extern void ospf_sr_ext_link_lsa_delete(struct ospf_lsa *lsa);
	352	extern void ospf_sr_ext_prefix_lsa_update(struct ospf_lsa *lsa);
	353	extern void ospf_sr_ext_prefix_lsa_delete(struct ospf_lsa *lsa);
21baf89a OD	354	/* Segment Routing Extending Link management */
	355	struct ext_itf;
	356	extern void ospf_sr_ext_itf_add(struct ext_itf *exti);
	357	extern void ospf_sr_ext_itf_delete(struct ext_itf *exti);
cf9b9f77	358	/* Segment Routing configuration functions */
7743f2f8	359	extern void ospf_sr_config_write_router(struct vty *vty);
b61264a8 OD	360	extern void ospf_sr_update_local_prefix(struct interface *ifp,
b61264a8 OD	361	struct prefix *p);
cf9b9f77	362	/* Segment Routing re-routing function */
b37eb79c	363	extern void ospf_sr_update_task(struct ospf *ospf);
cf9b9f77	364	#endif /* _FRR_OSPF_SR_H */