2 * Zebra MPLS Data structures and definitions
3 * Copyright (C) 2015 Cumulus Networks, Inc.
5 * This file is part of GNU Zebra.
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
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.
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
34 #include "zebra/zserv.h"
35 #include "zebra/zebra_vrf.h"
42 /* Definitions and macros. */
44 #define NHLFE_FAMILY(nhlfe) \
45 (((nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6 \
46 || (nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX) \
50 /* Declare LSP nexthop list types */
51 PREDECL_DLIST(nhlfe_list
);
54 * (Outgoing) nexthop label forwarding entry
57 /* Type of entry - static etc. */
58 enum lsp_types_t type
;
60 /* Nexthop information (with outgoing label) */
61 struct nexthop
*nexthop
;
63 /* Backpointer to base entry. */
64 struct zebra_lsp
*lsp
;
66 /* Runtime info - flags, pointers etc. */
68 #define NHLFE_FLAG_CHANGED (1 << 0)
69 #define NHLFE_FLAG_SELECTED (1 << 1)
70 #define NHLFE_FLAG_MULTIPATH (1 << 2)
71 #define NHLFE_FLAG_DELETED (1 << 3)
72 #define NHLFE_FLAG_INSTALLED (1 << 4)
73 #define NHLFE_FLAG_IS_BACKUP (1 << 5)
77 /* Linkage for LSPs' lists */
78 struct nhlfe_list_item list
;
82 * Incoming label entry
85 mpls_label_t in_label
;
89 * Label swap entry (ile -> list of nhlfes)
95 /* List of NHLFEs, pointer to best, and num equal-cost. */
96 struct nhlfe_list_head nhlfe_list
;
98 struct zebra_nhlfe
*best_nhlfe
;
101 /* Backup nhlfes, if present. The nexthop in a primary/active nhlfe
102 * refers to its backup (if any) by index, so the order of this list
105 struct nhlfe_list_head backup_nhlfe_list
;
109 #define LSP_FLAG_SCHEDULED (1 << 0)
110 #define LSP_FLAG_INSTALLED (1 << 1)
111 #define LSP_FLAG_CHANGED (1 << 2)
112 #define LSP_FLAG_FPM (1 << 3)
114 /* Address-family of NHLFE - saved here for delete. All NHLFEs */
115 /* have to be of the same AF */
120 * FEC to label binding.
124 struct route_node
*rn
;
126 /* In-label - either statically bound or derived from label block. */
129 /* Label index (into global label block), if valid */
130 uint32_t label_index
;
134 #define FEC_FLAG_CONFIGURED (1 << 0)
136 /* Clients interested in this FEC. */
137 struct list
*client_list
;
140 /* Declare typesafe list apis/macros */
141 DECLARE_DLIST(nhlfe_list
, struct zebra_nhlfe
, list
);
143 /* Function declarations. */
146 * Add/update global label block.
148 int zebra_mpls_label_block_add(struct zebra_vrf
*zvrf
, uint32_t start_label
,
152 * Delete global label block.
154 int zebra_mpls_label_block_del(struct zebra_vrf
*vrf
);
157 * Display MPLS global label block configuration (VTY command handler).
159 int zebra_mpls_write_label_block_config(struct vty
*vty
, struct zebra_vrf
*vrf
);
162 * Install dynamic LSP entry.
164 int zebra_mpls_lsp_install(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
165 struct route_entry
*re
);
168 * Uninstall dynamic LSP entry, if any.
170 int zebra_mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
171 struct route_entry
*re
);
173 /* Add an NHLFE to an LSP, return the newly-added object */
175 zebra_mpls_lsp_add_nhlfe(struct zebra_lsp
*lsp
, enum lsp_types_t lsp_type
,
176 enum nexthop_types_t gtype
, const union g_addr
*gate
,
177 ifindex_t ifindex
, uint8_t num_labels
,
178 const mpls_label_t
*out_labels
);
180 /* Add or update a backup NHLFE for an LSP; return the object */
181 struct zebra_nhlfe
*zebra_mpls_lsp_add_backup_nhlfe(
182 struct zebra_lsp
*lsp
, enum lsp_types_t lsp_type
,
183 enum nexthop_types_t gtype
, const union g_addr
*gate
, ifindex_t ifindex
,
184 uint8_t num_labels
, const mpls_label_t
*out_labels
);
187 * Add NHLFE or backup NHLFE to an LSP based on a nexthop. These just maintain
188 * the LSP and NHLFE objects; nothing is scheduled for processing.
189 * Return: the newly-added object
191 struct zebra_nhlfe
*zebra_mpls_lsp_add_nh(struct zebra_lsp
*lsp
,
192 enum lsp_types_t lsp_type
,
193 const struct nexthop
*nh
);
194 struct zebra_nhlfe
*zebra_mpls_lsp_add_backup_nh(struct zebra_lsp
*lsp
,
195 enum lsp_types_t lsp_type
,
196 const struct nexthop
*nh
);
198 /* Free an allocated NHLFE */
199 void zebra_mpls_nhlfe_free(struct zebra_nhlfe
*nhlfe
);
201 int zebra_mpls_fec_register(struct zebra_vrf
*zvrf
, struct prefix
*p
,
202 uint32_t label
, uint32_t label_index
,
203 struct zserv
*client
);
206 * Deregistration from a client for the label binding for a FEC. The FEC
207 * itself is deleted if no other registered clients exist and there is no
208 * label bound to the FEC.
210 int zebra_mpls_fec_unregister(struct zebra_vrf
*zvrf
, struct prefix
*p
,
211 struct zserv
*client
);
214 * Return FEC (if any) to which this label is bound.
215 * Note: Only works for per-prefix binding and when the label is not
217 * TODO: Currently walks entire table, can optimize later with another
220 struct zebra_fec
*zebra_mpls_fec_for_label(struct zebra_vrf
*zvrf
,
224 * Inform if specified label is currently bound to a FEC or not.
226 int zebra_mpls_label_already_bound(struct zebra_vrf
*zvrf
, mpls_label_t label
);
229 * Add static FEC to label binding. If there are clients registered for this
230 * FEC, notify them. If there are labeled routes for this FEC, install the
231 * label forwarding entry.
233 int zebra_mpls_static_fec_add(struct zebra_vrf
*zvrf
, struct prefix
*p
,
234 mpls_label_t in_label
);
237 * Remove static FEC to label binding. If there are no clients registered
238 * for this FEC, delete the FEC; else notify clients.
239 * Note: Upon delete of static binding, if label index exists for this FEC,
240 * client may need to be updated with derived label.
242 int zebra_mpls_static_fec_del(struct zebra_vrf
*zvrf
, struct prefix
*p
);
245 * Display MPLS FEC to label binding configuration (VTY command handler).
247 int zebra_mpls_write_fec_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
250 * Display MPLS FEC to label binding (VTY command handler).
252 void zebra_mpls_print_fec_table(struct vty
*vty
, struct zebra_vrf
*zvrf
);
255 * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
257 void zebra_mpls_print_fec(struct vty
*vty
, struct zebra_vrf
*zvrf
,
261 * Handle zapi request to install/uninstall LSP and
262 * (optionally) FEC-To-NHLFE (FTN) bindings.
264 int mpls_zapi_labels_process(bool add_p
, struct zebra_vrf
*zvrf
,
265 const struct zapi_labels
*zl
);
268 * Uninstall all NHLFEs bound to a single FEC.
270 int mpls_ftn_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
271 struct prefix
*prefix
, uint8_t route_type
,
272 unsigned short route_instance
);
275 * Install/update a NHLFE for an LSP in the forwarding table. This may be
276 * a new LSP entry or a new NHLFE for an existing in-label or an update of
277 * the out-label(s) for an existing NHLFE (update case).
279 int mpls_lsp_install(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
280 mpls_label_t in_label
, uint8_t num_out_labels
,
281 const mpls_label_t
*out_labels
, enum nexthop_types_t gtype
,
282 const union g_addr
*gate
, ifindex_t ifindex
);
285 * Lookup LSP by its input label.
287 struct zebra_lsp
*mpls_lsp_find(struct zebra_vrf
*zvrf
, mpls_label_t in_label
);
290 * Uninstall a particular NHLFE in the forwarding table. If this is
291 * the only NHLFE, the entire LSP forwarding entry has to be deleted.
293 int mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
294 mpls_label_t in_label
, enum nexthop_types_t gtype
,
295 const union g_addr
*gate
, ifindex_t ifindex
,
299 * Uninstall all NHLFEs for a particular LSP forwarding entry.
301 int mpls_lsp_uninstall_all_vrf(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
302 mpls_label_t in_label
);
304 #if defined(HAVE_CUMULUS)
306 * Check that the label values used in LSP creation are consistent. The
307 * main criteria is that if there is ECMP, the label operation must still
308 * be consistent - i.e., all paths either do a swap or do PHP. This is due
309 * to current HW restrictions.
311 int zebra_mpls_lsp_label_consistent(struct zebra_vrf
*zvrf
,
312 mpls_label_t in_label
,
313 mpls_label_t out_label
,
314 enum nexthop_types_t gtype
,
315 union g_addr
*gate
, ifindex_t ifindex
);
316 #endif /* HAVE_CUMULUS */
319 * Add static LSP entry. This may be the first entry for this incoming label
320 * or an additional nexthop; an existing entry may also have outgoing label
322 * Note: The label operation (swap or PHP) is common for the LSP entry (all
325 int zebra_mpls_static_lsp_add(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
326 mpls_label_t out_label
,
327 enum nexthop_types_t gtype
, union g_addr
*gate
,
331 * Delete static LSP entry. This may be the delete of one particular
332 * NHLFE for this incoming label or the delete of the entire entry (i.e.,
334 * NOTE: Delete of the only NHLFE will also end up deleting the entire
337 int zebra_mpls_static_lsp_del(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
338 enum nexthop_types_t gtype
, union g_addr
*gate
,
342 * Process LSP update results from zebra dataplane.
344 /* Forward ref of dplane update context type */
345 struct zebra_dplane_ctx
;
347 void zebra_mpls_lsp_dplane_result(struct zebra_dplane_ctx
*ctx
);
349 /* Process async dplane notifications. */
350 void zebra_mpls_process_dplane_notify(struct zebra_dplane_ctx
*ctx
);
353 * Schedule all MPLS label forwarding entries for processing.
354 * Called upon changes that may affect one or more of them such as
355 * interface or nexthop state changes.
357 void zebra_mpls_lsp_schedule(struct zebra_vrf
*zvrf
);
360 * Display MPLS label forwarding table for a specific LSP
361 * (VTY command handler).
363 void zebra_mpls_print_lsp(struct vty
*vty
, struct zebra_vrf
*zvrf
,
364 mpls_label_t label
, bool use_json
);
367 * Display MPLS label forwarding table (VTY command handler).
369 void zebra_mpls_print_lsp_table(struct vty
*vty
, struct zebra_vrf
*zvrf
,
373 * Display MPLS LSP configuration of all static LSPs (VTY command handler).
375 int zebra_mpls_write_lsp_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
378 * Called when VRF becomes inactive, cleans up information but keeps
380 * NOTE: Currently supported only for default VRF.
382 void zebra_mpls_cleanup_tables(struct zebra_vrf
*zvrf
);
385 * Called upon process exiting, need to delete LSP forwarding
386 * entries from the kernel.
387 * NOTE: Currently supported only for default VRF.
389 void zebra_mpls_close_tables(struct zebra_vrf
*zvrf
);
392 * Allocate MPLS tables for this VRF.
393 * NOTE: Currently supported only for default VRF.
395 void zebra_mpls_init_tables(struct zebra_vrf
*zvrf
);
398 * Global MPLS initialization.
400 void zebra_mpls_init(void);
405 void zebra_mpls_vty_init(void);
408 * When cleaning up a client connection ensure that there are no
409 * vrf labels that need cleaning up too
411 void zebra_mpls_client_cleanup_vrf_label(uint8_t proto
);
413 /* Inline functions. */
416 * Distance (priority) definition for LSP NHLFE.
418 static inline uint8_t lsp_distance(enum lsp_types_t type
)
421 case ZEBRA_LSP_STATIC
:
422 return (route_distance(ZEBRA_ROUTE_STATIC
));
424 return (route_distance(ZEBRA_ROUTE_LDP
));
426 return (route_distance(ZEBRA_ROUTE_BGP
));
428 case ZEBRA_LSP_SHARP
:
429 case ZEBRA_LSP_OSPF_SR
:
430 case ZEBRA_LSP_ISIS_SR
:
436 * For some reason certain compilers do not believe
437 * that all the cases have been handled. And
438 * WTF does this work differently than when I removed
439 * the default case????
445 * Map RIB type to LSP type. Used when labeled-routes from BGP
446 * are converted into LSPs.
448 static inline enum lsp_types_t
lsp_type_from_re_type(int re_type
)
451 case ZEBRA_ROUTE_STATIC
:
452 return ZEBRA_LSP_STATIC
;
453 case ZEBRA_ROUTE_LDP
:
454 return ZEBRA_LSP_LDP
;
455 case ZEBRA_ROUTE_BGP
:
456 return ZEBRA_LSP_BGP
;
457 case ZEBRA_ROUTE_OSPF
:
458 return ZEBRA_LSP_OSPF_SR
;
459 case ZEBRA_ROUTE_ISIS
:
460 return ZEBRA_LSP_ISIS_SR
;
461 case ZEBRA_ROUTE_SHARP
:
462 return ZEBRA_LSP_SHARP
;
463 case ZEBRA_ROUTE_SRTE
:
464 return ZEBRA_LSP_SRTE
;
466 return ZEBRA_LSP_NONE
;
471 * Map LSP type to RIB type.
473 static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type
)
476 case ZEBRA_LSP_STATIC
:
477 return ZEBRA_ROUTE_STATIC
;
479 return ZEBRA_ROUTE_LDP
;
481 return ZEBRA_ROUTE_BGP
;
482 case ZEBRA_LSP_OSPF_SR
:
483 return ZEBRA_ROUTE_OSPF
;
484 case ZEBRA_LSP_ISIS_SR
:
485 return ZEBRA_ROUTE_ISIS
;
487 return ZEBRA_ROUTE_KERNEL
;
488 case ZEBRA_LSP_SHARP
:
489 return ZEBRA_ROUTE_SHARP
;
491 return ZEBRA_ROUTE_SRTE
;
495 * For some reason certain compilers do not believe
496 * that all the cases have been handled. And
497 * WTF does this work differently than when I removed
498 * the default case????
500 return ZEBRA_ROUTE_KERNEL
;
503 /* NHLFE type as printable string. */
504 static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type
)
507 case ZEBRA_LSP_STATIC
:
513 case ZEBRA_LSP_OSPF_SR
:
515 case ZEBRA_LSP_ISIS_SR
:
517 case ZEBRA_LSP_SHARP
:
526 * For some reason certain compilers do not believe
527 * that all the cases have been handled. And
528 * WTF does this work differently than when I removed
529 * the default case????
534 static inline void mpls_mark_lsps_for_processing(struct zebra_vrf
*zvrf
,
537 struct route_table
*table
;
538 struct route_node
*rn
;
544 table
= zvrf
->table
[family2afi(p
->family
)][SAFI_UNICAST
];
548 rn
= route_node_match(table
, p
);
553 dest
= rib_dest_from_rnode(rn
);
554 SET_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
557 static inline void mpls_unmark_lsps_for_processing(struct route_node
*rn
)
559 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
561 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
564 static inline int mpls_should_lsps_be_processed(struct route_node
*rn
)
566 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
568 return !!CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
571 /* Global variables. */
572 extern int mpls_enabled
;
573 extern bool mpls_pw_reach_strict
; /* Strict pseudowire reachability checking */
579 #endif /*_ZEBRA_MPLS_H */