2 * EIGRP Definition of Data Structures.
3 * Copyright (C) 2013-2016
15 * This file is part of GNU Zebra.
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
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.
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
32 #ifndef _ZEBRA_EIGRP_STRUCTS_H_
33 #define _ZEBRA_EIGRP_STRUCTS_H_
37 #include "eigrpd/eigrp_const.h"
38 #include "eigrpd/eigrp_macros.h"
40 /* EIGRP master for system wide configuration and variables. */
45 /* EIGRP thread master. */
46 struct thread_master
*master
;
48 /* Zebra interface list. */
51 /* EIGRP start time. */
54 /* Various EIGRP global configuration. */
57 #define EIGRP_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
60 struct eigrp_metrics
{
72 uint16_t AS
; /* Autonomous system number */
73 uint16_t vrid
; /* Virtual Router ID */
74 uint8_t k_values
[6]; /*Array for K values configuration*/
75 uint8_t variance
; /*Metric variance multiplier*/
76 uint8_t max_paths
; /*Maximum allowed paths for 1 prefix*/
78 /*Name of this EIGRP instance*/
81 /* EIGRP Router ID. */
82 struct in_addr router_id
; /* Configured automatically. */
83 struct in_addr router_id_static
; /* Configured manually. */
85 struct list
*eiflist
; /* eigrp interfaces */
86 uint8_t passive_interface_default
; /* passive-interface default */
89 unsigned int maxsndbuflen
;
91 uint32_t sequence_number
; /*Global EIGRP sequence number*/
94 struct list
*oi_write_q
;
97 struct thread
*t_write
;
98 struct thread
*t_read
;
99 struct thread
*t_distribute
; /* timer for distribute list */
101 struct route_table
*networks
; /* EIGRP config networks. */
103 struct route_table
*topology_table
;
105 uint64_t serno
; /* Global serial number counter for topology entry
107 uint64_t serno_last_update
; /* Highest serial number of information send
109 struct list
*topology_changes_internalIPV4
;
110 struct list
*topology_changes_externalIPV4
;
113 struct eigrp_neighbor
*neighbor_self
;
115 /*Configured metric for redistributed routes*/
116 struct eigrp_metrics dmetric
[ZEBRA_ROUTE_MAX
+ 1];
117 int redistribute
; /* Num of redistributed protocols. */
120 struct access_list
*list
[EIGRP_FILTER_MAX
];
122 struct prefix_list
*prefix
[EIGRP_FILTER_MAX
];
124 struct route_map
*routemap
[EIGRP_FILTER_MAX
];
126 /* For redistribute route map. */
129 struct route_map
*map
;
132 } route_map
[ZEBRA_ROUTE_MAX
];
136 DECLARE_QOBJ_TYPE(eigrp
)
138 struct eigrp_if_params
{
139 uint8_t passive_interface
;
142 uint8_t type
; /* type of interface */
148 char *auth_keychain
; /* Associated keychain with interface*/
149 int auth_type
; /* EIGRP authentication type */
152 enum { MEMBER_ALLROUTERS
= 0,
156 /*EIGRP interface structure*/
157 struct eigrp_interface
{
158 struct eigrp_if_params params
;
160 /*multicast group refcnts */
161 bool member_allrouters
;
163 /* This interface's parent eigrp instance. */
166 /* Interface data from zebra. */
167 struct interface
*ifp
;
169 /* Packet send buffer. */
170 struct eigrp_fifo
*obuf
; /* Output queue */
172 /* To which multicast groups do we currently belong? */
175 uint8_t multicast_memberships
;
177 /* EIGRP Network Type. */
180 struct prefix
*address
; /* Interface prefix */
182 /* Neighbor information. */
183 struct list
*nbrs
; /* EIGRP Neighbor List */
186 struct thread
*t_hello
; /* timer */
187 struct thread
*t_distribute
; /* timer for distribute list */
191 /* Statistics fields. */
192 uint32_t hello_in
; /* Hello message input count. */
193 uint32_t update_in
; /* Update message input count. */
194 uint32_t query_in
; /* Querry message input count. */
195 uint32_t reply_in
; /* Reply message input count. */
196 uint32_t hello_out
; /* Hello message output count. */
197 uint32_t update_out
; /* Update message output count. */
198 uint32_t query_out
; /* Query message output count. */
199 uint32_t reply_out
; /* Reply message output count. */
200 uint32_t siaQuery_in
;
201 uint32_t siaQuery_out
;
202 uint32_t siaReply_in
;
203 uint32_t siaReply_out
;
207 uint32_t crypt_seqnum
; /* Cryptographic Sequence Number */
210 struct access_list
*list
[EIGRP_FILTER_MAX
];
212 struct prefix_list
*prefix
[EIGRP_FILTER_MAX
];
214 struct route_map
*routemap
[EIGRP_FILTER_MAX
];
217 /* Determines if it is first or last packet
218 * when packet consists of multiple packet
219 * chunks because of many route TLV
220 * (all won't fit into one packet) */
221 enum Packet_part_type
{
222 EIGRP_PACKET_PART_NA
,
223 EIGRP_PACKET_PART_FIRST
,
224 EIGRP_PACKET_PART_LAST
227 /* Neighbor Data Structure */
228 struct eigrp_neighbor
{
229 /* This neighbor's parent eigrp interface. */
230 struct eigrp_interface
*ei
;
232 /* EIGRP neighbor Information */
233 uint8_t state
; /* neigbor status. */
235 uint32_t recv_sequence_number
; /* Last received sequence Number. */
236 uint32_t init_sequence_number
;
238 /*If packet is unacknowledged, we try to send it again 16 times*/
239 uint8_t retrans_counter
;
241 struct in_addr src
; /* Neighbor Src address. */
243 uint8_t os_rel_major
; // system version - just for show
244 uint8_t os_rel_minor
; // system version - just for show
245 uint8_t tlv_rel_major
; // eigrp version - tells us what TLV format to
247 uint8_t tlv_rel_minor
; // eigrp version - tells us what TLV format to
261 struct thread
*t_holddown
;
262 struct thread
*t_nbr_send_gr
; /* thread for sending multiple GR packet
265 struct eigrp_fifo
*retrans_queue
;
266 struct eigrp_fifo
*multicast_queue
;
268 uint32_t crypt_seqnum
; /* Cryptographic Sequence Number. */
270 /* prefixes not received from neighbor during Graceful restart */
271 struct list
*nbr_gr_prefixes
;
272 /* prefixes not yet send to neighbor during Graceful restart */
273 struct list
*nbr_gr_prefixes_send
;
274 /* if packet is first or last during Graceful restart */
275 enum Packet_part_type nbr_gr_packet_type
;
278 //---------------------------------------------------------------------------------------------------------------------------------------------
281 struct eigrp_packet
{
282 struct eigrp_packet
*next
;
283 struct eigrp_packet
*previous
;
285 /* Pointer to data stream. */
288 /* IP destination address. */
291 /*Packet retransmission thread*/
292 struct thread
*t_retrans_timer
;
294 /*Packet retransmission counter*/
295 uint8_t retrans_counter
;
297 uint32_t sequence_number
;
299 /* EIGRP packet length. */
302 struct eigrp_neighbor
*nbr
;
306 struct eigrp_packet
*head
;
307 struct eigrp_packet
*tail
;
312 struct eigrp_header
{
323 } __attribute__((packed
));
327 * Generic TLV type used for packet decoding.
329 * +-----+------------------+
331 * | Type| Len | Vector |
333 * +-----+------------------+
335 struct eigrp_tlv_hdr_type
{
339 } __attribute__((packed
));
341 struct TLV_Parameter_Type
{
351 } __attribute__((packed
));
353 struct TLV_MD5_Authentication_Type
{
357 uint16_t auth_length
;
359 uint32_t key_sequence
;
361 uint8_t digest
[EIGRP_AUTH_TYPE_MD5_LEN
];
363 } __attribute__((packed
));
365 struct TLV_SHA256_Authentication_Type
{
369 uint16_t auth_length
;
371 uint32_t key_sequence
;
373 uint8_t digest
[EIGRP_AUTH_TYPE_SHA256_LEN
];
375 } __attribute__((packed
));
377 struct TLV_Sequence_Type
{
381 struct in_addr
*addresses
;
382 } __attribute__((packed
));
384 struct TLV_Next_Multicast_Sequence
{
387 uint32_t multicast_sequence
;
388 } __attribute__((packed
));
390 struct TLV_Software_Type
{
393 uint8_t vender_major
;
394 uint8_t vender_minor
;
397 } __attribute__((packed
));
399 struct TLV_IPv4_Internal_type
{
402 struct in_addr forward
;
405 struct eigrp_metrics metric
;
407 uint8_t prefix_length
;
409 unsigned char destination_part
[4];
410 struct in_addr destination
;
411 } __attribute__((packed
));
413 struct TLV_IPv4_External_type
{
416 struct in_addr next_hop
;
417 struct in_addr originating_router
;
418 uint32_t originating_as
;
419 uint32_t administrative_tag
;
420 uint32_t external_metric
;
422 uint8_t external_protocol
;
423 uint8_t external_flags
;
426 struct eigrp_metrics metric
;
428 uint8_t prefix_length
;
429 unsigned char destination_part
[4];
430 struct in_addr destination
;
431 } __attribute__((packed
));
433 /* EIGRP Peer Termination TLV - used for hard restart */
434 struct TLV_Peer_Termination_type
{
438 uint32_t neighbor_ip
;
439 } __attribute__((packed
));
441 /* Who executed Graceful restart */
442 enum GR_type
{ EIGRP_GR_MANUAL
, EIGRP_GR_FILTER
};
444 //---------------------------------------------------------------------------------------------------------------------------------------------
446 /* EIGRP Topology table node structure */
447 struct eigrp_prefix_entry
{
448 struct list
*entries
, *rij
;
449 uint32_t fdistance
; // FD
450 uint32_t rdistance
; // RD
451 uint32_t distance
; // D
452 struct eigrp_metrics reported_metric
; // RD for sending
454 uint8_t nt
; // network type
455 uint8_t state
; // route fsm state
456 uint8_t af
; // address family
457 uint8_t req_action
; // required action
459 struct prefix
*destination
;
461 // If network type is REMOTE_EXTERNAL, pointer will have reference to
463 struct TLV_IPv4_External_type
*extTLV
;
465 uint64_t serno
; /*Serial number for this entry. Increased with each
469 /* EIGRP Topology table record structure */
470 struct eigrp_nexthop_entry
{
471 struct eigrp_prefix_entry
*prefix
;
472 uint32_t reported_distance
; // distance reported by neighbor
473 uint32_t distance
; // sum of reported distance and link cost to
474 // advertised neighbor
476 struct eigrp_metrics reported_metric
;
477 struct eigrp_metrics total_metric
;
479 struct eigrp_neighbor
*adv_router
; // ip address of advertising neighbor
480 uint8_t flags
; // used for marking successor and FS
482 struct eigrp_interface
*ei
; // pointer for case of connected entry
485 //---------------------------------------------------------------------------------------------------------------------------------------------
492 /* EIGRP Finite State Machine */
494 struct eigrp_fsm_action_message
{
495 uint8_t packet_type
; // UPDATE, QUERY, SIAQUERY, SIAREPLY
496 struct eigrp
*eigrp
; // which thread sent mesg
497 struct eigrp_neighbor
*adv_router
; // advertising neighbor
498 struct eigrp_nexthop_entry
*entry
;
499 struct eigrp_prefix_entry
*prefix
;
500 msg_data_t data_type
; // internal or external tlv type
501 struct eigrp_metrics metrics
;
502 enum metric_change change
;
505 #endif /* _ZEBRA_EIGRP_STRUCTURES_H_ */