zebra/zebra_mpls.h

   1 /*
   2  * Zebra MPLS Data structures and definitions
   3  * Copyright (C) 2015 Cumulus Networks, Inc.
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   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
  10  * later version.
  11  *
  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.
  16  *
  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
  20  */
  21
  22 #ifndef _ZEBRA_MPLS_H
  23 #define _ZEBRA_MPLS_H
  24
  25 #include "prefix.h"
  26 #include "table.h"
  27 #include "queue.h"
  28 #include "hash.h"
  29 #include "jhash.h"
  30 #include "nexthop.h"
  31 #include "vty.h"
  32 #include "memory.h"
  33 #include "mpls.h"
  34 #include "zebra/zserv.h"
  35 #include "zebra/zebra_vrf.h"
  36 #include "hook.h"
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /* Definitions and macros. */
  43
  44 #define NHLFE_FAMILY(nhlfe)                                                    \
  45         (((nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6                          \
  46           || (nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX)              \
  47                  ? AF_INET6                                                    \
  48                  : AF_INET)
  49
  50 /* Typedefs */
  51
  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;
  56
  57 /* Declare LSP nexthop list types */
  58 PREDECL_DLIST(nhlfe_list);
  59
  60 /*
  61  * (Outgoing) nexthop label forwarding entry
  62  */
  63 struct zebra_nhlfe_t_ {
  64         /* Type of entry - static etc. */
  65         enum lsp_types_t type;
  66
  67         /* Nexthop information (with outgoing label) */
  68         struct nexthop *nexthop;
  69
  70         /* Backpointer to base entry. */
  71         zebra_lsp_t *lsp;
  72
  73         /* Runtime info - flags, pointers etc. */
  74         uint32_t flags;
  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)
  81
  82         uint8_t distance;
  83
  84         /* Linkage for LSPs' lists */
  85         struct nhlfe_list_item list;
  86 };
  87
  88 /*
  89  * Incoming label entry
  90  */
  91 struct zebra_ile_t_ {
  92         mpls_label_t in_label;
  93 };
  94
  95 /*
  96  * Label swap entry (ile -> list of nhlfes)
  97  */
  98 struct zebra_lsp_t_ {
  99         /* Incoming label */
 100         zebra_ile_t ile;
 101
 102         /* List of NHLFEs, pointer to best, and num equal-cost. */
 103         struct nhlfe_list_head nhlfe_list;
 104
 105         zebra_nhlfe_t *best_nhlfe;
 106         uint32_t num_ecmp;
 107
 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
 110          * is significant.
 111          */
 112         struct nhlfe_list_head backup_nhlfe_list;
 113
 114         /* Flags */
 115         uint32_t flags;
 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)
 120
 121         /* Address-family of NHLFE - saved here for delete. All NHLFEs */
 122         /* have to be of the same AF */
 123         uint8_t addr_family;
 124 };
 125
 126 /*
 127  * FEC to label binding.
 128  */
 129 struct zebra_fec_t_ {
 130         /* FEC (prefix) */
 131         struct route_node *rn;
 132
 133         /* In-label - either statically bound or derived from label block. */
 134         mpls_label_t label;
 135
 136         /* Label index (into global label block), if valid */
 137         uint32_t label_index;
 138
 139         /* Flags. */
 140         uint32_t flags;
 141 #define FEC_FLAG_CONFIGURED       (1 << 0)
 142
 143         /* Clients interested in this FEC. */
 144         struct list *client_list;
 145 };
 146
 147 /* Declare typesafe list apis/macros */
 148 DECLARE_DLIST(nhlfe_list, struct zebra_nhlfe_t_, list);
 149
 150 /* Function declarations. */
 151
 152 /*
 153  * Add/update global label block.
 154  */
 155 int zebra_mpls_label_block_add(struct zebra_vrf *zvrf, uint32_t start_label,
 156                                uint32_t end_label);
 157
 158 /*
 159  * Delete global label block.
 160  */
 161 int zebra_mpls_label_block_del(struct zebra_vrf *vrf);
 162
 163 /*
 164  * Display MPLS global label block configuration (VTY command handler).
 165  */
 166 int zebra_mpls_write_label_block_config(struct vty *vty, struct zebra_vrf *vrf);
 167
 168 /*
 169  * Install dynamic LSP entry.
 170  */
 171 int zebra_mpls_lsp_install(struct zebra_vrf *zvrf, struct route_node *rn,
 172                            struct route_entry *re);
 173
 174 /*
 175  * Uninstall dynamic LSP entry, if any.
 176  */
 177 int zebra_mpls_lsp_uninstall(struct zebra_vrf *zvrf, struct route_node *rn,
 178                              struct route_entry *re);
 179
 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,
 185                                         ifindex_t ifindex,
 186                                         uint8_t num_labels,
 187                                         const mpls_label_t *out_labels);
 188
 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,
 194                                                ifindex_t ifindex,
 195                                                uint8_t num_labels,
 196                                                const mpls_label_t *out_labels);
 197
 198 /*
 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
 202  */
 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);
 209
 210 /* Free an allocated NHLFE */
 211 void zebra_mpls_nhlfe_free(zebra_nhlfe_t *nhlfe);
 212
 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);
 216
 217 /*
 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.
 221  */
 222 int zebra_mpls_fec_unregister(struct zebra_vrf *zvrf, struct prefix *p,
 223                               struct zserv *client);
 224
 225 /*
 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
 228  * implicit-null.
 229  * TODO: Currently walks entire table, can optimize later with another
 230  * hash..
 231  */
 232 zebra_fec_t *zebra_mpls_fec_for_label(struct zebra_vrf *zvrf,
 233                                       mpls_label_t label);
 234
 235 /*
 236  * Inform if specified label is currently bound to a FEC or not.
 237  */
 238 int zebra_mpls_label_already_bound(struct zebra_vrf *zvrf, mpls_label_t label);
 239
 240 /*
 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.
 244  */
 245 int zebra_mpls_static_fec_add(struct zebra_vrf *zvrf, struct prefix *p,
 246                               mpls_label_t in_label);
 247
 248 /*
 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.
 253  */
 254 int zebra_mpls_static_fec_del(struct zebra_vrf *zvrf, struct prefix *p);
 255
 256 /*
 257  * Display MPLS FEC to label binding configuration (VTY command handler).
 258  */
 259 int zebra_mpls_write_fec_config(struct vty *vty, struct zebra_vrf *zvrf);
 260
 261 /*
 262  * Display MPLS FEC to label binding (VTY command handler).
 263  */
 264 void zebra_mpls_print_fec_table(struct vty *vty, struct zebra_vrf *zvrf);
 265
 266 /*
 267  * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
 268  */
 269 void zebra_mpls_print_fec(struct vty *vty, struct zebra_vrf *zvrf,
 270                           struct prefix *p);
 271
 272 /*
 273  * Handle zapi request to install/uninstall LSP and
 274  * (optionally) FEC-To-NHLFE (FTN) bindings.
 275  */
 276 int mpls_zapi_labels_process(bool add_p, struct zebra_vrf *zvrf,
 277                              const struct zapi_labels *zl);
 278
 279 /*
 280  * Uninstall all NHLFEs bound to a single FEC.
 281  */
 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);
 285
 286 /*
 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).
 290  */
 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);
 295
 296 /*
 297  * Lookup LSP by its input label.
 298  */
 299 zebra_lsp_t *mpls_lsp_find(struct zebra_vrf *zvrf, mpls_label_t in_label);
 300
 301 /*
 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.
 304  */
 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,
 308                        bool backup_p);
 309
 310 /*
 311  * Uninstall all NHLFEs for a particular LSP forwarding entry.
 312  */
 313 int mpls_lsp_uninstall_all_vrf(struct zebra_vrf *zvrf, enum lsp_types_t type,
 314                                mpls_label_t in_label);
 315
 316 #if defined(HAVE_CUMULUS)
 317 /*
 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.
 322  */
 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 */
 329
 330 /*
 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
 333  * changed.
 334  * Note: The label operation (swap or PHP) is common for the LSP entry (all
 335  * NHLFEs).
 336  */
 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,
 340                               ifindex_t ifindex);
 341
 342 /*
 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.,
 345  * all NHLFEs).
 346  * NOTE: Delete of the only NHLFE will also end up deleting the entire
 347  * LSP configuration.
 348  */
 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,
 351                               ifindex_t ifindex);
 352
 353 /*
 354  * Process LSP update results from zebra dataplane.
 355  */
 356 /* Forward ref of dplane update context type */
 357 struct zebra_dplane_ctx;
 358
 359 void zebra_mpls_lsp_dplane_result(struct zebra_dplane_ctx *ctx);
 360
 361 /* Process async dplane notifications. */
 362 void zebra_mpls_process_dplane_notify(struct zebra_dplane_ctx *ctx);
 363
 364 /*
 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.
 368  */
 369 void zebra_mpls_lsp_schedule(struct zebra_vrf *zvrf);
 370
 371 /*
 372  * Display MPLS label forwarding table for a specific LSP
 373  * (VTY command handler).
 374  */
 375 void zebra_mpls_print_lsp(struct vty *vty, struct zebra_vrf *zvrf,
 376                           mpls_label_t label, bool use_json);
 377
 378 /*
 379  * Display MPLS label forwarding table (VTY command handler).
 380  */
 381 void zebra_mpls_print_lsp_table(struct vty *vty, struct zebra_vrf *zvrf,
 382                                 bool use_json);
 383
 384 /*
 385  * Display MPLS LSP configuration of all static LSPs (VTY command handler).
 386  */
 387 int zebra_mpls_write_lsp_config(struct vty *vty, struct zebra_vrf *zvrf);
 388
 389 /*
 390  * Called when VRF becomes inactive, cleans up information but keeps
 391  * the table itself.
 392  * NOTE: Currently supported only for default VRF.
 393  */
 394 void zebra_mpls_cleanup_tables(struct zebra_vrf *zvrf);
 395
 396 /*
 397  * Called upon process exiting, need to delete LSP forwarding
 398  * entries from the kernel.
 399  * NOTE: Currently supported only for default VRF.
 400  */
 401 void zebra_mpls_close_tables(struct zebra_vrf *zvrf);
 402
 403 /*
 404  * Allocate MPLS tables for this VRF.
 405  * NOTE: Currently supported only for default VRF.
 406  */
 407 void zebra_mpls_init_tables(struct zebra_vrf *zvrf);
 408
 409 /*
 410  * Global MPLS initialization.
 411  */
 412 void zebra_mpls_init(void);
 413
 414 /*
 415  * MPLS VTY.
 416  */
 417 void zebra_mpls_vty_init(void);
 418
 419 /*
 420  * When cleaning up a client connection ensure that there are no
 421  * vrf labels that need cleaning up too
 422  */
 423 void zebra_mpls_client_cleanup_vrf_label(uint8_t proto);
 424
 425 /* Inline functions. */
 426
 427 /*
 428  * Distance (priority) definition for LSP NHLFE.
 429  */
 430 static inline uint8_t lsp_distance(enum lsp_types_t type)
 431 {
 432         switch (type) {
 433         case ZEBRA_LSP_STATIC:
 434                 return (route_distance(ZEBRA_ROUTE_STATIC));
 435         case ZEBRA_LSP_LDP:
 436                 return (route_distance(ZEBRA_ROUTE_LDP));
 437         case ZEBRA_LSP_BGP:
 438                 return (route_distance(ZEBRA_ROUTE_BGP));
 439         case ZEBRA_LSP_NONE:
 440         case ZEBRA_LSP_SHARP:
 441         case ZEBRA_LSP_OSPF_SR:
 442         case ZEBRA_LSP_ISIS_SR:
 443         case ZEBRA_LSP_SRTE:
 444                 return 150;
 445         }
 446
 447         /*
 448          * For some reason certain compilers do not believe
 449          * that all the cases have been handled.  And
 450          * WTF does this work differently than when I removed
 451          * the default case????
 452          */
 453         return 150;
 454 }
 455
 456 /*
 457  * Map RIB type to LSP type. Used when labeled-routes from BGP
 458  * are converted into LSPs.
 459  */
 460 static inline enum lsp_types_t lsp_type_from_re_type(int re_type)
 461 {
 462         switch (re_type) {
 463         case ZEBRA_ROUTE_STATIC:
 464                 return ZEBRA_LSP_STATIC;
 465         case ZEBRA_ROUTE_LDP:
 466                 return ZEBRA_LSP_LDP;
 467         case ZEBRA_ROUTE_BGP:
 468                 return ZEBRA_LSP_BGP;
 469         case ZEBRA_ROUTE_OSPF:
 470                 return ZEBRA_LSP_OSPF_SR;
 471         case ZEBRA_ROUTE_ISIS:
 472                 return ZEBRA_LSP_ISIS_SR;
 473         case ZEBRA_ROUTE_SHARP:
 474                 return ZEBRA_LSP_SHARP;
 475         case ZEBRA_ROUTE_SRTE:
 476                 return ZEBRA_LSP_SRTE;
 477         default:
 478                 return ZEBRA_LSP_NONE;
 479         }
 480 }
 481
 482 /*
 483  * Map LSP type to RIB type.
 484  */
 485 static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type)
 486 {
 487         switch (lsp_type) {
 488         case ZEBRA_LSP_STATIC:
 489                 return ZEBRA_ROUTE_STATIC;
 490         case ZEBRA_LSP_LDP:
 491                 return ZEBRA_ROUTE_LDP;
 492         case ZEBRA_LSP_BGP:
 493                 return ZEBRA_ROUTE_BGP;
 494         case ZEBRA_LSP_OSPF_SR:
 495                 return ZEBRA_ROUTE_OSPF;
 496         case ZEBRA_LSP_ISIS_SR:
 497                 return ZEBRA_ROUTE_ISIS;
 498         case ZEBRA_LSP_NONE:
 499                 return ZEBRA_ROUTE_KERNEL;
 500         case ZEBRA_LSP_SHARP:
 501                 return ZEBRA_ROUTE_SHARP;
 502         case ZEBRA_LSP_SRTE:
 503                 return ZEBRA_ROUTE_SRTE;
 504         }
 505
 506         /*
 507          * For some reason certain compilers do not believe
 508          * that all the cases have been handled.  And
 509          * WTF does this work differently than when I removed
 510          * the default case????
 511          */
 512         return ZEBRA_ROUTE_KERNEL;
 513 }
 514
 515 /* NHLFE type as printable string. */
 516 static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type)
 517 {
 518         switch (lsp_type) {
 519         case ZEBRA_LSP_STATIC:
 520                 return "Static";
 521         case ZEBRA_LSP_LDP:
 522                 return "LDP";
 523         case ZEBRA_LSP_BGP:
 524                 return "BGP";
 525         case ZEBRA_LSP_OSPF_SR:
 526                 return "SR (OSPF)";
 527         case ZEBRA_LSP_ISIS_SR:
 528                 return "SR (IS-IS)";
 529         case ZEBRA_LSP_SHARP:
 530                 return "SHARP";
 531         case ZEBRA_LSP_SRTE:
 532                 return "SR-TE";
 533         case ZEBRA_LSP_NONE:
 534                 return "Unknown";
 535         }
 536
 537         /*
 538          * For some reason certain compilers do not believe
 539          * that all the cases have been handled.  And
 540          * WTF does this work differently than when I removed
 541          * the default case????
 542          */
 543         return "Unknown";
 544 }
 545
 546 static inline void mpls_mark_lsps_for_processing(struct zebra_vrf *zvrf,
 547                                                  struct prefix *p)
 548 {
 549         struct route_table *table;
 550         struct route_node *rn;
 551         rib_dest_t *dest;
 552
 553         if (!zvrf)
 554                 return;
 555
 556         table = zvrf->table[family2afi(p->family)][SAFI_UNICAST];
 557         if (!table)
 558                 return;
 559
 560         rn = route_node_match(table, p);
 561         if (!rn)
 562                 return;
 563
 564
 565         dest = rib_dest_from_rnode(rn);
 566         SET_FLAG(dest->flags, RIB_DEST_UPDATE_LSPS);
 567 }
 568
 569 static inline void mpls_unmark_lsps_for_processing(struct route_node *rn)
 570 {
 571         rib_dest_t *dest = rib_dest_from_rnode(rn);
 572
 573         UNSET_FLAG(dest->flags, RIB_DEST_UPDATE_LSPS);
 574 }
 575
 576 static inline int mpls_should_lsps_be_processed(struct route_node *rn)
 577 {
 578         rib_dest_t *dest = rib_dest_from_rnode(rn);
 579
 580         return !!CHECK_FLAG(dest->flags, RIB_DEST_UPDATE_LSPS);
 581 }
 582
 583 /* Global variables. */
 584 extern int mpls_enabled;
 585 extern bool mpls_pw_reach_strict; /* Strict pseudowire reachability checking */
 586
 587 #ifdef __cplusplus
 588 }
 589 #endif
 590
 591 #endif /*_ZEBRA_MPLS_H */