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
  18  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
  19  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20  * 02111-1307, USA.
  21  */
  22
  23 #ifndef _ZEBRA_MPLS_H
  24 #define _ZEBRA_MPLS_H
  25
  26 #include "prefix.h"
  27 #include "table.h"
  28 #include "queue.h"
  29 #include "hash.h"
  30 #include "jhash.h"
  31 #include "nexthop.h"
  32 #include "vty.h"
  33 #include "memory.h"
  34 #include "mpls.h"
  35 #include "zebra/zserv.h"
  36 #include "zebra/zebra_vrf.h"
  37
  38
  39 /* Definitions and macros. */
  40
  41 #define MPLS_MAX_LABELS 2  /* Maximum # labels that can be pushed. */
  42
  43 #define NHLFE_FAMILY(nhlfe)                        \
  44   (((nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6 || \
  45     (nhlfe)->nexthop->type == NEXTHOP_TYPE_IPV6_IFINDEX) ? AF_INET6 : AF_INET)
  46
  47
  48 /* Typedefs */
  49
  50 typedef struct zebra_ile_t_ zebra_ile_t;
  51 typedef struct zebra_snhlfe_t_ zebra_snhlfe_t;
  52 typedef struct zebra_slsp_t_ zebra_slsp_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 /*
  58  * (Outgoing) nexthop label forwarding entry configuration
  59  */
  60 struct zebra_snhlfe_t_
  61 {
  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 {
  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 {
 111   mpls_label_t in_label;
 112 };
 113
 114 /*
 115  * Label swap entry static configuration.
 116  */
 117 struct zebra_slsp_t_
 118 {
 119   /* Incoming label */
 120   zebra_ile_t ile;
 121
 122   /* List of outgoing nexthop static configuration */
 123   zebra_snhlfe_t *snhlfe_list;
 124
 125 };
 126
 127 /*
 128  * Label swap entry (ile -> list of nhlfes)
 129  */
 130 struct zebra_lsp_t_
 131 {
 132   /* Incoming label */
 133   zebra_ile_t ile;
 134
 135   /* List of NHLFE, pointer to best and num equal-cost. */
 136   zebra_nhlfe_t *nhlfe_list;
 137   zebra_nhlfe_t *best_nhlfe;
 138   u_int32_t num_ecmp;
 139
 140   /* Flags */
 141   u_int32_t flags;
 142 #define LSP_FLAG_SCHEDULED        (1 << 0)
 143 #define LSP_FLAG_INSTALLED        (1 << 1)
 144 #define LSP_FLAG_CHANGED          (1 << 2)
 145
 146   /* Address-family of NHLFE - saved here for delete. All NHLFEs */
 147   /* have to be of the same AF */
 148   u_char addr_family;
 149 };
 150
 151 /*
 152  * FEC to label binding.
 153  */
 154 struct zebra_fec_t_
 155 {
 156   /* FEC (prefix) */
 157   struct route_node *rn;
 158
 159   /* In-label - either statically bound or derived from label block. */
 160   mpls_label_t label;
 161
 162   /* Flags. */
 163   u_int32_t flags;
 164 #define FEC_FLAG_CONFIGURED       (1 << 0)
 165
 166   /* Clients interested in this FEC. */
 167   struct list *client_list;
 168 };
 169
 170 /* Function declarations. */
 171
 172 /*
 173  * String to label conversion, labels separated by '/'.
 174  */
 175 int
 176 mpls_str2label (const char *label_str, u_int8_t *num_labels,
 177                 mpls_label_t *labels);
 178
 179 /*
 180  * Label to string conversion, labels in string separated by '/'.
 181  */
 182 char *
 183 mpls_label2str (u_int8_t num_labels, mpls_label_t *labels,
 184                 char *buf, int len);
 185
 186 /*
 187  * Registration from a client for the label binding for a FEC. If a binding
 188  * already exists, it is informed to the client.
 189  */
 190 int
 191 zebra_mpls_fec_register (struct zebra_vrf *zvrf, struct prefix *p,
 192                          struct zserv *client);
 193
 194 /*
 195  * Deregistration from a client for the label binding for a FEC. The FEC
 196  * itself is deleted if no other registered clients exist and there is no
 197  * label bound to the FEC.
 198  */
 199 int
 200 zebra_mpls_fec_unregister (struct zebra_vrf *zvrf, struct prefix *p,
 201                            struct zserv *client);
 202
 203 /*
 204  * Cleanup any FECs registered by this client.
 205  */
 206 int
 207 zebra_mpls_cleanup_fecs_for_client (struct zebra_vrf *zvrf, struct zserv *client);
 208
 209 /*
 210  * Return FEC (if any) to which this label is bound.
 211  * Note: Only works for per-prefix binding and when the label is not
 212  * implicit-null.
 213  * TODO: Currently walks entire table, can optimize later with another
 214  * hash..
 215  */
 216 zebra_fec_t *
 217 zebra_mpls_fec_for_label (struct zebra_vrf *zvrf, mpls_label_t label);
 218
 219 /*
 220  * Inform if specified label is currently bound to a FEC or not.
 221  */
 222 int
 223 zebra_mpls_label_already_bound (struct zebra_vrf *zvrf, mpls_label_t label);
 224
 225 /*
 226  * Add static FEC to label binding. If there are clients registered for this
 227  * FEC, notify them.
 228  */
 229 int
 230 zebra_mpls_static_fec_add (struct zebra_vrf *zvrf, struct prefix *p,
 231                            mpls_label_t in_label);
 232
 233 /*
 234  * Remove static FEC to label binding. If there are no clients registered
 235  * for this FEC, delete the FEC; else notify clients.
 236  */
 237 int
 238 zebra_mpls_static_fec_del (struct zebra_vrf *zvrf, struct prefix *p);
 239
 240 /*
 241  * Display MPLS FEC to label binding configuration (VTY command handler).
 242  */
 243 int
 244 zebra_mpls_write_fec_config (struct vty *vty, struct zebra_vrf *zvrf);
 245
 246 /*
 247  * Display MPLS FEC to label binding (VTY command handler).
 248  */
 249 void
 250 zebra_mpls_print_fec_table (struct vty *vty, struct zebra_vrf *zvrf);
 251
 252 /*
 253  * Display MPLS FEC to label binding for a specific FEC (VTY command handler).
 254  */
 255 void
 256 zebra_mpls_print_fec (struct vty *vty, struct zebra_vrf *zvrf, struct prefix *p);
 257
 258 /*
 259  * Install/uninstall a FEC-To-NHLFE (FTN) binding.
 260  */
 261 int
 262 mpls_ftn_update (int add, struct zebra_vrf *zvrf, enum lsp_types_t type,
 263                  struct prefix *prefix, enum nexthop_types_t gtype,
 264                  union g_addr *gate, ifindex_t ifindex, u_int8_t distance,
 265                  mpls_label_t out_label);
 266
 267 /*
 268  * Install/update a NHLFE for an LSP in the forwarding table. This may be
 269  * a new LSP entry or a new NHLFE for an existing in-label or an update of
 270  * the out-label for an existing NHLFE (update case).
 271  */
 272 int
 273 mpls_lsp_install (struct zebra_vrf *zvrf, enum lsp_types_t type,
 274                   mpls_label_t in_label, mpls_label_t out_label,
 275                   enum nexthop_types_t gtype, union g_addr *gate,
 276                   char *ifname, ifindex_t ifindex);
 277
 278 /*
 279  * Uninstall a particular NHLFE in the forwarding table. If this is
 280  * the only NHLFE, the entire LSP forwarding entry has to be deleted.
 281  */
 282 int
 283 mpls_lsp_uninstall (struct zebra_vrf *zvrf, enum lsp_types_t type,
 284                     mpls_label_t in_label, enum nexthop_types_t gtype,
 285                     union g_addr *gate, char *ifname, ifindex_t ifindex);
 286
 287 /*
 288  * Uninstall all LDP NHLFEs for a particular LSP forwarding entry.
 289  * If no other NHLFEs exist, the entry would be deleted.
 290  */
 291 void
 292 mpls_ldp_lsp_uninstall_all (struct hash_backet *backet, void *ctxt);
 293
 294 /*
 295  * Uninstall all LDP FEC-To-NHLFE (FTN) bindings of the given address-family.
 296  */
 297 void
 298 mpls_ldp_ftn_uninstall_all (struct zebra_vrf *zvrf, int afi);
 299
 300 #if defined(HAVE_CUMULUS)
 301 /*
 302  * Check that the label values used in LSP creation are consistent. The
 303  * main criteria is that if there is ECMP, the label operation must still
 304  * be consistent - i.e., all paths either do a swap or do PHP. This is due
 305  * to current HW restrictions.
 306  */
 307 int
 308 zebra_mpls_lsp_label_consistent (struct zebra_vrf *zvrf, mpls_label_t in_label,
 309                      mpls_label_t out_label, enum nexthop_types_t gtype,
 310                      union g_addr *gate, char *ifname, ifindex_t ifindex);
 311 #endif /* HAVE_CUMULUS */
 312
 313 /*
 314  * Add static LSP entry. This may be the first entry for this incoming label
 315  * or an additional nexthop; an existing entry may also have outgoing label
 316  * changed.
 317  * Note: The label operation (swap or PHP) is common for the LSP entry (all
 318  * NHLFEs).
 319  */
 320 int
 321 zebra_mpls_static_lsp_add (struct zebra_vrf *zvrf, mpls_label_t in_label,
 322                      mpls_label_t out_label, enum nexthop_types_t gtype,
 323                      union g_addr *gate, char *ifname, ifindex_t ifindex);
 324
 325 /*
 326  * Delete static LSP entry. This may be the delete of one particular
 327  * NHLFE for this incoming label or the delete of the entire entry (i.e.,
 328  * all NHLFEs).
 329  * NOTE: Delete of the only NHLFE will also end up deleting the entire
 330  * LSP configuration.
 331  */
 332 int
 333 zebra_mpls_static_lsp_del (struct zebra_vrf *zvrf, mpls_label_t in_label,
 334                            enum nexthop_types_t gtype, union g_addr *gate,
 335                            char *ifname, ifindex_t ifindex);
 336
 337 /*
 338  * Schedule all MPLS label forwarding entries for processing.
 339  * Called upon changes that may affect one or more of them such as
 340  * interface or nexthop state changes.
 341  */
 342 void
 343 zebra_mpls_lsp_schedule (struct zebra_vrf *zvrf);
 344
 345 /*
 346  * Display MPLS label forwarding table for a specific LSP
 347  * (VTY command handler).
 348  */
 349 void
 350 zebra_mpls_print_lsp (struct vty *vty, struct zebra_vrf *zvrf, mpls_label_t label,
 351                       u_char use_json);
 352
 353 /*
 354  * Display MPLS label forwarding table (VTY command handler).
 355  */
 356 void
 357 zebra_mpls_print_lsp_table (struct vty *vty, struct zebra_vrf *zvrf,
 358                             u_char use_json);
 359
 360 /*
 361  * Display MPLS LSP configuration of all static LSPs (VTY command handler).
 362  */
 363 int
 364 zebra_mpls_write_lsp_config (struct vty *vty, struct zebra_vrf *zvrf);
 365
 366 /*
 367  * Called upon process exiting, need to delete LSP forwarding
 368  * entries from the kernel.
 369  * NOTE: Currently supported only for default VRF.
 370  */
 371 void
 372 zebra_mpls_close_tables (struct zebra_vrf *zvrf);
 373
 374 /*
 375  * Allocate MPLS tables for this VRF.
 376  * NOTE: Currently supported only for default VRF.
 377  */
 378 void
 379 zebra_mpls_init_tables (struct zebra_vrf *zvrf);
 380
 381 /*
 382  * Global MPLS initialization.
 383  */
 384 void
 385 zebra_mpls_init (void);
 386
 387 /*
 388  * MPLS VTY.
 389  */
 390 void
 391 zebra_mpls_vty_init (void);
 392
 393 /* Inline functions. */
 394
 395 /*
 396  * Distance (priority) definition for LSP NHLFE.
 397  */
 398 static inline u_char
 399 lsp_distance (enum lsp_types_t type)
 400 {
 401   if (type == ZEBRA_LSP_STATIC)
 402     return (route_distance (ZEBRA_ROUTE_STATIC));
 403
 404   return 150;
 405 }
 406
 407 /*
 408  * Map RIB type to LSP type. Used when labeled-routes from BGP
 409  * are converted into LSPs.
 410  */
 411 static inline enum lsp_types_t
 412 lsp_type_from_rib_type (int rib_type)
 413 {
 414   switch (rib_type)
 415     {
 416       case ZEBRA_ROUTE_STATIC:
 417         return ZEBRA_LSP_STATIC;
 418       default:
 419         return ZEBRA_LSP_NONE;
 420     }
 421 }
 422
 423 /* NHLFE type as printable string. */
 424 static inline const char *
 425 nhlfe_type2str(enum lsp_types_t lsp_type)
 426 {
 427   switch (lsp_type)
 428     {
 429       case ZEBRA_LSP_STATIC:
 430         return "Static";
 431       case ZEBRA_LSP_LDP:
 432         return "LDP";
 433       default:
 434         return "Unknown";
 435     }
 436 }
 437
 438 static inline void
 439 mpls_mark_lsps_for_processing(struct zebra_vrf *zvrf)
 440 {
 441   if (!zvrf)
 442     return;
 443
 444   zvrf->mpls_flags |= MPLS_FLAG_SCHEDULE_LSPS;
 445 }
 446
 447 static inline void
 448 mpls_unmark_lsps_for_processing(struct zebra_vrf *zvrf)
 449 {
 450   if (!zvrf)
 451     return;
 452
 453   zvrf->mpls_flags &= ~MPLS_FLAG_SCHEDULE_LSPS;
 454 }
 455
 456 static inline int
 457 mpls_should_lsps_be_processed(struct zebra_vrf *zvrf)
 458 {
 459   if (!zvrf)
 460     return 0;
 461
 462   return ((zvrf->mpls_flags & MPLS_FLAG_SCHEDULE_LSPS) ? 1 : 0);
 463 }
 464
 465 /* Global variables. */
 466 extern int mpls_enabled;
 467
 468 #endif /*_ZEBRA_MPLS_H */