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
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /* Definitions and macros. */
  42
  43 #define NHLFE_FAMILY(nhlfe)                                                    \
  44         (((nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6                          \
  45           || (nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX)              \
  46                  ? AF_INET6                                                    \
  47                  : AF_INET)
  48
  49 /* Typedefs */
  50
  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;
  57
  58 /*
  59  * (Outgoing) nexthop label forwarding entry configuration
  60  */
  61 struct zebra_snhlfe_t_ {
  62         /* Nexthop information */
  63         enum nexthop_types_t gtype;
  64         union g_addr gate;
  65         char *ifname;
  66         ifindex_t ifindex;
  67
  68         /* Out label. */
  69         mpls_label_t out_label;
  70
  71         /* Backpointer to base entry. */
  72         zebra_slsp_t *slsp;
  73
  74         /* Pointers to more outgoing information for same in-label */
  75         zebra_snhlfe_t *next;
  76         zebra_snhlfe_t *prev;
  77 };
  78
  79 /*
  80  * (Outgoing) nexthop label forwarding entry
  81  */
  82 struct zebra_nhlfe_t_ {
  83         /* Type of entry - static etc. */
  84         enum lsp_types_t type;
  85
  86         /* Nexthop information (with outgoing label) */
  87         struct nexthop *nexthop;
  88
  89         /* Backpointer to base entry. */
  90         zebra_lsp_t *lsp;
  91
  92         /* Runtime info - flags, pointers etc. */
  93         uint32_t flags;
  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)
  99
 100         zebra_nhlfe_t *next;
 101         zebra_nhlfe_t *prev;
 102         uint8_t distance;
 103 };
 104
 105 /*
 106  * Incoming label entry
 107  */
 108 struct zebra_ile_t_ {
 109         mpls_label_t in_label;
 110 };
 111
 112 /*
 113  * Label swap entry static configuration.
 114  */
 115 struct zebra_slsp_t_ {
 116         /* Incoming label */
 117         zebra_ile_t ile;
 118
 119         /* List of outgoing nexthop static configuration */
 120         zebra_snhlfe_t *snhlfe_list;
 121 };
 122
 123 /*
 124  * Label swap entry (ile -> list of nhlfes)
 125  */
 126 struct zebra_lsp_t_ {
 127         /* Incoming label */
 128         zebra_ile_t ile;
 129
 130         /* List of NHLFE, pointer to best and num equal-cost. */
 131         zebra_nhlfe_t *nhlfe_list;
 132         zebra_nhlfe_t *best_nhlfe;
 133         uint32_t num_ecmp;
 134
 135         /* Flags */
 136         uint32_t flags;
 137 #define LSP_FLAG_SCHEDULED        (1 << 0)
 138 #define LSP_FLAG_INSTALLED        (1 << 1)
 139 #define LSP_FLAG_CHANGED          (1 << 2)
 140
 141         /* Address-family of NHLFE - saved here for delete. All NHLFEs */
 142         /* have to be of the same AF */
 143         uint8_t addr_family;
 144 };
 145
 146 /*
 147  * FEC to label binding.
 148  */
 149 struct zebra_fec_t_ {
 150         /* FEC (prefix) */
 151         struct route_node *rn;
 152
 153         /* In-label - either statically bound or derived from label block. */
 154         mpls_label_t label;
 155
 156         /* Label index (into global label block), if valid */
 157         uint32_t label_index;
 158
 159         /* Flags. */
 160         uint32_t flags;
 161 #define FEC_FLAG_CONFIGURED       (1 << 0)
 162
 163         /* Clients interested in this FEC. */
 164         struct list *client_list;
 165 };
 166
 167 /* Function declarations. */
 168
 169 /*
 170  * Add/update global label block.
 171  */
 172 int zebra_mpls_label_block_add(struct zebra_vrf *zvrf, uint32_t start_label,
 173                                uint32_t end_label);
 174
 175 /*
 176  * Delete global label block.
 177  */
 178 int zebra_mpls_label_block_del(struct zebra_vrf *vrf);
 179
 180 /*
 181  * Display MPLS global label block configuration (VTY command handler).
 182  */
 183 int zebra_mpls_write_label_block_config(struct vty *vty, struct zebra_vrf *vrf);
 184
 185 /*
 186  * Install dynamic LSP entry.
 187  */
 188 int zebra_mpls_lsp_install(struct zebra_vrf *zvrf, struct route_node *rn,
 189                            struct route_entry *re);
 190
 191 /*
 192  * Uninstall dynamic LSP entry, if any.
 193  */
 194 int zebra_mpls_lsp_uninstall(struct zebra_vrf *zvrf, struct route_node *rn,
 195                              struct route_entry *re);
 196
 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,
 201                                         union g_addr *gate,
 202                                         ifindex_t ifindex,
 203                                         mpls_label_t out_label);
 204
 205 /* Free an allocated NHLFE */
 206 void zebra_mpls_nhlfe_del(zebra_nhlfe_t *nhlfe);
 207
 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);
 211
 212 /*
 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.
 216  */
 217 int zebra_mpls_fec_unregister(struct zebra_vrf *zvrf, struct prefix *p,
 218                               struct zserv *client);
 219
 220 /*
 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
 223  * implicit-null.
 224  * TODO: Currently walks entire table, can optimize later with another
 225  * hash..
 226  */
 227 zebra_fec_t *zebra_mpls_fec_for_label(struct zebra_vrf *zvrf,
 228                                       mpls_label_t label);
 229
 230 /*
 231  * Inform if specified label is currently bound to a FEC or not.
 232  */
 233 int zebra_mpls_label_already_bound(struct zebra_vrf *zvrf, mpls_label_t label);
 234
 235 /*
 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.
 239  */
 240 int zebra_mpls_static_fec_add(struct zebra_vrf *zvrf, struct prefix *p,
 241                               mpls_label_t in_label);
 242
 243 /*
 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.
 248  */
 249 int zebra_mpls_static_fec_del(struct zebra_vrf *zvrf, struct prefix *p);
 250
 251 /*
 252  * Display MPLS FEC to label binding configuration (VTY command handler).
 253  */
 254 int zebra_mpls_write_fec_config(struct vty *vty, struct zebra_vrf *zvrf);
 255
 256 /*
 257  * Display MPLS FEC to label binding (VTY command handler).
 258  */
 259 void zebra_mpls_print_fec_table(struct vty *vty, struct zebra_vrf *zvrf);
 260
 261 /*
 262  * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
 263  */
 264 void zebra_mpls_print_fec(struct vty *vty, struct zebra_vrf *zvrf,
 265                           struct prefix *p);
 266
 267 /*
 268  * Install/uninstall a FEC-To-NHLFE (FTN) binding.
 269  */
 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 distance,
 273                     mpls_label_t out_label);
 274
 275 /*
 276  * Install/update a NHLFE for an LSP in the forwarding table. This may be
 277  * a new LSP entry or a new NHLFE for an existing in-label or an update of
 278  * the out-label for an existing NHLFE (update case).
 279  */
 280 int mpls_lsp_install(struct zebra_vrf *zvrf, enum lsp_types_t type,
 281                      mpls_label_t in_label, mpls_label_t out_label,
 282                      enum nexthop_types_t gtype, union g_addr *gate,
 283                      ifindex_t ifindex);
 284
 285 /*
 286  * Uninstall a particular NHLFE in the forwarding table. If this is
 287  * the only NHLFE, the entire LSP forwarding entry has to be deleted.
 288  */
 289 int mpls_lsp_uninstall(struct zebra_vrf *zvrf, enum lsp_types_t type,
 290                        mpls_label_t in_label, enum nexthop_types_t gtype,
 291                        union g_addr *gate, ifindex_t ifindex);
 292
 293 /*
 294  * Uninstall all LDP NHLFEs for a particular LSP forwarding entry.
 295  * If no other NHLFEs exist, the entry would be deleted.
 296  */
 297 void mpls_ldp_lsp_uninstall_all(struct hash_bucket *bucket, void *ctxt);
 298
 299 /*
 300  * Uninstall all LDP FEC-To-NHLFE (FTN) bindings of the given address-family.
 301  */
 302 void mpls_ldp_ftn_uninstall_all(struct zebra_vrf *zvrf, int afi);
 303
 304 /*
 305  * Uninstall all Segment Routing NHLFEs for a particular LSP forwarding entry.
 306  * If no other NHLFEs exist, the entry would be deleted.
 307  */
 308 void mpls_sr_lsp_uninstall_all(struct hash_bucket *bucket, void *ctxt);
 309
 310 #if defined(HAVE_CUMULUS)
 311 /*
 312  * Check that the label values used in LSP creation are consistent. The
 313  * main criteria is that if there is ECMP, the label operation must still
 314  * be consistent - i.e., all paths either do a swap or do PHP. This is due
 315  * to current HW restrictions.
 316  */
 317 int zebra_mpls_lsp_label_consistent(struct zebra_vrf *zvrf,
 318                                     mpls_label_t in_label,
 319                                     mpls_label_t out_label,
 320                                     enum nexthop_types_t gtype,
 321                                     union g_addr *gate, ifindex_t ifindex);
 322 #endif /* HAVE_CUMULUS */
 323
 324 /*
 325  * Add static LSP entry. This may be the first entry for this incoming label
 326  * or an additional nexthop; an existing entry may also have outgoing label
 327  * changed.
 328  * Note: The label operation (swap or PHP) is common for the LSP entry (all
 329  * NHLFEs).
 330  */
 331 int zebra_mpls_static_lsp_add(struct zebra_vrf *zvrf, mpls_label_t in_label,
 332                               mpls_label_t out_label,
 333                               enum nexthop_types_t gtype, union g_addr *gate,
 334                               ifindex_t ifindex);
 335
 336 /*
 337  * Delete static LSP entry. This may be the delete of one particular
 338  * NHLFE for this incoming label or the delete of the entire entry (i.e.,
 339  * all NHLFEs).
 340  * NOTE: Delete of the only NHLFE will also end up deleting the entire
 341  * LSP configuration.
 342  */
 343 int zebra_mpls_static_lsp_del(struct zebra_vrf *zvrf, mpls_label_t in_label,
 344                               enum nexthop_types_t gtype, union g_addr *gate,
 345                               ifindex_t ifindex);
 346
 347 /*
 348  * Process LSP update results from zebra dataplane.
 349  */
 350 /* Forward ref of dplane update context type */
 351 struct zebra_dplane_ctx;
 352
 353 void zebra_mpls_lsp_dplane_result(struct zebra_dplane_ctx *ctx);
 354
 355 /*
 356  * Schedule all MPLS label forwarding entries for processing.
 357  * Called upon changes that may affect one or more of them such as
 358  * interface or nexthop state changes.
 359  */
 360 void zebra_mpls_lsp_schedule(struct zebra_vrf *zvrf);
 361
 362 /*
 363  * Display MPLS label forwarding table for a specific LSP
 364  * (VTY command handler).
 365  */
 366 void zebra_mpls_print_lsp(struct vty *vty, struct zebra_vrf *zvrf,
 367                           mpls_label_t label, bool use_json);
 368
 369 /*
 370  * Display MPLS label forwarding table (VTY command handler).
 371  */
 372 void zebra_mpls_print_lsp_table(struct vty *vty, struct zebra_vrf *zvrf,
 373                                 bool use_json);
 374
 375 /*
 376  * Display MPLS LSP configuration of all static LSPs (VTY command handler).
 377  */
 378 int zebra_mpls_write_lsp_config(struct vty *vty, struct zebra_vrf *zvrf);
 379
 380 /*
 381  * Called when VRF becomes inactive, cleans up information but keeps
 382  * the table itself.
 383  * NOTE: Currently supported only for default VRF.
 384  */
 385 void zebra_mpls_cleanup_tables(struct zebra_vrf *zvrf);
 386
 387 /*
 388  * Called upon process exiting, need to delete LSP forwarding
 389  * entries from the kernel.
 390  * NOTE: Currently supported only for default VRF.
 391  */
 392 void zebra_mpls_close_tables(struct zebra_vrf *zvrf);
 393
 394 /*
 395  * Allocate MPLS tables for this VRF.
 396  * NOTE: Currently supported only for default VRF.
 397  */
 398 void zebra_mpls_init_tables(struct zebra_vrf *zvrf);
 399
 400 /*
 401  * Global MPLS initialization.
 402  */
 403 void zebra_mpls_init(void);
 404
 405 /*
 406  * MPLS VTY.
 407  */
 408 void zebra_mpls_vty_init(void);
 409
 410 /* Inline functions. */
 411
 412 /*
 413  * Distance (priority) definition for LSP NHLFE.
 414  */
 415 static inline uint8_t lsp_distance(enum lsp_types_t type)
 416 {
 417         switch (type) {
 418         case ZEBRA_LSP_STATIC:
 419                 return (route_distance(ZEBRA_ROUTE_STATIC));
 420         case ZEBRA_LSP_LDP:
 421                 return (route_distance(ZEBRA_ROUTE_LDP));
 422         case ZEBRA_LSP_BGP:
 423                 return (route_distance(ZEBRA_ROUTE_BGP));
 424         case ZEBRA_LSP_NONE:
 425         case ZEBRA_LSP_SHARP:
 426         case ZEBRA_LSP_SR:
 427                 return 150;
 428         }
 429
 430         /*
 431          * For some reason certain compilers do not believe
 432          * that all the cases have been handled.  And
 433          * WTF does this work differently than when I removed
 434          * the default case????
 435          */
 436         return 150;
 437 }
 438
 439 /*
 440  * Map RIB type to LSP type. Used when labeled-routes from BGP
 441  * are converted into LSPs.
 442  */
 443 static inline enum lsp_types_t lsp_type_from_re_type(int re_type)
 444 {
 445         switch (re_type) {
 446         case ZEBRA_ROUTE_STATIC:
 447                 return ZEBRA_LSP_STATIC;
 448         case ZEBRA_ROUTE_BGP:
 449                 return ZEBRA_LSP_BGP;
 450         case ZEBRA_ROUTE_SHARP:
 451                 return ZEBRA_LSP_SHARP;
 452         default:
 453                 return ZEBRA_LSP_NONE;
 454         }
 455 }
 456
 457 /*
 458  * Map LSP type to RIB type.
 459  */
 460 static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type)
 461 {
 462         switch (lsp_type) {
 463         case ZEBRA_LSP_STATIC:
 464                 return ZEBRA_ROUTE_STATIC;
 465         case ZEBRA_LSP_LDP:
 466                 return ZEBRA_ROUTE_LDP;
 467         case ZEBRA_LSP_BGP:
 468                 return ZEBRA_ROUTE_BGP;
 469         case ZEBRA_LSP_SR:
 470                 return ZEBRA_ROUTE_OSPF;
 471         case ZEBRA_LSP_NONE:
 472                 return ZEBRA_ROUTE_KERNEL;
 473         case ZEBRA_LSP_SHARP:
 474                 return ZEBRA_ROUTE_SHARP;
 475         }
 476
 477         /*
 478          * For some reason certain compilers do not believe
 479          * that all the cases have been handled.  And
 480          * WTF does this work differently than when I removed
 481          * the default case????
 482          */
 483         return ZEBRA_ROUTE_KERNEL;
 484 }
 485
 486 /* NHLFE type as printable string. */
 487 static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type)
 488 {
 489         switch (lsp_type) {
 490         case ZEBRA_LSP_STATIC:
 491                 return "Static";
 492         case ZEBRA_LSP_LDP:
 493                 return "LDP";
 494         case ZEBRA_LSP_BGP:
 495                 return "BGP";
 496         case ZEBRA_LSP_SR:
 497                 return "SR";
 498         case ZEBRA_LSP_SHARP:
 499                 return "SHARP";
 500         case ZEBRA_LSP_NONE:
 501                 return "Unknown";
 502         }
 503
 504         /*
 505          * For some reason certain compilers do not believe
 506          * that all the cases have been handled.  And
 507          * WTF does this work differently than when I removed
 508          * the default case????
 509          */
 510         return "Unknown";
 511 }
 512
 513 static inline void mpls_mark_lsps_for_processing(struct zebra_vrf *zvrf,
 514                                                  struct prefix *p)
 515 {
 516         struct route_table *table;
 517         struct route_node *rn;
 518         rib_dest_t *dest;
 519
 520         if (!zvrf)
 521                 return;
 522
 523         table = zvrf->table[family2afi(p->family)][SAFI_UNICAST];
 524         if (!table)
 525                 return;
 526
 527         rn = route_node_match(table, p);
 528         if (!rn)
 529                 return;
 530
 531
 532         dest = rib_dest_from_rnode(rn);
 533         SET_FLAG(dest->flags, RIB_DEST_UPDATE_LSPS);
 534 }
 535
 536 static inline void mpls_unmark_lsps_for_processing(struct route_node *rn)
 537 {
 538         rib_dest_t *dest = rib_dest_from_rnode(rn);
 539
 540         UNSET_FLAG(dest->flags, RIB_DEST_UPDATE_LSPS);
 541 }
 542
 543 static inline int mpls_should_lsps_be_processed(struct route_node *rn)
 544 {
 545         rib_dest_t *dest = rib_dest_from_rnode(rn);
 546
 547         return !!CHECK_FLAG(dest->flags, RIB_DEST_UPDATE_LSPS);
 548 }
 549
 550 /* Global variables. */
 551 extern int mpls_enabled;
 552
 553 #ifdef __cplusplus
 554 }
 555 #endif
 556
 557 #endif /*_ZEBRA_MPLS_H */