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
  38 /* Definitions and macros. */
  39
  40 #define NHLFE_FAMILY(nhlfe)                                                    \
  41         (((nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6                          \
  42           || (nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX)              \
  43                  ? AF_INET6                                                    \
  44                  : AF_INET)
  45
  46 #define MPLS_LABEL_HELPSTR                                                     \
  47         "Specify label(s) for this route\nOne or more "                        \
  48         "labels in the range (16-1048575) separated by '/'\n"
  49
  50 /* Typedefs */
  51
  52 typedef struct zebra_ile_t_ zebra_ile_t;
  53 typedef struct zebra_snhlfe_t_ zebra_snhlfe_t;
  54 typedef struct zebra_slsp_t_ zebra_slsp_t;
  55 typedef struct zebra_nhlfe_t_ zebra_nhlfe_t;
  56 typedef struct zebra_lsp_t_ zebra_lsp_t;
  57 typedef struct zebra_fec_t_ zebra_fec_t;
  58
  59 /*
  60  * (Outgoing) nexthop label forwarding entry configuration
  61  */
  62 struct zebra_snhlfe_t_ {
  63         /* Nexthop information */
  64         enum nexthop_types_t gtype;
  65         union g_addr gate;
  66         char *ifname;
  67         ifindex_t ifindex;
  68
  69         /* Out label. */
  70         mpls_label_t out_label;
  71
  72         /* Backpointer to base entry. */
  73         zebra_slsp_t *slsp;
  74
  75         /* Pointers to more outgoing information for same in-label */
  76         zebra_snhlfe_t *next;
  77         zebra_snhlfe_t *prev;
  78 };
  79
  80 /*
  81  * (Outgoing) nexthop label forwarding entry
  82  */
  83 struct zebra_nhlfe_t_ {
  84         /* Type of entry - static etc. */
  85         enum lsp_types_t type;
  86
  87         /* Nexthop information (with outgoing label) */
  88         struct nexthop *nexthop;
  89
  90         /* Backpointer to base entry. */
  91         zebra_lsp_t *lsp;
  92
  93         /* Runtime info - flags, pointers etc. */
  94         u_int32_t flags;
  95 #define NHLFE_FLAG_CHANGED     (1 << 0)
  96 #define NHLFE_FLAG_SELECTED    (1 << 1)
  97 #define NHLFE_FLAG_MULTIPATH   (1 << 2)
  98 #define NHLFE_FLAG_DELETED     (1 << 3)
  99 #define NHLFE_FLAG_INSTALLED   (1 << 4)
 100
 101         zebra_nhlfe_t *next;
 102         zebra_nhlfe_t *prev;
 103         u_char distance;
 104 };
 105
 106 /*
 107  * Incoming label entry
 108  */
 109 struct zebra_ile_t_ {
 110         mpls_label_t in_label;
 111 };
 112
 113 /*
 114  * Label swap entry static configuration.
 115  */
 116 struct zebra_slsp_t_ {
 117         /* Incoming label */
 118         zebra_ile_t ile;
 119
 120         /* List of outgoing nexthop static configuration */
 121         zebra_snhlfe_t *snhlfe_list;
 122 };
 123
 124 /*
 125  * Label swap entry (ile -> list of nhlfes)
 126  */
 127 struct zebra_lsp_t_ {
 128         /* Incoming label */
 129         zebra_ile_t ile;
 130
 131         /* List of NHLFE, pointer to best and num equal-cost. */
 132         zebra_nhlfe_t *nhlfe_list;
 133         zebra_nhlfe_t *best_nhlfe;
 134         u_int32_t num_ecmp;
 135
 136         /* Flags */
 137         u_int32_t flags;
 138 #define LSP_FLAG_SCHEDULED        (1 << 0)
 139 #define LSP_FLAG_INSTALLED        (1 << 1)
 140 #define LSP_FLAG_CHANGED          (1 << 2)
 141
 142         /* Address-family of NHLFE - saved here for delete. All NHLFEs */
 143         /* have to be of the same AF */
 144         u_char addr_family;
 145 };
 146
 147 /*
 148  * FEC to label binding.
 149  */
 150 struct zebra_fec_t_ {
 151         /* FEC (prefix) */
 152         struct route_node *rn;
 153
 154         /* In-label - either statically bound or derived from label block. */
 155         mpls_label_t label;
 156
 157         /* Label index (into global label block), if valid */
 158         u_int32_t label_index;
 159
 160         /* Flags. */
 161         u_int32_t flags;
 162 #define FEC_FLAG_CONFIGURED       (1 << 0)
 163
 164         /* Clients interested in this FEC. */
 165         struct list *client_list;
 166 };
 167
 168 /* Function declarations. */
 169
 170 /*
 171  * String to label conversion, labels separated by '/'.
 172  */
 173 int mpls_str2label(const char *label_str, u_int8_t *num_labels,
 174                    mpls_label_t *labels);
 175
 176 /*
 177  * Label to string conversion, labels in string separated by '/'.
 178  */
 179 char *mpls_label2str(u_int8_t num_labels, mpls_label_t *labels, char *buf,
 180                      int len, int pretty);
 181
 182 /*
 183  * Add/update global label block.
 184  */
 185 int zebra_mpls_label_block_add(struct zebra_vrf *zvrf, u_int32_t start_label,
 186                                u_int32_t end_label);
 187
 188 /*
 189  * Delete global label block.
 190  */
 191 int zebra_mpls_label_block_del(struct zebra_vrf *vrf);
 192
 193 /*
 194  * Display MPLS global label block configuration (VTY command handler).
 195  */
 196 int zebra_mpls_write_label_block_config(struct vty *vty, struct zebra_vrf *vrf);
 197
 198 /*
 199  * Install dynamic LSP entry.
 200  */
 201 int zebra_mpls_lsp_install(struct zebra_vrf *zvrf, struct route_node *rn,
 202                            struct route_entry *re);
 203
 204 /*
 205  * Uninstall dynamic LSP entry, if any.
 206  */
 207 int zebra_mpls_lsp_uninstall(struct zebra_vrf *zvrf, struct route_node *rn,
 208                              struct route_entry *re);
 209
 210 /*
 211  * Registration from a client for the label binding for a FEC. If a binding
 212  * already exists, it is informed to the client.
 213  * NOTE: If there is a manually configured label binding, that is used.
 214  * Otherwise, if aa label index is specified, it means we have to allocate the
 215  * label from a locally configured label block (SRGB), if one exists and index
 216  * is acceptable.
 217  */
 218 int zebra_mpls_fec_register(struct zebra_vrf *zvrf, struct prefix *p,
 219                             u_int32_t label_index, struct zserv *client);
 220
 221 /*
 222  * Deregistration from a client for the label binding for a FEC. The FEC
 223  * itself is deleted if no other registered clients exist and there is no
 224  * label bound to the FEC.
 225  */
 226 int zebra_mpls_fec_unregister(struct zebra_vrf *zvrf, struct prefix *p,
 227                               struct zserv *client);
 228
 229 /*
 230  * Cleanup any FECs registered by this client.
 231  */
 232 int zebra_mpls_cleanup_fecs_for_client(struct zebra_vrf *zvrf,
 233                                        struct zserv *client);
 234
 235 /*
 236  * Return FEC (if any) to which this label is bound.
 237  * Note: Only works for per-prefix binding and when the label is not
 238  * implicit-null.
 239  * TODO: Currently walks entire table, can optimize later with another
 240  * hash..
 241  */
 242 zebra_fec_t *zebra_mpls_fec_for_label(struct zebra_vrf *zvrf,
 243                                       mpls_label_t label);
 244
 245 /*
 246  * Inform if specified label is currently bound to a FEC or not.
 247  */
 248 int zebra_mpls_label_already_bound(struct zebra_vrf *zvrf, mpls_label_t label);
 249
 250 /*
 251  * Add static FEC to label binding. If there are clients registered for this
 252  * FEC, notify them. If there are labeled routes for this FEC, install the
 253  * label forwarding entry.
 254  */
 255 int zebra_mpls_static_fec_add(struct zebra_vrf *zvrf, struct prefix *p,
 256                               mpls_label_t in_label);
 257
 258 /*
 259  * Remove static FEC to label binding. If there are no clients registered
 260  * for this FEC, delete the FEC; else notify clients.
 261  * Note: Upon delete of static binding, if label index exists for this FEC,
 262  * client may need to be updated with derived label.
 263  */
 264 int zebra_mpls_static_fec_del(struct zebra_vrf *zvrf, struct prefix *p);
 265
 266 /*
 267  * Display MPLS FEC to label binding configuration (VTY command handler).
 268  */
 269 int zebra_mpls_write_fec_config(struct vty *vty, struct zebra_vrf *zvrf);
 270
 271 /*
 272  * Display MPLS FEC to label binding (VTY command handler).
 273  */
 274 void zebra_mpls_print_fec_table(struct vty *vty, struct zebra_vrf *zvrf);
 275
 276 /*
 277  * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
 278  */
 279 void zebra_mpls_print_fec(struct vty *vty, struct zebra_vrf *zvrf,
 280                           struct prefix *p);
 281
 282 /*
 283  * Install/uninstall a FEC-To-NHLFE (FTN) binding.
 284  */
 285 int mpls_ftn_update(int add, struct zebra_vrf *zvrf, enum lsp_types_t type,
 286                     struct prefix *prefix, enum nexthop_types_t gtype,
 287                     union g_addr *gate, ifindex_t ifindex, u_int8_t distance,
 288                     mpls_label_t out_label);
 289
 290 /*
 291  * Install/update a NHLFE for an LSP in the forwarding table. This may be
 292  * a new LSP entry or a new NHLFE for an existing in-label or an update of
 293  * the out-label for an existing NHLFE (update case).
 294  */
 295 int mpls_lsp_install(struct zebra_vrf *zvrf, enum lsp_types_t type,
 296                      mpls_label_t in_label, mpls_label_t out_label,
 297                      enum nexthop_types_t gtype, union g_addr *gate,
 298                      ifindex_t ifindex);
 299
 300 /*
 301  * Uninstall a particular NHLFE in the forwarding table. If this is
 302  * the only NHLFE, the entire LSP forwarding entry has to be deleted.
 303  */
 304 int mpls_lsp_uninstall(struct zebra_vrf *zvrf, enum lsp_types_t type,
 305                        mpls_label_t in_label, enum nexthop_types_t gtype,
 306                        union g_addr *gate, ifindex_t ifindex);
 307
 308 /*
 309  * Uninstall all LDP NHLFEs for a particular LSP forwarding entry.
 310  * If no other NHLFEs exist, the entry would be deleted.
 311  */
 312 void mpls_ldp_lsp_uninstall_all(struct hash_backet *backet, void *ctxt);
 313
 314 /*
 315  * Uninstall all LDP FEC-To-NHLFE (FTN) bindings of the given address-family.
 316  */
 317 void mpls_ldp_ftn_uninstall_all(struct zebra_vrf *zvrf, int afi);
 318
 319 /*
 320  * Uninstall all Segment Routing NHLFEs for a particular LSP forwarding entry.
 321  * If no other NHLFEs exist, the entry would be deleted.
 322  */
 323 void mpls_sr_lsp_uninstall_all(struct hash_backet *backet, void *ctxt);
 324
 325 #if defined(HAVE_CUMULUS)
 326 /*
 327  * Check that the label values used in LSP creation are consistent. The
 328  * main criteria is that if there is ECMP, the label operation must still
 329  * be consistent - i.e., all paths either do a swap or do PHP. This is due
 330  * to current HW restrictions.
 331  */
 332 int zebra_mpls_lsp_label_consistent(struct zebra_vrf *zvrf,
 333                                     mpls_label_t in_label,
 334                                     mpls_label_t out_label,
 335                                     enum nexthop_types_t gtype,
 336                                     union g_addr *gate, ifindex_t ifindex);
 337 #endif /* HAVE_CUMULUS */
 338
 339 /*
 340  * Add static LSP entry. This may be the first entry for this incoming label
 341  * or an additional nexthop; an existing entry may also have outgoing label
 342  * changed.
 343  * Note: The label operation (swap or PHP) is common for the LSP entry (all
 344  * NHLFEs).
 345  */
 346 int zebra_mpls_static_lsp_add(struct zebra_vrf *zvrf, mpls_label_t in_label,
 347                               mpls_label_t out_label,
 348                               enum nexthop_types_t gtype, union g_addr *gate,
 349                               ifindex_t ifindex);
 350
 351 /*
 352  * Delete static LSP entry. This may be the delete of one particular
 353  * NHLFE for this incoming label or the delete of the entire entry (i.e.,
 354  * all NHLFEs).
 355  * NOTE: Delete of the only NHLFE will also end up deleting the entire
 356  * LSP configuration.
 357  */
 358 int zebra_mpls_static_lsp_del(struct zebra_vrf *zvrf, mpls_label_t in_label,
 359                               enum nexthop_types_t gtype, union g_addr *gate,
 360                               ifindex_t ifindex);
 361
 362 /*
 363  * Schedule all MPLS label forwarding entries for processing.
 364  * Called upon changes that may affect one or more of them such as
 365  * interface or nexthop state changes.
 366  */
 367 void zebra_mpls_lsp_schedule(struct zebra_vrf *zvrf);
 368
 369 /*
 370  * Display MPLS label forwarding table for a specific LSP
 371  * (VTY command handler).
 372  */
 373 void zebra_mpls_print_lsp(struct vty *vty, struct zebra_vrf *zvrf,
 374                           mpls_label_t label, u_char use_json);
 375
 376 /*
 377  * Display MPLS label forwarding table (VTY command handler).
 378  */
 379 void zebra_mpls_print_lsp_table(struct vty *vty, struct zebra_vrf *zvrf,
 380                                 u_char use_json);
 381
 382 /*
 383  * Display MPLS LSP configuration of all static LSPs (VTY command handler).
 384  */
 385 int zebra_mpls_write_lsp_config(struct vty *vty, 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 u_char 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         default:
 425                 return 150;
 426         }
 427 }
 428
 429 /*
 430  * Map RIB type to LSP type. Used when labeled-routes from BGP
 431  * are converted into LSPs.
 432  */
 433 static inline enum lsp_types_t lsp_type_from_re_type(int re_type)
 434 {
 435         switch (re_type) {
 436         case ZEBRA_ROUTE_STATIC:
 437                 return ZEBRA_LSP_STATIC;
 438         case ZEBRA_ROUTE_BGP:
 439                 return ZEBRA_LSP_BGP;
 440         default:
 441                 return ZEBRA_LSP_NONE;
 442         }
 443 }
 444
 445 /*
 446  * Map LSP type to RIB type.
 447  */
 448 static inline int re_type_from_lsp_type(enum lsp_types_t lsp_type)
 449 {
 450         switch (lsp_type) {
 451         case ZEBRA_LSP_STATIC:
 452                 return ZEBRA_ROUTE_STATIC;
 453         case ZEBRA_LSP_LDP:
 454                 return ZEBRA_ROUTE_LDP;
 455         case ZEBRA_LSP_BGP:
 456                 return ZEBRA_ROUTE_BGP;
 457         case ZEBRA_LSP_SR:
 458                 return ZEBRA_ROUTE_OSPF;
 459         case ZEBRA_LSP_NONE:
 460         default:
 461                 return ZEBRA_ROUTE_KERNEL;
 462         }
 463 }
 464
 465 /* NHLFE type as printable string. */
 466 static inline const char *nhlfe_type2str(enum lsp_types_t lsp_type)
 467 {
 468         switch (lsp_type) {
 469         case ZEBRA_LSP_STATIC:
 470                 return "Static";
 471         case ZEBRA_LSP_LDP:
 472                 return "LDP";
 473         case ZEBRA_LSP_BGP:
 474                 return "BGP";
 475         case ZEBRA_LSP_SR:
 476                 return "SR";
 477         default:
 478                 return "Unknown";
 479         }
 480 }
 481
 482 static inline void mpls_mark_lsps_for_processing(struct zebra_vrf *zvrf)
 483 {
 484         if (!zvrf)
 485                 return;
 486
 487         zvrf->mpls_flags |= MPLS_FLAG_SCHEDULE_LSPS;
 488 }
 489
 490 static inline void mpls_unmark_lsps_for_processing(struct zebra_vrf *zvrf)
 491 {
 492         if (!zvrf)
 493                 return;
 494
 495         zvrf->mpls_flags &= ~MPLS_FLAG_SCHEDULE_LSPS;
 496 }
 497
 498 static inline int mpls_should_lsps_be_processed(struct zebra_vrf *zvrf)
 499 {
 500         if (!zvrf)
 501                 return 0;
 502
 503         return ((zvrf->mpls_flags & MPLS_FLAG_SCHEDULE_LSPS) ? 1 : 0);
 504 }
 505
 506 /* Global variables. */
 507 extern int mpls_enabled;
 508
 509 #endif /*_ZEBRA_MPLS_H */