1 /* RIP related values and structures.
2 * Copyright (C) 1997, 1998, 1999 Kunihiro Ishiguro <kunihiro@zebra.org>
4 * This file is part of GNU Zebra.
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
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.
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
26 #include "rip_memory.h"
28 /* RIP version number. */
31 /* N.B. stuff will break if
32 (RIPv1 != RI_RIP_VERSION_1) || (RIPv2 != RI_RIP_VERSION_2) */
35 /* RIP command list. */
37 #define RIP_RESPONSE 2
38 #define RIP_TRACEON 3 /* Obsolete */
39 #define RIP_TRACEOFF 4 /* Obsolete */
41 #define RIP_POLL_ENTRY 6
42 #define RIP_COMMAND_MAX 7
44 /* RIP metric infinity value.*/
45 #define RIP_METRIC_INFINITY 16
47 /* Normal RIP packet min and max size. */
48 #define RIP_PACKET_MINSIZ 4
49 #define RIP_PACKET_MAXSIZ 512
51 #define RIP_HEADER_SIZE 4
52 #define RIP_RTE_SIZE 20
54 /* Max count of routing table entry in one rip packet. */
55 #define RIP_MAX_RTE ((RIP_PACKET_MAXSIZ - RIP_HEADER_SIZE) / RIP_RTE_SIZE)
57 /* RIP version 2 multicast address. */
58 #ifndef INADDR_RIP_GROUP
59 #define INADDR_RIP_GROUP 0xe0000009 /* 224.0.0.9 */
62 /* RIP peer timeout value. */
63 #define RIP_PEER_TIMER_DEFAULT 180
65 /* RIP port number. */
66 #define RIP_PORT_DEFAULT 520
67 #define RIP_VTY_PORT 2602
69 /* Default configuration file name. */
70 #define RIPD_DEFAULT_CONFIG "ripd.conf"
72 /* RIP route types. */
73 #define RIP_ROUTE_RTE 0
74 #define RIP_ROUTE_STATIC 1
75 #define RIP_ROUTE_DEFAULT 2
76 #define RIP_ROUTE_REDISTRIBUTE 3
77 #define RIP_ROUTE_INTERFACE 4
79 /* RIPv2 special RTE family types */
80 #define RIP_FAMILY_AUTH 0xffff
82 /* RIPv2 authentication types, for RIP_FAMILY_AUTH RTE's */
84 #define RIP_AUTH_DATA 1
85 #define RIP_AUTH_SIMPLE_PASSWORD 2
86 #define RIP_AUTH_MD5 3
88 /* RIPv2 Simple authentication */
89 #define RIP_AUTH_SIMPLE_SIZE 16
91 /* RIPv2 MD5 authentication. */
92 #define RIP_AUTH_MD5_SIZE 16
93 #define RIP_AUTH_MD5_COMPAT_SIZE RIP_RTE_SIZE
96 #define RIP_INSTANCE "/frr-ripd:ripd/instance"
97 #define RIP_IFACE "/frr-interface:lib/interface/frr-ripd:rip"
104 /* Default version of rip instance. */
105 int version_send
; /* version 1 or 2 (but not both) */
106 int version_recv
; /* version 1 or 2 or both */
108 /* Output buffer of RIP. */
111 /* RIP routing information base. */
112 struct route_table
*table
;
115 struct route_table
*neighbor
;
118 struct thread
*t_read
;
120 /* Update and garbage timer. */
121 struct thread
*t_update
;
123 /* Triggered update hack. */
125 struct thread
*t_triggered_update
;
126 struct thread
*t_triggered_interval
;
128 /* RIP timer values. */
129 uint32_t update_time
;
130 uint32_t timeout_time
;
131 uint32_t garbage_time
;
133 /* RIP default metric. */
134 uint8_t default_metric
;
136 /* RIP default distance. */
138 struct route_table
*distance_table
;
143 /* Are we in passive-interface default mode? */
144 bool passive_default
;
146 /* For redistribute route map. */
149 struct route_map
*map
;
152 } route_map
[ZEBRA_ROUTE_MAX
];
155 /* RIP routing table entry which belong to rip_packet. */
157 uint16_t family
; /* Address family of this route. */
158 uint16_t tag
; /* Route Tag which included in RIP2 packet. */
159 struct in_addr prefix
; /* Prefix of rip route. */
160 struct in_addr mask
; /* Netmask of rip route. */
161 struct in_addr nexthop
; /* Next hop of rip route. */
162 uint32_t metric
; /* Metric value of rip route. */
165 /* RIP packet structure. */
167 unsigned char command
; /* Command type of RIP packet. */
168 unsigned char version
; /* RIP version which coming from peer. */
169 unsigned char pad1
; /* Padding of RIP packet header. */
170 unsigned char pad2
; /* Same as above. */
171 struct rte rte
[1]; /* Address structure. */
174 /* Buffer to read RIP packet. */
176 struct rip_packet rip_packet
;
177 char buf
[RIP_PACKET_MAXSIZ
];
180 /* RIP route information. */
182 /* This route's type. */
192 /* Metric of this route. */
195 /* External metric of this route.
196 if learnt from an externalm proto */
197 uint32_t external_metric
;
199 /* Tag information of this route. */
202 /* Flags of RIP route. */
203 #define RIP_RTF_FIB 1
204 #define RIP_RTF_CHANGED 2
207 /* Garbage collect timer. */
208 struct thread
*t_timeout
;
209 struct thread
*t_garbage_collect
;
211 /* Route-map futures - this variables can be changed. */
212 struct in_addr nexthop_out
;
216 ifindex_t ifindex_out
;
218 struct route_node
*rp
;
223 struct rip_info
*next
;
224 struct rip_info
*prev
;
225 #endif /* NEW_RIP_TABLE */
229 RIP_NO_SPLIT_HORIZON
= 0,
231 RIP_SPLIT_HORIZON_POISONED_REVERSE
232 } split_horizon_policy_t
;
234 /* RIP specific interface configuration. */
235 struct rip_interface
{
236 /* RIP is enabled on this interface. */
238 int enable_interface
;
240 /* RIP is running on this interface. */
243 /* RIP version control. */
247 /* RIPv2 broadcast mode */
250 /* RIPv2 authentication type. */
253 /* RIPv2 authentication string. */
256 /* RIPv2 authentication key chain. */
259 /* value to use for md5->auth_len */
260 uint8_t md5_auth_len
;
262 /* Split horizon flag. */
263 split_horizon_policy_t split_horizon
;
264 split_horizon_policy_t split_horizon_default
;
266 /* For filter type slot. */
267 #define RIP_FILTER_IN 0
268 #define RIP_FILTER_OUT 1
269 #define RIP_FILTER_MAX 2
272 struct access_list
*list
[RIP_FILTER_MAX
];
275 struct prefix_list
*prefix
[RIP_FILTER_MAX
];
278 struct route_map
*routemap
[RIP_FILTER_MAX
];
280 /* Wake up thread. */
281 struct thread
*t_wakeup
;
283 /* Interface statistics. */
288 /* Passive interface. */
292 /* RIP peer information. */
297 /* Peer RIP tag value. */
300 /* Last update time. */
303 /* Peer RIP version. */
310 /* Timeout thread. */
311 struct thread
*t_timeout
;
314 struct rip_distance
{
315 /* Distance value for the IP source prefix. */
318 /* Name of the access-list to be matched. */
322 struct rip_md5_info
{
333 struct rip_md5_data
{
339 /* RIP accepet/announce methods. */
340 #define RI_RIP_UNSPEC 0
341 #define RI_RIP_VERSION_1 1
342 #define RI_RIP_VERSION_2 2
343 #define RI_RIP_VERSION_1_AND_2 3
344 #define RI_RIP_VERSION_NONE 4
345 /* N.B. stuff will break if
346 (RIPv1 != RI_RIP_VERSION_1) || (RIPv2 != RI_RIP_VERSION_2) */
352 RIP_TRIGGERED_UPDATE
,
355 /* Macro for timer turn on. */
356 #define RIP_TIMER_ON(T,F,V) thread_add_timer (master, (F), rinfo, (V), &(T))
358 /* Macro for timer turn off. */
359 #define RIP_TIMER_OFF(X) THREAD_TIMER_OFF(X)
361 #define RIP_OFFSET_LIST_IN 0
362 #define RIP_OFFSET_LIST_OUT 1
363 #define RIP_OFFSET_LIST_MAX 2
365 struct rip_offset_list
{
370 /* struct access_list *alist; */
372 } direct
[RIP_OFFSET_LIST_MAX
];
376 extern void rip_init(void);
377 extern void rip_reset(void);
378 extern void rip_clean(void);
379 extern void rip_clean_network(void);
380 extern void rip_interfaces_clean(void);
381 extern void rip_interfaces_reset(void);
382 extern int rip_passive_nondefault_set(const char *ifname
);
383 extern int rip_passive_nondefault_unset(const char *ifname
);
384 extern void rip_passive_nondefault_clean(void);
385 extern void rip_if_init(void);
386 extern void rip_if_down_all(void);
387 extern void rip_route_map_init(void);
388 extern void rip_route_map_reset(void);
389 extern void rip_zclient_init(struct thread_master
*);
390 extern void rip_zclient_stop(void);
391 extern void rip_zclient_reset(void);
392 extern int if_check_address(struct in_addr addr
);
393 extern int rip_create(int socket
);
395 extern int rip_request_send(struct sockaddr_in
*, struct interface
*, uint8_t,
397 extern int rip_neighbor_lookup(struct sockaddr_in
*);
398 extern int rip_neighbor_add(struct prefix_ipv4
*p
);
399 extern int rip_neighbor_delete(struct prefix_ipv4
*p
);
401 extern int rip_enable_network_add(struct prefix
*p
);
402 extern int rip_enable_network_delete(struct prefix
*p
);
403 extern int rip_enable_if_add(const char *ifname
);
404 extern int rip_enable_if_delete(const char *ifname
);
406 extern void rip_event(enum rip_event
, int);
407 extern void rip_ecmp_disable(void);
409 extern int rip_create_socket(void);
411 extern int rip_redistribute_check(int);
412 extern void rip_redistribute_conf_update(int type
);
413 extern void rip_redistribute_conf_delete(int type
);
414 extern void rip_redistribute_add(int type
, int sub_type
, struct prefix_ipv4
*p
,
415 struct nexthop
*nh
, unsigned int metric
,
416 unsigned char distance
, route_tag_t tag
);
417 extern void rip_redistribute_delete(int, int, struct prefix_ipv4
*, ifindex_t
);
418 extern void rip_redistribute_withdraw(int);
419 extern void rip_zebra_ipv4_add(struct route_node
*);
420 extern void rip_zebra_ipv4_delete(struct route_node
*);
421 extern void rip_interface_multicast_set(int, struct connected
*);
422 extern void rip_distribute_update_interface(struct interface
*);
423 extern void rip_if_rmap_update_interface(struct interface
*);
425 extern int rip_show_network_config(struct vty
*);
426 extern void rip_show_redistribute_config(struct vty
*);
428 extern void rip_peer_init(void);
429 extern void rip_peer_update(struct sockaddr_in
*, uint8_t);
430 extern void rip_peer_bad_route(struct sockaddr_in
*);
431 extern void rip_peer_bad_packet(struct sockaddr_in
*);
432 extern void rip_peer_display(struct vty
*);
433 extern struct rip_peer
*rip_peer_lookup(struct in_addr
*);
434 extern struct rip_peer
*rip_peer_lookup_next(struct in_addr
*);
436 extern void rip_info_free(struct rip_info
*);
437 extern struct rip_distance
*rip_distance_new(void);
438 extern void rip_distance_free(struct rip_distance
*rdistance
);
439 extern uint8_t rip_distance_apply(struct rip_info
*);
440 extern void rip_redistribute_clean(void);
442 extern struct rip_info
*rip_ecmp_add(struct rip_info
*);
443 extern struct rip_info
*rip_ecmp_replace(struct rip_info
*);
444 extern struct rip_info
*rip_ecmp_delete(struct rip_info
*);
446 extern struct rip_offset_list
*rip_offset_list_new(const char *ifname
);
447 extern void offset_list_del(struct rip_offset_list
*offset
);
448 extern struct rip_offset_list
*rip_offset_list_lookup(const char *ifname
);
449 extern int rip_offset_list_apply_in(struct prefix_ipv4
*, struct interface
*,
451 extern int rip_offset_list_apply_out(struct prefix_ipv4
*, struct interface
*,
453 extern void rip_offset_init(void);
454 extern void rip_offset_clean(void);
456 /* There is only one rip strucutre. */
457 extern struct rip
*rip
;
459 extern struct zebra_privs_t ripd_privs
;
461 /* Master thread strucutre. */
462 extern struct thread_master
*master
;
464 /* RIP statistics for SNMP. */
465 extern long rip_global_route_changes
;
466 extern long rip_global_queries
;
468 DECLARE_HOOK(rip_ifaddr_add
, (struct connected
* ifc
), (ifc
))
469 DECLARE_HOOK(rip_ifaddr_del
, (struct connected
* ifc
), (ifc
))
471 extern struct route_table
*rip_distance_table
;
472 extern vector Vrip_passive_nondefault
;
475 extern void rip_cli_init(void);
476 extern const struct frr_yang_module_info frr_ripd_info
;
478 #endif /* _ZEBRA_RIP_H */