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) \
52 typedef struct zebra_ile_t_ zebra_ile_t
;
53 typedef struct zebra_nhlfe_t_ zebra_nhlfe_t
;
54 typedef struct zebra_lsp_t_ zebra_lsp_t
;
55 typedef struct zebra_fec_t_ zebra_fec_t
;
57 /* Declare LSP nexthop list types */
58 PREDECL_DLIST(nhlfe_list
);
61 * (Outgoing) nexthop label forwarding entry
63 struct zebra_nhlfe_t_
{
64 /* Type of entry - static etc. */
65 enum lsp_types_t type
;
67 /* Nexthop information (with outgoing label) */
68 struct nexthop
*nexthop
;
70 /* Backpointer to base entry. */
73 /* Runtime info - flags, pointers etc. */
75 #define NHLFE_FLAG_CHANGED (1 << 0)
76 #define NHLFE_FLAG_SELECTED (1 << 1)
77 #define NHLFE_FLAG_MULTIPATH (1 << 2)
78 #define NHLFE_FLAG_DELETED (1 << 3)
79 #define NHLFE_FLAG_INSTALLED (1 << 4)
80 #define NHLFE_FLAG_IS_BACKUP (1 << 5)
84 /* Linkage for LSPs' lists */
85 struct nhlfe_list_item list
;
89 * Incoming label entry
92 mpls_label_t in_label
;
96 * Label swap entry (ile -> list of nhlfes)
102 /* List of NHLFEs, pointer to best, and num equal-cost. */
103 struct nhlfe_list_head nhlfe_list
;
105 zebra_nhlfe_t
*best_nhlfe
;
108 /* Backup nhlfes, if present. The nexthop in a primary/active nhlfe
109 * refers to its backup (if any) by index, so the order of this list
112 struct nhlfe_list_head backup_nhlfe_list
;
116 #define LSP_FLAG_SCHEDULED (1 << 0)
117 #define LSP_FLAG_INSTALLED (1 << 1)
118 #define LSP_FLAG_CHANGED (1 << 2)
119 #define LSP_FLAG_FPM (1 << 3)
121 /* Address-family of NHLFE - saved here for delete. All NHLFEs */
122 /* have to be of the same AF */
127 * FEC to label binding.
129 struct zebra_fec_t_
{
131 struct route_node
*rn
;
133 /* In-label - either statically bound or derived from label block. */
136 /* Label index (into global label block), if valid */
137 uint32_t label_index
;
141 #define FEC_FLAG_CONFIGURED (1 << 0)
143 /* Clients interested in this FEC. */
144 struct list
*client_list
;
147 /* Declare typesafe list apis/macros */
148 DECLARE_DLIST(nhlfe_list
, struct zebra_nhlfe_t_
, list
);
150 /* Function declarations. */
153 * Add/update global label block.
155 int zebra_mpls_label_block_add(struct zebra_vrf
*zvrf
, uint32_t start_label
,
159 * Delete global label block.
161 int zebra_mpls_label_block_del(struct zebra_vrf
*vrf
);
164 * Display MPLS global label block configuration (VTY command handler).
166 int zebra_mpls_write_label_block_config(struct vty
*vty
, struct zebra_vrf
*vrf
);
169 * Install dynamic LSP entry.
171 int zebra_mpls_lsp_install(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
172 struct route_entry
*re
);
175 * Uninstall dynamic LSP entry, if any.
177 int zebra_mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
178 struct route_entry
*re
);
180 /* Add an NHLFE to an LSP, return the newly-added object */
181 zebra_nhlfe_t
*zebra_mpls_lsp_add_nhlfe(zebra_lsp_t
*lsp
,
182 enum lsp_types_t lsp_type
,
183 enum nexthop_types_t gtype
,
184 const union g_addr
*gate
,
187 const mpls_label_t
*out_labels
);
189 /* Add or update a backup NHLFE for an LSP; return the object */
190 zebra_nhlfe_t
*zebra_mpls_lsp_add_backup_nhlfe(zebra_lsp_t
*lsp
,
191 enum lsp_types_t lsp_type
,
192 enum nexthop_types_t gtype
,
193 const union g_addr
*gate
,
196 const mpls_label_t
*out_labels
);
199 * Add NHLFE or backup NHLFE to an LSP based on a nexthop. These just maintain
200 * the LSP and NHLFE objects; nothing is scheduled for processing.
201 * Return: the newly-added object
203 zebra_nhlfe_t
*zebra_mpls_lsp_add_nh(zebra_lsp_t
*lsp
,
204 enum lsp_types_t lsp_type
,
205 const struct nexthop
*nh
);
206 zebra_nhlfe_t
*zebra_mpls_lsp_add_backup_nh(zebra_lsp_t
*lsp
,
207 enum lsp_types_t lsp_type
,
208 const struct nexthop
*nh
);
210 /* Free an allocated NHLFE */
211 void zebra_mpls_nhlfe_free(zebra_nhlfe_t
*nhlfe
);
213 int zebra_mpls_fec_register(struct zebra_vrf
*zvrf
, struct prefix
*p
,
214 uint32_t label
, uint32_t label_index
,
215 struct zserv
*client
);
218 * Deregistration from a client for the label binding for a FEC. The FEC
219 * itself is deleted if no other registered clients exist and there is no
220 * label bound to the FEC.
222 int zebra_mpls_fec_unregister(struct zebra_vrf
*zvrf
, struct prefix
*p
,
223 struct zserv
*client
);
226 * Return FEC (if any) to which this label is bound.
227 * Note: Only works for per-prefix binding and when the label is not
229 * TODO: Currently walks entire table, can optimize later with another
232 zebra_fec_t
*zebra_mpls_fec_for_label(struct zebra_vrf
*zvrf
,
236 * Inform if specified label is currently bound to a FEC or not.
238 int zebra_mpls_label_already_bound(struct zebra_vrf
*zvrf
, mpls_label_t label
);
241 * Add static FEC to label binding. If there are clients registered for this
242 * FEC, notify them. If there are labeled routes for this FEC, install the
243 * label forwarding entry.
245 int zebra_mpls_static_fec_add(struct zebra_vrf
*zvrf
, struct prefix
*p
,
246 mpls_label_t in_label
);
249 * Remove static FEC to label binding. If there are no clients registered
250 * for this FEC, delete the FEC; else notify clients.
251 * Note: Upon delete of static binding, if label index exists for this FEC,
252 * client may need to be updated with derived label.
254 int zebra_mpls_static_fec_del(struct zebra_vrf
*zvrf
, struct prefix
*p
);
257 * Display MPLS FEC to label binding configuration (VTY command handler).
259 int zebra_mpls_write_fec_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
262 * Display MPLS FEC to label binding (VTY command handler).
264 void zebra_mpls_print_fec_table(struct vty
*vty
, struct zebra_vrf
*zvrf
);
267 * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
269 void zebra_mpls_print_fec(struct vty
*vty
, struct zebra_vrf
*zvrf
,
273 * Handle zapi request to install/uninstall LSP and
274 * (optionally) FEC-To-NHLFE (FTN) bindings.
276 int mpls_zapi_labels_process(bool add_p
, struct zebra_vrf
*zvrf
,
277 const struct zapi_labels
*zl
);
280 * Uninstall all NHLFEs bound to a single FEC.
282 int mpls_ftn_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
283 struct prefix
*prefix
, uint8_t route_type
,
284 unsigned short route_instance
);
287 * Install/update a NHLFE for an LSP in the forwarding table. This may be
288 * a new LSP entry or a new NHLFE for an existing in-label or an update of
289 * the out-label(s) for an existing NHLFE (update case).
291 int mpls_lsp_install(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
292 mpls_label_t in_label
, uint8_t num_out_labels
,
293 const mpls_label_t
*out_labels
, enum nexthop_types_t gtype
,
294 const union g_addr
*gate
, ifindex_t ifindex
);
297 * Lookup LSP by its input label.
299 zebra_lsp_t
*mpls_lsp_find(struct zebra_vrf
*zvrf
, mpls_label_t in_label
);
302 * Uninstall a particular NHLFE in the forwarding table. If this is
303 * the only NHLFE, the entire LSP forwarding entry has to be deleted.
305 int mpls_lsp_uninstall(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
306 mpls_label_t in_label
, enum nexthop_types_t gtype
,
307 const union g_addr
*gate
, ifindex_t ifindex
,
311 * Uninstall all NHLFEs for a particular LSP forwarding entry.
313 int mpls_lsp_uninstall_all_vrf(struct zebra_vrf
*zvrf
, enum lsp_types_t type
,
314 mpls_label_t in_label
);
316 #if defined(HAVE_CUMULUS)
318 * Check that the label values used in LSP creation are consistent. The
319 * main criteria is that if there is ECMP, the label operation must still
320 * be consistent - i.e., all paths either do a swap or do PHP. This is due
321 * to current HW restrictions.
323 int zebra_mpls_lsp_label_consistent(struct zebra_vrf
*zvrf
,
324 mpls_label_t in_label
,
325 mpls_label_t out_label
,
326 enum nexthop_types_t gtype
,
327 union g_addr
*gate
, ifindex_t ifindex
);
328 #endif /* HAVE_CUMULUS */
331 * Add static LSP entry. This may be the first entry for this incoming label
332 * or an additional nexthop; an existing entry may also have outgoing label
334 * Note: The label operation (swap or PHP) is common for the LSP entry (all
337 int zebra_mpls_static_lsp_add(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
338 mpls_label_t out_label
,
339 enum nexthop_types_t gtype
, union g_addr
*gate
,
343 * Delete static LSP entry. This may be the delete of one particular
344 * NHLFE for this incoming label or the delete of the entire entry (i.e.,
346 * NOTE: Delete of the only NHLFE will also end up deleting the entire
349 int zebra_mpls_static_lsp_del(struct zebra_vrf
*zvrf
, mpls_label_t in_label
,
350 enum nexthop_types_t gtype
, union g_addr
*gate
,
354 * Process LSP update results from zebra dataplane.
356 /* Forward ref of dplane update context type */
357 struct zebra_dplane_ctx
;
359 void zebra_mpls_lsp_dplane_result(struct zebra_dplane_ctx
*ctx
);
361 /* Process async dplane notifications. */
362 void zebra_mpls_process_dplane_notify(struct zebra_dplane_ctx
*ctx
);
365 * Schedule all MPLS label forwarding entries for processing.
366 * Called upon changes that may affect one or more of them such as
367 * interface or nexthop state changes.
369 void zebra_mpls_lsp_schedule(struct zebra_vrf
*zvrf
);
372 * Display MPLS label forwarding table for a specific LSP
373 * (VTY command handler).
375 void zebra_mpls_print_lsp(struct vty
*vty
, struct zebra_vrf
*zvrf
,
376 mpls_label_t label
, bool use_json
);
379 * Display MPLS label forwarding table (VTY command handler).
381 void zebra_mpls_print_lsp_table(struct vty
*vty
, struct zebra_vrf
*zvrf
,
385 * Display MPLS LSP configuration of all static LSPs (VTY command handler).
387 int zebra_mpls_write_lsp_config(struct vty
*vty
, struct zebra_vrf
*zvrf
);
390 * Called when VRF becomes inactive, cleans up information but keeps
392 * NOTE: Currently supported only for default VRF.
394 void zebra_mpls_cleanup_tables(struct zebra_vrf
*zvrf
);
397 * Called upon process exiting, need to delete LSP forwarding
398 * entries from the kernel.
399 * NOTE: Currently supported only for default VRF.
401 void zebra_mpls_close_tables(struct zebra_vrf
*zvrf
);
404 * Allocate MPLS tables for this VRF.
405 * NOTE: Currently supported only for default VRF.
407 void zebra_mpls_init_tables(struct zebra_vrf
*zvrf
);
410 * Global MPLS initialization.
412 void zebra_mpls_init(void);
417 void zebra_mpls_vty_init(void);
419 /* Inline functions. */
422 * Distance (priority) definition for LSP NHLFE.
424 static inline uint8_t lsp_distance(enum lsp_types_t type
)
427 case ZEBRA_LSP_STATIC
:
428 return (route_distance(ZEBRA_ROUTE_STATIC
));
430 return (route_distance(ZEBRA_ROUTE_LDP
));
432 return (route_distance(ZEBRA_ROUTE_BGP
));
434 case ZEBRA_LSP_SHARP
:
435 case ZEBRA_LSP_OSPF_SR
:
436 case ZEBRA_LSP_ISIS_SR
:
442 * For some reason certain compilers do not believe
443 * that all the cases have been handled. And
444 * WTF does this work differently than when I removed
445 * the default case????
451 * Map RIB type to LSP type. Used when labeled-routes from BGP
452 * are converted into LSPs.
454 static inline enum lsp_types_t
lsp_type_from_re_type(int re_type
)
457 case ZEBRA_ROUTE_STATIC
:
458 return ZEBRA_LSP_STATIC
;
459 case ZEBRA_ROUTE_LDP
:
460 return ZEBRA_LSP_LDP
;
461 case ZEBRA_ROUTE_BGP
:
462 return ZEBRA_LSP_BGP
;
463 case ZEBRA_ROUTE_OSPF
:
464 return ZEBRA_LSP_OSPF_SR
;
465 case ZEBRA_ROUTE_ISIS
:
466 return ZEBRA_LSP_ISIS_SR
;
467 case ZEBRA_ROUTE_SHARP
:
468 return ZEBRA_LSP_SHARP
;
469 case ZEBRA_ROUTE_SRTE
:
470 return ZEBRA_LSP_SRTE
;
472 return ZEBRA_LSP_NONE
;
477 * Map LSP type to RIB type.
479 static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type
)
482 case ZEBRA_LSP_STATIC
:
483 return ZEBRA_ROUTE_STATIC
;
485 return ZEBRA_ROUTE_LDP
;
487 return ZEBRA_ROUTE_BGP
;
488 case ZEBRA_LSP_OSPF_SR
:
489 return ZEBRA_ROUTE_OSPF
;
490 case ZEBRA_LSP_ISIS_SR
:
491 return ZEBRA_ROUTE_ISIS
;
493 return ZEBRA_ROUTE_KERNEL
;
494 case ZEBRA_LSP_SHARP
:
495 return ZEBRA_ROUTE_SHARP
;
497 return ZEBRA_ROUTE_SRTE
;
501 * For some reason certain compilers do not believe
502 * that all the cases have been handled. And
503 * WTF does this work differently than when I removed
504 * the default case????
506 return ZEBRA_ROUTE_KERNEL
;
509 /* NHLFE type as printable string. */
510 static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type
)
513 case ZEBRA_LSP_STATIC
:
519 case ZEBRA_LSP_OSPF_SR
:
521 case ZEBRA_LSP_ISIS_SR
:
523 case ZEBRA_LSP_SHARP
:
532 * For some reason certain compilers do not believe
533 * that all the cases have been handled. And
534 * WTF does this work differently than when I removed
535 * the default case????
540 static inline void mpls_mark_lsps_for_processing(struct zebra_vrf
*zvrf
,
543 struct route_table
*table
;
544 struct route_node
*rn
;
550 table
= zvrf
->table
[family2afi(p
->family
)][SAFI_UNICAST
];
554 rn
= route_node_match(table
, p
);
559 dest
= rib_dest_from_rnode(rn
);
560 SET_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
563 static inline void mpls_unmark_lsps_for_processing(struct route_node
*rn
)
565 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
567 UNSET_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
570 static inline int mpls_should_lsps_be_processed(struct route_node
*rn
)
572 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
574 return !!CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
);
577 /* Global variables. */
578 extern int mpls_enabled
;
584 #endif /*_ZEBRA_MPLS_H */