]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * Zebra MPLS Data structures and definitions | |
3 | * Copyright (C) 2015 Cumulus Networks, Inc. | |
4 | * | |
5 | * This file is part of GNU Zebra. | |
6 | * | |
7 | * GNU Zebra is free software; you can redistribute it and/or modify it | |
8 | * under the terms of the GNU General Public License as published by the | |
9 | * Free Software Foundation; either version 2, or (at your option) any | |
10 | * later version. | |
11 | * | |
12 | * GNU Zebra is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License along | |
18 | * with this program; see the file COPYING; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
20 | */ | |
21 | ||
22 | #ifndef _ZEBRA_MPLS_H | |
23 | #define _ZEBRA_MPLS_H | |
24 | ||
25 | #include "prefix.h" | |
26 | #include "table.h" | |
27 | #include "queue.h" | |
28 | #include "hash.h" | |
29 | #include "jhash.h" | |
30 | #include "nexthop.h" | |
31 | #include "vty.h" | |
32 | #include "memory.h" | |
33 | #include "mpls.h" | |
34 | #include "zebra/zserv.h" | |
35 | #include "zebra/zebra_vrf.h" | |
36 | ||
37 | ||
38 | /* Definitions and macros. */ | |
39 | ||
40 | #define NHLFE_FAMILY(nhlfe) \ | |
41 | (((nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6 \ | |
42 | || (nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX) \ | |
43 | ? AF_INET6 \ | |
44 | : AF_INET) | |
45 | ||
46 | /* Typedefs */ | |
47 | ||
48 | typedef struct zebra_ile_t_ zebra_ile_t; | |
49 | typedef struct zebra_snhlfe_t_ zebra_snhlfe_t; | |
50 | typedef struct zebra_slsp_t_ zebra_slsp_t; | |
51 | typedef struct zebra_nhlfe_t_ zebra_nhlfe_t; | |
52 | typedef struct zebra_lsp_t_ zebra_lsp_t; | |
53 | typedef struct zebra_fec_t_ zebra_fec_t; | |
54 | ||
55 | /* | |
56 | * (Outgoing) nexthop label forwarding entry configuration | |
57 | */ | |
58 | struct zebra_snhlfe_t_ { | |
59 | /* Nexthop information */ | |
60 | enum nexthop_types_t gtype; | |
61 | union g_addr gate; | |
62 | char *ifname; | |
63 | ifindex_t ifindex; | |
64 | ||
65 | /* Out label. */ | |
66 | mpls_label_t out_label; | |
67 | ||
68 | /* Backpointer to base entry. */ | |
69 | zebra_slsp_t *slsp; | |
70 | ||
71 | /* Pointers to more outgoing information for same in-label */ | |
72 | zebra_snhlfe_t *next; | |
73 | zebra_snhlfe_t *prev; | |
74 | }; | |
75 | ||
76 | /* | |
77 | * (Outgoing) nexthop label forwarding entry | |
78 | */ | |
79 | struct zebra_nhlfe_t_ { | |
80 | /* Type of entry - static etc. */ | |
81 | enum lsp_types_t type; | |
82 | ||
83 | /* Nexthop information (with outgoing label) */ | |
84 | struct nexthop *nexthop; | |
85 | ||
86 | /* Backpointer to base entry. */ | |
87 | zebra_lsp_t *lsp; | |
88 | ||
89 | /* Runtime info - flags, pointers etc. */ | |
90 | uint32_t flags; | |
91 | #define NHLFE_FLAG_CHANGED (1 << 0) | |
92 | #define NHLFE_FLAG_SELECTED (1 << 1) | |
93 | #define NHLFE_FLAG_MULTIPATH (1 << 2) | |
94 | #define NHLFE_FLAG_DELETED (1 << 3) | |
95 | #define NHLFE_FLAG_INSTALLED (1 << 4) | |
96 | ||
97 | zebra_nhlfe_t *next; | |
98 | zebra_nhlfe_t *prev; | |
99 | uint8_t distance; | |
100 | }; | |
101 | ||
102 | /* | |
103 | * Incoming label entry | |
104 | */ | |
105 | struct zebra_ile_t_ { | |
106 | mpls_label_t in_label; | |
107 | }; | |
108 | ||
109 | /* | |
110 | * Label swap entry static configuration. | |
111 | */ | |
112 | struct zebra_slsp_t_ { | |
113 | /* Incoming label */ | |
114 | zebra_ile_t ile; | |
115 | ||
116 | /* List of outgoing nexthop static configuration */ | |
117 | zebra_snhlfe_t *snhlfe_list; | |
118 | }; | |
119 | ||
120 | /* | |
121 | * Label swap entry (ile -> list of nhlfes) | |
122 | */ | |
123 | struct zebra_lsp_t_ { | |
124 | /* Incoming label */ | |
125 | zebra_ile_t ile; | |
126 | ||
127 | /* List of NHLFE, pointer to best and num equal-cost. */ | |
128 | zebra_nhlfe_t *nhlfe_list; | |
129 | zebra_nhlfe_t *best_nhlfe; | |
130 | uint32_t num_ecmp; | |
131 | ||
132 | /* Flags */ | |
133 | uint32_t flags; | |
134 | #define LSP_FLAG_SCHEDULED (1 << 0) | |
135 | #define LSP_FLAG_INSTALLED (1 << 1) | |
136 | #define LSP_FLAG_CHANGED (1 << 2) | |
137 | ||
138 | /* Address-family of NHLFE - saved here for delete. All NHLFEs */ | |
139 | /* have to be of the same AF */ | |
140 | uint8_t addr_family; | |
141 | }; | |
142 | ||
143 | /* | |
144 | * FEC to label binding. | |
145 | */ | |
146 | struct zebra_fec_t_ { | |
147 | /* FEC (prefix) */ | |
148 | struct route_node *rn; | |
149 | ||
150 | /* In-label - either statically bound or derived from label block. */ | |
151 | mpls_label_t label; | |
152 | ||
153 | /* Label index (into global label block), if valid */ | |
154 | uint32_t label_index; | |
155 | ||
156 | /* Flags. */ | |
157 | uint32_t flags; | |
158 | #define FEC_FLAG_CONFIGURED (1 << 0) | |
159 | ||
160 | /* Clients interested in this FEC. */ | |
161 | struct list *client_list; | |
162 | }; | |
163 | ||
164 | /* Function declarations. */ | |
165 | ||
166 | /* | |
167 | * Add/update global label block. | |
168 | */ | |
169 | int zebra_mpls_label_block_add(struct zebra_vrf *zvrf, uint32_t start_label, | |
170 | uint32_t end_label); | |
171 | ||
172 | /* | |
173 | * Delete global label block. | |
174 | */ | |
175 | int zebra_mpls_label_block_del(struct zebra_vrf *vrf); | |
176 | ||
177 | /* | |
178 | * Display MPLS global label block configuration (VTY command handler). | |
179 | */ | |
180 | int zebra_mpls_write_label_block_config(struct vty *vty, struct zebra_vrf *vrf); | |
181 | ||
182 | /* | |
183 | * Install dynamic LSP entry. | |
184 | */ | |
185 | int zebra_mpls_lsp_install(struct zebra_vrf *zvrf, struct route_node *rn, | |
186 | struct route_entry *re); | |
187 | ||
188 | /* | |
189 | * Uninstall dynamic LSP entry, if any. | |
190 | */ | |
191 | int zebra_mpls_lsp_uninstall(struct zebra_vrf *zvrf, struct route_node *rn, | |
192 | struct route_entry *re); | |
193 | ||
194 | int zebra_mpls_fec_register(struct zebra_vrf *zvrf, struct prefix *p, | |
195 | uint32_t label, uint32_t label_index, | |
196 | struct zserv *client); | |
197 | ||
198 | /* | |
199 | * Deregistration from a client for the label binding for a FEC. The FEC | |
200 | * itself is deleted if no other registered clients exist and there is no | |
201 | * label bound to the FEC. | |
202 | */ | |
203 | int zebra_mpls_fec_unregister(struct zebra_vrf *zvrf, struct prefix *p, | |
204 | struct zserv *client); | |
205 | ||
206 | /* | |
207 | * Return FEC (if any) to which this label is bound. | |
208 | * Note: Only works for per-prefix binding and when the label is not | |
209 | * implicit-null. | |
210 | * TODO: Currently walks entire table, can optimize later with another | |
211 | * hash.. | |
212 | */ | |
213 | zebra_fec_t *zebra_mpls_fec_for_label(struct zebra_vrf *zvrf, | |
214 | mpls_label_t label); | |
215 | ||
216 | /* | |
217 | * Inform if specified label is currently bound to a FEC or not. | |
218 | */ | |
219 | int zebra_mpls_label_already_bound(struct zebra_vrf *zvrf, mpls_label_t label); | |
220 | ||
221 | /* | |
222 | * Add static FEC to label binding. If there are clients registered for this | |
223 | * FEC, notify them. If there are labeled routes for this FEC, install the | |
224 | * label forwarding entry. | |
225 | */ | |
226 | int zebra_mpls_static_fec_add(struct zebra_vrf *zvrf, struct prefix *p, | |
227 | mpls_label_t in_label); | |
228 | ||
229 | /* | |
230 | * Remove static FEC to label binding. If there are no clients registered | |
231 | * for this FEC, delete the FEC; else notify clients. | |
232 | * Note: Upon delete of static binding, if label index exists for this FEC, | |
233 | * client may need to be updated with derived label. | |
234 | */ | |
235 | int zebra_mpls_static_fec_del(struct zebra_vrf *zvrf, struct prefix *p); | |
236 | ||
237 | /* | |
238 | * Display MPLS FEC to label binding configuration (VTY command handler). | |
239 | */ | |
240 | int zebra_mpls_write_fec_config(struct vty *vty, struct zebra_vrf *zvrf); | |
241 | ||
242 | /* | |
243 | * Display MPLS FEC to label binding (VTY command handler). | |
244 | */ | |
245 | void zebra_mpls_print_fec_table(struct vty *vty, struct zebra_vrf *zvrf); | |
246 | ||
247 | /* | |
248 | * Display MPLS FEC to label binding for a specific FEC (VTY command handler). | |
249 | */ | |
250 | void zebra_mpls_print_fec(struct vty *vty, struct zebra_vrf *zvrf, | |
251 | struct prefix *p); | |
252 | ||
253 | /* | |
254 | * Install/uninstall a FEC-To-NHLFE (FTN) binding. | |
255 | */ | |
256 | int mpls_ftn_update(int add, struct zebra_vrf *zvrf, enum lsp_types_t type, | |
257 | struct prefix *prefix, enum nexthop_types_t gtype, | |
258 | union g_addr *gate, ifindex_t ifindex, uint8_t distance, | |
259 | mpls_label_t out_label); | |
260 | ||
261 | /* | |
262 | * Install/update a NHLFE for an LSP in the forwarding table. This may be | |
263 | * a new LSP entry or a new NHLFE for an existing in-label or an update of | |
264 | * the out-label for an existing NHLFE (update case). | |
265 | */ | |
266 | int mpls_lsp_install(struct zebra_vrf *zvrf, enum lsp_types_t type, | |
267 | mpls_label_t in_label, mpls_label_t out_label, | |
268 | enum nexthop_types_t gtype, union g_addr *gate, | |
269 | ifindex_t ifindex); | |
270 | ||
271 | /* | |
272 | * Uninstall a particular NHLFE in the forwarding table. If this is | |
273 | * the only NHLFE, the entire LSP forwarding entry has to be deleted. | |
274 | */ | |
275 | int mpls_lsp_uninstall(struct zebra_vrf *zvrf, enum lsp_types_t type, | |
276 | mpls_label_t in_label, enum nexthop_types_t gtype, | |
277 | union g_addr *gate, ifindex_t ifindex); | |
278 | ||
279 | /* | |
280 | * Uninstall all LDP NHLFEs for a particular LSP forwarding entry. | |
281 | * If no other NHLFEs exist, the entry would be deleted. | |
282 | */ | |
283 | void mpls_ldp_lsp_uninstall_all(struct hash_backet *backet, void *ctxt); | |
284 | ||
285 | /* | |
286 | * Uninstall all LDP FEC-To-NHLFE (FTN) bindings of the given address-family. | |
287 | */ | |
288 | void mpls_ldp_ftn_uninstall_all(struct zebra_vrf *zvrf, int afi); | |
289 | ||
290 | /* | |
291 | * Uninstall all Segment Routing NHLFEs for a particular LSP forwarding entry. | |
292 | * If no other NHLFEs exist, the entry would be deleted. | |
293 | */ | |
294 | void mpls_sr_lsp_uninstall_all(struct hash_backet *backet, void *ctxt); | |
295 | ||
296 | #if defined(HAVE_CUMULUS) | |
297 | /* | |
298 | * Check that the label values used in LSP creation are consistent. The | |
299 | * main criteria is that if there is ECMP, the label operation must still | |
300 | * be consistent - i.e., all paths either do a swap or do PHP. This is due | |
301 | * to current HW restrictions. | |
302 | */ | |
303 | int zebra_mpls_lsp_label_consistent(struct zebra_vrf *zvrf, | |
304 | mpls_label_t in_label, | |
305 | mpls_label_t out_label, | |
306 | enum nexthop_types_t gtype, | |
307 | union g_addr *gate, ifindex_t ifindex); | |
308 | #endif /* HAVE_CUMULUS */ | |
309 | ||
310 | /* | |
311 | * Add static LSP entry. This may be the first entry for this incoming label | |
312 | * or an additional nexthop; an existing entry may also have outgoing label | |
313 | * changed. | |
314 | * Note: The label operation (swap or PHP) is common for the LSP entry (all | |
315 | * NHLFEs). | |
316 | */ | |
317 | int zebra_mpls_static_lsp_add(struct zebra_vrf *zvrf, mpls_label_t in_label, | |
318 | mpls_label_t out_label, | |
319 | enum nexthop_types_t gtype, union g_addr *gate, | |
320 | ifindex_t ifindex); | |
321 | ||
322 | /* | |
323 | * Delete static LSP entry. This may be the delete of one particular | |
324 | * NHLFE for this incoming label or the delete of the entire entry (i.e., | |
325 | * all NHLFEs). | |
326 | * NOTE: Delete of the only NHLFE will also end up deleting the entire | |
327 | * LSP configuration. | |
328 | */ | |
329 | int zebra_mpls_static_lsp_del(struct zebra_vrf *zvrf, mpls_label_t in_label, | |
330 | enum nexthop_types_t gtype, union g_addr *gate, | |
331 | ifindex_t ifindex); | |
332 | ||
333 | /* | |
334 | * Schedule all MPLS label forwarding entries for processing. | |
335 | * Called upon changes that may affect one or more of them such as | |
336 | * interface or nexthop state changes. | |
337 | */ | |
338 | void zebra_mpls_lsp_schedule(struct zebra_vrf *zvrf); | |
339 | ||
340 | /* | |
341 | * Display MPLS label forwarding table for a specific LSP | |
342 | * (VTY command handler). | |
343 | */ | |
344 | void zebra_mpls_print_lsp(struct vty *vty, struct zebra_vrf *zvrf, | |
345 | mpls_label_t label, bool use_json); | |
346 | ||
347 | /* | |
348 | * Display MPLS label forwarding table (VTY command handler). | |
349 | */ | |
350 | void zebra_mpls_print_lsp_table(struct vty *vty, struct zebra_vrf *zvrf, | |
351 | bool use_json); | |
352 | ||
353 | /* | |
354 | * Display MPLS LSP configuration of all static LSPs (VTY command handler). | |
355 | */ | |
356 | int zebra_mpls_write_lsp_config(struct vty *vty, struct zebra_vrf *zvrf); | |
357 | ||
358 | /* | |
359 | * Called when VRF becomes inactive, cleans up information but keeps | |
360 | * the table itself. | |
361 | * NOTE: Currently supported only for default VRF. | |
362 | */ | |
363 | void zebra_mpls_cleanup_tables(struct zebra_vrf *zvrf); | |
364 | ||
365 | /* | |
366 | * Called upon process exiting, need to delete LSP forwarding | |
367 | * entries from the kernel. | |
368 | * NOTE: Currently supported only for default VRF. | |
369 | */ | |
370 | void zebra_mpls_close_tables(struct zebra_vrf *zvrf); | |
371 | ||
372 | /* | |
373 | * Allocate MPLS tables for this VRF. | |
374 | * NOTE: Currently supported only for default VRF. | |
375 | */ | |
376 | void zebra_mpls_init_tables(struct zebra_vrf *zvrf); | |
377 | ||
378 | /* | |
379 | * Global MPLS initialization. | |
380 | */ | |
381 | void zebra_mpls_init(void); | |
382 | ||
383 | /* | |
384 | * MPLS VTY. | |
385 | */ | |
386 | void zebra_mpls_vty_init(void); | |
387 | ||
388 | /* Inline functions. */ | |
389 | ||
390 | /* | |
391 | * Distance (priority) definition for LSP NHLFE. | |
392 | */ | |
393 | static inline uint8_t lsp_distance(enum lsp_types_t type) | |
394 | { | |
395 | switch (type) { | |
396 | case ZEBRA_LSP_STATIC: | |
397 | return (route_distance(ZEBRA_ROUTE_STATIC)); | |
398 | case ZEBRA_LSP_LDP: | |
399 | return (route_distance(ZEBRA_ROUTE_LDP)); | |
400 | case ZEBRA_LSP_BGP: | |
401 | return (route_distance(ZEBRA_ROUTE_BGP)); | |
402 | case ZEBRA_LSP_NONE: | |
403 | case ZEBRA_LSP_SHARP: | |
404 | case ZEBRA_LSP_SR: | |
405 | return 150; | |
406 | } | |
407 | ||
408 | /* | |
409 | * For some reason certain compilers do not believe | |
410 | * that all the cases have been handled. And | |
411 | * WTF does this work differently than when I removed | |
412 | * the default case???? | |
413 | */ | |
414 | return 150; | |
415 | } | |
416 | ||
417 | /* | |
418 | * Map RIB type to LSP type. Used when labeled-routes from BGP | |
419 | * are converted into LSPs. | |
420 | */ | |
421 | static inline enum lsp_types_t lsp_type_from_re_type(int re_type) | |
422 | { | |
423 | switch (re_type) { | |
424 | case ZEBRA_ROUTE_STATIC: | |
425 | return ZEBRA_LSP_STATIC; | |
426 | case ZEBRA_ROUTE_BGP: | |
427 | return ZEBRA_LSP_BGP; | |
428 | case ZEBRA_ROUTE_SHARP: | |
429 | return ZEBRA_LSP_SHARP; | |
430 | default: | |
431 | return ZEBRA_LSP_NONE; | |
432 | } | |
433 | } | |
434 | ||
435 | /* | |
436 | * Map LSP type to RIB type. | |
437 | */ | |
438 | static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type) | |
439 | { | |
440 | switch (lsp_type) { | |
441 | case ZEBRA_LSP_STATIC: | |
442 | return ZEBRA_ROUTE_STATIC; | |
443 | case ZEBRA_LSP_LDP: | |
444 | return ZEBRA_ROUTE_LDP; | |
445 | case ZEBRA_LSP_BGP: | |
446 | return ZEBRA_ROUTE_BGP; | |
447 | case ZEBRA_LSP_SR: | |
448 | return ZEBRA_ROUTE_OSPF; | |
449 | case ZEBRA_LSP_NONE: | |
450 | return ZEBRA_ROUTE_KERNEL; | |
451 | case ZEBRA_LSP_SHARP: | |
452 | return ZEBRA_ROUTE_SHARP; | |
453 | } | |
454 | ||
455 | /* | |
456 | * For some reason certain compilers do not believe | |
457 | * that all the cases have been handled. And | |
458 | * WTF does this work differently than when I removed | |
459 | * the default case???? | |
460 | */ | |
461 | return ZEBRA_ROUTE_KERNEL; | |
462 | } | |
463 | ||
464 | /* NHLFE type as printable string. */ | |
465 | static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type) | |
466 | { | |
467 | switch (lsp_type) { | |
468 | case ZEBRA_LSP_STATIC: | |
469 | return "Static"; | |
470 | case ZEBRA_LSP_LDP: | |
471 | return "LDP"; | |
472 | case ZEBRA_LSP_BGP: | |
473 | return "BGP"; | |
474 | case ZEBRA_LSP_SR: | |
475 | return "SR"; | |
476 | case ZEBRA_LSP_SHARP: | |
477 | return "SHARP"; | |
478 | case ZEBRA_LSP_NONE: | |
479 | return "Unknown"; | |
480 | } | |
481 | ||
482 | /* | |
483 | * For some reason certain compilers do not believe | |
484 | * that all the cases have been handled. And | |
485 | * WTF does this work differently than when I removed | |
486 | * the default case???? | |
487 | */ | |
488 | return "Unknown"; | |
489 | } | |
490 | ||
491 | static inline void mpls_mark_lsps_for_processing(struct zebra_vrf *zvrf) | |
492 | { | |
493 | if (!zvrf) | |
494 | return; | |
495 | ||
496 | zvrf->mpls_flags |= MPLS_FLAG_SCHEDULE_LSPS; | |
497 | } | |
498 | ||
499 | static inline void mpls_unmark_lsps_for_processing(struct zebra_vrf *zvrf) | |
500 | { | |
501 | if (!zvrf) | |
502 | return; | |
503 | ||
504 | zvrf->mpls_flags &= ~MPLS_FLAG_SCHEDULE_LSPS; | |
505 | } | |
506 | ||
507 | static inline int mpls_should_lsps_be_processed(struct zebra_vrf *zvrf) | |
508 | { | |
509 | if (!zvrf) | |
510 | return 0; | |
511 | ||
512 | return ((zvrf->mpls_flags & MPLS_FLAG_SCHEDULE_LSPS) ? 1 : 0); | |
513 | } | |
514 | ||
515 | /* Global variables. */ | |
516 | extern int mpls_enabled; | |
517 | ||
518 | #endif /*_ZEBRA_MPLS_H */ |