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"
38 /* Definitions and macros. */
40 #define NHLFE_FAMILY(nhlfe) \
41 (((nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6 \
42 || (nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX) \
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
;
56 * (Outgoing) nexthop label forwarding entry configuration
58 struct zebra_snhlfe_t_
{
59 /* Nexthop information */
60 enum nexthop_types_t gtype
;
66 mpls_label_t out_label
;
68 /* Backpointer to base entry. */
71 /* Pointers to more outgoing information for same in-label */
77 * (Outgoing) nexthop label forwarding entry
79 struct zebra_nhlfe_t_
{
80 /* Type of entry - static etc. */
81 enum lsp_types_t type
;
83 /* Nexthop information (with outgoing label) */
84 struct nexthop
*nexthop
;
86 /* Backpointer to base entry. */
89 /* Runtime info - flags, pointers etc. */
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)
103 * Incoming label entry
105 struct zebra_ile_t_
{
106 mpls_label_t in_label
;
110 * Label swap entry static configuration.
112 struct zebra_slsp_t_
{
116 /* List of outgoing nexthop static configuration */
117 zebra_snhlfe_t
*snhlfe_list
;
121 * Label swap entry (ile -> list of nhlfes)
123 struct zebra_lsp_t_
{
127 /* List of NHLFE, pointer to best and num equal-cost. */
128 zebra_nhlfe_t
*nhlfe_list
;
129 zebra_nhlfe_t
*best_nhlfe
;
134 #define LSP_FLAG_SCHEDULED (1 << 0)
135 #define LSP_FLAG_INSTALLED (1 << 1)
136 #define LSP_FLAG_CHANGED (1 << 2)
138 /* Address-family of NHLFE - saved here for delete. All NHLFEs */
139 /* have to be of the same AF */
144 * FEC to label binding.
146 struct zebra_fec_t_
{
148 struct route_node
*rn
;
150 /* In-label - either statically bound or derived from label block. */
153 /* Label index (into global label block), if valid */
154 uint32_t label_index
;
158 #define FEC_FLAG_CONFIGURED (1 << 0)
160 /* Clients interested in this FEC. */
161 struct list
*client_list
;
164 /* Function declarations. */
167 * Add/update global label block.
169 int zebra_mpls_label_block_add(struct zebra_vrf
*zvrf
, uint32_t start_label
,
173 * Delete global label block.
175 int zebra_mpls_label_block_del(struct zebra_vrf
*vrf
);
178 * Display MPLS global label block configuration (VTY command handler).
180 int zebra_mpls_write_label_block_config(struct vty
*vty
, struct zebra_vrf
*vrf
);
183 * Install dynamic LSP entry.
185 int zebra_mpls_lsp_install(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
186 struct route_entry
*re
);
189 * Uninstall dynamic LSP entry, if any.
191 int zebra_mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
192 struct route_entry
*re
);
194 /* Add an NHLFE to an LSP, return the newly-added object */
195 zebra_nhlfe_t
*zebra_mpls_lsp_add_nhlfe(zebra_lsp_t
*lsp
,
196 enum lsp_types_t lsp_type
,
197 enum nexthop_types_t gtype
,
200 mpls_label_t out_label
);
202 /* Free an allocated NHLFE */
203 void zebra_mpls_nhlfe_del(zebra_nhlfe_t
*nhlfe
);
205 int zebra_mpls_fec_register(struct zebra_vrf
*zvrf
, struct prefix
*p
,
206 uint32_t label
, uint32_t label_index
,
207 struct zserv
*client
);
210 * Deregistration from a client for the label binding for a FEC. The FEC
211 * itself is deleted if no other registered clients exist and there is no
212 * label bound to the FEC.
214 int zebra_mpls_fec_unregister(struct zebra_vrf
*zvrf
, struct prefix
*p
,
215 struct zserv
*client
);
218 * Return FEC (if any) to which this label is bound.
219 * Note: Only works for per-prefix binding and when the label is not
221 * TODO: Currently walks entire table, can optimize later with another
224 zebra_fec_t
*zebra_mpls_fec_for_label(struct zebra_vrf
*zvrf
,
228 * Inform if specified label is currently bound to a FEC or not.
230 int zebra_mpls_label_already_bound(struct zebra_vrf
*zvrf
, mpls_label_t label
);
233 * Add static FEC to label binding. If there are clients registered for this
234 * FEC, notify them. If there are labeled routes for this FEC, install the
235 * label forwarding entry.
237 int zebra_mpls_static_fec_add(struct zebra_vrf
*zvrf
, struct prefix
*p
,
238 mpls_label_t in_label
);
241 * Remove static FEC to label binding. If there are no clients registered
242 * for this FEC, delete the FEC; else notify clients.
243 * Note: Upon delete of static binding, if label index exists for this FEC,
244 * client may need to be updated with derived label.
246 int zebra_mpls_static_fec_del(struct zebra_vrf
*zvrf
, struct prefix
*p
);
249 * Display MPLS FEC to label binding configuration (VTY command handler).
251 int zebra_mpls_write_fec_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
254 * Display MPLS FEC to label binding (VTY command handler).
256 void zebra_mpls_print_fec_table(struct vty
*vty
, struct zebra_vrf
*zvrf
);
259 * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
261 void zebra_mpls_print_fec(struct vty
*vty
, struct zebra_vrf
*zvrf
,
265 * Install/uninstall a FEC-To-NHLFE (FTN) binding.
267 int mpls_ftn_update(int add
, struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
268 struct prefix
*prefix
, enum nexthop_types_t gtype
,
269 union g_addr
*gate
, ifindex_t ifindex
, uint8_t distance
,
270 mpls_label_t out_label
);
273 * Install/update a NHLFE for an LSP in the forwarding table. This may be
274 * a new LSP entry or a new NHLFE for an existing in-label or an update of
275 * the out-label for an existing NHLFE (update case).
277 int mpls_lsp_install(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
278 mpls_label_t in_label
, mpls_label_t out_label
,
279 enum nexthop_types_t gtype
, union g_addr
*gate
,
283 * Uninstall a particular NHLFE in the forwarding table. If this is
284 * the only NHLFE, the entire LSP forwarding entry has to be deleted.
286 int mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
287 mpls_label_t in_label
, enum nexthop_types_t gtype
,
288 union g_addr
*gate
, ifindex_t ifindex
);
291 * Uninstall all LDP NHLFEs for a particular LSP forwarding entry.
292 * If no other NHLFEs exist, the entry would be deleted.
294 void mpls_ldp_lsp_uninstall_all(struct hash_backet
*backet
, void *ctxt
);
297 * Uninstall all LDP FEC-To-NHLFE (FTN) bindings of the given address-family.
299 void mpls_ldp_ftn_uninstall_all(struct zebra_vrf
*zvrf
, int afi
);
302 * Uninstall all Segment Routing NHLFEs for a particular LSP forwarding entry.
303 * If no other NHLFEs exist, the entry would be deleted.
305 void mpls_sr_lsp_uninstall_all(struct hash_backet
*backet
, void *ctxt
);
307 #if defined(HAVE_CUMULUS)
309 * Check that the label values used in LSP creation are consistent. The
310 * main criteria is that if there is ECMP, the label operation must still
311 * be consistent - i.e., all paths either do a swap or do PHP. This is due
312 * to current HW restrictions.
314 int zebra_mpls_lsp_label_consistent(struct zebra_vrf
*zvrf
,
315 mpls_label_t in_label
,
316 mpls_label_t out_label
,
317 enum nexthop_types_t gtype
,
318 union g_addr
*gate
, ifindex_t ifindex
);
319 #endif /* HAVE_CUMULUS */
322 * Add static LSP entry. This may be the first entry for this incoming label
323 * or an additional nexthop; an existing entry may also have outgoing label
325 * Note: The label operation (swap or PHP) is common for the LSP entry (all
328 int zebra_mpls_static_lsp_add(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
329 mpls_label_t out_label
,
330 enum nexthop_types_t gtype
, union g_addr
*gate
,
334 * Delete static LSP entry. This may be the delete of one particular
335 * NHLFE for this incoming label or the delete of the entire entry (i.e.,
337 * NOTE: Delete of the only NHLFE will also end up deleting the entire
340 int zebra_mpls_static_lsp_del(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
341 enum nexthop_types_t gtype
, union g_addr
*gate
,
345 * Process LSP update results from zebra dataplane.
347 /* Forward ref of dplane update context type */
348 struct zebra_dplane_ctx
;
350 void zebra_mpls_lsp_dplane_result(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);
407 /* Inline functions. */
410 * Distance (priority) definition for LSP NHLFE.
412 static inline uint8_t lsp_distance(enum lsp_types_t type
)
415 case ZEBRA_LSP_STATIC
:
416 return (route_distance(ZEBRA_ROUTE_STATIC
));
418 return (route_distance(ZEBRA_ROUTE_LDP
));
420 return (route_distance(ZEBRA_ROUTE_BGP
));
422 case ZEBRA_LSP_SHARP
:
428 * For some reason certain compilers do not believe
429 * that all the cases have been handled. And
430 * WTF does this work differently than when I removed
431 * the default case????
437 * Map RIB type to LSP type. Used when labeled-routes from BGP
438 * are converted into LSPs.
440 static inline enum lsp_types_t
lsp_type_from_re_type(int re_type
)
443 case ZEBRA_ROUTE_STATIC
:
444 return ZEBRA_LSP_STATIC
;
445 case ZEBRA_ROUTE_BGP
:
446 return ZEBRA_LSP_BGP
;
447 case ZEBRA_ROUTE_SHARP
:
448 return ZEBRA_LSP_SHARP
;
450 return ZEBRA_LSP_NONE
;
455 * Map LSP type to RIB type.
457 static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type
)
460 case ZEBRA_LSP_STATIC
:
461 return ZEBRA_ROUTE_STATIC
;
463 return ZEBRA_ROUTE_LDP
;
465 return ZEBRA_ROUTE_BGP
;
467 return ZEBRA_ROUTE_OSPF
;
469 return ZEBRA_ROUTE_KERNEL
;
470 case ZEBRA_LSP_SHARP
:
471 return ZEBRA_ROUTE_SHARP
;
475 * For some reason certain compilers do not believe
476 * that all the cases have been handled. And
477 * WTF does this work differently than when I removed
478 * the default case????
480 return ZEBRA_ROUTE_KERNEL
;
483 /* NHLFE type as printable string. */
484 static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type
)
487 case ZEBRA_LSP_STATIC
:
495 case ZEBRA_LSP_SHARP
:
502 * For some reason certain compilers do not believe
503 * that all the cases have been handled. And
504 * WTF does this work differently than when I removed
505 * the default case????
510 static inline void mpls_mark_lsps_for_processing(struct zebra_vrf
*zvrf
)
515 zvrf
->mpls_flags
|= MPLS_FLAG_SCHEDULE_LSPS
;
518 static inline void mpls_unmark_lsps_for_processing(struct zebra_vrf
*zvrf
)
523 zvrf
->mpls_flags
&= ~MPLS_FLAG_SCHEDULE_LSPS
;
526 static inline int mpls_should_lsps_be_processed(struct zebra_vrf
*zvrf
)
531 return ((zvrf
->mpls_flags
& MPLS_FLAG_SCHEDULE_LSPS
) ? 1 : 0);
534 /* Global variables. */
535 extern int mpls_enabled
;
537 #endif /*_ZEBRA_MPLS_H */