[mirror_frr.git] / eigrpd / eigrp_const.h

/*
 * EIGRP Definition of Constants.
 * Copyright (C) 2013-2016
 * Authors:
 *   Donnie Savage
 *   Jan Janovic
 *   Matej Perina
 *   Peter Orsag
 *   Peter Paluch
 *   Frantisek Gazo
 *   Tomas Hvorkovy
 *   Martin Kontsek
 *   Lukas Koribsky
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef _ZEBRA_EIGRP_CONST_H_
#define _ZEBRA_EIGRP_CONST_H_

#define FALSE 0

#define EIGRP_NEIGHBOR_DOWN           0
#define EIGRP_NEIGHBOR_PENDING        1
#define EIGRP_NEIGHBOR_UP             2
#define EIGRP_NEIGHBOR_STATE_MAX      3

/*Packet requiring ack will be retransmitted again after this time*/
#define EIGRP_PACKET_RETRANS_TIME        2 /* in seconds */
#define EIGRP_PACKET_RETRANS_MAX         16 /* number of retrans attempts */
#define PLAINTEXT_LENGTH                 81

/*Metric variance multiplier*/
#define EIGRP_VARIANCE_DEFAULT  1
#define EIGRP_MAX_PATHS_DEFAULT 4


/* Return values of functions involved in packet verification */
#define MSG_OK    0
#define MSG_NG    1

#define EIGRP_HEADER_VERSION            2

/* Default protocol, port number. */
#ifndef IPPROTO_EIGRPIGP
#define IPPROTO_EIGRPIGP         88
#endif /* IPPROTO_EIGRPIGP */

#define EIGRP_AUTH_MD5_TLV_SIZE          40
#define EIGRP_AUTH_SHA256_TLV_SIZE          56

/*Cisco routers use only first 44 bytes of basic hello for their MD5 calculations*/
#define EIGRP_MD5_BASIC_COMPUTE       44
#define EIGRP_MD5_UPDATE_INIT_COMPUTE       40


#define EIGRP_AUTH_BASIC_HELLO_FLAG       0x01
#define EIGRP_AUTH_TID_HELLO_FLAG       0x02
#define EIGRP_AUTH_UPDATE_INIT_FLAG       0x04
#define EIGRP_AUTH_UPDATE_FLAG            0x08
#define EIGRP_AUTH_EXTRA_SALT_FLAG        0x10

#define EIGRP_NEXT_SEQUENCE_TLV_SIZE     8

/* IP TTL for EIGRP protocol. */
#define EIGRP_IP_TTL             1

/* VTY port number. */
#define EIGRP_VTY_PORT          2609

/* Default configuration file name for eigrp. */
#define EIGRP_DEFAULT_CONFIG   "eigrpd.conf"

#define EIGRP_HELLO_INTERVAL_DEFAULT        5
#define EIGRP_HOLD_INTERVAL_DEFAULT         15
#define EIGRP_BANDWIDTH_DEFAULT             10000000
#define EIGRP_DELAY_DEFAULT                 1000
#define EIGRP_RELIABILITY_DEFAULT           255
#define EIGRP_LOAD_DEFAULT                  1

#define EIGRP_MULTICAST_ADDRESS            0xe000000A /*224.0.0.10*/

#define EIGRP_MAX_METRIC                   0xffffffffU    /*4294967295*/

#define DEFAULT_ROUTE               ZEBRA_ROUTE_MAX
#define DEFAULT_ROUTE_TYPE(T) ((T) == DEFAULT_ROUTE)

#define INTERFACE_DOWN_BY_ZEBRA       1
#define INTERFACE_DOWN_BY_VTY         2

#define EIGRP_HELLO_NORMAL                    0x00
#define EIGRP_HELLO_GRACEFUL_SHUTDOWN         0x01
#define EIGRP_HELLO_ADD_SEQUENCE              0x02
#define EIGRP_HELLO_GRACEFUL_SHUTDOWN_NBR     0x04

    /* EIGRP Network Type. */
 #define EIGRP_IFTYPE_NONE                0
 #define EIGRP_IFTYPE_POINTOPOINT         1
 #define EIGRP_IFTYPE_BROADCAST           2
 #define EIGRP_IFTYPE_NBMA                3
 #define EIGRP_IFTYPE_POINTOMULTIPOINT    4
 #define EIGRP_IFTYPE_LOOPBACK            5
 #define EIGRP_IFTYPE_MAX                 6

#define EIGRP_IF_ACTIVE                  0
#define EIGRP_IF_PASSIVE                 1

/* EIGRP TT destination type */
#define EIGRP_TOPOLOGY_TYPE_CONNECTED           0 // Connected network
#define EIGRP_TOPOLOGY_TYPE_REMOTE              1 // Remote internal network
#define EIGRP_TOPOLOGY_TYPE_REMOTE_EXTERNAL     2 // Remote external network

/*EIGRP TT entry flags*/
#define EIGRP_NEIGHBOR_ENTRY_SUCCESSOR_FLAG     1
#define EIGRP_NEIGHBOR_ENTRY_FSUCCESSOR_FLAG    2
#define EIGRP_NEIGHBOR_ENTRY_INTABLE_FLAG		4
#define EIGRP_NEIGHBOR_ENTRY_EXTERNAL_FLAG		8

/*EIGRP FSM state count, event count*/
#define EIGRP_FSM_STATE_MAX                  5
#define EIGRP_FSM_EVENT_MAX                  16

/*EGRP FSM states*/
#define EIGRP_FSM_STATE_PASSIVE              0
#define EIGRP_FSM_STATE_ACTIVE_0             1
#define EIGRP_FSM_STATE_ACTIVE_1             2
#define EIGRP_FSM_STATE_ACTIVE_2             3
#define EIGRP_FSM_STATE_ACTIVE_3             4

/*EIGRP FSM events return values*/
#define EIGRP_FSM_NEED_UPDATE				1
#define EIGRP_FSM_NEED_QUERY				2

/*EIGRP FSM events*/
#define EIGRP_FSM_EVENT_NQ_FCN                  0 /*input event other than query from succ, FC not satisfied*/
#define EIGRP_FSM_EVENT_LR                      1 /*last reply, FD is reset*/
#define EIGRP_FSM_EVENT_Q_FCN                   2 /*query from succ, FC not satisfied*/
#define EIGRP_FSM_EVENT_LR_FCS                  3 /*last reply, FC satisfied with current value of FDij*/
#define EIGRP_FSM_EVENT_DINC                    4 /*distance increase while in active state*/
#define EIGRP_FSM_EVENT_QACT                    5 /*query from succ while in active state*/
#define EIGRP_FSM_EVENT_LR_FCN                  6 /*last reply, FC not satisfied with current value of FDij*/
#define EIGRP_FSM_KEEP_STATE                    7 /*state not changed, usually by receiving not last reply */

#define INT_TYPES_CMD_STR						 \
	"detail|fastethernet|loopback|static"

#define INT_TYPES_DESC							\
	"Virtual Ethernet interface\n"				\
	"FastEthernet IEEE 802.3\n"					\
	"Loopback interface\n"						\
	"Show static peer information\n"

/**
 * External routes originate from some other protocol - these are them
 */
#define NULL_PROTID		0		/*!< unknown protocol */
#define IGRP_PROTID		1		/*!< IGRP.. whos your daddy! */
#define EIGRP_PROTID		2		/*!< EIGRP - Just flat out the best */
#define STATIC_PROTID		3		/*!< Staticly configured source */
#define RIP_PROTID		4		/*!< Routing Information Protocol */
#define HELLO_PROTID		5		/*!< Hello? RFC-891 you there? */
#define OSPF_PROTID		6		/*!< OSPF - Open Shortest Path First */
#define ISIS_PROTID		7		/*!< Intermediate System To Intermediate System */
#define EGP_PROTID		8		/*!< Exterior Gateway Protocol */
#define BGP_PROTID		9		/*!< Border Gateway Protocol */
#define IDRP_PROTID		10		/*!< InterDomain Routing Protocol */
#define CONN_PROTID		11		/*!< Connected source */

/* 
 * metric k-value defaults
 */
#define EIGRP_K1_DEFAULT	1		//!< unweighed inverse bandwidth
#define EIGRP_K2_DEFAULT	0		//!< no loading term
#define EIGRP_K3_DEFAULT	1		//!< unweighted delay
#define EIGRP_K4_DEFAULT	0		//!< no reliability term
#define EIGRP_K5_DEFAULT	0		//!< no reliability term
#define EIGRP_K6_DEFAULT	0		//!< do not add in extended metrics


/*
 * EIGRP Fixed header
 */
#define EIGRP_HEADER_LEN        20U
#define EIGRP_PACKET_MAX_LEN    65535U   /* includes IP Header size. */


#define EIGRP_TLV_HDR_LENGTH    4

/**
 * EIGRP Packet Opcodes
 */
#define EIGRP_OPC_UPDATE        1       /*!< packet containing routing information */
#define EIGRP_OPC_REQUEST       2       /*!< sent to request one or more routes */
#define EIGRP_OPC_QUERY         3       /*!< sent when a routing is in active start */
#define EIGRP_OPC_REPLY         4       /*!< sent in response to a query */
#define EIGRP_OPC_HELLO         5       /*!< sent to maintain a peering session */
#define EIGRP_OPC_IPXSAP        6       /*!< IPX SAP information */
#define EIGRP_OPC_PROBE         7       /*!< for test purposes   */
#define EIGRP_OPC_ACK           8       /*!< acknowledge         */
#define EIGRP_OPC_SIAQUERY      10      /*!< QUERY - with relaxed restrictions */
#define EIGRP_OPC_SIAREPLY      11      /*!< REPLY - may contain old routing information */

/**
 * EIGRP TLV Range definitions
 *      PDM             TLV Range
 *      General         0x0000
 *      IPv4            0x0100                  ** TLVs for one and all
 *      ATALK           0x0200                  ** legacy
 *      IPX             0x0300                  ** discontinued
 *      IPv6            0x0400                  ** legacy
 *      Multiprotocol   0x0600                  ** wide metrics
 *      MultiTopology   0x00f0                  ** deprecated
 */
#define EIGRP_TLV_RANGEMASK     0xfff0          /*!< should be 0xff00 - opps */
#define EIGRP_TLV_GENERAL       0x0000

/**
 * 1.2 TLV Definitions  ** legacy
 * These are considered legacyu and are only used for backward compability with
 * older Cisco Routers.  They should not be your first choice for packet codings
 */
#define EIGRP_TLV_IPv4          0x0100          /*!< Classic IPv4 TLV encoding */
#define EIGRP_TLV_ATALK         0x0200          /*!< Classic Appletalk TLV encoding*/
#define EIGRP_TLV_IPX           0x0300          /*!< Classic IPX TLV encoding */
#define EIGRP_TLV_IPv6          0x0400          /*!< Classic IPv6 TLV encoding */

/**
 * 2.0 Multi-Protocol TLV Definitions
 * These are the current packet formats and should be used for packets
 */
#define EIGRP_TLV_MP            0x0600          /*!< Non-PDM specific encoding */

/**
 * TLV type definitions.  Generic (protocol-independent) TLV types are
 * defined here.  Protocol-specific ones are defined elsewhere.
 */
#define EIGRP_TLV_PARAMETER             (EIGRP_TLV_GENERAL | 0x0001)    /*!< eigrp parameters */
#define EIGRP_TLV_PARAMETER_LEN         (12U)
#define EIGRP_TLV_AUTH                  (EIGRP_TLV_GENERAL | 0x0002)    /*!< authentication */
#define EIGRP_TLV_SEQ                   (EIGRP_TLV_GENERAL | 0x0003)    /*!< sequenced packet */
#define EIGRP_TLV_SEQ_BASE_LEN          (5U)
#define EIGRP_TLV_SW_VERSION            (EIGRP_TLV_GENERAL | 0x0004)    /*!< software version */
#define EIGRP_TLV_SW_VERSION_LEN        (8U)
#define EIGRP_TLV_NEXT_MCAST_SEQ        (EIGRP_TLV_GENERAL | 0x0005)    /*!< sequence number */
#define EIGRP_TLV_PEER_TERMINATION      (EIGRP_TLV_GENERAL | 0x0007)    /*!< peer termination */
#define EIGRP_TLV_PEER_TERMINATION_LEN 	(9U)
#define EIGRP_TLV_PEER_TIDLIST          (EIGRP_TLV_GENERAL | 0x0008)    /*!< peer sub-topology list */

/* Older cisco routers send TIDLIST value wrong, adding for backwards compatabily */
#define EIGRP_TLV_PEER_MTRLIST          (EIGRP_TLV_GENERAL | 0x00f5)

/**
 * Route Based TLVs
 */
#define EIGRP_TLV_REQUEST               0x0001
#define EIGRP_TLV_INTERNAL              0x0002
#define EIGRP_TLV_EXTERNAL              0x0003
#define EIGRP_TLV_COMMUNITY             0x0004
#define EIGRP_TLV_TYPEMASK              0x000f

#define EIGRP_TLV_IPv4_REQ              (EIGRP_TLV_IPv4 | EIGRP_TLV_REQUEST)
#define EIGRP_TLV_IPv4_INT              (EIGRP_TLV_IPv4 | EIGRP_TLV_INTERNAL)
#define EIGRP_TLV_IPv4_EXT              (EIGRP_TLV_IPv4 | EIGRP_TLV_EXTERNAL)
#define EIGRP_TLV_IPv4_COM              (EIGRP_TLV_IPv4 | EIGRP_TLV_COMMUNITY)

/* max number of TLV IPv4 prefixes in packet */
#define EIGRP_TLV_MAX_IPv4				25

/**
 *
 * extdata flag field definitions
 */
#define EIGRP_OPAQUE_EXT        0x01    /*!< Route is external */
#define EIGRP_OPAQUE_CD         0x02    /*!< Candidate default route */

/**
 * Address-Family types are taken from:
 *       http://www.iana.org/assignments/address-family-numbers
 * to provide a standards based exchange of AFI information between
 * EIGRP routers.
 */
#define EIGRP_AF_IPv4           1       /*!< IPv4 (IP version 4) */
#define EIGRP_AF_IPv6           2       /*!< IPv6 (IP version 6) */
#define EIGRP_AF_IPX            11      /*!< IPX */
#define EIGRP_AF_ATALK          12      /*!< Appletalk */
#define EIGRP_SF_COMMON         16384   /*!< Cisco Service Family */
#define EIGRP_SF_IPv4           16385   /*!< Cisco IPv4 Service Family */
#define EIGRP_SF_IPv6           16386   /*!< Cisco IPv6 Service Family */

/**
 * Authentication types supported by EIGRP
 */
#define EIGRP_AUTH_TYPE_NONE            0
#define EIGRP_AUTH_TYPE_TEXT            1
#define EIGRP_AUTH_TYPE_MD5             2
#define EIGRP_AUTH_TYPE_MD5_LEN         16
#define EIGRP_AUTH_TYPE_SHA256          3
#define EIGRP_AUTH_TYPE_SHA256_LEN      32

/**
 * opaque flag field definitions
 */
#define EIGRP_OPAQUE_SRCWD      0x01    /*!< Route Source Withdraw */
#define EIGRP_OPAQUE_ACTIVE     0x04    /*!< Route is currently in active state */
#define EIGRP_OPAQUE_REPL       0x08    /*!< Route is replicated from different tableid */

/**
 * pak flag bit field definitions - 0 (none)-7 source priority
 */
#define EIGRP_PRIV_DEFAULT      0x00    /* 0 (none)-7 source priority */
#define EIGRP_PRIV_LOW          0x01
#define EIGRP_PRIV_MEDIUM       0x04
#define EIGRP_PRIV_HIGH         0x07

/*
 * Init bit definition. First unicast transmitted Update has this
 * bit set in the flags field of the fixed header. It tells the neighbor
 * to down-load his topology table.
 */
#define EIGRP_INIT_FLAG 0x01

/*
 * CR bit (Conditionally Received) definition in flags field on header. Any
 * packets with the CR-bit set can be accepted by an EIGRP speaker if and
 * only if a previous Hello was received with the SEQUENCE_TYPE TLV present.
 *
 * This allows multicasts to be transmitted in order and reliably at the
 * same time as unicasts are transmitted.
 */
#define EIGRP_CR_FLAG 0x02

/*
 * RS bit.  The Restart flag is set in the hello and the init
 * update packets during the nsf signaling period.  A nsf-aware
 * router looks at the RS flag to detect if a peer is restarting
 * and maintain the adjacency. A restarting router looks at
 * this flag to determine if the peer is helping out with the restart.
 */
#define EIGRP_RS_FLAG 0x04

/*
 * EOT bit.  The End-of-Table flag marks the end of the start-up updates
 * sent to a new peer.  A nsf restarting router looks at this flag to
 * determine if it has finished receiving the start-up updates from all
 * peers.  A nsf-aware router waits for this flag before cleaning up
 * the stale routes from the restarting peer.
 */
#define EIGRP_EOT_FLAG 0x08

/**
 * EIGRP Virtual Router ID
 *
 * Define values to deal with EIGRP virtual router ids.  Virtual
 * router IDs are stored in the upper short of the EIGRP fixed packet
 * header.  The lower short of the packet header continues to be used
 * as asystem number.
 *
 * Virtual Router IDs are PDM-independent.  All PDMs will use
 * VRID_BASE to indicate the 'base' or 'legacy' EIGRP instance.
 * All PDMs need to initialize their vrid to VRID_BASE for compatibility
 * with legacy routers.
 * Once IPv6 supports 'MTR Multicast', it will use the same VRID as
 * IPv4.  No current plans to support VRIDs on IPX. :)
 * Initial usage of VRID is to signal usage of Multicast topology for
 * MTR.
 *
 * VRID_MCAST is a well known constant, other VRIDs will be determined
 * programmatic...
 *
 * With the addition of SAF the VRID space has been divided into two
 * segments 0x0000-0x7fff is for EIGRP and vNets, 0x8000-0xffff is
 * for saf and its associated vNets.
 */
#define EIGRP_VRID_MASK         0x8001
#define EIGRP_VRID_AF_BASE      0x0000
#define EIGRP_VRID_MCAST_BASE   0x0001
#define EIGRP_VRID_SF_BASE      0x8000

/* Extended Attributes for a destination */
#define EIGRP_ATTR_HDRLEN (2)
#define EIGRP_ATTR_MAXDATA (512)

#define EIGRP_ATTR_NOOP         0       /*!< No-Op used as offset padding */
#define EIGRP_ATTR_SCALED       1       /*!< Scaled metric values */
#define EIGRP_ATTR_TAG          2       /*!< Tag assigned by Admin for dest */
#define EIGRP_ATTR_COMM         3       /*!< Community attribute for dest */
#define EIGRP_ATTR_JITTER       4       /*!< Variation in path delay */
#define EIGRP_ATTR_QENERGY      5       /*!< Non-Active energy usage along path */
#define EIGRP_ATTR_ENERGY       6       /*!< Active energy usage along path */

/*
 * Begin EIGRP-BGP interoperability communities
 */
#define EIGRP_EXTCOMM_SOO_ASFMT         0x0003 /* Site-of-Origin, BGP AS format */
#define EIGRP_EXTCOMM_SOO_ADRFMT        0x0103 /* Site-of-Origin, BGP/EIGRP addr format */

/*
 * EIGRP Specific communities
 */
#define EIGRP_EXTCOMM_EIGRP             0x8800 /* EIGRP route information appended*/
#define EIGRP_EXTCOMM_DAD               0x8801 /* EIGRP AS + Delay           */
#define EIGRP_EXTCOMM_VRHB              0x8802 /* EIGRP Vector: Reliability + Hop + BW */
#define EIGRP_EXTCOMM_SRLM              0x8803 /* EIGRP System: Reserve +Load + MTU   */
#define EIGRP_EXTCOMM_SAR               0x8804 /* EIGRP System: Remote AS + Remote ID  */
#define EIGRP_EXTCOMM_RPM               0x8805 /* EIGRP Remote: Protocol + Metric    */
#define EIGRP_EXTCOMM_VRR               0x8806 /* EIGRP Vecmet: Rsvd + (internal) Routerid */


/*
 * EIGRP Filter constants
 */
#define EIGRP_FILTER_IN  0
#define EIGRP_FILTER_OUT 1
#define EIGRP_FILTER_MAX 2

/*
 * EIGRP Filter constants
 */
#define EIGRP_HSROLE_DEFAULT  	EIGRP_HSROLE_SPOKE
#define EIGRP_HSROLE_HUB 		0x01
#define EIGRP_HSROLE_SPOKE 		0x02

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