2 * This is an implementation of Segment Routing
3 * as per draft draft-ietf-ospf-segment-routing-extensions-24
5 * Module name: Segment Routing header definitions
7 * Author: Olivier Dugeon <olivier.dugeon@orange.com>
8 * Author: Anselme Sawadogo <anselmesawadogo@gmail.com>
10 * Copyright (C) 2016 - 2018 Orange Labs http://www.orange.com
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 2 of the License, or (at your option)
17 * This program is distributed in the hope that it will be useful, but WITHOUT
18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
22 * You should have received a copy of the GNU General Public License along
23 * with this program; see the file COPYING; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
27 #ifndef _FRR_OSPF_SR_H
28 #define _FRR_OSPF_SR_H
30 /* Default Route priority for OSPF Segment Routing */
31 #define OSPF_SR_PRIORITY_DEFAULT 10
33 /* macros and constants for segment routing */
34 #define SET_RANGE_SIZE_MASK 0xffffff00
35 #define GET_RANGE_SIZE_MASK 0x00ffffff
36 #define SET_LABEL_MASK 0xffffff00
37 #define GET_LABEL_MASK 0x00ffffff
38 #define SET_RANGE_SIZE(range_size) ((range_size << 8) & SET_RANGE_SIZE_MASK)
39 #define GET_RANGE_SIZE(range_size) ((range_size >> 8) & GET_RANGE_SIZE_MASK)
40 #define SET_LABEL(label) ((label << 8) & SET_LABEL_MASK)
41 #define GET_LABEL(label) ((label >> 8) & GET_LABEL_MASK)
43 /* Label range for Adj-SID attribution purpose. Start just right after SRGB */
44 #define ADJ_SID_MIN MPLS_DEFAULT_MAX_SRGB_LABEL
45 #define ADJ_SID_MAX (MPLS_DEFAULT_MAX_SRGB_LABEL + 1000)
47 #define OSPF_SR_DEFAULT_METRIC 1
49 /* Segment Routing TLVs as per draft-ietf-ospf-segment-routing-extensions-19 */
51 /* Segment ID could be a Label (3 bytes) or an Index (4 bytes) */
53 #define SID_LABEL_SIZE(U) (U - 1)
55 #define SID_INDEX_SIZE(U) (U)
57 /* SID/Label Sub TLV - section 2.1 */
58 #define SUBTLV_SID_LABEL 1
59 #define SUBTLV_SID_LABEL_SIZE 8
60 struct subtlv_sid_label
{
61 /* Length is 3 (20 rightmost bits MPLS label) or 4 (32 bits SID) */
62 struct tlv_header header
;
67 * Following section defines Segment Routing TLV (tag, length, value)
68 * structures, used in Router Information Opaque LSA.
71 /* RI SR-Algorithm TLV - section 3.1 */
72 #define RI_SR_TLV_SR_ALGORITHM 8
73 struct ri_sr_tlv_sr_algorithm
{
74 struct tlv_header header
;
75 #define SR_ALGORITHM_SPF 0
76 #define SR_ALGORITHM_STRICT_SPF 1
77 #define SR_ALGORITHM_UNSET 255
78 #define ALGORITHM_COUNT 4
79 /* Only 4 algorithms supported in this code */
80 uint8_t value
[ALGORITHM_COUNT
];
83 /* RI SID/Label Range TLV - section 3.2 */
84 #define RI_SR_TLV_SID_LABEL_RANGE 9
85 struct ri_sr_tlv_sid_label_range
{
86 struct tlv_header header
;
87 /* Only 24 upper most bits are significant */
88 #define SID_RANGE_LABEL_LENGTH 3
90 /* A SID/Label sub-TLV will follow. */
91 struct subtlv_sid_label lower
;
94 /* RI Node/MSD TLV as per draft-ietf-ospf-segment-routing-msd-05 */
95 #define RI_SR_TLV_NODE_MSD 12
96 struct ri_sr_tlv_node_msd
{
97 struct tlv_header header
;
98 uint8_t subtype
; /* always = 1 */
104 * Following section defines Segment Routing TLV (tag, length, value)
105 * structures, used in Extended Prefix/Link Opaque LSA.
108 /* Adj-SID and LAN-Ajd-SID subtlvs' flags */
109 #define EXT_SUBTLV_LINK_ADJ_SID_BFLG 0x80
110 #define EXT_SUBTLV_LINK_ADJ_SID_VFLG 0x40
111 #define EXT_SUBTLV_LINK_ADJ_SID_LFLG 0x20
112 #define EXT_SUBTLV_LINK_ADJ_SID_SFLG 0x10
114 /* Prefix SID subtlv Flags */
115 #define EXT_SUBTLV_PREFIX_SID_NPFLG 0x40
116 #define EXT_SUBTLV_PREFIX_SID_MFLG 0x20
117 #define EXT_SUBTLV_PREFIX_SID_EFLG 0x10
118 #define EXT_SUBTLV_PREFIX_SID_VFLG 0x08
119 #define EXT_SUBTLV_PREFIX_SID_LFLG 0x04
121 /* SID/Label Binding subtlv Flags */
122 #define EXT_SUBTLV_SID_BINDING_MFLG 0x80
124 /* Extended Prefix Range TLV - section 4 */
125 #define EXT_TLV_PREF_RANGE 2
126 #define EXT_SUBTLV_PREFIX_RANGE_SIZE 12
127 struct ext_tlv_prefix_range
{
128 struct tlv_header header
;
134 struct in_addr address
;
137 /* Prefix SID Sub-TLV - section 5 */
138 #define EXT_SUBTLV_PREFIX_SID 2
139 #define EXT_SUBTLV_PREFIX_SID_SIZE 8
140 struct ext_subtlv_prefix_sid
{
141 struct tlv_header header
;
149 /* Adj-SID Sub-TLV - section 6.1 */
150 #define EXT_SUBTLV_ADJ_SID 2
151 #define EXT_SUBTLV_ADJ_SID_SIZE 8
152 struct ext_subtlv_adj_sid
{
153 struct tlv_header header
;
161 /* LAN Adj-SID Sub-TLV - section 6.2 */
162 #define EXT_SUBTLV_LAN_ADJ_SID 3
163 #define EXT_SUBTLV_LAN_ADJ_SID_SIZE 12
164 struct ext_subtlv_lan_adj_sid
{
165 struct tlv_header header
;
170 struct in_addr neighbor_id
;
175 * Following section define structure used to manage Segment Routing
176 * information and TLVs / SubTLVs
179 /* Structure aggregating SRGB info retrieved from an lsa */
182 uint32_t lower_bound
;
185 /* SID type to make difference between loopback interfaces and others */
186 enum sid_type
{ PREF_SID
, ADJ_SID
, LAN_ADJ_SID
};
188 /* Structure aggregating all OSPF Segment Routing information for the node */
190 /* Status of Segment Routing: enable or disable */
193 /* Ongoing Update following an OSPF SPF */
196 /* Flooding Scope: Area = 10 or AS = 11 */
200 struct sr_node
*self
;
202 /* List of neighbour SR nodes */
203 struct hash
*neighbors
;
205 /* List of SR prefix */
206 struct route_table
*prefix
;
208 /* Local SR info announced in Router Info LSA */
210 /* Algorithms supported by the node */
211 uint8_t algo
[ALGORITHM_COUNT
];
213 * Segment Routing Global Block i.e. label range
214 * Only one range supported in this code
217 /* Maximum SID Depth supported by the node */
221 /* Structure aggregating all received SR info from LSAs by node */
223 struct in_addr adv_router
; /* used to identify sender of LSA */
224 /* 24-bit Opaque-ID field value according to RFC 7684 specification */
227 uint8_t algo
[ALGORITHM_COUNT
]; /* Algorithms supported by the node */
228 /* Segment Routing Global Block i.e. label range */
230 uint8_t msd
; /* Maximum SID Depth */
232 /* List of Prefix & Link advertise by this node */
233 struct list
*ext_prefix
; /* For Node SID */
234 struct list
*ext_link
; /* For Adj and LAN SID */
236 /* Pointer to FRR SR-Node or NULL if it is not a neighbor */
237 struct sr_node
*neighbor
;
241 /* Segment Routing - NHLFE info: support IPv4 Only */
243 struct prefix_ipv4 prefv4
;
244 struct in_addr nexthop
;
246 mpls_label_t label_in
;
247 mpls_label_t label_out
;
250 /* Structure aggregating all Segment Routing Link information */
251 /* Link are generally advertised by pair: primary + backup */
253 struct in_addr adv_router
; /* used to identify sender of LSA */
254 /* 24-bit Opaque-ID field value according to RFC 7684 specification */
257 /* Flags to manage this link parameters. */
260 /* Segment Routing ID */
264 /* SR NHLFE for this link */
265 struct sr_nhlfe nhlfe
[2];
267 /* Back pointer to SR Node which advertise this Link */
271 /* Structure aggregating all Segment Routing Prefix information */
273 struct in_addr adv_router
; /* used to identify sender of LSA */
274 /* 24-bit Opaque-ID field value according to RFC 7684 specification */
277 /* Flags to manage this prefix parameters. */
280 /* Segment Routing ID */
284 /* SR NHLFE for this prefix */
285 struct sr_nhlfe nhlfe
;
287 /* Back pointer to SR Node which advertise this Prefix */
291 * Pointer to SR Node which is the next hop for this Prefix
292 * or NULL if next hop is the destination of the prefix
294 struct sr_node
*nexthop
;
297 /* Prototypes definition */
298 /* Segment Routing initialisation functions */
299 extern int ospf_sr_init(void);
300 extern void ospf_sr_term(void);
301 extern void ospf_sr_finish(void);
302 /* Segment Routing LSA update & delete functions */
303 extern void ospf_sr_ri_lsa_update(struct ospf_lsa
*lsa
);
304 extern void ospf_sr_ri_lsa_delete(struct ospf_lsa
*lsa
);
305 extern void ospf_sr_ext_link_lsa_update(struct ospf_lsa
*lsa
);
306 extern void ospf_sr_ext_link_lsa_delete(struct ospf_lsa
*lsa
);
307 extern void ospf_sr_ext_prefix_lsa_update(struct ospf_lsa
*lsa
);
308 extern void ospf_sr_ext_prefix_lsa_delete(struct ospf_lsa
*lsa
);
309 /* Segment Routing configuration functions */
310 extern uint32_t get_ext_link_label_value(void);
311 extern void ospf_sr_config_write_router(struct vty
*vty
);
312 extern void ospf_sr_update_prefix(struct interface
*ifp
, struct prefix
*p
);
313 /* Segment Routing re-routing function */
314 extern void ospf_sr_update_timer_add(struct ospf
*ospf
);
315 #endif /* _FRR_OSPF_SR_H */