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
,
203 mpls_label_t out_label
);
205 /* Free an allocated NHLFE */
206 void zebra_mpls_nhlfe_del(zebra_nhlfe_t
*nhlfe
);
208 int zebra_mpls_fec_register(struct zebra_vrf
*zvrf
, struct prefix
*p
,
209 uint32_t label
, uint32_t label_index
,
210 struct zserv
*client
);
213 * Deregistration from a client for the label binding for a FEC. The FEC
214 * itself is deleted if no other registered clients exist and there is no
215 * label bound to the FEC.
217 int zebra_mpls_fec_unregister(struct zebra_vrf
*zvrf
, struct prefix
*p
,
218 struct zserv
*client
);
221 * Return FEC (if any) to which this label is bound.
222 * Note: Only works for per-prefix binding and when the label is not
224 * TODO: Currently walks entire table, can optimize later with another
227 zebra_fec_t
*zebra_mpls_fec_for_label(struct zebra_vrf
*zvrf
,
231 * Inform if specified label is currently bound to a FEC or not.
233 int zebra_mpls_label_already_bound(struct zebra_vrf
*zvrf
, mpls_label_t label
);
236 * Add static FEC to label binding. If there are clients registered for this
237 * FEC, notify them. If there are labeled routes for this FEC, install the
238 * label forwarding entry.
240 int zebra_mpls_static_fec_add(struct zebra_vrf
*zvrf
, struct prefix
*p
,
241 mpls_label_t in_label
);
244 * Remove static FEC to label binding. If there are no clients registered
245 * for this FEC, delete the FEC; else notify clients.
246 * Note: Upon delete of static binding, if label index exists for this FEC,
247 * client may need to be updated with derived label.
249 int zebra_mpls_static_fec_del(struct zebra_vrf
*zvrf
, struct prefix
*p
);
252 * Display MPLS FEC to label binding configuration (VTY command handler).
254 int zebra_mpls_write_fec_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
257 * Display MPLS FEC to label binding (VTY command handler).
259 void zebra_mpls_print_fec_table(struct vty
*vty
, struct zebra_vrf
*zvrf
);
262 * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
264 void zebra_mpls_print_fec(struct vty
*vty
, struct zebra_vrf
*zvrf
,
268 * Install/uninstall a FEC-To-NHLFE (FTN) binding.
270 int mpls_ftn_update(int add
, struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
271 struct prefix
*prefix
, enum nexthop_types_t gtype
,
272 union g_addr
*gate
, ifindex_t ifindex
, uint8_t route_type
,
273 unsigned short route_instance
, mpls_label_t out_label
);
276 * Uninstall all NHLFEs bound to a single FEC.
278 int mpls_ftn_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
279 struct prefix
*prefix
, uint8_t route_type
,
280 unsigned short route_instance
);
283 * Install/update a NHLFE for an LSP in the forwarding table. This may be
284 * a new LSP entry or a new NHLFE for an existing in-label or an update of
285 * the out-label for an existing NHLFE (update case).
287 int mpls_lsp_install(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
288 mpls_label_t in_label
, mpls_label_t out_label
,
289 enum nexthop_types_t gtype
, union g_addr
*gate
,
293 * Uninstall a particular NHLFE in the forwarding table. If this is
294 * the only NHLFE, the entire LSP forwarding entry has to be deleted.
296 int mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
297 mpls_label_t in_label
, enum nexthop_types_t gtype
,
298 union g_addr
*gate
, ifindex_t ifindex
);
301 * Uninstall all NHLFEs for a particular LSP forwarding entry.
303 int mpls_lsp_uninstall_all_vrf(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
304 mpls_label_t in_label
);
307 * Uninstall all Segment Routing NHLFEs for a particular LSP forwarding entry.
308 * If no other NHLFEs exist, the entry would be deleted.
310 void mpls_sr_lsp_uninstall_all(struct hash_bucket
*bucket
, void *ctxt
);
312 #if defined(HAVE_CUMULUS)
314 * Check that the label values used in LSP creation are consistent. The
315 * main criteria is that if there is ECMP, the label operation must still
316 * be consistent - i.e., all paths either do a swap or do PHP. This is due
317 * to current HW restrictions.
319 int zebra_mpls_lsp_label_consistent(struct zebra_vrf
*zvrf
,
320 mpls_label_t in_label
,
321 mpls_label_t out_label
,
322 enum nexthop_types_t gtype
,
323 union g_addr
*gate
, ifindex_t ifindex
);
324 #endif /* HAVE_CUMULUS */
327 * Add static LSP entry. This may be the first entry for this incoming label
328 * or an additional nexthop; an existing entry may also have outgoing label
330 * Note: The label operation (swap or PHP) is common for the LSP entry (all
333 int zebra_mpls_static_lsp_add(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
334 mpls_label_t out_label
,
335 enum nexthop_types_t gtype
, union g_addr
*gate
,
339 * Delete static LSP entry. This may be the delete of one particular
340 * NHLFE for this incoming label or the delete of the entire entry (i.e.,
342 * NOTE: Delete of the only NHLFE will also end up deleting the entire
345 int zebra_mpls_static_lsp_del(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
346 enum nexthop_types_t gtype
, union g_addr
*gate
,
350 * Process LSP update results from zebra dataplane.
352 /* Forward ref of dplane update context type */
353 struct zebra_dplane_ctx
;
355 void zebra_mpls_lsp_dplane_result(struct zebra_dplane_ctx
*ctx
);
357 /* Process async dplane notifications. */
358 void zebra_mpls_process_dplane_notify(struct zebra_dplane_ctx
*ctx
);
361 * Schedule all MPLS label forwarding entries for processing.
362 * Called upon changes that may affect one or more of them such as
363 * interface or nexthop state changes.
365 void zebra_mpls_lsp_schedule(struct zebra_vrf
*zvrf
);
368 * Display MPLS label forwarding table for a specific LSP
369 * (VTY command handler).
371 void zebra_mpls_print_lsp(struct vty
*vty
, struct zebra_vrf
*zvrf
,
372 mpls_label_t label
, bool use_json
);
375 * Display MPLS label forwarding table (VTY command handler).
377 void zebra_mpls_print_lsp_table(struct vty
*vty
, struct zebra_vrf
*zvrf
,
381 * Display MPLS LSP configuration of all static LSPs (VTY command handler).
383 int zebra_mpls_write_lsp_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
386 * Called when VRF becomes inactive, cleans up information but keeps
388 * NOTE: Currently supported only for default VRF.
390 void zebra_mpls_cleanup_tables(struct zebra_vrf
*zvrf
);
393 * Called upon process exiting, need to delete LSP forwarding
394 * entries from the kernel.
395 * NOTE: Currently supported only for default VRF.
397 void zebra_mpls_close_tables(struct zebra_vrf
*zvrf
);
400 * Allocate MPLS tables for this VRF.
401 * NOTE: Currently supported only for default VRF.
403 void zebra_mpls_init_tables(struct zebra_vrf
*zvrf
);
406 * Global MPLS initialization.
408 void zebra_mpls_init(void);
413 void zebra_mpls_vty_init(void);
415 /* Inline functions. */
418 * Distance (priority) definition for LSP NHLFE.
420 static inline uint8_t lsp_distance(enum lsp_types_t type
)
423 case ZEBRA_LSP_STATIC
:
424 return (route_distance(ZEBRA_ROUTE_STATIC
));
426 return (route_distance(ZEBRA_ROUTE_LDP
));
428 return (route_distance(ZEBRA_ROUTE_BGP
));
430 case ZEBRA_LSP_SHARP
:
431 case ZEBRA_LSP_OSPF_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_SHARP
:
460 return ZEBRA_LSP_SHARP
;
462 return ZEBRA_LSP_NONE
;
467 * Map LSP type to RIB type.
469 static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type
)
472 case ZEBRA_LSP_STATIC
:
473 return ZEBRA_ROUTE_STATIC
;
475 return ZEBRA_ROUTE_LDP
;
477 return ZEBRA_ROUTE_BGP
;
478 case ZEBRA_LSP_OSPF_SR
:
479 return ZEBRA_ROUTE_OSPF
;
481 return ZEBRA_ROUTE_KERNEL
;
482 case ZEBRA_LSP_SHARP
:
483 return ZEBRA_ROUTE_SHARP
;
487 * For some reason certain compilers do not believe
488 * that all the cases have been handled. And
489 * WTF does this work differently than when I removed
490 * the default case????
492 return ZEBRA_ROUTE_KERNEL
;
495 /* NHLFE type as printable string. */
496 static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type
)
499 case ZEBRA_LSP_STATIC
:
505 case ZEBRA_LSP_OSPF_SR
:
507 case ZEBRA_LSP_SHARP
:
514 * For some reason certain compilers do not believe
515 * that all the cases have been handled. And
516 * WTF does this work differently than when I removed
517 * the default case????
522 static inline void mpls_mark_lsps_for_processing(struct zebra_vrf
*zvrf
,
525 struct route_table
*table
;
526 struct route_node
*rn
;
532 table
= zvrf
->table
[family2afi(p
->family
)][SAFI_UNICAST
];
536 rn
= route_node_match(table
, p
);
541 dest
= rib_dest_from_rnode(rn
);
542 SET_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
545 static inline void mpls_unmark_lsps_for_processing(struct route_node
*rn
)
547 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
549 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
552 static inline int mpls_should_lsps_be_processed(struct route_node
*rn
)
554 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
556 return !!CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
559 /* Global variables. */
560 extern int mpls_enabled
;
566 #endif /*_ZEBRA_MPLS_H */