2 * Routing Information Base header
3 * Copyright (C) 1997 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
7 * GNU Zebra is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
33 #include "nexthop_group.h"
37 #include "srcdest_table.h"
43 typedef enum { RNH_NEXTHOP_TYPE
, RNH_IMPORT_CHECK_TYPE
} rnh_type_t
;
45 PREDECL_LIST(rnh_list
)
47 /* Nexthop structure. */
51 #define ZEBRA_NHT_CONNECTED 0x1
52 #define ZEBRA_NHT_DELETED 0x2
53 #define ZEBRA_NHT_EXACT_MATCH 0x4
64 struct route_entry
*state
;
65 struct prefix resolved_route
;
66 struct list
*client_list
;
68 /* pseudowires dependent on this nh */
69 struct list
*zebra_pseudowire_list
;
71 struct route_node
*node
;
74 * if this has been filtered for the client
76 int filtered
[ZEBRA_ROUTE_MAX
];
78 struct rnh_list_item rnh_list_item
;
81 #define DISTANCE_INFINITY 255
82 #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
88 struct re_list_item next
;
90 /* Nexthop structure */
91 struct nexthop_group ng
;
99 /* Type fo this route. */
102 /* Source protocol instance */
103 unsigned short instance
;
105 /* VRF identifier. */
108 /* Which routing table */
116 uint32_t nexthop_mtu
;
121 /* Flags of this route.
122 * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
123 * to clients via Zserv
127 /* RIB internal status */
129 #define ROUTE_ENTRY_REMOVED 0x1
130 /* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */
131 #define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2
132 /* The Route Entry has changed */
133 #define ROUTE_ENTRY_CHANGED 0x4
134 /* The Label has changed on the Route entry */
135 #define ROUTE_ENTRY_LABELS_CHANGED 0x8
136 /* Route is queued for Installation into the Data Plane */
137 #define ROUTE_ENTRY_QUEUED 0x10
138 /* Route is installed into the Data Plane */
139 #define ROUTE_ENTRY_INSTALLED 0x20
140 /* Route has Failed installation into the Data Plane in some manner */
141 #define ROUTE_ENTRY_FAILED 0x40
143 /* Nexthop information. */
145 uint8_t nexthop_active_num
;
147 /* Sequence value incremented for each dataplane operation */
148 uint32_t dplane_sequence
;
151 #define RIB_SYSTEM_ROUTE(R) RSYSTEM_ROUTE((R)->type)
153 #define RIB_KERNEL_ROUTE(R) RKERNEL_ROUTE((R)->type)
155 /* meta-queue structure:
156 * sub-queue 0: connected, kernel
157 * sub-queue 1: static
158 * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
159 * sub-queue 3: iBGP, eBGP
160 * sub-queue 4: any other origin (if any)
164 struct list
*subq
[MQ_SIZE
];
165 uint32_t size
; /* sum of lengths of all subqueues */
169 * Structure that represents a single destination (prefix).
171 typedef struct rib_dest_t_
{
174 * Back pointer to the route node for this destination. This helps
175 * us get to the prefix that this structure is for.
177 struct route_node
*rnode
;
180 * Doubly-linked list of routes for this prefix.
182 struct re_list_head routes
;
184 struct route_entry
*selected_fib
;
192 * The list of nht prefixes that have ended up
193 * depending on this route node.
194 * After route processing is returned from
195 * the data plane we will run evaluate_rnh
198 struct rnh_list_head nht
;
201 * Linkage to put dest on the FPM processing queue.
203 TAILQ_ENTRY(rib_dest_t_
) fpm_q_entries
;
207 DECLARE_LIST(rnh_list
, struct rnh
, rnh_list_item
);
208 DECLARE_LIST(re_list
, struct route_entry
, next
);
210 #define RIB_ROUTE_QUEUED(x) (1 << (x))
211 // If MQ_SIZE is modified this value needs to be updated.
212 #define RIB_ROUTE_ANY_QUEUED 0x1F
215 * The maximum qindex that can be used.
217 #define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
220 * This flag indicates that a given prefix has been 'advertised' to
221 * the FPM to be installed in the forwarding plane.
223 #define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
226 * This flag is set when we need to send an update to the FPM about a
229 #define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
231 #define RIB_DEST_UPDATE_LSPS (1 << (ZEBRA_MAX_QINDEX + 3))
234 * Macro to iterate over each route for a destination (prefix).
236 #define RE_DEST_FOREACH_ROUTE(dest, re) \
237 for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; (re); \
238 (re) = re_list_next(&((dest)->routes), (re)))
241 * Same as above, but allows the current node to be unlinked.
243 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \
244 for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; \
245 (re) && ((next) = re_list_next(&((dest)->routes), (re)), 1); \
248 #define RNODE_FOREACH_RE(rn, re) \
249 RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
251 #define RNODE_FOREACH_RE_SAFE(rn, re, next) \
252 RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
254 #if defined(HAVE_RTADV)
255 /* Structure which hold status of router advertisement. */
260 int adv_msec_if_count
;
262 struct thread
*ra_read
;
263 struct thread
*ra_timer
;
265 #endif /* HAVE_RTADV */
270 * Structure that is hung off of a route_table that holds information about
273 typedef struct rib_table_info_t_
{
276 * Back pointer to zebra_vrf.
278 struct zebra_vrf
*zvrf
;
285 RIB_TABLES_ITER_S_INIT
,
286 RIB_TABLES_ITER_S_ITERATING
,
287 RIB_TABLES_ITER_S_DONE
288 } rib_tables_iter_state_t
;
291 * Structure that holds state for iterating over all tables in the
292 * Routing Information Base.
294 typedef struct rib_tables_iter_t_
{
298 rib_tables_iter_state_t state
;
301 /* Events/reasons triggering a RIB update. */
303 RIB_UPDATE_IF_CHANGE
,
304 RIB_UPDATE_RMAP_CHANGE
,
306 } rib_update_event_t
;
308 extern struct nexthop
*route_entry_nexthop_ifindex_add(struct route_entry
*re
,
311 extern struct nexthop
*
312 route_entry_nexthop_blackhole_add(struct route_entry
*re
,
313 enum blackhole_type bh_type
);
314 extern struct nexthop
*route_entry_nexthop_ipv4_add(struct route_entry
*re
,
315 struct in_addr
*ipv4
,
318 extern struct nexthop
*
319 route_entry_nexthop_ipv4_ifindex_add(struct route_entry
*re
,
320 struct in_addr
*ipv4
, struct in_addr
*src
,
321 ifindex_t ifindex
, vrf_id_t nh_vrf_id
);
322 extern void route_entry_nexthop_delete(struct route_entry
*re
,
323 struct nexthop
*nexthop
);
324 extern struct nexthop
*route_entry_nexthop_ipv6_add(struct route_entry
*re
,
325 struct in6_addr
*ipv6
,
327 extern struct nexthop
*
328 route_entry_nexthop_ipv6_ifindex_add(struct route_entry
*re
,
329 struct in6_addr
*ipv6
, ifindex_t ifindex
,
331 extern void route_entry_nexthop_add(struct route_entry
*re
,
332 struct nexthop
*nexthop
);
333 extern void route_entry_copy_nexthops(struct route_entry
*re
,
336 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
337 extern void _route_entry_dump(const char *func
, union prefixconstptr pp
,
338 union prefixconstptr src_pp
,
339 const struct route_entry
*re
);
340 /* RPF lookup behaviour */
341 enum multicast_mode
{
342 MCAST_NO_CONFIG
= 0, /* MIX_MRIB_FIRST, but no show in config write */
343 MCAST_MRIB_ONLY
, /* MRIB only */
344 MCAST_URIB_ONLY
, /* URIB only */
345 MCAST_MIX_MRIB_FIRST
, /* MRIB, if nothing at all then URIB */
346 MCAST_MIX_DISTANCE
, /* MRIB & URIB, lower distance wins */
347 MCAST_MIX_PFXLEN
, /* MRIB & URIB, longer prefix wins */
348 /* on equal value, MRIB wins for last 2 */
351 extern void multicast_mode_ipv4_set(enum multicast_mode mode
);
352 extern enum multicast_mode
multicast_mode_ipv4_get(void);
354 extern void rib_lookup_and_dump(struct prefix_ipv4
*p
, vrf_id_t vrf_id
);
355 extern void rib_lookup_and_pushup(struct prefix_ipv4
*p
, vrf_id_t vrf_id
);
357 #define ZEBRA_RIB_LOOKUP_ERROR -1
358 #define ZEBRA_RIB_FOUND_EXACT 0
359 #define ZEBRA_RIB_FOUND_NOGATE 1
360 #define ZEBRA_RIB_FOUND_CONNECTED 2
361 #define ZEBRA_RIB_NOTFOUND 3
363 extern int is_zebra_valid_kernel_table(uint32_t table_id
);
364 extern int is_zebra_main_routing_table(uint32_t table_id
);
365 extern int zebra_check_addr(const struct prefix
*p
);
367 extern void rib_delnode(struct route_node
*rn
, struct route_entry
*re
);
368 extern void rib_install_kernel(struct route_node
*rn
, struct route_entry
*re
,
369 struct route_entry
*old
);
370 extern void rib_uninstall_kernel(struct route_node
*rn
, struct route_entry
*re
);
373 * All rib_add function will not just add prefix into RIB, but
374 * also implicitly withdraw equal prefix of same type. */
375 extern int rib_add(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
376 unsigned short instance
, int flags
, struct prefix
*p
,
377 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
378 uint32_t table_id
, uint32_t metric
, uint32_t mtu
,
379 uint8_t distance
, route_tag_t tag
);
381 extern int rib_add_multipath(afi_t afi
, safi_t safi
, struct prefix
*p
,
382 struct prefix_ipv6
*src_p
, struct route_entry
*re
);
384 extern void rib_delete(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
385 unsigned short instance
, int flags
, struct prefix
*p
,
386 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
387 uint32_t table_id
, uint32_t metric
, uint8_t distance
,
390 extern struct route_entry
*rib_match(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
,
392 struct route_node
**rn_out
);
393 extern struct route_entry
*rib_match_ipv4_multicast(vrf_id_t vrf_id
,
395 struct route_node
**rn_out
);
397 extern struct route_entry
*rib_lookup_ipv4(struct prefix_ipv4
*p
,
400 extern void rib_update(vrf_id_t vrf_id
, rib_update_event_t event
);
401 extern void rib_update_table(struct route_table
*table
,
402 rib_update_event_t event
);
403 extern void rib_sweep_route(void);
404 extern void rib_sweep_table(struct route_table
*table
);
405 extern void rib_close_table(struct route_table
*table
);
406 extern void rib_init(void);
407 extern unsigned long rib_score_proto(uint8_t proto
, unsigned short instance
);
408 extern unsigned long rib_score_proto_table(uint8_t proto
,
409 unsigned short instance
,
410 struct route_table
*table
);
411 extern void rib_queue_add(struct route_node
*rn
);
412 extern void meta_queue_free(struct meta_queue
*mq
);
413 extern int zebra_rib_labeled_unicast(struct route_entry
*re
);
414 extern struct route_table
*rib_table_ipv6
;
416 extern void rib_unlink(struct route_node
*rn
, struct route_entry
*re
);
417 extern int rib_gc_dest(struct route_node
*rn
);
418 extern struct route_table
*rib_tables_iter_next(rib_tables_iter_t
*iter
);
420 extern uint8_t route_distance(int type
);
422 extern void zebra_rib_evaluate_rn_nexthops(struct route_node
*rn
, uint32_t seq
);
431 static inline rib_table_info_t
*rib_table_info(struct route_table
*table
)
433 return (rib_table_info_t
*)route_table_get_info(table
);
437 * rib_dest_from_rnode
439 static inline rib_dest_t
*rib_dest_from_rnode(struct route_node
*rn
)
441 return (rib_dest_t
*)rn
->info
;
447 * Returns a pointer to the list of routes corresponding to the given
450 static inline struct route_entry
*rnode_to_ribs(struct route_node
*rn
)
454 dest
= rib_dest_from_rnode(rn
);
458 return re_list_first(&dest
->routes
);
464 static inline struct prefix
*rib_dest_prefix(rib_dest_t
*dest
)
466 return &dest
->rnode
->p
;
472 * Returns the address family that the destination is for.
474 static inline uint8_t rib_dest_af(rib_dest_t
*dest
)
476 return dest
->rnode
->p
.family
;
482 static inline struct route_table
*rib_dest_table(rib_dest_t
*dest
)
484 return srcdest_rnode_table(dest
->rnode
);
490 static inline struct zebra_vrf
*rib_dest_vrf(rib_dest_t
*dest
)
492 return rib_table_info(rib_dest_table(dest
))->zvrf
;
496 * Create the rib_dest_t and attach it to the specified node
498 extern rib_dest_t
*zebra_rib_create_dest(struct route_node
*rn
);
501 * rib_tables_iter_init
503 static inline void rib_tables_iter_init(rib_tables_iter_t
*iter
)
506 memset(iter
, 0, sizeof(*iter
));
507 iter
->state
= RIB_TABLES_ITER_S_INIT
;
511 * rib_tables_iter_started
513 * Returns TRUE if this iterator has started iterating over the set of
516 static inline int rib_tables_iter_started(rib_tables_iter_t
*iter
)
518 return iter
->state
!= RIB_TABLES_ITER_S_INIT
;
522 * rib_tables_iter_cleanup
524 static inline void rib_tables_iter_cleanup(rib_tables_iter_t
*iter
)
526 iter
->state
= RIB_TABLES_ITER_S_DONE
;
529 DECLARE_HOOK(rib_update
, (struct route_node
* rn
, const char *reason
),
533 extern void zebra_vty_init(void);
537 extern bool v6_rr_semantics
;
543 #endif /*_ZEBRA_RIB_H */