ospfd/ospf_te.h

   1 /*
   2  * This is an implementation of RFC3630, RFC5392 & RFC6827
   3  * Copyright (C) 2001 KDD R&D Laboratories, Inc.
   4  * http://www.kddlabs.co.jp/
   5  *
   6  * Copyright (C) 2012 Orange Labs
   7  * http://www.orange.com
   8  *
   9  * This file is part of GNU Zebra.
  10  *
  11  * GNU Zebra is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License as published by the
  13  * Free Software Foundation; either version 2, or (at your option) any
  14  * later version.
  15  *
  16  * GNU Zebra is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; see the file COPYING; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24  */
  25
  26 /* Add support of RFC7471 */
  27 /* Add support of RFC5392 */
  28 /* Add support of RFC6827 (partial) */
  29
  30 #ifndef _ZEBRA_OSPF_MPLS_TE_H
  31 #define _ZEBRA_OSPF_MPLS_TE_H
  32
  33 /*
  34  * Opaque LSA's link state ID for Traffic Engineering is
  35  * structured as follows.
  36  *
  37  *        24       16        8        0
  38  * +--------+--------+--------+--------+
  39  * |    1   |  MBZ   |........|........|
  40  * +--------+--------+--------+--------+
  41  * |<-Type->|<Resv'd>|<-- Instance --->|
  42  *
  43  *
  44  * Type:      IANA has assigned '1' for Traffic Engineering.
  45  * MBZ:       Reserved, must be set to zero.
  46  * Instance:  User may select an arbitrary 16-bit value.
  47  *
  48  */
  49
  50 #define MAX_LEGAL_TE_INSTANCE_NUM (0xffff)
  51 #define LEGAL_TE_INSTANCE_RANGE(i)  (0 <= (i) && (i) <= 0xffff)
  52
  53 /*
  54  *        24       16        8        0
  55  * +--------+--------+--------+--------+ ---
  56  * |   LS age        |Options |   10   |  A
  57  * +--------+--------+--------+--------+  |
  58  * |    1   |   0    |    Instance     |  |
  59  * +--------+--------+--------+--------+  |
  60  * |        Advertising router         |  |  Standard (Opaque) LSA header;
  61  * +--------+--------+--------+--------+  |  Only type-10 is used.
  62  * |        LS sequence number         |  |
  63  * +--------+--------+--------+--------+  |
  64  * |   LS checksum   |     Length      |  V
  65  * +--------+--------+--------+--------+ ---
  66  * |      Type       |     Length      |  A
  67  * +--------+--------+--------+--------+  |  TLV part for TE; Values might be
  68  * |              Values ...           |  V  structured as a set of sub-TLVs.
  69  * +--------+--------+--------+--------+ ---
  70  */
  71
  72 /* Following define the type of TE link regarding the various RFC */
  73 #define STD_TE          0x01
  74 #define GMPLS           0x02
  75 #define INTER_AS        0x04
  76 #define PSEUDO_TE       0x08
  77 #define FLOOD_AREA      0x10
  78 #define FLOOD_AS        0x20
  79 #define EMULATED        0x80
  80
  81 #define IS_STD_TE(x)        (x & STD_TE)
  82 #define IS_PSEUDO_TE(x)         (x & PSEUDO_TE)
  83 #define IS_INTER_AS(x)          (x & INTER_AS)
  84 #define IS_EMULATED(x)          (x & EMULATED)
  85 #define IS_FLOOD_AREA(x)        (x & FLOOD_AREA)
  86 #define IS_FLOOD_AS(x)          (x & FLOOD_AS)
  87 #define IS_INTER_AS_EMU(x)      (x & INTER_AS & EMULATED)
  88 #define IS_INTER_AS_AS(x)       (x & INTER_AS & FLOOD_AS)
  89
  90 /* Flags to manage TE Link LSA */
  91 #define LPFLG_LSA_INACTIVE              0x0
  92 #define LPFLG_LSA_ACTIVE                0x1
  93 #define LPFLG_LSA_ENGAGED               0x2
  94 #define LPFLG_LOOKUP_DONE               0x4
  95 #define LPFLG_LSA_FORCED_REFRESH        0x8
  96
  97 /*
  98  * Following section defines TLV body parts.
  99  */
 100
 101 /* Router Address TLV */ /* Mandatory */
 102 #define TE_TLV_ROUTER_ADDR              1
 103 struct te_tlv_router_addr {
 104         struct tlv_header header; /* Value length is 4 octets. */
 105         struct in_addr value;
 106 };
 107
 108 /* Link TLV */
 109 #define TE_TLV_LINK                     2
 110 struct te_tlv_link {
 111         struct tlv_header header;
 112         /* A set of link-sub-TLVs will follow. */
 113 };
 114
 115 /* Default TE TLV size */
 116 #define TE_LINK_SUBTLV_DEF_SIZE         4
 117
 118 /* Link Type Sub-TLV */ /* Mandatory */
 119 #define TE_LINK_SUBTLV_LINK_TYPE        1
 120 #define TE_LINK_SUBTLV_TYPE_SIZE        1
 121 struct te_link_subtlv_link_type {
 122         struct tlv_header header; /* Value length is 1 octet. */
 123         struct {
 124 #define LINK_TYPE_SUBTLV_VALUE_PTP      1
 125 #define LINK_TYPE_SUBTLV_VALUE_MA       2
 126                 uint8_t value;
 127                 uint8_t padding[3];
 128         } link_type;
 129 };
 130
 131 /* Link Sub-TLV: Link ID */ /* Mandatory */
 132 #define TE_LINK_SUBTLV_LINK_ID          2
 133 struct te_link_subtlv_link_id {
 134         struct tlv_header header; /* Value length is 4 octets. */
 135         struct in_addr value;     /* Same as router-lsa's link-id. */
 136 };
 137
 138 /* Link Sub-TLV: Local Interface IP Address */ /* Optional */
 139 #define TE_LINK_SUBTLV_LCLIF_IPADDR     3
 140 struct te_link_subtlv_lclif_ipaddr {
 141         struct tlv_header header; /* Value length is 4 x N octets. */
 142         struct in_addr value[1];  /* Local IP address(es). */
 143 };
 144
 145 /* Link Sub-TLV: Remote Interface IP Address */ /* Optional */
 146 #define TE_LINK_SUBTLV_RMTIF_IPADDR     4
 147 struct te_link_subtlv_rmtif_ipaddr {
 148         struct tlv_header header; /* Value length is 4 x N octets. */
 149         struct in_addr value[1];  /* Neighbor's IP address(es). */
 150 };
 151
 152 /* Link Sub-TLV: Traffic Engineering Metric */ /* Optional */
 153 #define TE_LINK_SUBTLV_TE_METRIC        5
 154 struct te_link_subtlv_te_metric {
 155         struct tlv_header header; /* Value length is 4 octets. */
 156         uint32_t value;           /* Link metric for TE purpose. */
 157 };
 158
 159 /* Link Sub-TLV: Maximum Bandwidth */ /* Optional */
 160 #define TE_LINK_SUBTLV_MAX_BW           6
 161 struct te_link_subtlv_max_bw {
 162         struct tlv_header header; /* Value length is 4 octets. */
 163         float value;              /* bytes/sec */
 164 };
 165
 166 /* Link Sub-TLV: Maximum Reservable Bandwidth */ /* Optional */
 167 #define TE_LINK_SUBTLV_MAX_RSV_BW       7
 168 struct te_link_subtlv_max_rsv_bw {
 169         struct tlv_header header; /* Value length is 4 octets. */
 170         float value;              /* bytes/sec */
 171 };
 172
 173 /* Link Sub-TLV: Unreserved Bandwidth */ /* Optional */
 174 #define TE_LINK_SUBTLV_UNRSV_BW         8
 175 #define TE_LINK_SUBTLV_UNRSV_SIZE       32
 176 struct te_link_subtlv_unrsv_bw {
 177         struct tlv_header header;    /* Value length is 32 octets. */
 178         float value[MAX_CLASS_TYPE]; /* One for each priority level. */
 179 };
 180
 181 /* Link Sub-TLV: Resource Class/Color */ /* Optional */
 182 #define TE_LINK_SUBTLV_RSC_CLSCLR       9
 183 struct te_link_subtlv_rsc_clsclr {
 184         struct tlv_header header; /* Value length is 4 octets. */
 185         uint32_t value;           /* Admin. group membership. */
 186 };
 187
 188 /* For RFC6827 */
 189 /* Local and Remote TE Router ID */
 190 #define TE_LINK_SUBTLV_LRRID            10
 191 #define TE_LINK_SUBTLV_LRRID_SIZE       8
 192 struct te_link_subtlv_lrrid {
 193         struct tlv_header header; /* Value length is 8 octets. */
 194         struct in_addr local;     /* Local TE Router Identifier */
 195         struct in_addr remote;    /* Remote TE Router Identifier */
 196 };
 197
 198 /* RFC4203: Link Local/Remote Identifiers */
 199 #define TE_LINK_SUBTLV_LLRI             11
 200 #define TE_LINK_SUBTLV_LLRI_SIZE        8
 201 struct te_link_subtlv_llri {
 202         struct tlv_header header; /* Value length is 8 octets. */
 203         uint32_t local;           /* Link Local Identifier */
 204         uint32_t remote;          /* Link Remote Identifier */
 205 };
 206
 207 /* Inter-RA Export Upward sub-TLV (12) and Inter-RA Export Downward sub-TLV (13)
 208  * (RFC6827bis) are not yet supported */
 209 /* SUBTLV 14-16 (RFC4203) are not yet supported */
 210 /* Bandwidth Constraints sub-TLV (17) (RFC4124) is not yet supported */
 211 /* SUBLV 18-20 are for OSPFv3 TE (RFC5329). see ospf6d */
 212
 213 /* For RFC 5392 */
 214 /* Remote AS Number sub-TLV */
 215 #define TE_LINK_SUBTLV_RAS              21
 216 struct te_link_subtlv_ras {
 217         struct tlv_header header; /* Value length is 4 octets. */
 218         uint32_t value;           /* Remote AS number */
 219 };
 220
 221 /* IPv4 Remote ASBR ID Sub-TLV */
 222 #define TE_LINK_SUBTLV_RIP              22
 223 struct te_link_subtlv_rip {
 224         struct tlv_header header; /* Value length is 4 octets. */
 225         struct in_addr value;     /* Remote ASBR IP address */
 226 };
 227
 228 /* SUBTLV 24 is IPv6 Remote ASBR ID (RFC5392). see ospf6d */
 229
 230 /* SUBTLV 23 (RFC5330) and 25 (RFC6001) are not yet supported */
 231
 232 /* SUBTLV 26 (RFC7308) is not yet supported */
 233
 234 /* RFC7471 */
 235 /* Link Sub-TLV: Average Link Delay */ /* Optional */
 236 #define TE_LINK_SUBTLV_AV_DELAY         27
 237 struct te_link_subtlv_av_delay {
 238         struct tlv_header header; /* Value length is 4 bytes. */
 239         /*
 240          * delay in micro-seconds only 24 bits => 0 ... 16777215
 241          * with Anomalous Bit as Upper most bit
 242          */
 243         uint32_t value;
 244 };
 245
 246 /* Link Sub-TLV: Low/High Link Delay */
 247 #define TE_LINK_SUBTLV_MM_DELAY         28
 248 #define TE_LINK_SUBTLV_MM_DELAY_SIZE    8
 249 struct te_link_subtlv_mm_delay {
 250         struct tlv_header header; /* Value length is 8 bytes. */
 251         /*
 252          * low delay in micro-seconds only 24 bits => 0 ... 16777215
 253          * with Anomalous Bit (A) as Upper most bit
 254          */
 255         uint32_t low;
 256         /* high delay in micro-seconds only 24 bits => 0 ... 16777215 */
 257         uint32_t high;
 258 };
 259
 260 /* Link Sub-TLV: Link Delay Variation i.e. Jitter */
 261 #define TE_LINK_SUBTLV_DELAY_VAR        29
 262 struct te_link_subtlv_delay_var {
 263         struct tlv_header header; /* Value length is 4 bytes. */
 264         /* interval in micro-seconds only 24 bits => 0 ... 16777215 */
 265         uint32_t value;
 266 };
 267
 268 /* Link Sub-TLV: Routine Unidirectional Link Packet Loss */
 269 #define TE_LINK_SUBTLV_PKT_LOSS         30
 270 struct te_link_subtlv_pkt_loss {
 271         struct tlv_header header; /* Value length is 4 bytes. */
 272         /*
 273          * in percentage of total traffic only 24 bits (2^24 - 2)
 274          * with Anomalous Bit as Upper most bit
 275          */
 276         uint32_t value;
 277 };
 278
 279 /* Link Sub-TLV: Unidirectional Residual Bandwidth */ /* Optional */
 280 #define TE_LINK_SUBTLV_RES_BW           31
 281 struct te_link_subtlv_res_bw {
 282         struct tlv_header header; /* Value length is 4 bytes. */
 283         /* bandwidth in IEEE floating point format with units in bytes/second */
 284         float value;
 285 };
 286
 287 /* Link Sub-TLV: Unidirectional Available Bandwidth */ /* Optional */
 288 #define TE_LINK_SUBTLV_AVA_BW           32
 289 struct te_link_subtlv_ava_bw {
 290         struct tlv_header header; /* Value length is 4 octets. */
 291         /* bandwidth in IEEE floating point format with units in bytes/second */
 292         float value;
 293 };
 294
 295 /* Link Sub-TLV: Unidirectional Utilized Bandwidth */ /* Optional */
 296 #define TE_LINK_SUBTLV_USE_BW           33
 297 struct te_link_subtlv_use_bw {
 298         struct tlv_header header; /* Value length is 4 octets. */
 299         /* bandwidth in IEEE floating point format with units in bytes/second */
 300         float value;
 301 };
 302
 303 #define TE_LINK_SUBTLV_MAX              34      /* Last SUBTLV + 1 */
 304
 305 /* Here are "non-official" architectural constants. */
 306 #define MPLS_TE_MINIMUM_BANDWIDTH       1.0     /* Reasonable? *//* XXX */
 307
 308 /* Mode for Inter-AS Opaque-LSA */
 309 enum inter_as_mode { Off, AS, Area };
 310
 311 struct te_link_subtlv {
 312         struct tlv_header header;
 313         union {
 314                 uint32_t link_type;
 315                 struct in_addr link_id;
 316                 struct in_addr lclif;
 317                 struct in_addr rmtif;
 318                 uint32_t te_metric;
 319                 float max_bw;
 320                 float max_rsv_bw;
 321                 float unrsv[8];
 322                 uint32_t rsc_clsclr;
 323                 uint32_t llri[2];
 324                 uint32_t ras;
 325                 struct in_addr rip;
 326                 struct in_addr lrrid[2];
 327                 uint32_t av_delay;
 328                 uint32_t mm_delay;
 329                 uint32_t delay_var;
 330                 uint32_t pkt_loss;
 331                 float res_bw;
 332                 float ava_bw;
 333                 float use_bw;
 334         } value;
 335 };
 336
 337 /* Following structure are internal use only. */
 338 struct ospf_mpls_te {
 339         /* Status of MPLS-TE: enable or disbale */
 340         bool enabled;
 341
 342         /* RFC5392 */
 343         enum inter_as_mode inter_as;
 344         struct in_addr interas_areaid;
 345
 346         /* List elements are zebra-interfaces (ifp), not ospf-interfaces (oi).
 347          */
 348         struct list *iflist;
 349
 350         /* Store Router-TLV in network byte order. */
 351         struct te_tlv_router_addr router_addr;
 352 };
 353
 354 struct mpls_te_link {
 355         /*
 356          * According to MPLS-TE (draft) specification, 24-bit Opaque-ID field
 357          * is subdivided into 8-bit "unused" field and 16-bit "instance" field.
 358          * In this implementation, each Link-TLV has its own instance.
 359          */
 360         uint32_t instance;
 361
 362         /* Reference pointer to a Zebra-interface. */
 363         struct interface *ifp;
 364
 365         /* Area info in which this MPLS-TE link belongs to. */
 366         struct ospf_area *area;
 367
 368         /* Flags to manage this link parameters. */
 369         uint32_t flags;
 370
 371         /* Type of MPLS-TE link: RFC3630, RFC5392, RFC5392 emulated, RFC6827 */
 372         uint8_t type;
 373
 374         /* Store Link-TLV in network byte order. */
 375         /* RFC3630 & RFC6827 / RFC 6827 */
 376         struct te_tlv_link link_header;
 377         struct te_link_subtlv_link_type link_type;
 378         struct te_link_subtlv_link_id link_id;
 379         struct te_link_subtlv_lclif_ipaddr lclif_ipaddr;
 380         struct te_link_subtlv_rmtif_ipaddr rmtif_ipaddr;
 381         struct te_link_subtlv_te_metric te_metric;
 382         struct te_link_subtlv_max_bw max_bw;
 383         struct te_link_subtlv_max_rsv_bw max_rsv_bw;
 384         struct te_link_subtlv_unrsv_bw unrsv_bw;
 385         struct te_link_subtlv_rsc_clsclr rsc_clsclr;
 386         /* RFC4203 */
 387         struct te_link_subtlv_llri llri;
 388         /* RFC5392 */
 389         struct te_link_subtlv_ras ras;
 390         struct te_link_subtlv_rip rip;
 391         /* RFC6827 */
 392         struct te_link_subtlv_lrrid lrrid;
 393         /* RFC7471 */
 394         struct te_link_subtlv_av_delay av_delay;
 395         struct te_link_subtlv_mm_delay mm_delay;
 396         struct te_link_subtlv_delay_var delay_var;
 397         struct te_link_subtlv_pkt_loss pkt_loss;
 398         struct te_link_subtlv_res_bw res_bw;
 399         struct te_link_subtlv_ava_bw ava_bw;
 400         struct te_link_subtlv_use_bw use_bw;
 401
 402         struct in_addr adv_router;
 403         struct in_addr id;
 404 };
 405
 406 /* Prototypes. */
 407 extern int ospf_mpls_te_init(void);
 408 extern void ospf_mpls_te_term(void);
 409 extern void ospf_mpls_te_finish(void);
 410 extern struct ospf_mpls_te *get_ospf_mpls_te(void);
 411 extern void ospf_mpls_te_update_if(struct interface *);
 412 extern void ospf_mpls_te_lsa_schedule(struct mpls_te_link *, enum lsa_opcode);
 413 extern void set_linkparams_llri(struct mpls_te_link *, uint32_t, uint32_t);
 414 extern void set_linkparams_lrrid(struct mpls_te_link *, struct in_addr,
 415                                  struct in_addr);
 416
 417 #endif /* _ZEBRA_OSPF_MPLS_TE_H */