4 This is an EXPERIMENTAL support of `RFC 8665`.
5 DON'T use it for production network.
10 * Automatic computation of Primary and Backup Adjacency SID with
11 Cisco experimental remote IP address
12 * SRGB & SRLB configuration
13 * Prefix configuration for Node SID with optional NO-PHP flag (Linux
14 kernel support both mode)
15 * Node MSD configuration (with Linux Kernel >= 4.10 a maximum of 32 labels
17 * Automatic provisioning of MPLS table
18 * Equal Cost Multi-Path (ECMP)
19 * Static route configuration with label stack up to 32 labels
24 * Tested on various topology including point-to-point and LAN interfaces
25 in a mix of FRRouting instance and Cisco IOS-XR 6.0.x
26 * Check OSPF LSA conformity with latest wireshark release 2.5.0-rc
28 Implementation details
29 ----------------------
34 Segment Routing used 3 different OPAQUE LSA in OSPF to carry the various
37 * **Router Information:** flood the Segment Routing capabilities of the node.
38 This include the supported algorithms, the Segment Routing Global Block
39 (SRGB) and the Maximum Stack Depth (MSD).
40 * **Extended Link:** flood the Adjaceny and Lan Adjacency Segment Identifier
41 * **Extended Prefix:** flood the Prefix Segment Identifier
43 The implementation follows previous TE and Router Information codes. It used the
44 OPAQUE LSA functions defined in ospf_opaque.[c,h] as well as the OSPF API. This
45 latter is mandatory for the implementation as it provides the Callback to
46 Segment Routing functions (see below) when an Extended Link / Prefix or Router
47 Information LSA s are received.
52 Following files where modified or added:
54 * ospd_ri.[c,h] have been modified to add the new TLVs for Segment Routing.
55 * ospf_ext.[c,h] implement RFC7684 as base support of Extended Link and Prefix
57 * ospf_sr.[c,h] implement the earth of Segment Routing. It adds a new Segment
58 Routing database to manage Segment Identifiers per Link and Prefix and
59 Segment Routing enable node, Callback functions to process incoming LSA and
60 install MPLS FIB entry through Zebra.
62 The figure below shows the relation between the various files:
64 * ospf_sr.c centralized all the Segment Routing processing. It receives Opaque
65 LSA Router Information (4.0.0.0) from ospf_ri.c and Extended Prefix
66 (7.0.0.X) Link (8.0.0.X) from ospf_ext.c. Once received, it parse TLVs and
67 SubTLVs and store information in SRDB (which is defined in ospf_sr.h). For
68 each received LSA, NHLFE is computed and send to Zebra to add/remove new
69 MPLS labels entries and FEC. New CLI configurations are also centralized in
70 ospf_sr.c. This CLI will trigger the flooding of new LSA Router Information
71 (4.0.0.0), Extended Prefix (7.0.0.X) and Link (8.0.0.X) by ospf_ri.c,
72 respectively ospf_ext.c.
73 * ospf_ri.c send back to ospf_sr.c received Router Information LSA and update
74 Self Router Information LSA with parameters provided by ospf_sr.c i.e. SRGB
75 and MSD. It use ospf_opaque.c functions to send/received these Opaque LSAs.
76 * ospf_ext.c send back to ospf_sr.c received Extended Prefix and Link Opaque
77 LSA and send self Extended Prefix and Link Opaque LSA through ospf_opaque.c
82 +-----------+ +-------+
84 | ospf_sr.c +-----+ SRDB |
85 +-----------+ +--+ | |
86 | +-^-------^-+ | +-------+
91 +---v----------+ | | | +-----v-------+
93 | ospf_ri.c +--+ | +-------+ ospf_ext.c |
94 | LSA 4.0.0.0 | | | LSA 7.0.0.X |
96 +---^----------+ | | |
100 | +--------v------------+ |
102 | | ZEBRA: Labels + FEC | |
104 | +---------------------+ |
107 | +---------------+ |
109 +---------> ospf_opaque.c <---------+
113 Figure 1: Overview of Segment Routing interaction
118 To process incoming LSA, the code is based on the capability to call `hook()`
119 functions when LSA are inserted or delete to / from the LSDB and the
120 possibility to register particular treatment for Opaque LSA. The first point
121 is provided by the OSPF API feature and the second by the Opaque implementation
122 itself. Indeed, it is possible to register callback function for a given Opaque
123 LSA ID (see `ospf_register_opaque_functab()` function defined in
124 `ospf_opaque.c`). Each time a new LSA is added to the LSDB, the
125 `new_lsa_hook()` function previously register for this LSA type is called. For
126 Opaque LSA it is the `ospf_opaque_lsa_install_hook()`. For deletion, it is
127 `ospf_opaque_lsa_delete_hook()`.
129 Note that incoming LSA which is already present in the LSDB will be inserted
130 after the old instance of this LSA remove from the LSDB. Thus, after the first
131 time, each incoming LSA will trigger a `delete` following by an `install`. This
132 is not very helpful to handle real LSA deletion. In fact, LSA deletion is done
133 by Flushing LSA i.e. flood LSA after setting its age to MAX_AGE. Then, a garbage
134 function has the role to remove all LSA with `age == MAX_AGE` in the LSDB. So,
135 to handle LSA Flush, the best is to look to the LSA age to determine if it is
136 an installation or a future deletion i.e. the flushed LSA is first store in the
137 LSDB with MAX_AGE waiting for the garbage collector function.
139 Router Information LSAs
140 ^^^^^^^^^^^^^^^^^^^^^^^
142 To activate Segment Routing, new CLI command `segment-routing on` has been
143 introduced. When this command is activated, function
144 `ospf_router_info_update_sr()` is called to indicate to Router Information
145 process that Segment Routing TLVs must be flood. Same function is called to
146 modify the Segment Routing Global Block (SRGB) and Maximum Stack Depth (MSD)
147 TLV. Only Shortest Path First (SPF) Algorithm is supported, so no possibility
148 to modify this TLV is offer by the code.
150 When Opaque LSA Type 4 i.e. Router Information are stored in LSDB, function
151 `ospf_opaque_lsa_install_hook()` will call the previously registered function
152 `ospf_router_info_lsa_update()`. In turn, the function will simply trigger
153 `ospf_sr_ri_lsa_update()` or `ospf_sr_ri_lsa_delete` in function of the LSA
154 age. Before, it verifies that the LSA Opaque Type is 4 (Router Information).
155 Self Opaque LSA are not send back to the Segment Routing functions as
156 information are already stored.
158 Extended Link Prefix LSAs
159 ^^^^^^^^^^^^^^^^^^^^^^^^^
161 Like for Router Information, Segment Routing is activate at the Extended
162 Link/Prefix level with new `segment-routing on` command. This triggers
163 automatically the flooding of Extended Link LSA for all ospf interfaces where
164 adjacency is full. For Extended Prefix LSA, the new CLI command
165 `segment-routing prefix ...` will trigger the flooding of Prefix SID
168 When Opaque LSA Type 7 i.e. Extended Prefix and Type 8 i.e. Extended Link are
169 store in the LSDB, `ospf_ext_pref_update_lsa()` respectively
170 `ospf_ext_link_update_lsa()` are called like for Router Information LSA. In
171 turn, they respectively trigger `ospf_sr_ext_prefix_lsa_update()` /
172 `ospf_sr_ext_link_lsa_update()` or `ospf_sr_ext_prefix_lsa_delete()` /
173 `ospf_sr_ext_link_lsa_delete()` if the LSA age is equal to MAX_AGE.
178 When a new MPLS entry or new Forwarding Equivalent Class (FEC) must be added or
179 deleted in the data plane, `add_sid_nhlfe()` respectively `del_sid_nhlfe()` are
180 called. Once check the validity of labels, they are send to ZEBRA layer through
181 `ZEBRA_MPLS_LABELS_ADD` command, respectively `ZEBRA_MPLS_LABELS_DELETE`
182 command for deletion. This is completed by a new labelled route through
183 `ZEBRA_ROUTE_ADD` command, respectively `ZEBRA_ROUTE_DELETE` command.
191 In order to use OSPF Segment Routing, you must setup MPLS data plane. Up to
192 know, only Linux Kernel version >= 4.5 is supported.
194 First, the MPLS modules aren't loaded by default, so you'll need to load them
201 modprobe mpls_iptunnel
203 Then, you must activate MPLS on the interface you would used:
207 sysctl -w net.mpls.conf.enp0s9.input=1
208 sysctl -w net.mpls.conf.lo.input=1
209 sysctl -w net.mpls.platform_labels=1048575
211 The last line fix the maximum MPLS label value.
213 Once OSPFd start with Segment Routing, you could check that MPLS routes are
221 The first command show the MPLS LFIB table while the second show the FIB
222 table which contains route with MPLS label encapsulation.
224 If you disable Penultimate Hop Popping with the `no-php-flag` (see below), you
225 MUST check that RP filter is not enable for the interface you intend to use,
226 especially the `lo` one. For that purpose, disable RP filtering with:
230 systcl -w net.ipv4.conf.all.rp_filter=0
231 sysctl -w net.ipv4.conf.lo.rp_filter=0
236 Here it is a simple example of configuration to enable Segment Routing. Note
237 that `opaque capability` and `router information` must be set to activate
238 Opaque LSA prior to Segment
244 ospf router-id 192.168.1.11
247 segment-routing global-block 10000 19999
248 segment-routing local-block 5000 5999
249 segment-routing node-msd 8
250 segment-routing prefix 192.168.1.11/32 index 1100
252 The first segment-routing statement enables it. The second and third one set
253 the SRGB and SRLB respectively, fourth line the MSD and finally, set the
254 Prefix SID index for a given prefix.
256 Note that only prefix of Loopback interface could be configured with a Prefix
257 SID. It is possible to add `no-php-flag` at the end of the prefix command to
258 disable Penultimate Hop Popping. This advertises to peers that they MUST NOT pop
259 the MPLS label prior to sending the packet.
264 * Runs only within default VRF
265 * Only single Area is supported. ABR is not yet supported
266 * Only SPF algorithm is supported
267 * Extended Prefix Range is not supported
268 * With NO Penultimate Hop Popping, it is not possible to express a Segment
269 Path with an Adjacency SID due to the impossibility for the Linux Kernel to
270 perform double POP instruction.
275 * Author: Anselme Sawadogo <anselmesawadogo@gmail.com>
276 * Author: Olivier Dugeon <olivier.dugeon@orange.com>
277 * Copyright (C) 2016 - 2018 Orange Labs http://www.orange.com
279 This work has been performed in the framework of the H2020-ICT-2014
280 project 5GEx (Grant Agreement no. 671636), which is partially funded
281 by the European Commission.