eigrpd/eigrp_structs.h

   1 /*
   2  * EIGRP Definition of Data Structures.
   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_STRUCTS_H_
  33 #define _ZEBRA_EIGRP_STRUCTS_H_
  34
  35 #include "filter.h"
  36
  37 #include "eigrpd/eigrp_const.h"
  38 #include "eigrpd/eigrp_macros.h"
  39
  40 /* EIGRP master for system wide configuration and variables. */
  41 struct eigrp_master {
  42         /* EIGRP instance. */
  43         struct list *eigrp;
  44
  45         /* EIGRP thread master. */
  46         struct thread_master *master;
  47
  48         /* Zebra interface list. */
  49         struct list *iflist;
  50
  51         /* EIGRP start time. */
  52         time_t start_time;
  53
  54         /* Various EIGRP global configuration. */
  55         u_char options;
  56
  57 #define EIGRP_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
  58 };
  59
  60 struct eigrp_metrics {
  61         u_int32_t delay;
  62         u_int32_t bandwidth;
  63         unsigned char mtu[3];
  64         u_char hop_count;
  65         u_char reliability;
  66         u_char load;
  67         u_char tag;
  68         u_char flags;
  69 };
  70
  71 struct eigrp {
  72         u_int16_t AS;       /* Autonomous system number */
  73         u_int16_t vrid;     /* Virtual Router ID */
  74         u_char k_values[6]; /*Array for K values configuration*/
  75         u_char variance;    /*Metric variance multiplier*/
  76         u_char max_paths;   /*Maximum allowed paths for 1 prefix*/
  77
  78         /*Name of this EIGRP instance*/
  79         char *name;
  80
  81         /* EIGRP Router ID. */
  82         u_int32_t router_id;    /* Configured automatically. */
  83         u_int32_t router_id_static; /* Configured manually. */
  84
  85         struct list *eiflist;             /* eigrp interfaces */
  86         u_char passive_interface_default; /* passive-interface default */
  87
  88         unsigned int fd;
  89         unsigned int maxsndbuflen;
  90
  91         u_int32_t sequence_number; /*Global EIGRP sequence number*/
  92
  93         struct stream *ibuf;
  94         struct list *oi_write_q;
  95
  96         /*Threads*/
  97         struct thread *t_write;
  98         struct thread *t_read;
  99         struct thread *t_distribute; /* timer for distribute list */
 100
 101         struct route_table *networks; /* EIGRP config networks. */
 102
 103         struct route_table *topology_table;
 104
 105         uint64_t serno; /* Global serial number counter for topology entry
 106                            changes*/
 107         uint64_t serno_last_update; /* Highest serial number of information send
 108                                        by last update*/
 109         struct list *topology_changes_internalIPV4;
 110         struct list *topology_changes_externalIPV4;
 111
 112         /*Neighbor self*/
 113         struct eigrp_neighbor *neighbor_self;
 114
 115         /*Configured metric for redistributed routes*/
 116         struct eigrp_metrics dmetric[ZEBRA_ROUTE_MAX + 1];
 117         int redistribute; /* Num of redistributed protocols. */
 118
 119         /* Access-list. */
 120         struct access_list *list[EIGRP_FILTER_MAX];
 121         /* Prefix-list. */
 122         struct prefix_list *prefix[EIGRP_FILTER_MAX];
 123         /* Route-map. */
 124         struct route_map *routemap[EIGRP_FILTER_MAX];
 125
 126         /* For redistribute route map. */
 127         struct {
 128                 char *name;
 129                 struct route_map *map;
 130                 int metric_config;
 131                 u_int32_t metric;
 132         } route_map[ZEBRA_ROUTE_MAX];
 133
 134         QOBJ_FIELDS
 135 };
 136 DECLARE_QOBJ_TYPE(eigrp)
 137
 138 struct eigrp_if_params {
 139         u_char passive_interface;
 140         u_int32_t v_hello;
 141         u_int16_t v_wait;
 142         u_char type; /* type of interface */
 143         u_int32_t bandwidth;
 144         u_int32_t delay;
 145         u_char reliability;
 146         u_char load;
 147
 148         char *auth_keychain; /* Associated keychain with interface*/
 149         int auth_type;       /* EIGRP authentication type */
 150 };
 151
 152 enum { MEMBER_ALLROUTERS = 0,
 153        MEMBER_MAX,
 154 };
 155
 156 /*EIGRP interface structure*/
 157 struct eigrp_interface {
 158         struct eigrp_if_params params;
 159
 160         /*multicast group refcnts */
 161         bool member_allrouters;
 162
 163         /* This interface's parent eigrp instance. */
 164         struct eigrp *eigrp;
 165
 166         /* Interface data from zebra. */
 167         struct interface *ifp;
 168
 169         /* Packet send buffer. */
 170         struct eigrp_fifo *obuf; /* Output queue */
 171
 172         /* To which multicast groups do we currently belong? */
 173
 174
 175         u_char multicast_memberships;
 176
 177         /* EIGRP Network Type. */
 178         u_char type;
 179
 180         struct prefix *address;      /* Interface prefix */
 181         struct connected *connected; /* Pointer to connected */
 182
 183         /* Neighbor information. */
 184         struct list *nbrs; /* EIGRP Neighbor List */
 185
 186         /* Threads. */
 187         struct thread *t_hello;      /* timer */
 188         struct thread *t_distribute; /* timer for distribute list */
 189
 190         int on_write_q;
 191
 192         /* Statistics fields. */
 193         u_int32_t hello_in;   /* Hello message input count. */
 194         u_int32_t update_in;  /* Update message input count. */
 195         u_int32_t query_in;   /* Querry message input count. */
 196         u_int32_t reply_in;   /* Reply message input count. */
 197         u_int32_t hello_out;  /* Hello message output count. */
 198         u_int32_t update_out; /* Update message output count. */
 199         u_int32_t query_out;  /* Query message output count. */
 200         u_int32_t reply_out;  /* Reply message output count. */
 201         u_int32_t siaQuery_in;
 202         u_int32_t siaQuery_out;
 203         u_int32_t siaReply_in;
 204         u_int32_t siaReply_out;
 205         u_int32_t ack_out;
 206         u_int32_t ack_in;
 207
 208         u_int32_t crypt_seqnum; /* Cryptographic Sequence Number */
 209
 210         /* Access-list. */
 211         struct access_list *list[EIGRP_FILTER_MAX];
 212         /* Prefix-list. */
 213         struct prefix_list *prefix[EIGRP_FILTER_MAX];
 214         /* Route-map. */
 215         struct route_map *routemap[EIGRP_FILTER_MAX];
 216 };
 217
 218 /* Determines if it is first or last packet
 219  * when packet consists of multiple packet
 220  * chunks because of many route TLV
 221  * (all won't fit into one packet) */
 222 enum Packet_part_type {
 223         EIGRP_PACKET_PART_NA,
 224         EIGRP_PACKET_PART_FIRST,
 225         EIGRP_PACKET_PART_LAST
 226 };
 227
 228 /* Neighbor Data Structure */
 229 struct eigrp_neighbor {
 230         /* This neighbor's parent eigrp interface. */
 231         struct eigrp_interface *ei;
 232
 233         /* EIGRP neighbor Information */
 234         u_char state; /* neigbor status. */
 235
 236         u_int32_t recv_sequence_number; /* Last received sequence Number. */
 237         u_int32_t init_sequence_number;
 238
 239         /*If packet is unacknowledged, we try to send it again 16 times*/
 240         u_char retrans_counter;
 241
 242         struct in_addr src; /* Neighbor Src address. */
 243
 244         u_char os_rel_major;  // system version - just for show
 245         u_char os_rel_minor;  // system version - just for show
 246         u_char tlv_rel_major; // eigrp version - tells us what TLV format to use
 247         u_char tlv_rel_minor; // eigrp version - tells us what TLV format to use
 248
 249         u_char K1;
 250         u_char K2;
 251         u_char K3;
 252         u_char K4;
 253         u_char K5;
 254         u_char K6;
 255
 256         /* Timer values. */
 257         u_int16_t v_holddown;
 258
 259         /* Threads. */
 260         struct thread *t_holddown;
 261         struct thread *t_nbr_send_gr; /* thread for sending multiple GR packet
 262                                          chunks */
 263
 264         struct eigrp_fifo *retrans_queue;
 265         struct eigrp_fifo *multicast_queue;
 266
 267         u_int32_t crypt_seqnum; /* Cryptographic Sequence Number. */
 268
 269         /* prefixes not received from neighbor during Graceful restart */
 270         struct list *nbr_gr_prefixes;
 271         /* prefixes not yet send to neighbor during Graceful restart */
 272         struct list *nbr_gr_prefixes_send;
 273         /* if packet is first or last during Graceful restart */
 274         enum Packet_part_type nbr_gr_packet_type;
 275 };
 276
 277 //---------------------------------------------------------------------------------------------------------------------------------------------
 278
 279
 280 struct eigrp_packet {
 281         struct eigrp_packet *next;
 282         struct eigrp_packet *previous;
 283
 284         /* Pointer to data stream. */
 285         struct stream *s;
 286
 287         /* IP destination address. */
 288         struct in_addr dst;
 289
 290         /*Packet retransmission thread*/
 291         struct thread *t_retrans_timer;
 292
 293         /*Packet retransmission counter*/
 294         u_char retrans_counter;
 295
 296         u_int32_t sequence_number;
 297
 298         /* EIGRP packet length. */
 299         u_int16_t length;
 300
 301         struct eigrp_neighbor *nbr;
 302 };
 303
 304 struct eigrp_fifo {
 305         struct eigrp_packet *head;
 306         struct eigrp_packet *tail;
 307
 308         unsigned long count;
 309 };
 310
 311 struct eigrp_header {
 312         u_char version;
 313         u_char opcode;
 314         u_int16_t checksum;
 315         u_int32_t flags;
 316         u_int32_t sequence;
 317         u_int32_t ack;
 318         u_int16_t vrid;
 319         u_int16_t ASNumber;
 320         char *tlv[0];
 321
 322 } __attribute__((packed));
 323
 324
 325 /**
 326  * Generic TLV type used for packet decoding.
 327  *
 328  *      +-----+------------------+
 329  *      |     |     |            |
 330  *      | Type| Len |    Vector  |
 331  *      |     |     |            |
 332  *      +-----+------------------+
 333  */
 334 struct eigrp_tlv_hdr_type {
 335         u_int16_t type;
 336         u_int16_t length;
 337         uint8_t value[0];
 338 } __attribute__((packed));
 339
 340 struct TLV_Parameter_Type {
 341         u_int16_t type;
 342         u_int16_t length;
 343         u_char K1;
 344         u_char K2;
 345         u_char K3;
 346         u_char K4;
 347         u_char K5;
 348         u_char K6;
 349         u_int16_t hold_time;
 350 } __attribute__((packed));
 351
 352 struct TLV_MD5_Authentication_Type {
 353         u_int16_t type;
 354         u_int16_t length;
 355         u_int16_t auth_type;
 356         u_int16_t auth_length;
 357         u_int32_t key_id;
 358         u_int32_t key_sequence;
 359         u_char Nullpad[8];
 360         u_char digest[EIGRP_AUTH_TYPE_MD5_LEN];
 361
 362 } __attribute__((packed));
 363
 364 struct TLV_SHA256_Authentication_Type {
 365         u_int16_t type;
 366         u_int16_t length;
 367         u_int16_t auth_type;
 368         u_int16_t auth_length;
 369         u_int32_t key_id;
 370         u_int32_t key_sequence;
 371         u_char Nullpad[8];
 372         u_char digest[EIGRP_AUTH_TYPE_SHA256_LEN];
 373
 374 } __attribute__((packed));
 375
 376 struct TLV_Sequence_Type {
 377         u_int16_t type;
 378         u_int16_t length;
 379         u_char addr_length;
 380         struct in_addr *addresses;
 381 } __attribute__((packed));
 382
 383 struct TLV_Next_Multicast_Sequence {
 384         u_int16_t type;
 385         u_int16_t length;
 386         u_int32_t multicast_sequence;
 387 } __attribute__((packed));
 388
 389 struct TLV_Software_Type {
 390         u_int16_t type;
 391         u_int16_t length;
 392         u_char vender_major;
 393         u_char vender_minor;
 394         u_char eigrp_major;
 395         u_char eigrp_minor;
 396 } __attribute__((packed));
 397
 398 struct TLV_IPv4_Internal_type {
 399         u_int16_t type;
 400         u_int16_t length;
 401         struct in_addr forward;
 402
 403         /*Metrics*/
 404         struct eigrp_metrics metric;
 405
 406         u_char prefix_length;
 407
 408         unsigned char destination_part[4];
 409         struct in_addr destination;
 410 } __attribute__((packed));
 411
 412 struct TLV_IPv4_External_type {
 413         u_int16_t type;
 414         u_int16_t length;
 415         struct in_addr next_hop;
 416         struct in_addr originating_router;
 417         u_int32_t originating_as;
 418         u_int32_t administrative_tag;
 419         u_int32_t external_metric;
 420         u_int16_t reserved;
 421         u_char external_protocol;
 422         u_char external_flags;
 423
 424         /*Metrics*/
 425         struct eigrp_metrics metric;
 426
 427         u_char prefix_length;
 428         unsigned char destination_part[4];
 429         struct in_addr destination;
 430 } __attribute__((packed));
 431
 432 /* EIGRP Peer Termination TLV - used for hard restart */
 433 struct TLV_Peer_Termination_type {
 434         u_int16_t type;
 435         u_int16_t length;
 436         u_char unknown;
 437         u_int32_t neighbor_ip;
 438 } __attribute__((packed));
 439
 440 /* Who executed Graceful restart */
 441 enum GR_type { EIGRP_GR_MANUAL, EIGRP_GR_FILTER };
 442
 443 //---------------------------------------------------------------------------------------------------------------------------------------------
 444
 445 /* EIGRP Topology table node structure */
 446 struct eigrp_prefix_entry {
 447         struct list *entries, *rij;
 448         u_int32_t fdistance;                  // FD
 449         u_int32_t rdistance;                  // RD
 450         u_int32_t distance;                   // D
 451         struct eigrp_metrics reported_metric; // RD for sending
 452
 453         u_char nt;       // network type
 454         u_char state;      // route fsm state
 455         u_char af;       // address family
 456         u_char req_action; // required action
 457
 458         struct prefix *destination;
 459
 460         // If network type is REMOTE_EXTERNAL, pointer will have reference to
 461         // its external TLV
 462         struct TLV_IPv4_External_type *extTLV;
 463
 464         uint64_t serno; /*Serial number for this entry. Increased with each
 465                            change of entry*/
 466 };
 467
 468 /* EIGRP Topology table record structure */
 469 struct eigrp_nexthop_entry {
 470         struct eigrp_prefix_entry *prefix;
 471         u_int32_t reported_distance; // distance reported by neighbor
 472         u_int32_t distance; // sum of reported distance and link cost to
 473                             // advertised neighbor
 474
 475         struct eigrp_metrics reported_metric;
 476         struct eigrp_metrics total_metric;
 477
 478         struct eigrp_neighbor *adv_router; // ip address of advertising neighbor
 479         u_char flags;                      // used for marking successor and FS
 480
 481         struct eigrp_interface *ei; // pointer for case of connected entry
 482 };
 483
 484 //---------------------------------------------------------------------------------------------------------------------------------------------
 485 typedef enum {
 486         EIGRP_CONNECTED,
 487         EIGRP_INT,
 488         EIGRP_EXT,
 489 } msg_data_t;
 490
 491 /* EIGRP Finite State Machine */
 492
 493 struct eigrp_fsm_action_message {
 494         u_char packet_type;                // UPDATE, QUERY, SIAQUERY, SIAREPLY
 495         struct eigrp *eigrp;               // which thread sent mesg
 496         struct eigrp_neighbor *adv_router; // advertising neighbor
 497         struct eigrp_nexthop_entry *entry;
 498         struct eigrp_prefix_entry *prefix;
 499         msg_data_t data_type; // internal or external tlv type
 500         struct eigrp_metrics metrics;
 501         enum metric_change change;
 502 };
 503
 504 #endif /* _ZEBRA_EIGRP_STRUCTURES_H_ */