]> git.proxmox.com Git - mirror_frr.git/blame - ripd/ripd.h
Merge pull request #3823 from opensourcerouting/confd-build-fix
[mirror_frr.git] / ripd / ripd.h
CommitLineData
718e3744 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 *
896014f4
DL
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
718e3744 19 */
20
21#ifndef _ZEBRA_RIP_H
22#define _ZEBRA_RIP_H
23
3012671f 24#include "hook.h"
dd127197 25#include "nexthop.h"
03a38493 26#include "distribute.h"
4a1ab8e4
DL
27#include "rip_memory.h"
28
718e3744 29/* RIP version number. */
30#define RIPv1 1
31#define RIPv2 2
f38a471c 32/* N.B. stuff will break if
33 (RIPv1 != RI_RIP_VERSION_1) || (RIPv2 != RI_RIP_VERSION_2) */
34
718e3744 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. */
6a7cff75 56#define RIP_MAX_RTE ((RIP_PACKET_MAXSIZ - RIP_HEADER_SIZE) / RIP_RTE_SIZE)
718e3744 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
718e3744 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
718e3744 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
ca5e516c 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
b14ee00b 89/* RIPv2 Simple authentication */
90#define RIP_AUTH_SIMPLE_SIZE 16
91
ca5e516c 92/* RIPv2 MD5 authentication. */
718e3744 93#define RIP_AUTH_MD5_SIZE 16
ca5e516c 94#define RIP_AUTH_MD5_COMPAT_SIZE RIP_RTE_SIZE
718e3744 95
707656ec
RW
96/* YANG paths */
97#define RIP_INSTANCE "/frr-ripd:ripd/instance"
98#define RIP_IFACE "/frr-interface:lib/interface/frr-ripd:rip"
99
718e3744 100/* RIP structure. */
d62a17ae 101struct rip {
102 /* RIP socket. */
103 int sock;
104
105 /* Default version of rip instance. */
106 int version_send; /* version 1 or 2 (but not both) */
107 int version_recv; /* version 1 or 2 or both */
108
109 /* Output buffer of RIP. */
110 struct stream *obuf;
111
112 /* RIP routing information base. */
113 struct route_table *table;
114
d62a17ae 115 /* RIP neighbor. */
116 struct route_table *neighbor;
117
118 /* RIP threads. */
119 struct thread *t_read;
120
121 /* Update and garbage timer. */
122 struct thread *t_update;
123
124 /* Triggered update hack. */
125 int trigger;
126 struct thread *t_triggered_update;
127 struct thread *t_triggered_interval;
128
129 /* RIP timer values. */
b745780b
RW
130 uint32_t update_time;
131 uint32_t timeout_time;
132 uint32_t garbage_time;
d62a17ae 133
134 /* RIP default metric. */
282ae30c 135 uint8_t default_metric;
d62a17ae 136
d62a17ae 137 /* RIP default distance. */
d7c0a89a 138 uint8_t distance;
d62a17ae 139 struct route_table *distance_table;
140
141 /* RIP ECMP flag */
edbf59d2 142 bool ecmp;
d62a17ae 143
44f2f852
RW
144 /* Are we in passive-interface default mode? */
145 bool passive_default;
146
d62a17ae 147 /* For redistribute route map. */
148 struct {
149 char *name;
150 struct route_map *map;
908f0020
RW
151 bool metric_config;
152 uint8_t metric;
d62a17ae 153 } route_map[ZEBRA_ROUTE_MAX];
03a38493
PG
154
155 /* For distribute-list container */
156 struct distribute_ctx *distribute_ctx;
718e3744 157};
158
159/* RIP routing table entry which belong to rip_packet. */
d62a17ae 160struct rte {
d7c0a89a
QY
161 uint16_t family; /* Address family of this route. */
162 uint16_t tag; /* Route Tag which included in RIP2 packet. */
d62a17ae 163 struct in_addr prefix; /* Prefix of rip route. */
164 struct in_addr mask; /* Netmask of rip route. */
165 struct in_addr nexthop; /* Next hop of rip route. */
d7c0a89a 166 uint32_t metric; /* Metric value of rip route. */
718e3744 167};
168
169/* RIP packet structure. */
d62a17ae 170struct rip_packet {
171 unsigned char command; /* Command type of RIP packet. */
172 unsigned char version; /* RIP version which coming from peer. */
173 unsigned char pad1; /* Padding of RIP packet header. */
174 unsigned char pad2; /* Same as above. */
175 struct rte rte[1]; /* Address structure. */
718e3744 176};
177
178/* Buffer to read RIP packet. */
d62a17ae 179union rip_buf {
180 struct rip_packet rip_packet;
181 char buf[RIP_PACKET_MAXSIZ];
718e3744 182};
183
184/* RIP route information. */
d62a17ae 185struct rip_info {
186 /* This route's type. */
187 int type;
718e3744 188
d62a17ae 189 /* Sub type. */
190 int sub_type;
718e3744 191
d62a17ae 192 /* RIP nexthop. */
dd127197 193 struct nexthop nh;
d62a17ae 194 struct in_addr from;
718e3744 195
d62a17ae 196 /* Metric of this route. */
d7c0a89a 197 uint32_t metric;
718e3744 198
d62a17ae 199 /* External metric of this route.
200 if learnt from an externalm proto */
d7c0a89a 201 uint32_t external_metric;
fbf5d033 202
d62a17ae 203 /* Tag information of this route. */
d7c0a89a 204 uint16_t tag;
718e3744 205
d62a17ae 206/* Flags of RIP route. */
718e3744 207#define RIP_RTF_FIB 1
208#define RIP_RTF_CHANGED 2
d7c0a89a 209 uint8_t flags;
718e3744 210
d62a17ae 211 /* Garbage collect timer. */
212 struct thread *t_timeout;
213 struct thread *t_garbage_collect;
718e3744 214
d62a17ae 215 /* Route-map futures - this variables can be changed. */
216 struct in_addr nexthop_out;
d7c0a89a
QY
217 uint8_t metric_set;
218 uint32_t metric_out;
219 uint16_t tag_out;
d62a17ae 220 ifindex_t ifindex_out;
718e3744 221
d62a17ae 222 struct route_node *rp;
718e3744 223
d7c0a89a 224 uint8_t distance;
718e3744 225
226#ifdef NEW_RIP_TABLE
d62a17ae 227 struct rip_info *next;
228 struct rip_info *prev;
718e3744 229#endif /* NEW_RIP_TABLE */
230};
231
16705130 232typedef enum {
d62a17ae 233 RIP_NO_SPLIT_HORIZON = 0,
234 RIP_SPLIT_HORIZON,
235 RIP_SPLIT_HORIZON_POISONED_REVERSE
16705130 236} split_horizon_policy_t;
237
718e3744 238/* RIP specific interface configuration. */
d62a17ae 239struct rip_interface {
240 /* RIP is enabled on this interface. */
241 int enable_network;
242 int enable_interface;
718e3744 243
d62a17ae 244 /* RIP is running on this interface. */
245 int running;
718e3744 246
d62a17ae 247 /* RIP version control. */
248 int ri_send;
249 int ri_receive;
718e3744 250
d62a17ae 251 /* RIPv2 broadcast mode */
94b117b2 252 bool v2_broadcast;
f90310cf 253
d62a17ae 254 /* RIPv2 authentication type. */
255 int auth_type;
718e3744 256
d62a17ae 257 /* RIPv2 authentication string. */
258 char *auth_str;
718e3744 259
d62a17ae 260 /* RIPv2 authentication key chain. */
261 char *key_chain;
718e3744 262
d62a17ae 263 /* value to use for md5->auth_len */
94b117b2 264 int md5_auth_len;
ca5e516c 265
d62a17ae 266 /* Split horizon flag. */
267 split_horizon_policy_t split_horizon;
718e3744 268
d62a17ae 269/* For filter type slot. */
718e3744 270#define RIP_FILTER_IN 0
271#define RIP_FILTER_OUT 1
272#define RIP_FILTER_MAX 2
273
d62a17ae 274 /* Access-list. */
275 struct access_list *list[RIP_FILTER_MAX];
718e3744 276
d62a17ae 277 /* Prefix-list. */
278 struct prefix_list *prefix[RIP_FILTER_MAX];
718e3744 279
d62a17ae 280 /* Route-map. */
281 struct route_map *routemap[RIP_FILTER_MAX];
16705130 282
d62a17ae 283 /* Wake up thread. */
284 struct thread *t_wakeup;
718e3744 285
d62a17ae 286 /* Interface statistics. */
287 int recv_badpackets;
288 int recv_badroutes;
289 int sent_updates;
718e3744 290
d62a17ae 291 /* Passive interface. */
292 int passive;
718e3744 293};
294
295/* RIP peer information. */
d62a17ae 296struct rip_peer {
297 /* Peer address. */
298 struct in_addr addr;
718e3744 299
d62a17ae 300 /* Peer RIP tag value. */
301 int domain;
718e3744 302
d62a17ae 303 /* Last update time. */
304 time_t uptime;
718e3744 305
d62a17ae 306 /* Peer RIP version. */
d7c0a89a 307 uint8_t version;
718e3744 308
d62a17ae 309 /* Statistics. */
310 int recv_badpackets;
311 int recv_badroutes;
718e3744 312
d62a17ae 313 /* Timeout thread. */
314 struct thread *t_timeout;
718e3744 315};
316
23b23d8c
RW
317struct rip_distance {
318 /* Distance value for the IP source prefix. */
319 uint8_t distance;
320
321 /* Name of the access-list to be matched. */
322 char *access_list;
323};
324
d62a17ae 325struct rip_md5_info {
d7c0a89a
QY
326 uint16_t family;
327 uint16_t type;
328 uint16_t packet_len;
329 uint8_t keyid;
330 uint8_t auth_len;
331 uint32_t sequence;
332 uint32_t reserv1;
333 uint32_t reserv2;
718e3744 334};
335
d62a17ae 336struct rip_md5_data {
d7c0a89a
QY
337 uint16_t family;
338 uint16_t type;
339 uint8_t digest[16];
718e3744 340};
341
342/* RIP accepet/announce methods. */
343#define RI_RIP_UNSPEC 0
344#define RI_RIP_VERSION_1 1
345#define RI_RIP_VERSION_2 2
346#define RI_RIP_VERSION_1_AND_2 3
6aec4b41 347#define RI_RIP_VERSION_NONE 4
f38a471c 348/* N.B. stuff will break if
349 (RIPv1 != RI_RIP_VERSION_1) || (RIPv2 != RI_RIP_VERSION_2) */
718e3744 350
718e3744 351/* RIP event. */
d62a17ae 352enum rip_event {
353 RIP_READ,
354 RIP_UPDATE_EVENT,
355 RIP_TRIGGERED_UPDATE,
718e3744 356};
357
358/* Macro for timer turn on. */
ffa2c898 359#define RIP_TIMER_ON(T,F,V) thread_add_timer (master, (F), rinfo, (V), &(T))
718e3744 360
361/* Macro for timer turn off. */
8578874d 362#define RIP_TIMER_OFF(X) THREAD_TIMER_OFF(X)
718e3744 363
8c942f65
RW
364#define RIP_OFFSET_LIST_IN 0
365#define RIP_OFFSET_LIST_OUT 1
366#define RIP_OFFSET_LIST_MAX 2
367
368struct rip_offset_list {
369 char *ifname;
370
371 struct {
372 char *alist_name;
373 /* struct access_list *alist; */
374 uint8_t metric;
375 } direct[RIP_OFFSET_LIST_MAX];
376};
377
718e3744 378/* Prototypes. */
d62a17ae 379extern void rip_init(void);
d62a17ae 380extern void rip_clean(void);
381extern void rip_clean_network(void);
382extern void rip_interfaces_clean(void);
44f2f852
RW
383extern int rip_passive_nondefault_set(const char *ifname);
384extern int rip_passive_nondefault_unset(const char *ifname);
d62a17ae 385extern void rip_passive_nondefault_clean(void);
386extern void rip_if_init(void);
387extern void rip_if_down_all(void);
388extern void rip_route_map_init(void);
4140ca4d 389extern void rip_zclient_init(struct thread_master *);
a2f9eb82 390extern void rip_zclient_stop(void);
d62a17ae 391extern int if_check_address(struct in_addr addr);
8c9226c2 392extern int rip_create(int socket);
d62a17ae 393
d7c0a89a 394extern int rip_request_send(struct sockaddr_in *, struct interface *, uint8_t,
d62a17ae 395 struct connected *);
396extern int rip_neighbor_lookup(struct sockaddr_in *);
f0ab22fb
RW
397extern int rip_neighbor_add(struct prefix_ipv4 *p);
398extern int rip_neighbor_delete(struct prefix_ipv4 *p);
d62a17ae 399
3d7a1be8
RW
400extern int rip_enable_network_add(struct prefix *p);
401extern int rip_enable_network_delete(struct prefix *p);
402extern int rip_enable_if_add(const char *ifname);
403extern int rip_enable_if_delete(const char *ifname);
404
b745780b 405extern void rip_event(enum rip_event, int);
edbf59d2
RW
406extern void rip_ecmp_disable(void);
407
8c9226c2
RW
408extern int rip_create_socket(void);
409
d62a17ae 410extern int rip_redistribute_check(int);
908f0020
RW
411extern void rip_redistribute_conf_update(int type);
412extern void rip_redistribute_conf_delete(int type);
996c9314
LB
413extern void rip_redistribute_add(int type, int sub_type, struct prefix_ipv4 *p,
414 struct nexthop *nh, unsigned int metric,
415 unsigned char distance, route_tag_t tag);
d62a17ae 416extern void rip_redistribute_delete(int, int, struct prefix_ipv4 *, ifindex_t);
417extern void rip_redistribute_withdraw(int);
418extern void rip_zebra_ipv4_add(struct route_node *);
419extern void rip_zebra_ipv4_delete(struct route_node *);
420extern void rip_interface_multicast_set(int, struct connected *);
421extern void rip_distribute_update_interface(struct interface *);
422extern void rip_if_rmap_update_interface(struct interface *);
423
44f2f852 424extern int rip_show_network_config(struct vty *);
908f0020 425extern void rip_show_redistribute_config(struct vty *);
d62a17ae 426
427extern void rip_peer_init(void);
d7c0a89a 428extern void rip_peer_update(struct sockaddr_in *, uint8_t);
d62a17ae 429extern void rip_peer_bad_route(struct sockaddr_in *);
430extern void rip_peer_bad_packet(struct sockaddr_in *);
431extern void rip_peer_display(struct vty *);
432extern struct rip_peer *rip_peer_lookup(struct in_addr *);
433extern struct rip_peer *rip_peer_lookup_next(struct in_addr *);
434
d62a17ae 435extern void rip_info_free(struct rip_info *);
23b23d8c
RW
436extern struct rip_distance *rip_distance_new(void);
437extern void rip_distance_free(struct rip_distance *rdistance);
d7c0a89a 438extern uint8_t rip_distance_apply(struct rip_info *);
d62a17ae 439extern void rip_redistribute_clean(void);
440
1137aef4 441extern int rip_route_rte(struct rip_info *rinfo);
d62a17ae 442extern struct rip_info *rip_ecmp_add(struct rip_info *);
443extern struct rip_info *rip_ecmp_replace(struct rip_info *);
444extern struct rip_info *rip_ecmp_delete(struct rip_info *);
bce8e868 445
8c942f65
RW
446extern struct rip_offset_list *rip_offset_list_new(const char *ifname);
447extern void offset_list_del(struct rip_offset_list *offset);
448extern struct rip_offset_list *rip_offset_list_lookup(const char *ifname);
449extern int rip_offset_list_apply_in(struct prefix_ipv4 *, struct interface *,
450 uint32_t *);
451extern int rip_offset_list_apply_out(struct prefix_ipv4 *, struct interface *,
452 uint32_t *);
453extern void rip_offset_init(void);
454extern void rip_offset_clean(void);
455
fe339c95
RW
456/* YANG notifications */
457extern void ripd_notif_send_auth_type_failure(const char *ifname);
458extern void ripd_notif_send_auth_failure(const char *ifname);
459
718e3744 460/* There is only one rip strucutre. */
461extern struct rip *rip;
462
32b5a493
DS
463extern struct zebra_privs_t ripd_privs;
464
718e3744 465/* Master thread strucutre. */
466extern struct thread_master *master;
467
468/* RIP statistics for SNMP. */
469extern long rip_global_route_changes;
470extern long rip_global_queries;
3012671f 471
d62a17ae 472DECLARE_HOOK(rip_ifaddr_add, (struct connected * ifc), (ifc))
473DECLARE_HOOK(rip_ifaddr_del, (struct connected * ifc), (ifc))
3012671f 474
5c1a8497 475extern struct list *peer_list;
23b23d8c 476extern struct route_table *rip_distance_table;
44f2f852 477extern vector Vrip_passive_nondefault;
23b23d8c 478
707656ec
RW
479/* Northbound. */
480extern void rip_cli_init(void);
481extern const struct frr_yang_module_info frr_ripd_info;
482
718e3744 483#endif /* _ZEBRA_RIP_H */