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"
41 /* Definitions and macros. */
43 #define NHLFE_FAMILY(nhlfe) \
44 (((nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6 \
45 || (nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX) \
51 typedef struct zebra_ile_t_ zebra_ile_t
;
52 typedef struct zebra_snhlfe_t_ zebra_snhlfe_t
;
53 typedef struct zebra_slsp_t_ zebra_slsp_t
;
54 typedef struct zebra_nhlfe_t_ zebra_nhlfe_t
;
55 typedef struct zebra_lsp_t_ zebra_lsp_t
;
56 typedef struct zebra_fec_t_ zebra_fec_t
;
59 * (Outgoing) nexthop label forwarding entry configuration
61 struct zebra_snhlfe_t_
{
62 /* Nexthop information */
63 enum nexthop_types_t gtype
;
69 mpls_label_t out_label
;
71 /* Backpointer to base entry. */
74 /* Pointers to more outgoing information for same in-label */
80 * (Outgoing) nexthop label forwarding entry
82 struct zebra_nhlfe_t_
{
83 /* Type of entry - static etc. */
84 enum lsp_types_t type
;
86 /* Nexthop information (with outgoing label) */
87 struct nexthop
*nexthop
;
89 /* Backpointer to base entry. */
92 /* Runtime info - flags, pointers etc. */
94 #define NHLFE_FLAG_CHANGED (1 << 0)
95 #define NHLFE_FLAG_SELECTED (1 << 1)
96 #define NHLFE_FLAG_MULTIPATH (1 << 2)
97 #define NHLFE_FLAG_DELETED (1 << 3)
98 #define NHLFE_FLAG_INSTALLED (1 << 4)
106 * Incoming label entry
108 struct zebra_ile_t_
{
109 mpls_label_t in_label
;
113 * Label swap entry static configuration.
115 struct zebra_slsp_t_
{
119 /* List of outgoing nexthop static configuration */
120 zebra_snhlfe_t
*snhlfe_list
;
124 * Label swap entry (ile -> list of nhlfes)
126 struct zebra_lsp_t_
{
130 /* List of NHLFE, pointer to best and num equal-cost. */
131 zebra_nhlfe_t
*nhlfe_list
;
132 zebra_nhlfe_t
*best_nhlfe
;
137 #define LSP_FLAG_SCHEDULED (1 << 0)
138 #define LSP_FLAG_INSTALLED (1 << 1)
139 #define LSP_FLAG_CHANGED (1 << 2)
141 /* Address-family of NHLFE - saved here for delete. All NHLFEs */
142 /* have to be of the same AF */
147 * FEC to label binding.
149 struct zebra_fec_t_
{
151 struct route_node
*rn
;
153 /* In-label - either statically bound or derived from label block. */
156 /* Label index (into global label block), if valid */
157 uint32_t label_index
;
161 #define FEC_FLAG_CONFIGURED (1 << 0)
163 /* Clients interested in this FEC. */
164 struct list
*client_list
;
167 /* Function declarations. */
170 * Add/update global label block.
172 int zebra_mpls_label_block_add(struct zebra_vrf
*zvrf
, uint32_t start_label
,
176 * Delete global label block.
178 int zebra_mpls_label_block_del(struct zebra_vrf
*vrf
);
181 * Display MPLS global label block configuration (VTY command handler).
183 int zebra_mpls_write_label_block_config(struct vty
*vty
, struct zebra_vrf
*vrf
);
186 * Install dynamic LSP entry.
188 int zebra_mpls_lsp_install(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
189 struct route_entry
*re
);
192 * Uninstall dynamic LSP entry, if any.
194 int zebra_mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
195 struct route_entry
*re
);
197 /* Add an NHLFE to an LSP, return the newly-added object */
198 zebra_nhlfe_t
*zebra_mpls_lsp_add_nhlfe(zebra_lsp_t
*lsp
,
199 enum lsp_types_t lsp_type
,
200 enum nexthop_types_t gtype
,
204 mpls_label_t out_labels
[]);
206 /* Free an allocated NHLFE */
207 void zebra_mpls_nhlfe_del(zebra_nhlfe_t
*nhlfe
);
209 int zebra_mpls_fec_register(struct zebra_vrf
*zvrf
, struct prefix
*p
,
210 uint32_t label
, uint32_t label_index
,
211 struct zserv
*client
);
214 * Deregistration from a client for the label binding for a FEC. The FEC
215 * itself is deleted if no other registered clients exist and there is no
216 * label bound to the FEC.
218 int zebra_mpls_fec_unregister(struct zebra_vrf
*zvrf
, struct prefix
*p
,
219 struct zserv
*client
);
222 * Return FEC (if any) to which this label is bound.
223 * Note: Only works for per-prefix binding and when the label is not
225 * TODO: Currently walks entire table, can optimize later with another
228 zebra_fec_t
*zebra_mpls_fec_for_label(struct zebra_vrf
*zvrf
,
232 * Inform if specified label is currently bound to a FEC or not.
234 int zebra_mpls_label_already_bound(struct zebra_vrf
*zvrf
, mpls_label_t label
);
237 * Add static FEC to label binding. If there are clients registered for this
238 * FEC, notify them. If there are labeled routes for this FEC, install the
239 * label forwarding entry.
241 int zebra_mpls_static_fec_add(struct zebra_vrf
*zvrf
, struct prefix
*p
,
242 mpls_label_t in_label
);
245 * Remove static FEC to label binding. If there are no clients registered
246 * for this FEC, delete the FEC; else notify clients.
247 * Note: Upon delete of static binding, if label index exists for this FEC,
248 * client may need to be updated with derived label.
250 int zebra_mpls_static_fec_del(struct zebra_vrf
*zvrf
, struct prefix
*p
);
253 * Display MPLS FEC to label binding configuration (VTY command handler).
255 int zebra_mpls_write_fec_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
258 * Display MPLS FEC to label binding (VTY command handler).
260 void zebra_mpls_print_fec_table(struct vty
*vty
, struct zebra_vrf
*zvrf
);
263 * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
265 void zebra_mpls_print_fec(struct vty
*vty
, struct zebra_vrf
*zvrf
,
269 * Install/uninstall a FEC-To-NHLFE (FTN) binding.
271 int mpls_ftn_update(int add
, struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
272 struct prefix
*prefix
, enum nexthop_types_t gtype
,
273 union g_addr
*gate
, ifindex_t ifindex
, uint8_t route_type
,
274 unsigned short route_instance
, mpls_label_t out_label
);
277 * Uninstall all NHLFEs bound to a single FEC.
279 int mpls_ftn_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
280 struct prefix
*prefix
, uint8_t route_type
,
281 unsigned short route_instance
);
284 * Install/update a NHLFE for an LSP in the forwarding table. This may be
285 * a new LSP entry or a new NHLFE for an existing in-label or an update of
286 * the out-label(s) for an existing NHLFE (update case).
288 int mpls_lsp_install(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
289 mpls_label_t in_label
, uint8_t num_out_labels
,
290 mpls_label_t out_labels
[], enum nexthop_types_t gtype
,
291 union g_addr
*gate
, ifindex_t ifindex
);
294 * Uninstall a particular NHLFE in the forwarding table. If this is
295 * the only NHLFE, the entire LSP forwarding entry has to be deleted.
297 int mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
298 mpls_label_t in_label
, enum nexthop_types_t gtype
,
299 union g_addr
*gate
, ifindex_t ifindex
);
302 * Uninstall all NHLFEs for a particular LSP forwarding entry.
304 int mpls_lsp_uninstall_all_vrf(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
305 mpls_label_t in_label
);
308 * Uninstall all Segment Routing NHLFEs for a particular LSP forwarding entry.
309 * If no other NHLFEs exist, the entry would be deleted.
311 void mpls_sr_lsp_uninstall_all(struct hash_bucket
*bucket
, void *ctxt
);
313 #if defined(HAVE_CUMULUS)
315 * Check that the label values used in LSP creation are consistent. The
316 * main criteria is that if there is ECMP, the label operation must still
317 * be consistent - i.e., all paths either do a swap or do PHP. This is due
318 * to current HW restrictions.
320 int zebra_mpls_lsp_label_consistent(struct zebra_vrf
*zvrf
,
321 mpls_label_t in_label
,
322 mpls_label_t out_label
,
323 enum nexthop_types_t gtype
,
324 union g_addr
*gate
, ifindex_t ifindex
);
325 #endif /* HAVE_CUMULUS */
328 * Add static LSP entry. This may be the first entry for this incoming label
329 * or an additional nexthop; an existing entry may also have outgoing label
331 * Note: The label operation (swap or PHP) is common for the LSP entry (all
334 int zebra_mpls_static_lsp_add(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
335 mpls_label_t out_label
,
336 enum nexthop_types_t gtype
, union g_addr
*gate
,
340 * Delete static LSP entry. This may be the delete of one particular
341 * NHLFE for this incoming label or the delete of the entire entry (i.e.,
343 * NOTE: Delete of the only NHLFE will also end up deleting the entire
346 int zebra_mpls_static_lsp_del(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
347 enum nexthop_types_t gtype
, union g_addr
*gate
,
351 * Process LSP update results from zebra dataplane.
353 /* Forward ref of dplane update context type */
354 struct zebra_dplane_ctx
;
356 void zebra_mpls_lsp_dplane_result(struct zebra_dplane_ctx
*ctx
);
358 /* Process async dplane notifications. */
359 void zebra_mpls_process_dplane_notify(struct zebra_dplane_ctx
*ctx
);
362 * Schedule all MPLS label forwarding entries for processing.
363 * Called upon changes that may affect one or more of them such as
364 * interface or nexthop state changes.
366 void zebra_mpls_lsp_schedule(struct zebra_vrf
*zvrf
);
369 * Display MPLS label forwarding table for a specific LSP
370 * (VTY command handler).
372 void zebra_mpls_print_lsp(struct vty
*vty
, struct zebra_vrf
*zvrf
,
373 mpls_label_t label
, bool use_json
);
376 * Display MPLS label forwarding table (VTY command handler).
378 void zebra_mpls_print_lsp_table(struct vty
*vty
, struct zebra_vrf
*zvrf
,
382 * Display MPLS LSP configuration of all static LSPs (VTY command handler).
384 int zebra_mpls_write_lsp_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
387 * Called when VRF becomes inactive, cleans up information but keeps
389 * NOTE: Currently supported only for default VRF.
391 void zebra_mpls_cleanup_tables(struct zebra_vrf
*zvrf
);
394 * Called upon process exiting, need to delete LSP forwarding
395 * entries from the kernel.
396 * NOTE: Currently supported only for default VRF.
398 void zebra_mpls_close_tables(struct zebra_vrf
*zvrf
);
401 * Allocate MPLS tables for this VRF.
402 * NOTE: Currently supported only for default VRF.
404 void zebra_mpls_init_tables(struct zebra_vrf
*zvrf
);
407 * Global MPLS initialization.
409 void zebra_mpls_init(void);
414 void zebra_mpls_vty_init(void);
416 /* Inline functions. */
419 * Distance (priority) definition for LSP NHLFE.
421 static inline uint8_t lsp_distance(enum lsp_types_t type
)
424 case ZEBRA_LSP_STATIC
:
425 return (route_distance(ZEBRA_ROUTE_STATIC
));
427 return (route_distance(ZEBRA_ROUTE_LDP
));
429 return (route_distance(ZEBRA_ROUTE_BGP
));
431 case ZEBRA_LSP_SHARP
:
432 case ZEBRA_LSP_OSPF_SR
:
437 * For some reason certain compilers do not believe
438 * that all the cases have been handled. And
439 * WTF does this work differently than when I removed
440 * the default case????
446 * Map RIB type to LSP type. Used when labeled-routes from BGP
447 * are converted into LSPs.
449 static inline enum lsp_types_t
lsp_type_from_re_type(int re_type
)
452 case ZEBRA_ROUTE_STATIC
:
453 return ZEBRA_LSP_STATIC
;
454 case ZEBRA_ROUTE_LDP
:
455 return ZEBRA_LSP_LDP
;
456 case ZEBRA_ROUTE_BGP
:
457 return ZEBRA_LSP_BGP
;
458 case ZEBRA_ROUTE_OSPF
:
459 return ZEBRA_LSP_OSPF_SR
;
460 case ZEBRA_ROUTE_SHARP
:
461 return ZEBRA_LSP_SHARP
;
463 return ZEBRA_LSP_NONE
;
468 * Map LSP type to RIB type.
470 static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type
)
473 case ZEBRA_LSP_STATIC
:
474 return ZEBRA_ROUTE_STATIC
;
476 return ZEBRA_ROUTE_LDP
;
478 return ZEBRA_ROUTE_BGP
;
479 case ZEBRA_LSP_OSPF_SR
:
480 return ZEBRA_ROUTE_OSPF
;
482 return ZEBRA_ROUTE_KERNEL
;
483 case ZEBRA_LSP_SHARP
:
484 return ZEBRA_ROUTE_SHARP
;
488 * For some reason certain compilers do not believe
489 * that all the cases have been handled. And
490 * WTF does this work differently than when I removed
491 * the default case????
493 return ZEBRA_ROUTE_KERNEL
;
496 /* NHLFE type as printable string. */
497 static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type
)
500 case ZEBRA_LSP_STATIC
:
506 case ZEBRA_LSP_OSPF_SR
:
508 case ZEBRA_LSP_SHARP
:
515 * For some reason certain compilers do not believe
516 * that all the cases have been handled. And
517 * WTF does this work differently than when I removed
518 * the default case????
523 static inline void mpls_mark_lsps_for_processing(struct zebra_vrf
*zvrf
,
526 struct route_table
*table
;
527 struct route_node
*rn
;
533 table
= zvrf
->table
[family2afi(p
->family
)][SAFI_UNICAST
];
537 rn
= route_node_match(table
, p
);
542 dest
= rib_dest_from_rnode(rn
);
543 SET_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
546 static inline void mpls_unmark_lsps_for_processing(struct route_node
*rn
)
548 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
550 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
553 static inline int mpls_should_lsps_be_processed(struct route_node
*rn
)
555 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
557 return !!CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
560 /* Global variables. */
561 extern int mpls_enabled
;
567 #endif /*_ZEBRA_MPLS_H */