eigrpd/eigrp_const.h

   1 /*
   2  * EIGRP Definition of Constants.
   3  * Copyright (C) 2013-2016
   4  * Authors:
   5  *   Donnie Savage
   6  *   Jan Janovic
   7  *   Matej Perina
   8  *   Peter Orsag
   9  *   Peter Paluch
  10  *   Frantisek Gazo
  11  *   Tomas Hvorkovy
  12  *   Martin Kontsek
  13  *   Lukas Koribsky
  14  *
  15  * This file is part of GNU Zebra.
  16  *
  17  * GNU Zebra is free software; you can redistribute it and/or modify it
  18  * under the terms of the GNU General Public License as published by the
  19  * Free Software Foundation; either version 2, or (at your option) any
  20  * later version.
  21  *
  22  * GNU Zebra is distributed in the hope that it will be useful, but
  23  * WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  25  * General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License along
  28  * with this program; see the file COPYING; if not, write to the Free Software
  29  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  30  */
  31
  32 #ifndef _ZEBRA_EIGRP_CONST_H_
  33 #define _ZEBRA_EIGRP_CONST_H_
  34
  35 #define FALSE 0
  36
  37 #define EIGRP_NEIGHBOR_DOWN           0
  38 #define EIGRP_NEIGHBOR_PENDING        1
  39 #define EIGRP_NEIGHBOR_UP             2
  40 #define EIGRP_NEIGHBOR_STATE_MAX      3
  41
  42 /*Packet requiring ack will be retransmitted again after this time*/
  43 #define EIGRP_PACKET_RETRANS_TIME        2 /* in seconds */
  44 #define EIGRP_PACKET_RETRANS_MAX         16 /* number of retrans attempts */
  45 #define PLAINTEXT_LENGTH                 81
  46
  47 /*Metric variance multiplier*/
  48 #define EIGRP_VARIANCE_DEFAULT  1
  49 #define EIGRP_MAX_PATHS_DEFAULT 4
  50
  51 /* Return values of functions involved in packet verification */
  52 #define MSG_OK    0
  53 #define MSG_NG    1
  54
  55 #define EIGRP_HEADER_VERSION            2
  56
  57 /* Default protocol, port number. */
  58 #ifndef IPPROTO_EIGRPIGP
  59 #define IPPROTO_EIGRPIGP         88
  60 #endif /* IPPROTO_EIGRPIGP */
  61
  62 #define EIGRP_AUTH_MD5_TLV_SIZE          40
  63 #define EIGRP_AUTH_SHA256_TLV_SIZE          56
  64
  65 /*Cisco routers use only first 44 bytes of basic hello for their MD5
  66  * calculations*/
  67 #define EIGRP_MD5_BASIC_COMPUTE       44
  68 #define EIGRP_MD5_UPDATE_INIT_COMPUTE       40
  69
  70 #define EIGRP_AUTH_BASIC_HELLO_FLAG       0x01
  71 #define EIGRP_AUTH_TID_HELLO_FLAG       0x02
  72 #define EIGRP_AUTH_UPDATE_INIT_FLAG       0x04
  73 #define EIGRP_AUTH_UPDATE_FLAG            0x08
  74 #define EIGRP_AUTH_EXTRA_SALT_FLAG        0x10
  75
  76 #define EIGRP_NEXT_SEQUENCE_TLV_SIZE     8
  77
  78 /* IP TTL for EIGRP protocol. */
  79 #define EIGRP_IP_TTL             1
  80
  81 /* VTY port number. */
  82 #define EIGRP_VTY_PORT          2613
  83
  84 /* Default configuration file name for eigrp. */
  85 #define EIGRP_DEFAULT_CONFIG   "eigrpd.conf"
  86
  87 #define EIGRP_HELLO_INTERVAL_DEFAULT        5
  88 #define EIGRP_HOLD_INTERVAL_DEFAULT         15
  89 #define EIGRP_BANDWIDTH_DEFAULT             100000
  90 #define EIGRP_DELAY_DEFAULT                 10
  91 #define EIGRP_RELIABILITY_DEFAULT           255
  92 #define EIGRP_LOAD_DEFAULT                  1
  93
  94 #define EIGRP_MULTICAST_ADDRESS            0xe000000A /*224.0.0.10*/
  95
  96 #define EIGRP_MAX_METRIC                   0xffffffffU    /*4294967295*/
  97 enum metric_change { METRIC_DECREASE, METRIC_SAME, METRIC_INCREASE };
  98
  99 #define DEFAULT_ROUTE               ZEBRA_ROUTE_MAX
 100 #define DEFAULT_ROUTE_TYPE(T) ((T) == DEFAULT_ROUTE)
 101
 102 #define INTERFACE_DOWN_BY_ZEBRA       1
 103 #define INTERFACE_DOWN_BY_VTY         2
 104 #define INTERFACE_DOWN_BY_FINAL       3
 105
 106 #define EIGRP_HELLO_NORMAL                    0x00
 107 #define EIGRP_HELLO_GRACEFUL_SHUTDOWN         0x01
 108 #define EIGRP_HELLO_ADD_SEQUENCE              0x02
 109 #define EIGRP_HELLO_GRACEFUL_SHUTDOWN_NBR     0x04
 110
 111 /* EIGRP Network Type. */
 112 #define EIGRP_IFTYPE_NONE 0
 113 #define EIGRP_IFTYPE_POINTOPOINT 1
 114 #define EIGRP_IFTYPE_BROADCAST 2
 115 #define EIGRP_IFTYPE_NBMA 3
 116 #define EIGRP_IFTYPE_POINTOMULTIPOINT 4
 117 #define EIGRP_IFTYPE_LOOPBACK 5
 118 #define EIGRP_IFTYPE_MAX 6
 119
 120 #define EIGRP_IF_ACTIVE                  0
 121 #define EIGRP_IF_PASSIVE                 1
 122
 123 /* EIGRP TT destination type */
 124 #define EIGRP_TOPOLOGY_TYPE_CONNECTED           0 // Connected network
 125 #define EIGRP_TOPOLOGY_TYPE_REMOTE              1 // Remote internal network
 126 #define EIGRP_TOPOLOGY_TYPE_REMOTE_EXTERNAL     2 // Remote external network
 127
 128 /*EIGRP TT entry flags*/
 129 #define EIGRP_NEXTHOP_ENTRY_SUCCESSOR_FLAG     (1 << 0)
 130 #define EIGRP_NEXTHOP_ENTRY_FSUCCESSOR_FLAG    (1 << 1)
 131 #define EIGRP_NEXTHOP_ENTRY_INTABLE_FLAG       (1 << 2)
 132 #define EIGRP_NEXTHOP_ENTRY_EXTERNAL_FLAG      (1 << 3)
 133
 134 /*EIGRP FSM state count, event count*/
 135 #define EIGRP_FSM_STATE_MAX                  5
 136 #define EIGRP_FSM_EVENT_MAX                  16
 137
 138 /*EEGRP FSM states*/
 139 enum eigrp_fsm_states {
 140         EIGRP_FSM_STATE_PASSIVE,
 141         EIGRP_FSM_STATE_ACTIVE_0,
 142         EIGRP_FSM_STATE_ACTIVE_1,
 143         EIGRP_FSM_STATE_ACTIVE_2,
 144         EIGRP_FSM_STATE_ACTIVE_3,
 145 };
 146
 147 /*EIGRP FSM events return values*/
 148 #define EIGRP_FSM_NEED_UPDATE                           1
 149 #define EIGRP_FSM_NEED_QUERY                            2
 150
 151 /*EIGRP FSM events*/
 152 enum eigrp_fsm_events {
 153         /*
 154          * Input event other than query from succ,
 155          * FC is not satisfied
 156          */
 157         EIGRP_FSM_EVENT_NQ_FCN,
 158
 159         /* last reply, FD is reset */
 160         EIGRP_FSM_EVENT_LR,
 161
 162         /* Query from succ, FC not satisfied */
 163         EIGRP_FSM_EVENT_Q_FCN,
 164
 165         /* last reply, FC satisifed with current value of FDij */
 166         EIGRP_FSM_EVENT_LR_FCS,
 167
 168         /* distance increase while in a active state */
 169         EIGRP_FSM_EVENT_DINC,
 170
 171         /* Query from succ while in active state */
 172         EIGRP_FSM_EVENT_QACT,
 173
 174         /* last reply, FC not satisfied */
 175         EIGRP_FSM_EVENT_LR_FCN,
 176
 177         /*
 178          * state not changed
 179          * usually by receiving not last reply
 180          */
 181         EIGRP_FSM_KEEP_STATE,
 182 };
 183
 184 /**
 185  * External routes originate from some other protocol - these are them
 186  */
 187 #define NULL_PROTID             0               /*!< unknown protocol */
 188 #define IGRP_PROTID             1               /*!< IGRP.. whos your daddy! */
 189 #define EIGRP_PROTID            2               /*!< EIGRP - Just flat out the best */
 190 #define STATIC_PROTID           3               /*!< Staticly configured source */
 191 #define RIP_PROTID              4               /*!< Routing Information Protocol */
 192 #define HELLO_PROTID            5               /*!< Hello? RFC-891 you there? */
 193 #define OSPF_PROTID             6               /*!< OSPF - Open Shortest Path First */
 194 #define ISIS_PROTID             7               /*!< Intermediate System To Intermediate System */
 195 #define EGP_PROTID              8               /*!< Exterior Gateway Protocol */
 196 #define BGP_PROTID              9               /*!< Border Gateway Protocol */
 197 #define IDRP_PROTID             10              /*!< InterDomain Routing Protocol */
 198 #define CONN_PROTID             11              /*!< Connected source */
 199
 200 /*
 201  * metric k-value defaults
 202  */
 203 #define EIGRP_K1_DEFAULT        1               //!< unweighed inverse bandwidth
 204 #define EIGRP_K2_DEFAULT        0               //!< no loading term
 205 #define EIGRP_K3_DEFAULT        1               //!< unweighted delay
 206 #define EIGRP_K4_DEFAULT        0               //!< no reliability term
 207 #define EIGRP_K5_DEFAULT        0               //!< no reliability term
 208 #define EIGRP_K6_DEFAULT        0               //!< do not add in extended metrics
 209
 210 /*
 211  * EIGRP Fixed header
 212  */
 213 #define EIGRP_HEADER_LEN        20U
 214 #define EIGRP_PACKET_MAX_LEN    65535U   /* includes IP Header size. */
 215
 216 #define EIGRP_TLV_HDR_LENGTH    4
 217
 218 /**
 219  * EIGRP Packet Opcodes
 220  */
 221 #define EIGRP_OPC_UPDATE        1       /*!< packet containing routing information */
 222 #define EIGRP_OPC_REQUEST       2       /*!< sent to request one or more routes */
 223 #define EIGRP_OPC_QUERY         3       /*!< sent when a routing is in active start */
 224 #define EIGRP_OPC_REPLY         4       /*!< sent in response to a query */
 225 #define EIGRP_OPC_HELLO         5       /*!< sent to maintain a peering session */
 226 #define EIGRP_OPC_IPXSAP        6       /*!< IPX SAP information */
 227 #define EIGRP_OPC_PROBE         7       /*!< for test purposes   */
 228 #define EIGRP_OPC_ACK           8       /*!< acknowledge         */
 229 #define EIGRP_OPC_SIAQUERY      10      /*!< QUERY - with relaxed restrictions */
 230 #define EIGRP_OPC_SIAREPLY      11      /*!< REPLY - may contain old routing information */
 231
 232 /**
 233  * EIGRP TLV Range definitions
 234  *      PDM             TLV Range
 235  *      General         0x0000
 236  *      IPv4            0x0100                  ** TLVs for one and all
 237  *      ATALK           0x0200                  ** legacy
 238  *      IPX             0x0300                  ** discontinued
 239  *      IPv6            0x0400                  ** legacy
 240  *      Multiprotocol   0x0600                  ** wide metrics
 241  *      MultiTopology   0x00f0                  ** deprecated
 242  */
 243 #define EIGRP_TLV_RANGEMASK     0xfff0          /*!< should be 0xff00 - opps */
 244 #define EIGRP_TLV_GENERAL       0x0000
 245
 246 /**
 247  * 1.2 TLV Definitions  ** legacy
 248  * These are considered legacyu and are only used for backward compability with
 249  * older Cisco Routers.  They should not be your first choice for packet codings
 250  */
 251 #define EIGRP_TLV_IPv4          0x0100          /*!< Classic IPv4 TLV encoding */
 252 #define EIGRP_TLV_ATALK         0x0200          /*!< Classic Appletalk TLV encoding*/
 253 #define EIGRP_TLV_IPX           0x0300          /*!< Classic IPX TLV encoding */
 254 #define EIGRP_TLV_IPv6          0x0400          /*!< Classic IPv6 TLV encoding */
 255
 256 /**
 257  * 2.0 Multi-Protocol TLV Definitions
 258  * These are the current packet formats and should be used for packets
 259  */
 260 #define EIGRP_TLV_MP            0x0600          /*!< Non-PDM specific encoding */
 261
 262 /**
 263  * TLV type definitions.  Generic (protocol-independent) TLV types are
 264  * defined here.  Protocol-specific ones are defined elsewhere.
 265  */
 266 #define EIGRP_TLV_PARAMETER             (EIGRP_TLV_GENERAL | 0x0001)    /*!< eigrp parameters */
 267 #define EIGRP_TLV_PARAMETER_LEN         (12U)
 268 #define EIGRP_TLV_AUTH                  (EIGRP_TLV_GENERAL | 0x0002)    /*!< authentication */
 269 #define EIGRP_TLV_SEQ                   (EIGRP_TLV_GENERAL | 0x0003)    /*!< sequenced packet */
 270 #define EIGRP_TLV_SEQ_BASE_LEN          (5U)
 271 #define EIGRP_TLV_SW_VERSION            (EIGRP_TLV_GENERAL | 0x0004)    /*!< software version */
 272 #define EIGRP_TLV_SW_VERSION_LEN        (8U)
 273 #define EIGRP_TLV_NEXT_MCAST_SEQ        (EIGRP_TLV_GENERAL | 0x0005)    /*!< sequence number */
 274 #define EIGRP_TLV_PEER_TERMINATION      (EIGRP_TLV_GENERAL | 0x0007)    /*!< peer termination */
 275 #define EIGRP_TLV_PEER_TERMINATION_LEN  (9U)
 276 #define EIGRP_TLV_PEER_TIDLIST          (EIGRP_TLV_GENERAL | 0x0008)    /*!< peer sub-topology list */
 277
 278 /* Older cisco routers send TIDLIST value wrong, adding for backwards
 279  * compatabily */
 280 #define EIGRP_TLV_PEER_MTRLIST          (EIGRP_TLV_GENERAL | 0x00f5)
 281
 282 /**
 283  * Route Based TLVs
 284  */
 285 #define EIGRP_TLV_REQUEST               0x0001
 286 #define EIGRP_TLV_INTERNAL              0x0002
 287 #define EIGRP_TLV_EXTERNAL              0x0003
 288 #define EIGRP_TLV_COMMUNITY             0x0004
 289 #define EIGRP_TLV_TYPEMASK              0x000f
 290
 291 #define EIGRP_TLV_IPv4_REQ              (EIGRP_TLV_IPv4 | EIGRP_TLV_REQUEST)
 292 #define EIGRP_TLV_IPv4_INT              (EIGRP_TLV_IPv4 | EIGRP_TLV_INTERNAL)
 293 #define EIGRP_TLV_IPv4_EXT              (EIGRP_TLV_IPv4 | EIGRP_TLV_EXTERNAL)
 294 #define EIGRP_TLV_IPv4_COM              (EIGRP_TLV_IPv4 | EIGRP_TLV_COMMUNITY)
 295
 296 #define EIGRP_TLV_IPV4_SIZE_GRT_24_BIT      0x001D
 297 #define EIGRP_TLV_IPV4_SIZE_GRT_16_BIT      0x001C
 298 #define EIGRP_TLV_IPV4_SIZE_GRT_8_BIT       0x001B
 299 #define EIGRP_TLV_IPV4_SIZE_GRT_0_BIT       0x001A
 300 #define EIGRP_TLV_MAX_IPV4_BYTE             EIGRP_TLV_IPV4_SIZE_GRT_24_BIT
 301
 302 /* max number of TLV IPv4 prefixes in packet */
 303 #define EIGRP_TLV_MAX_IPv4                              25
 304
 305 /**
 306  *
 307  * extdata flag field definitions
 308  */
 309 #define EIGRP_OPAQUE_EXT        0x01    /*!< Route is external */
 310 #define EIGRP_OPAQUE_CD         0x02    /*!< Candidate default route */
 311
 312 /**
 313  * Address-Family types are taken from:
 314  *       http://www.iana.org/assignments/address-family-numbers
 315  * to provide a standards based exchange of AFI information between
 316  * EIGRP routers.
 317  */
 318 #define EIGRP_AF_IPv4           1       /*!< IPv4 (IP version 4) */
 319 #define EIGRP_AF_IPv6           2       /*!< IPv6 (IP version 6) */
 320 #define EIGRP_AF_IPX            11      /*!< IPX */
 321 #define EIGRP_AF_ATALK          12      /*!< Appletalk */
 322 #define EIGRP_SF_COMMON         16384   /*!< Cisco Service Family */
 323 #define EIGRP_SF_IPv4           16385   /*!< Cisco IPv4 Service Family */
 324 #define EIGRP_SF_IPv6           16386   /*!< Cisco IPv6 Service Family */
 325
 326 /**
 327  * Authentication types supported by EIGRP
 328  */
 329 #define EIGRP_AUTH_TYPE_NONE            0
 330 #define EIGRP_AUTH_TYPE_TEXT            1
 331 #define EIGRP_AUTH_TYPE_MD5             2
 332 #define EIGRP_AUTH_TYPE_MD5_LEN         16
 333 #define EIGRP_AUTH_TYPE_SHA256          3
 334 #define EIGRP_AUTH_TYPE_SHA256_LEN      32
 335
 336 /**
 337  * opaque flag field definitions
 338  */
 339 #define EIGRP_OPAQUE_SRCWD      0x01    /*!< Route Source Withdraw */
 340 #define EIGRP_OPAQUE_ACTIVE     0x04    /*!< Route is currently in active state */
 341 #define EIGRP_OPAQUE_REPL       0x08    /*!< Route is replicated from different tableid */
 342
 343 /**
 344  * pak flag bit field definitions - 0 (none)-7 source priority
 345  */
 346 #define EIGRP_PRIV_DEFAULT      0x00    /* 0 (none)-7 source priority */
 347 #define EIGRP_PRIV_LOW          0x01
 348 #define EIGRP_PRIV_MEDIUM       0x04
 349 #define EIGRP_PRIV_HIGH         0x07
 350
 351 /*
 352  * Init bit definition. First unicast transmitted Update has this
 353  * bit set in the flags field of the fixed header. It tells the neighbor
 354  * to down-load his topology table.
 355  */
 356 #define EIGRP_INIT_FLAG 0x01
 357
 358 /*
 359  * CR bit (Conditionally Received) definition in flags field on header. Any
 360  * packets with the CR-bit set can be accepted by an EIGRP speaker if and
 361  * only if a previous Hello was received with the SEQUENCE_TYPE TLV present.
 362  *
 363  * This allows multicasts to be transmitted in order and reliably at the
 364  * same time as unicasts are transmitted.
 365  */
 366 #define EIGRP_CR_FLAG 0x02
 367
 368 /*
 369  * RS bit.  The Restart flag is set in the hello and the init
 370  * update packets during the nsf signaling period.  A nsf-aware
 371  * router looks at the RS flag to detect if a peer is restarting
 372  * and maintain the adjacency. A restarting router looks at
 373  * this flag to determine if the peer is helping out with the restart.
 374  */
 375 #define EIGRP_RS_FLAG 0x04
 376
 377 /*
 378  * EOT bit.  The End-of-Table flag marks the end of the start-up updates
 379  * sent to a new peer.  A nsf restarting router looks at this flag to
 380  * determine if it has finished receiving the start-up updates from all
 381  * peers.  A nsf-aware router waits for this flag before cleaning up
 382  * the stale routes from the restarting peer.
 383  */
 384 #define EIGRP_EOT_FLAG 0x08
 385
 386 /**
 387  * EIGRP Virtual Router ID
 388  *
 389  * Define values to deal with EIGRP virtual router ids.  Virtual
 390  * router IDs are stored in the upper short of the EIGRP fixed packet
 391  * header.  The lower short of the packet header continues to be used
 392  * as asystem number.
 393  *
 394  * Virtual Router IDs are PDM-independent.  All PDMs will use
 395  * VRID_BASE to indicate the 'base' or 'legacy' EIGRP instance.
 396  * All PDMs need to initialize their vrid to VRID_BASE for compatibility
 397  * with legacy routers.
 398  * Once IPv6 supports 'MTR Multicast', it will use the same VRID as
 399  * IPv4.  No current plans to support VRIDs on IPX. :)
 400  * Initial usage of VRID is to signal usage of Multicast topology for
 401  * MTR.
 402  *
 403  * VRID_MCAST is a well known constant, other VRIDs will be determined
 404  * programmatic...
 405  *
 406  * With the addition of SAF the VRID space has been divided into two
 407  * segments 0x0000-0x7fff is for EIGRP and vNets, 0x8000-0xffff is
 408  * for saf and its associated vNets.
 409  */
 410 #define EIGRP_VRID_MASK         0x8001
 411 #define EIGRP_VRID_AF_BASE      0x0000
 412 #define EIGRP_VRID_MCAST_BASE   0x0001
 413 #define EIGRP_VRID_SF_BASE      0x8000
 414
 415 /* Extended Attributes for a destination */
 416 #define EIGRP_ATTR_HDRLEN (2)
 417 #define EIGRP_ATTR_MAXDATA (512)
 418
 419 #define EIGRP_ATTR_NOOP         0       /*!< No-Op used as offset padding */
 420 #define EIGRP_ATTR_SCALED       1       /*!< Scaled metric values */
 421 #define EIGRP_ATTR_TAG          2       /*!< Tag assigned by Admin for dest */
 422 #define EIGRP_ATTR_COMM         3       /*!< Community attribute for dest */
 423 #define EIGRP_ATTR_JITTER       4       /*!< Variation in path delay */
 424 #define EIGRP_ATTR_QENERGY      5       /*!< Non-Active energy usage along path */
 425 #define EIGRP_ATTR_ENERGY       6       /*!< Active energy usage along path */
 426
 427 /*
 428  * Begin EIGRP-BGP interoperability communities
 429  */
 430 #define EIGRP_EXTCOMM_SOO_ASFMT         0x0003 /* Site-of-Origin, BGP AS format */
 431 #define EIGRP_EXTCOMM_SOO_ADRFMT        0x0103 /* Site-of-Origin, BGP/EIGRP addr format */
 432
 433 /*
 434  * EIGRP Specific communities
 435  */
 436 #define EIGRP_EXTCOMM_EIGRP             0x8800 /* EIGRP route information appended*/
 437 #define EIGRP_EXTCOMM_DAD               0x8801 /* EIGRP AS + Delay           */
 438 #define EIGRP_EXTCOMM_VRHB              0x8802 /* EIGRP Vector: Reliability + Hop + BW */
 439 #define EIGRP_EXTCOMM_SRLM              0x8803 /* EIGRP System: Reserve +Load + MTU   */
 440 #define EIGRP_EXTCOMM_SAR               0x8804 /* EIGRP System: Remote AS + Remote ID  */
 441 #define EIGRP_EXTCOMM_RPM               0x8805 /* EIGRP Remote: Protocol + Metric    */
 442 #define EIGRP_EXTCOMM_VRR               0x8806 /* EIGRP Vecmet: Rsvd + (internal) Routerid */
 443
 444 /*
 445  * EIGRP Filter constants
 446  */
 447 #define EIGRP_FILTER_IN  0
 448 #define EIGRP_FILTER_OUT 1
 449 #define EIGRP_FILTER_MAX 2
 450
 451 /*
 452  * EIGRP Filter constants
 453  */
 454 #define EIGRP_HSROLE_DEFAULT    EIGRP_HSROLE_SPOKE
 455 #define EIGRP_HSROLE_HUB                0x01
 456 #define EIGRP_HSROLE_SPOKE              0x02
 457
 458 #endif /* _ZEBRA_EIGRP_CONST_H_ */