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 "hook.h"
  25 #include "nexthop.h"
  26 #include "distribute.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 peer timeout value. */
  64 #define RIP_PEER_TIMER_DEFAULT         180
  65
  66 /* RIP port number. */
  67 #define RIP_PORT_DEFAULT               520
  68 #define RIP_VTY_PORT                  2602
  69
  70 /* Default configuration file name. */
  71 #define RIPD_DEFAULT_CONFIG    "ripd.conf"
  72
  73 /* RIP route types. */
  74 #define RIP_ROUTE_RTE                    0
  75 #define RIP_ROUTE_STATIC                 1
  76 #define RIP_ROUTE_DEFAULT                2
  77 #define RIP_ROUTE_REDISTRIBUTE           3
  78 #define RIP_ROUTE_INTERFACE              4
  79
  80 /* RIPv2 special RTE family types */
  81 #define RIP_FAMILY_AUTH                  0xffff
  82
  83 /* RIPv2 authentication types, for RIP_FAMILY_AUTH RTE's */
  84 #define RIP_NO_AUTH                0
  85 #define RIP_AUTH_DATA              1
  86 #define RIP_AUTH_SIMPLE_PASSWORD   2
  87 #define RIP_AUTH_MD5               3
  88
  89 /* RIPv2 Simple authentication */
  90 #define RIP_AUTH_SIMPLE_SIZE            16
  91
  92 /* RIPv2 MD5 authentication. */
  93 #define RIP_AUTH_MD5_SIZE               16
  94 #define RIP_AUTH_MD5_COMPAT_SIZE        RIP_RTE_SIZE
  95
  96 /* YANG paths */
  97 #define RIP_INSTANCE    "/frr-ripd:ripd/instance"
  98 #define RIP_IFACE       "/frr-interface:lib/interface/frr-ripd:rip"
  99
 100 /* RIP structure. */
 101 struct rip {
 102         RB_ENTRY(rip) entry;
 103
 104         /* VRF this routing instance is associated with. */
 105         char *vrf_name;
 106
 107         /* VRF backpointer (might be NULL if the VRF doesn't exist). */
 108         struct vrf *vrf;
 109
 110         /* Status of the routing instance. */
 111         bool enabled;
 112
 113         /* RIP socket. */
 114         int sock;
 115
 116         /* Default version of rip instance. */
 117         int version_send; /* version 1 or 2 (but not both) */
 118         int version_recv; /* version 1 or 2 or both */
 119
 120         /* Output buffer of RIP. */
 121         struct stream *obuf;
 122
 123         /* RIP routing information base. */
 124         struct route_table *table;
 125
 126         /* RIP static neighbors. */
 127         struct route_table *neighbor;
 128
 129         /* Linked list of RIP peers. */
 130         struct list *peer_list;
 131
 132         /* RIP threads. */
 133         struct thread *t_read;
 134
 135         /* Update and garbage timer. */
 136         struct thread *t_update;
 137
 138         /* Triggered update hack. */
 139         int trigger;
 140         struct thread *t_triggered_update;
 141         struct thread *t_triggered_interval;
 142
 143         /* RIP timer values. */
 144         uint32_t update_time;
 145         uint32_t timeout_time;
 146         uint32_t garbage_time;
 147
 148         /* RIP default metric. */
 149         uint8_t default_metric;
 150
 151         /* RIP default distance. */
 152         uint8_t distance;
 153         struct route_table *distance_table;
 154
 155         /* RIP ECMP flag */
 156         bool ecmp;
 157
 158         /* Are we in passive-interface default mode? */
 159         bool passive_default;
 160
 161         /* RIP enabled interfaces. */
 162         vector enable_interface;
 163
 164         /* RIP enabled networks. */
 165         struct route_table *enable_network;
 166
 167         /* Vector to store passive-interface name. */
 168         vector passive_nondefault;
 169
 170         /* RIP offset-lists. */
 171         struct list *offset_list_master;
 172
 173         /* For redistribute route map. */
 174         struct {
 175                 char *name;
 176                 struct route_map *map;
 177                 bool metric_config;
 178                 uint8_t metric;
 179         } route_map[ZEBRA_ROUTE_MAX];
 180
 181         /* For distribute-list container */
 182         struct distribute_ctx *distribute_ctx;
 183
 184         /* Counters for SNMP. */
 185         struct {
 186                 /* RIP route changes. */
 187                 long route_changes;
 188
 189                 /* RIP queries. */
 190                 long queries;
 191         } counters;
 192 };
 193 RB_HEAD(rip_instance_head, rip);
 194 RB_PROTOTYPE(rip_instance_head, rip, entry, rip_instance_compare)
 195
 196 /* RIP routing table entry which belong to rip_packet. */
 197 struct rte {
 198         uint16_t family;        /* Address family of this route. */
 199         uint16_t tag;           /* Route Tag which included in RIP2 packet. */
 200         struct in_addr prefix;  /* Prefix of rip route. */
 201         struct in_addr mask;    /* Netmask of rip route. */
 202         struct in_addr nexthop; /* Next hop of rip route. */
 203         uint32_t metric;        /* Metric value of rip route. */
 204 };
 205
 206 /* RIP packet structure. */
 207 struct rip_packet {
 208         unsigned char command; /* Command type of RIP packet. */
 209         unsigned char version; /* RIP version which coming from peer. */
 210         unsigned char pad1;    /* Padding of RIP packet header. */
 211         unsigned char pad2;    /* Same as above. */
 212         struct rte rte[1];     /* Address structure. */
 213 };
 214
 215 /* Buffer to read RIP packet. */
 216 union rip_buf {
 217         struct rip_packet rip_packet;
 218         char buf[RIP_PACKET_MAXSIZ];
 219 };
 220
 221 /* RIP route information. */
 222 struct rip_info {
 223         /* This route's type. */
 224         int type;
 225
 226         /* Sub type. */
 227         int sub_type;
 228
 229         /* RIP nexthop. */
 230         struct nexthop nh;
 231         struct in_addr from;
 232
 233         /* Metric of this route. */
 234         uint32_t metric;
 235
 236         /* External metric of this route.
 237            if learnt from an externalm proto */
 238         uint32_t external_metric;
 239
 240         /* Tag information of this route. */
 241         uint16_t tag;
 242
 243 /* Flags of RIP route. */
 244 #define RIP_RTF_FIB      1
 245 #define RIP_RTF_CHANGED  2
 246         uint8_t flags;
 247
 248         /* Garbage collect timer. */
 249         struct thread *t_timeout;
 250         struct thread *t_garbage_collect;
 251
 252         /* Route-map futures - this variables can be changed. */
 253         struct in_addr nexthop_out;
 254         uint8_t metric_set;
 255         uint32_t metric_out;
 256         uint16_t tag_out;
 257         ifindex_t ifindex_out;
 258
 259         struct route_node *rp;
 260
 261         uint8_t distance;
 262 };
 263
 264 typedef enum {
 265         RIP_NO_SPLIT_HORIZON = 0,
 266         RIP_SPLIT_HORIZON,
 267         RIP_SPLIT_HORIZON_POISONED_REVERSE
 268 } split_horizon_policy_t;
 269
 270 /* RIP specific interface configuration. */
 271 struct rip_interface {
 272         /* Parent routing instance. */
 273         struct rip *rip;
 274
 275         /* RIP is enabled on this interface. */
 276         int enable_network;
 277         int enable_interface;
 278
 279         /* RIP is running on this interface. */
 280         int running;
 281
 282         /* RIP version control. */
 283         int ri_send;
 284         int ri_receive;
 285
 286         /* RIPv2 broadcast mode */
 287         bool v2_broadcast;
 288
 289         /* RIPv2 authentication type. */
 290         int auth_type;
 291
 292         /* RIPv2 authentication string. */
 293         char *auth_str;
 294
 295         /* RIPv2 authentication key chain. */
 296         char *key_chain;
 297
 298         /* value to use for md5->auth_len */
 299         int md5_auth_len;
 300
 301         /* Split horizon flag. */
 302         split_horizon_policy_t split_horizon;
 303
 304 /* For filter type slot. */
 305 #define RIP_FILTER_IN  0
 306 #define RIP_FILTER_OUT 1
 307 #define RIP_FILTER_MAX 2
 308
 309         /* Access-list. */
 310         struct access_list *list[RIP_FILTER_MAX];
 311
 312         /* Prefix-list. */
 313         struct prefix_list *prefix[RIP_FILTER_MAX];
 314
 315         /* Route-map. */
 316         struct route_map *routemap[RIP_FILTER_MAX];
 317
 318         /* Wake up thread. */
 319         struct thread *t_wakeup;
 320
 321         /* Interface statistics. */
 322         int recv_badpackets;
 323         int recv_badroutes;
 324         int sent_updates;
 325
 326         /* Passive interface. */
 327         int passive;
 328 };
 329
 330 /* RIP peer information. */
 331 struct rip_peer {
 332         /* Parent routing instance. */
 333         struct rip *rip;
 334
 335         /* Peer address. */
 336         struct in_addr addr;
 337
 338         /* Peer RIP tag value. */
 339         int domain;
 340
 341         /* Last update time. */
 342         time_t uptime;
 343
 344         /* Peer RIP version. */
 345         uint8_t version;
 346
 347         /* Statistics. */
 348         int recv_badpackets;
 349         int recv_badroutes;
 350
 351         /* Timeout thread. */
 352         struct thread *t_timeout;
 353 };
 354
 355 struct rip_distance {
 356         /* Distance value for the IP source prefix. */
 357         uint8_t distance;
 358
 359         /* Name of the access-list to be matched. */
 360         char *access_list;
 361 };
 362
 363 struct rip_md5_info {
 364         uint16_t family;
 365         uint16_t type;
 366         uint16_t packet_len;
 367         uint8_t keyid;
 368         uint8_t auth_len;
 369         uint32_t sequence;
 370         uint32_t reserv1;
 371         uint32_t reserv2;
 372 };
 373
 374 struct rip_md5_data {
 375         uint16_t family;
 376         uint16_t type;
 377         uint8_t digest[16];
 378 };
 379
 380 /* RIP accepet/announce methods. */
 381 #define RI_RIP_UNSPEC                      0
 382 #define RI_RIP_VERSION_1                   1
 383 #define RI_RIP_VERSION_2                   2
 384 #define RI_RIP_VERSION_1_AND_2             3
 385 #define RI_RIP_VERSION_NONE                4
 386 /* N.B. stuff will break if
 387         (RIPv1 != RI_RIP_VERSION_1) || (RIPv2 != RI_RIP_VERSION_2) */
 388
 389 /* RIP event. */
 390 enum rip_event {
 391         RIP_READ,
 392         RIP_UPDATE_EVENT,
 393         RIP_TRIGGERED_UPDATE,
 394 };
 395
 396 /* Macro for timer turn on. */
 397 #define RIP_TIMER_ON(T,F,V) thread_add_timer (master, (F), rinfo, (V), &(T))
 398
 399 /* Macro for timer turn off. */
 400 #define RIP_TIMER_OFF(X) THREAD_TIMER_OFF(X)
 401
 402 #define RIP_OFFSET_LIST_IN  0
 403 #define RIP_OFFSET_LIST_OUT 1
 404 #define RIP_OFFSET_LIST_MAX 2
 405
 406 struct rip_offset_list {
 407         /* Parent routing instance. */
 408         struct rip *rip;
 409
 410         char *ifname;
 411
 412         struct {
 413                 char *alist_name;
 414                 /* struct access_list *alist; */
 415                 uint8_t metric;
 416         } direct[RIP_OFFSET_LIST_MAX];
 417 };
 418
 419 /* Prototypes. */
 420 extern void rip_init(void);
 421 extern void rip_clean(struct rip *rip);
 422 extern void rip_clean_network(struct rip *rip);
 423 extern void rip_interfaces_clean(struct rip *rip);
 424 extern int rip_passive_nondefault_set(struct rip *rip, const char *ifname);
 425 extern int rip_passive_nondefault_unset(struct rip *rip, const char *ifname);
 426 extern void rip_passive_nondefault_clean(struct rip *rip);
 427 extern void rip_if_init(void);
 428 extern void rip_route_map_init(void);
 429 extern void rip_zebra_vrf_register(struct vrf *vrf);
 430 extern void rip_zebra_vrf_deregister(struct vrf *vrf);
 431 extern void rip_zclient_init(struct thread_master *);
 432 extern void rip_zclient_stop(void);
 433 extern int if_check_address(struct rip *rip, struct in_addr addr);
 434 extern struct rip *rip_lookup_by_vrf_id(vrf_id_t vrf_id);
 435 extern struct rip *rip_lookup_by_vrf_name(const char *vrf_name);
 436 extern struct rip *rip_create(const char *vrf_name, struct vrf *vrf,
 437                               int socket);
 438
 439 extern int rip_request_send(struct sockaddr_in *, struct interface *, uint8_t,
 440                             struct connected *);
 441 extern int rip_neighbor_lookup(struct rip *rip, struct sockaddr_in *from);
 442 extern int rip_neighbor_add(struct rip *rip, struct prefix_ipv4 *p);
 443 extern int rip_neighbor_delete(struct rip *rip, struct prefix_ipv4 *p);
 444
 445 extern int rip_enable_network_add(struct rip *rip, struct prefix *p);
 446 extern int rip_enable_network_delete(struct rip *rip, struct prefix *p);
 447 extern int rip_enable_if_add(struct rip *rip, const char *ifname);
 448 extern int rip_enable_if_delete(struct rip *rip, const char *ifname);
 449
 450 extern void rip_event(struct rip *rip, enum rip_event event, int sock);
 451 extern void rip_ecmp_disable(struct rip *rip);
 452
 453 extern int rip_create_socket(struct vrf *vrf);
 454
 455 extern int rip_redistribute_check(struct rip *rip, int type);
 456 extern void rip_redistribute_conf_update(struct rip *rip, int type);
 457 extern void rip_redistribute_conf_delete(struct rip *rip, int type);
 458 extern void rip_redistribute_add(struct rip *rip, int type, int sub_type,
 459                                  struct prefix_ipv4 *p, struct nexthop *nh,
 460                                  unsigned int metric, unsigned char distance,
 461                                  route_tag_t tag);
 462 extern void rip_redistribute_delete(struct rip *rip, int type, int sub_type,
 463                                     struct prefix_ipv4 *p, ifindex_t ifindex);
 464 extern void rip_redistribute_withdraw(struct rip *rip, int type);
 465 extern void rip_zebra_ipv4_add(struct rip *rip, struct route_node *rp);
 466 extern void rip_zebra_ipv4_delete(struct rip *rip, struct route_node *rp);
 467 extern void rip_interface_multicast_set(int, struct connected *);
 468 extern void rip_distribute_update_interface(struct interface *);
 469 extern void rip_if_rmap_update_interface(struct interface *);
 470
 471 extern int rip_show_network_config(struct vty *vty, struct rip *rip);
 472 extern void rip_show_redistribute_config(struct vty *vty, struct rip *rip);
 473
 474 extern void rip_peer_update(struct rip *rip, struct sockaddr_in *from,
 475                             uint8_t version);
 476 extern void rip_peer_bad_route(struct rip *rip, struct sockaddr_in *from);
 477 extern void rip_peer_bad_packet(struct rip *rip, struct sockaddr_in *from);
 478 extern void rip_peer_display(struct vty *vty, struct rip *rip);
 479 extern struct rip_peer *rip_peer_lookup(struct rip *rip, struct in_addr *addr);
 480 extern struct rip_peer *rip_peer_lookup_next(struct rip *rip,
 481                                              struct in_addr *addr);
 482 extern int rip_peer_list_cmp(struct rip_peer *p1, struct rip_peer *p2);
 483 extern void rip_peer_list_del(void *arg);
 484
 485 extern void rip_info_free(struct rip_info *);
 486 extern struct rip *rip_info_get_instance(const struct rip_info *rinfo);
 487 extern struct rip_distance *rip_distance_new(void);
 488 extern void rip_distance_free(struct rip_distance *rdistance);
 489 extern uint8_t rip_distance_apply(struct rip *rip, struct rip_info *rinfo);
 490 extern void rip_redistribute_clean(struct rip *rip);
 491
 492 extern int rip_route_rte(struct rip_info *rinfo);
 493 extern struct rip_info *rip_ecmp_add(struct rip *rip,
 494                                      struct rip_info *rinfo_new);
 495 extern struct rip_info *rip_ecmp_replace(struct rip *rip,
 496                                          struct rip_info *rinfo_new);
 497 extern struct rip_info *rip_ecmp_delete(struct rip *rip,
 498                                         struct rip_info *rinfo);
 499
 500 extern struct rip_offset_list *rip_offset_list_new(struct rip *rip,
 501                                                    const char *ifname);
 502 extern void offset_list_del(struct rip_offset_list *offset);
 503 extern struct rip_offset_list *rip_offset_list_lookup(struct rip *rip,
 504                                                       const char *ifname);
 505 extern int rip_offset_list_apply_in(struct prefix_ipv4 *, struct interface *,
 506                                     uint32_t *);
 507 extern int rip_offset_list_apply_out(struct prefix_ipv4 *, struct interface *,
 508                                      uint32_t *);
 509 extern int offset_list_cmp(struct rip_offset_list *o1,
 510                            struct rip_offset_list *o2);
 511
 512 extern void rip_vrf_init(void);
 513 extern void rip_vrf_terminate(void);
 514
 515 /* YANG notifications */
 516 extern void ripd_notif_send_auth_type_failure(const char *ifname);
 517 extern void ripd_notif_send_auth_failure(const char *ifname);
 518
 519 extern struct zebra_privs_t ripd_privs;
 520
 521 /* Master thread strucutre. */
 522 extern struct thread_master *master;
 523
 524 DECLARE_HOOK(rip_ifaddr_add, (struct connected * ifc), (ifc))
 525 DECLARE_HOOK(rip_ifaddr_del, (struct connected * ifc), (ifc))
 526
 527 /* Northbound. */
 528 extern void rip_cli_init(void);
 529 extern const struct frr_yang_module_info frr_ripd_info;
 530
 531 #endif /* _ZEBRA_RIP_H */