]> git.proxmox.com Git - mirror_frr.git/blob - eigrpd/eigrp_const.h
Merge pull request #805 from Orange-OpenSource/master
[mirror_frr.git] / 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
98 #define DEFAULT_ROUTE ZEBRA_ROUTE_MAX
99 #define DEFAULT_ROUTE_TYPE(T) ((T) == DEFAULT_ROUTE)
100
101 #define INTERFACE_DOWN_BY_ZEBRA 1
102 #define INTERFACE_DOWN_BY_VTY 2
103 #define INTERFACE_DOWN_BY_FINAL 3
104
105 #define EIGRP_HELLO_NORMAL 0x00
106 #define EIGRP_HELLO_GRACEFUL_SHUTDOWN 0x01
107 #define EIGRP_HELLO_ADD_SEQUENCE 0x02
108 #define EIGRP_HELLO_GRACEFUL_SHUTDOWN_NBR 0x04
109
110 /* EIGRP Network Type. */
111 #define EIGRP_IFTYPE_NONE 0
112 #define EIGRP_IFTYPE_POINTOPOINT 1
113 #define EIGRP_IFTYPE_BROADCAST 2
114 #define EIGRP_IFTYPE_NBMA 3
115 #define EIGRP_IFTYPE_POINTOMULTIPOINT 4
116 #define EIGRP_IFTYPE_LOOPBACK 5
117 #define EIGRP_IFTYPE_MAX 6
118
119 #define EIGRP_IF_ACTIVE 0
120 #define EIGRP_IF_PASSIVE 1
121
122 /* EIGRP TT destination type */
123 #define EIGRP_TOPOLOGY_TYPE_CONNECTED 0 // Connected network
124 #define EIGRP_TOPOLOGY_TYPE_REMOTE 1 // Remote internal network
125 #define EIGRP_TOPOLOGY_TYPE_REMOTE_EXTERNAL 2 // Remote external network
126
127 /*EIGRP TT entry flags*/
128 #define EIGRP_NEIGHBOR_ENTRY_SUCCESSOR_FLAG (1 << 0)
129 #define EIGRP_NEIGHBOR_ENTRY_FSUCCESSOR_FLAG (1 << 1)
130 #define EIGRP_NEIGHBOR_ENTRY_INTABLE_FLAG (1 << 2)
131 #define EIGRP_NEIGHBOR_ENTRY_EXTERNAL_FLAG (1 << 3)
132
133 /*EIGRP FSM state count, event count*/
134 #define EIGRP_FSM_STATE_MAX 5
135 #define EIGRP_FSM_EVENT_MAX 16
136
137 /*EEGRP FSM states*/
138 enum eigrp_fsm_states {
139 EIGRP_FSM_STATE_PASSIVE,
140 EIGRP_FSM_STATE_ACTIVE_0,
141 EIGRP_FSM_STATE_ACTIVE_1,
142 EIGRP_FSM_STATE_ACTIVE_2,
143 EIGRP_FSM_STATE_ACTIVE_3,
144 };
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 /**
161 * External routes originate from some other protocol - these are them
162 */
163 #define NULL_PROTID 0 /*!< unknown protocol */
164 #define IGRP_PROTID 1 /*!< IGRP.. whos your daddy! */
165 #define EIGRP_PROTID 2 /*!< EIGRP - Just flat out the best */
166 #define STATIC_PROTID 3 /*!< Staticly configured source */
167 #define RIP_PROTID 4 /*!< Routing Information Protocol */
168 #define HELLO_PROTID 5 /*!< Hello? RFC-891 you there? */
169 #define OSPF_PROTID 6 /*!< OSPF - Open Shortest Path First */
170 #define ISIS_PROTID 7 /*!< Intermediate System To Intermediate System */
171 #define EGP_PROTID 8 /*!< Exterior Gateway Protocol */
172 #define BGP_PROTID 9 /*!< Border Gateway Protocol */
173 #define IDRP_PROTID 10 /*!< InterDomain Routing Protocol */
174 #define CONN_PROTID 11 /*!< Connected source */
175
176 /*
177 * metric k-value defaults
178 */
179 #define EIGRP_K1_DEFAULT 1 //!< unweighed inverse bandwidth
180 #define EIGRP_K2_DEFAULT 0 //!< no loading term
181 #define EIGRP_K3_DEFAULT 1 //!< unweighted delay
182 #define EIGRP_K4_DEFAULT 0 //!< no reliability term
183 #define EIGRP_K5_DEFAULT 0 //!< no reliability term
184 #define EIGRP_K6_DEFAULT 0 //!< do not add in extended metrics
185
186 /*
187 * EIGRP Fixed header
188 */
189 #define EIGRP_HEADER_LEN 20U
190 #define EIGRP_PACKET_MAX_LEN 65535U /* includes IP Header size. */
191
192 #define EIGRP_TLV_HDR_LENGTH 4
193
194 /**
195 * EIGRP Packet Opcodes
196 */
197 #define EIGRP_OPC_UPDATE 1 /*!< packet containing routing information */
198 #define EIGRP_OPC_REQUEST 2 /*!< sent to request one or more routes */
199 #define EIGRP_OPC_QUERY 3 /*!< sent when a routing is in active start */
200 #define EIGRP_OPC_REPLY 4 /*!< sent in response to a query */
201 #define EIGRP_OPC_HELLO 5 /*!< sent to maintain a peering session */
202 #define EIGRP_OPC_IPXSAP 6 /*!< IPX SAP information */
203 #define EIGRP_OPC_PROBE 7 /*!< for test purposes */
204 #define EIGRP_OPC_ACK 8 /*!< acknowledge */
205 #define EIGRP_OPC_SIAQUERY 10 /*!< QUERY - with relaxed restrictions */
206 #define EIGRP_OPC_SIAREPLY 11 /*!< REPLY - may contain old routing information */
207
208 /**
209 * EIGRP TLV Range definitions
210 * PDM TLV Range
211 * General 0x0000
212 * IPv4 0x0100 ** TLVs for one and all
213 * ATALK 0x0200 ** legacy
214 * IPX 0x0300 ** discontinued
215 * IPv6 0x0400 ** legacy
216 * Multiprotocol 0x0600 ** wide metrics
217 * MultiTopology 0x00f0 ** deprecated
218 */
219 #define EIGRP_TLV_RANGEMASK 0xfff0 /*!< should be 0xff00 - opps */
220 #define EIGRP_TLV_GENERAL 0x0000
221
222 /**
223 * 1.2 TLV Definitions ** legacy
224 * These are considered legacyu and are only used for backward compability with
225 * older Cisco Routers. They should not be your first choice for packet codings
226 */
227 #define EIGRP_TLV_IPv4 0x0100 /*!< Classic IPv4 TLV encoding */
228 #define EIGRP_TLV_ATALK 0x0200 /*!< Classic Appletalk TLV encoding*/
229 #define EIGRP_TLV_IPX 0x0300 /*!< Classic IPX TLV encoding */
230 #define EIGRP_TLV_IPv6 0x0400 /*!< Classic IPv6 TLV encoding */
231
232 /**
233 * 2.0 Multi-Protocol TLV Definitions
234 * These are the current packet formats and should be used for packets
235 */
236 #define EIGRP_TLV_MP 0x0600 /*!< Non-PDM specific encoding */
237
238 /**
239 * TLV type definitions. Generic (protocol-independent) TLV types are
240 * defined here. Protocol-specific ones are defined elsewhere.
241 */
242 #define EIGRP_TLV_PARAMETER (EIGRP_TLV_GENERAL | 0x0001) /*!< eigrp parameters */
243 #define EIGRP_TLV_PARAMETER_LEN (12U)
244 #define EIGRP_TLV_AUTH (EIGRP_TLV_GENERAL | 0x0002) /*!< authentication */
245 #define EIGRP_TLV_SEQ (EIGRP_TLV_GENERAL | 0x0003) /*!< sequenced packet */
246 #define EIGRP_TLV_SEQ_BASE_LEN (5U)
247 #define EIGRP_TLV_SW_VERSION (EIGRP_TLV_GENERAL | 0x0004) /*!< software version */
248 #define EIGRP_TLV_SW_VERSION_LEN (8U)
249 #define EIGRP_TLV_NEXT_MCAST_SEQ (EIGRP_TLV_GENERAL | 0x0005) /*!< sequence number */
250 #define EIGRP_TLV_PEER_TERMINATION (EIGRP_TLV_GENERAL | 0x0007) /*!< peer termination */
251 #define EIGRP_TLV_PEER_TERMINATION_LEN (9U)
252 #define EIGRP_TLV_PEER_TIDLIST (EIGRP_TLV_GENERAL | 0x0008) /*!< peer sub-topology list */
253
254 /* Older cisco routers send TIDLIST value wrong, adding for backwards
255 * compatabily */
256 #define EIGRP_TLV_PEER_MTRLIST (EIGRP_TLV_GENERAL | 0x00f5)
257
258 /**
259 * Route Based TLVs
260 */
261 #define EIGRP_TLV_REQUEST 0x0001
262 #define EIGRP_TLV_INTERNAL 0x0002
263 #define EIGRP_TLV_EXTERNAL 0x0003
264 #define EIGRP_TLV_COMMUNITY 0x0004
265 #define EIGRP_TLV_TYPEMASK 0x000f
266
267 #define EIGRP_TLV_IPv4_REQ (EIGRP_TLV_IPv4 | EIGRP_TLV_REQUEST)
268 #define EIGRP_TLV_IPv4_INT (EIGRP_TLV_IPv4 | EIGRP_TLV_INTERNAL)
269 #define EIGRP_TLV_IPv4_EXT (EIGRP_TLV_IPv4 | EIGRP_TLV_EXTERNAL)
270 #define EIGRP_TLV_IPv4_COM (EIGRP_TLV_IPv4 | EIGRP_TLV_COMMUNITY)
271
272 /* max number of TLV IPv4 prefixes in packet */
273 #define EIGRP_TLV_MAX_IPv4 25
274
275 /**
276 *
277 * extdata flag field definitions
278 */
279 #define EIGRP_OPAQUE_EXT 0x01 /*!< Route is external */
280 #define EIGRP_OPAQUE_CD 0x02 /*!< Candidate default route */
281
282 /**
283 * Address-Family types are taken from:
284 * http://www.iana.org/assignments/address-family-numbers
285 * to provide a standards based exchange of AFI information between
286 * EIGRP routers.
287 */
288 #define EIGRP_AF_IPv4 1 /*!< IPv4 (IP version 4) */
289 #define EIGRP_AF_IPv6 2 /*!< IPv6 (IP version 6) */
290 #define EIGRP_AF_IPX 11 /*!< IPX */
291 #define EIGRP_AF_ATALK 12 /*!< Appletalk */
292 #define EIGRP_SF_COMMON 16384 /*!< Cisco Service Family */
293 #define EIGRP_SF_IPv4 16385 /*!< Cisco IPv4 Service Family */
294 #define EIGRP_SF_IPv6 16386 /*!< Cisco IPv6 Service Family */
295
296 /**
297 * Authentication types supported by EIGRP
298 */
299 #define EIGRP_AUTH_TYPE_NONE 0
300 #define EIGRP_AUTH_TYPE_TEXT 1
301 #define EIGRP_AUTH_TYPE_MD5 2
302 #define EIGRP_AUTH_TYPE_MD5_LEN 16
303 #define EIGRP_AUTH_TYPE_SHA256 3
304 #define EIGRP_AUTH_TYPE_SHA256_LEN 32
305
306 /**
307 * opaque flag field definitions
308 */
309 #define EIGRP_OPAQUE_SRCWD 0x01 /*!< Route Source Withdraw */
310 #define EIGRP_OPAQUE_ACTIVE 0x04 /*!< Route is currently in active state */
311 #define EIGRP_OPAQUE_REPL 0x08 /*!< Route is replicated from different tableid */
312
313 /**
314 * pak flag bit field definitions - 0 (none)-7 source priority
315 */
316 #define EIGRP_PRIV_DEFAULT 0x00 /* 0 (none)-7 source priority */
317 #define EIGRP_PRIV_LOW 0x01
318 #define EIGRP_PRIV_MEDIUM 0x04
319 #define EIGRP_PRIV_HIGH 0x07
320
321 /*
322 * Init bit definition. First unicast transmitted Update has this
323 * bit set in the flags field of the fixed header. It tells the neighbor
324 * to down-load his topology table.
325 */
326 #define EIGRP_INIT_FLAG 0x01
327
328 /*
329 * CR bit (Conditionally Received) definition in flags field on header. Any
330 * packets with the CR-bit set can be accepted by an EIGRP speaker if and
331 * only if a previous Hello was received with the SEQUENCE_TYPE TLV present.
332 *
333 * This allows multicasts to be transmitted in order and reliably at the
334 * same time as unicasts are transmitted.
335 */
336 #define EIGRP_CR_FLAG 0x02
337
338 /*
339 * RS bit. The Restart flag is set in the hello and the init
340 * update packets during the nsf signaling period. A nsf-aware
341 * router looks at the RS flag to detect if a peer is restarting
342 * and maintain the adjacency. A restarting router looks at
343 * this flag to determine if the peer is helping out with the restart.
344 */
345 #define EIGRP_RS_FLAG 0x04
346
347 /*
348 * EOT bit. The End-of-Table flag marks the end of the start-up updates
349 * sent to a new peer. A nsf restarting router looks at this flag to
350 * determine if it has finished receiving the start-up updates from all
351 * peers. A nsf-aware router waits for this flag before cleaning up
352 * the stale routes from the restarting peer.
353 */
354 #define EIGRP_EOT_FLAG 0x08
355
356 /**
357 * EIGRP Virtual Router ID
358 *
359 * Define values to deal with EIGRP virtual router ids. Virtual
360 * router IDs are stored in the upper short of the EIGRP fixed packet
361 * header. The lower short of the packet header continues to be used
362 * as asystem number.
363 *
364 * Virtual Router IDs are PDM-independent. All PDMs will use
365 * VRID_BASE to indicate the 'base' or 'legacy' EIGRP instance.
366 * All PDMs need to initialize their vrid to VRID_BASE for compatibility
367 * with legacy routers.
368 * Once IPv6 supports 'MTR Multicast', it will use the same VRID as
369 * IPv4. No current plans to support VRIDs on IPX. :)
370 * Initial usage of VRID is to signal usage of Multicast topology for
371 * MTR.
372 *
373 * VRID_MCAST is a well known constant, other VRIDs will be determined
374 * programmatic...
375 *
376 * With the addition of SAF the VRID space has been divided into two
377 * segments 0x0000-0x7fff is for EIGRP and vNets, 0x8000-0xffff is
378 * for saf and its associated vNets.
379 */
380 #define EIGRP_VRID_MASK 0x8001
381 #define EIGRP_VRID_AF_BASE 0x0000
382 #define EIGRP_VRID_MCAST_BASE 0x0001
383 #define EIGRP_VRID_SF_BASE 0x8000
384
385 /* Extended Attributes for a destination */
386 #define EIGRP_ATTR_HDRLEN (2)
387 #define EIGRP_ATTR_MAXDATA (512)
388
389 #define EIGRP_ATTR_NOOP 0 /*!< No-Op used as offset padding */
390 #define EIGRP_ATTR_SCALED 1 /*!< Scaled metric values */
391 #define EIGRP_ATTR_TAG 2 /*!< Tag assigned by Admin for dest */
392 #define EIGRP_ATTR_COMM 3 /*!< Community attribute for dest */
393 #define EIGRP_ATTR_JITTER 4 /*!< Variation in path delay */
394 #define EIGRP_ATTR_QENERGY 5 /*!< Non-Active energy usage along path */
395 #define EIGRP_ATTR_ENERGY 6 /*!< Active energy usage along path */
396
397 /*
398 * Begin EIGRP-BGP interoperability communities
399 */
400 #define EIGRP_EXTCOMM_SOO_ASFMT 0x0003 /* Site-of-Origin, BGP AS format */
401 #define EIGRP_EXTCOMM_SOO_ADRFMT 0x0103 /* Site-of-Origin, BGP/EIGRP addr format */
402
403 /*
404 * EIGRP Specific communities
405 */
406 #define EIGRP_EXTCOMM_EIGRP 0x8800 /* EIGRP route information appended*/
407 #define EIGRP_EXTCOMM_DAD 0x8801 /* EIGRP AS + Delay */
408 #define EIGRP_EXTCOMM_VRHB 0x8802 /* EIGRP Vector: Reliability + Hop + BW */
409 #define EIGRP_EXTCOMM_SRLM 0x8803 /* EIGRP System: Reserve +Load + MTU */
410 #define EIGRP_EXTCOMM_SAR 0x8804 /* EIGRP System: Remote AS + Remote ID */
411 #define EIGRP_EXTCOMM_RPM 0x8805 /* EIGRP Remote: Protocol + Metric */
412 #define EIGRP_EXTCOMM_VRR 0x8806 /* EIGRP Vecmet: Rsvd + (internal) Routerid */
413
414 /*
415 * EIGRP Filter constants
416 */
417 #define EIGRP_FILTER_IN 0
418 #define EIGRP_FILTER_OUT 1
419 #define EIGRP_FILTER_MAX 2
420
421 /*
422 * EIGRP Filter constants
423 */
424 #define EIGRP_HSROLE_DEFAULT EIGRP_HSROLE_SPOKE
425 #define EIGRP_HSROLE_HUB 0x01
426 #define EIGRP_HSROLE_SPOKE 0x02
427
428 #endif /* _ZEBRA_EIGRP_CONST_H_ */