ripd/ripd.h

   1 /* RIP related values and structures.
   2  * Copyright (C) 1997, 1998, 1999 Kunihiro Ishiguro <kunihiro@zebra.org>
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _ZEBRA_RIP_H
  22 #define _ZEBRA_RIP_H
  23
  24 #include "qobj.h"
  25 #include "hook.h"
  26 #include "nexthop.h"
  27 #include "rip_memory.h"
  28
  29 /* RIP version number. */
  30 #define RIPv1                            1
  31 #define RIPv2                            2
  32 /* N.B. stuff will break if
  33         (RIPv1 != RI_RIP_VERSION_1) || (RIPv2 != RI_RIP_VERSION_2) */
  34
  35
  36 /* RIP command list. */
  37 #define RIP_REQUEST                      1
  38 #define RIP_RESPONSE                     2
  39 #define RIP_TRACEON                      3      /* Obsolete */
  40 #define RIP_TRACEOFF                     4      /* Obsolete */
  41 #define RIP_POLL                         5
  42 #define RIP_POLL_ENTRY                   6
  43 #define RIP_COMMAND_MAX                  7
  44
  45 /* RIP metric infinity value.*/
  46 #define RIP_METRIC_INFINITY             16
  47
  48 /* Normal RIP packet min and max size. */
  49 #define RIP_PACKET_MINSIZ                4
  50 #define RIP_PACKET_MAXSIZ              512
  51
  52 #define RIP_HEADER_SIZE                  4
  53 #define RIP_RTE_SIZE                    20
  54
  55 /* Max count of routing table entry in one rip packet. */
  56 #define RIP_MAX_RTE   ((RIP_PACKET_MAXSIZ - RIP_HEADER_SIZE) / RIP_RTE_SIZE)
  57
  58 /* RIP version 2 multicast address. */
  59 #ifndef INADDR_RIP_GROUP
  60 #define INADDR_RIP_GROUP        0xe0000009    /* 224.0.0.9 */
  61 #endif
  62
  63 /* RIP timers */
  64 #define RIP_UPDATE_TIMER_DEFAULT        30
  65 #define RIP_TIMEOUT_TIMER_DEFAULT      180
  66 #define RIP_GARBAGE_TIMER_DEFAULT      120
  67
  68 /* RIP peer timeout value. */
  69 #define RIP_PEER_TIMER_DEFAULT         180
  70
  71 /* RIP port number. */
  72 #define RIP_PORT_DEFAULT               520
  73 #define RIP_VTY_PORT                  2602
  74
  75 /* Default configuration file name. */
  76 #define RIPD_DEFAULT_CONFIG    "ripd.conf"
  77
  78 /* RIP route types. */
  79 #define RIP_ROUTE_RTE                    0
  80 #define RIP_ROUTE_STATIC                 1
  81 #define RIP_ROUTE_DEFAULT                2
  82 #define RIP_ROUTE_REDISTRIBUTE           3
  83 #define RIP_ROUTE_INTERFACE              4
  84
  85 /* RIPv2 special RTE family types */
  86 #define RIP_FAMILY_AUTH                  0xffff
  87
  88 /* RIPv2 authentication types, for RIP_FAMILY_AUTH RTE's */
  89 #define RIP_NO_AUTH                0
  90 #define RIP_AUTH_DATA              1
  91 #define RIP_AUTH_SIMPLE_PASSWORD   2
  92 #define RIP_AUTH_MD5               3
  93
  94 /* RIPv2 Simple authentication */
  95 #define RIP_AUTH_SIMPLE_SIZE            16
  96
  97 /* RIPv2 MD5 authentication. */
  98 #define RIP_AUTH_MD5_SIZE               16
  99 #define RIP_AUTH_MD5_COMPAT_SIZE        RIP_RTE_SIZE
 100
 101 /* RIP structure. */
 102 struct rip {
 103         /* RIP socket. */
 104         int sock;
 105
 106         /* Default version of rip instance. */
 107         int version_send; /* version 1 or 2 (but not both) */
 108         int version_recv; /* version 1 or 2 or both */
 109
 110         /* Output buffer of RIP. */
 111         struct stream *obuf;
 112
 113         /* RIP routing information base. */
 114         struct route_table *table;
 115
 116         /* RIP only static routing information. */
 117         struct route_table *route;
 118
 119         /* RIP neighbor. */
 120         struct route_table *neighbor;
 121
 122         /* RIP threads. */
 123         struct thread *t_read;
 124
 125         /* Update and garbage timer. */
 126         struct thread *t_update;
 127
 128         /* Triggered update hack. */
 129         int trigger;
 130         struct thread *t_triggered_update;
 131         struct thread *t_triggered_interval;
 132
 133         /* RIP timer values. */
 134         unsigned long update_time;
 135         unsigned long timeout_time;
 136         unsigned long garbage_time;
 137
 138         /* RIP default metric. */
 139         int default_metric;
 140
 141         /* RIP default-information originate. */
 142         uint8_t default_information;
 143         char *default_information_route_map;
 144
 145         /* RIP default distance. */
 146         uint8_t distance;
 147         struct route_table *distance_table;
 148
 149         /* RIP ECMP flag */
 150         unsigned int ecmp;
 151
 152         /* For redistribute route map. */
 153         struct {
 154                 char *name;
 155                 struct route_map *map;
 156                 int metric_config;
 157                 uint32_t metric;
 158         } route_map[ZEBRA_ROUTE_MAX];
 159
 160         QOBJ_FIELDS
 161 };
 162 DECLARE_QOBJ_TYPE(rip)
 163
 164 /* RIP routing table entry which belong to rip_packet. */
 165 struct rte {
 166         uint16_t family;        /* Address family of this route. */
 167         uint16_t tag;           /* Route Tag which included in RIP2 packet. */
 168         struct in_addr prefix;  /* Prefix of rip route. */
 169         struct in_addr mask;    /* Netmask of rip route. */
 170         struct in_addr nexthop; /* Next hop of rip route. */
 171         uint32_t metric;        /* Metric value of rip route. */
 172 };
 173
 174 /* RIP packet structure. */
 175 struct rip_packet {
 176         unsigned char command; /* Command type of RIP packet. */
 177         unsigned char version; /* RIP version which coming from peer. */
 178         unsigned char pad1;    /* Padding of RIP packet header. */
 179         unsigned char pad2;    /* Same as above. */
 180         struct rte rte[1];     /* Address structure. */
 181 };
 182
 183 /* Buffer to read RIP packet. */
 184 union rip_buf {
 185         struct rip_packet rip_packet;
 186         char buf[RIP_PACKET_MAXSIZ];
 187 };
 188
 189 /* RIP route information. */
 190 struct rip_info {
 191         /* This route's type. */
 192         int type;
 193
 194         /* Sub type. */
 195         int sub_type;
 196
 197         /* RIP nexthop. */
 198         struct nexthop nh;
 199         struct in_addr from;
 200
 201         /* Metric of this route. */
 202         uint32_t metric;
 203
 204         /* External metric of this route.
 205            if learnt from an externalm proto */
 206         uint32_t external_metric;
 207
 208         /* Tag information of this route. */
 209         uint16_t tag;
 210
 211 /* Flags of RIP route. */
 212 #define RIP_RTF_FIB      1
 213 #define RIP_RTF_CHANGED  2
 214         uint8_t flags;
 215
 216         /* Garbage collect timer. */
 217         struct thread *t_timeout;
 218         struct thread *t_garbage_collect;
 219
 220         /* Route-map futures - this variables can be changed. */
 221         struct in_addr nexthop_out;
 222         uint8_t metric_set;
 223         uint32_t metric_out;
 224         uint16_t tag_out;
 225         ifindex_t ifindex_out;
 226
 227         struct route_node *rp;
 228
 229         uint8_t distance;
 230
 231 #ifdef NEW_RIP_TABLE
 232         struct rip_info *next;
 233         struct rip_info *prev;
 234 #endif /* NEW_RIP_TABLE */
 235 };
 236
 237 typedef enum {
 238         RIP_NO_SPLIT_HORIZON = 0,
 239         RIP_SPLIT_HORIZON,
 240         RIP_SPLIT_HORIZON_POISONED_REVERSE
 241 } split_horizon_policy_t;
 242
 243 /* RIP specific interface configuration. */
 244 struct rip_interface {
 245         /* RIP is enabled on this interface. */
 246         int enable_network;
 247         int enable_interface;
 248
 249         /* RIP is running on this interface. */
 250         int running;
 251
 252         /* RIP version control. */
 253         int ri_send;
 254         int ri_receive;
 255
 256         /* RIPv2 broadcast mode */
 257         int v2_broadcast;
 258
 259         /* RIPv2 authentication type. */
 260         int auth_type;
 261
 262         /* RIPv2 authentication string. */
 263         char *auth_str;
 264
 265         /* RIPv2 authentication key chain. */
 266         char *key_chain;
 267
 268         /* value to use for md5->auth_len */
 269         uint8_t md5_auth_len;
 270
 271         /* Split horizon flag. */
 272         split_horizon_policy_t split_horizon;
 273         split_horizon_policy_t split_horizon_default;
 274
 275 /* For filter type slot. */
 276 #define RIP_FILTER_IN  0
 277 #define RIP_FILTER_OUT 1
 278 #define RIP_FILTER_MAX 2
 279
 280         /* Access-list. */
 281         struct access_list *list[RIP_FILTER_MAX];
 282
 283         /* Prefix-list. */
 284         struct prefix_list *prefix[RIP_FILTER_MAX];
 285
 286         /* Route-map. */
 287         struct route_map *routemap[RIP_FILTER_MAX];
 288
 289         /* Wake up thread. */
 290         struct thread *t_wakeup;
 291
 292         /* Interface statistics. */
 293         int recv_badpackets;
 294         int recv_badroutes;
 295         int sent_updates;
 296
 297         /* Passive interface. */
 298         int passive;
 299 };
 300
 301 /* RIP peer information. */
 302 struct rip_peer {
 303         /* Peer address. */
 304         struct in_addr addr;
 305
 306         /* Peer RIP tag value. */
 307         int domain;
 308
 309         /* Last update time. */
 310         time_t uptime;
 311
 312         /* Peer RIP version. */
 313         uint8_t version;
 314
 315         /* Statistics. */
 316         int recv_badpackets;
 317         int recv_badroutes;
 318
 319         /* Timeout thread. */
 320         struct thread *t_timeout;
 321 };
 322
 323 struct rip_md5_info {
 324         uint16_t family;
 325         uint16_t type;
 326         uint16_t packet_len;
 327         uint8_t keyid;
 328         uint8_t auth_len;
 329         uint32_t sequence;
 330         uint32_t reserv1;
 331         uint32_t reserv2;
 332 };
 333
 334 struct rip_md5_data {
 335         uint16_t family;
 336         uint16_t type;
 337         uint8_t digest[16];
 338 };
 339
 340 /* RIP accepet/announce methods. */
 341 #define RI_RIP_UNSPEC                      0
 342 #define RI_RIP_VERSION_1                   1
 343 #define RI_RIP_VERSION_2                   2
 344 #define RI_RIP_VERSION_1_AND_2             3
 345 #define RI_RIP_VERSION_NONE                4
 346 /* N.B. stuff will break if
 347         (RIPv1 != RI_RIP_VERSION_1) || (RIPv2 != RI_RIP_VERSION_2) */
 348
 349 /* Default value for "default-metric" command. */
 350 #define RIP_DEFAULT_METRIC_DEFAULT         1
 351
 352 /* RIP event. */
 353 enum rip_event {
 354         RIP_READ,
 355         RIP_UPDATE_EVENT,
 356         RIP_TRIGGERED_UPDATE,
 357 };
 358
 359 /* Macro for timer turn on. */
 360 #define RIP_TIMER_ON(T,F,V) thread_add_timer (master, (F), rinfo, (V), &(T))
 361
 362 /* Macro for timer turn off. */
 363 #define RIP_TIMER_OFF(X) THREAD_TIMER_OFF(X)
 364
 365 /* Prototypes. */
 366 extern void rip_init(void);
 367 extern void rip_reset(void);
 368 extern void rip_clean(void);
 369 extern void rip_clean_network(void);
 370 extern void rip_interfaces_clean(void);
 371 extern void rip_interfaces_reset(void);
 372 extern void rip_passive_nondefault_clean(void);
 373 extern void rip_if_init(void);
 374 extern void rip_if_down_all(void);
 375 extern void rip_route_map_init(void);
 376 extern void rip_route_map_reset(void);
 377 extern void rip_zclient_init(struct thread_master *);
 378 extern void rip_zclient_stop(void);
 379 extern void rip_zclient_reset(void);
 380 extern void rip_offset_init(void);
 381 extern int if_check_address(struct in_addr addr);
 382
 383 extern int rip_request_send(struct sockaddr_in *, struct interface *, uint8_t,
 384                             struct connected *);
 385 extern int rip_neighbor_lookup(struct sockaddr_in *);
 386
 387 extern int rip_redistribute_check(int);
 388 extern void rip_redistribute_add(int type, int sub_type, struct prefix_ipv4 *p,
 389                                  struct nexthop *nh, unsigned int metric,
 390                                  unsigned char distance, route_tag_t tag);
 391 extern void rip_redistribute_delete(int, int, struct prefix_ipv4 *, ifindex_t);
 392 extern void rip_redistribute_withdraw(int);
 393 extern void rip_zebra_ipv4_add(struct route_node *);
 394 extern void rip_zebra_ipv4_delete(struct route_node *);
 395 extern void rip_interface_multicast_set(int, struct connected *);
 396 extern void rip_distribute_update_interface(struct interface *);
 397 extern void rip_if_rmap_update_interface(struct interface *);
 398
 399 extern int config_write_rip_network(struct vty *, int);
 400 extern int config_write_rip_offset_list(struct vty *);
 401 extern int config_write_rip_redistribute(struct vty *, int);
 402
 403 extern void rip_peer_init(void);
 404 extern void rip_peer_update(struct sockaddr_in *, uint8_t);
 405 extern void rip_peer_bad_route(struct sockaddr_in *);
 406 extern void rip_peer_bad_packet(struct sockaddr_in *);
 407 extern void rip_peer_display(struct vty *);
 408 extern struct rip_peer *rip_peer_lookup(struct in_addr *);
 409 extern struct rip_peer *rip_peer_lookup_next(struct in_addr *);
 410
 411 extern int rip_offset_list_apply_in(struct prefix_ipv4 *, struct interface *,
 412                                     uint32_t *);
 413 extern int rip_offset_list_apply_out(struct prefix_ipv4 *, struct interface *,
 414                                      uint32_t *);
 415 extern void rip_offset_clean(void);
 416
 417 extern void rip_info_free(struct rip_info *);
 418 extern uint8_t rip_distance_apply(struct rip_info *);
 419 extern void rip_redistribute_clean(void);
 420
 421 extern struct rip_info *rip_ecmp_add(struct rip_info *);
 422 extern struct rip_info *rip_ecmp_replace(struct rip_info *);
 423 extern struct rip_info *rip_ecmp_delete(struct rip_info *);
 424
 425 /* There is only one rip strucutre. */
 426 extern struct rip *rip;
 427
 428 extern struct zebra_privs_t ripd_privs;
 429
 430 /* Master thread strucutre. */
 431 extern struct thread_master *master;
 432
 433 /* RIP statistics for SNMP. */
 434 extern long rip_global_route_changes;
 435 extern long rip_global_queries;
 436
 437 DECLARE_HOOK(rip_ifaddr_add, (struct connected * ifc), (ifc))
 438 DECLARE_HOOK(rip_ifaddr_del, (struct connected * ifc), (ifc))
 439
 440 #endif /* _ZEBRA_RIP_H */