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 (from RIB) */
91 struct nexthop_group
*ng
;
93 /* Nexthop group from FIB (optional) */
94 struct nexthop_group fib_ng
;
102 /* Type fo this route. */
105 /* VRF identifier. */
108 /* Which routing table */
116 uint32_t nexthop_mtu
;
118 /* Flags of this route.
119 * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
120 * to clients via Zserv
124 /* RIB internal status */
126 #define ROUTE_ENTRY_REMOVED 0x1
127 /* The Route Entry has changed */
128 #define ROUTE_ENTRY_CHANGED 0x2
129 /* The Label has changed on the Route entry */
130 #define ROUTE_ENTRY_LABELS_CHANGED 0x4
131 /* Route is queued for Installation into the Data Plane */
132 #define ROUTE_ENTRY_QUEUED 0x8
133 /* Route is installed into the Data Plane */
134 #define ROUTE_ENTRY_INSTALLED 0x10
135 /* Route has Failed installation into the Data Plane in some manner */
136 #define ROUTE_ENTRY_FAILED 0x20
138 /* Nexthop information. */
140 uint8_t nexthop_active_num
;
142 /* Sequence value incremented for each dataplane operation */
143 uint32_t dplane_sequence
;
145 /* Source protocol instance */
152 #define RIB_SYSTEM_ROUTE(R) RSYSTEM_ROUTE((R)->type)
154 #define RIB_KERNEL_ROUTE(R) RKERNEL_ROUTE((R)->type)
156 /* meta-queue structure:
157 * sub-queue 0: connected, kernel
158 * sub-queue 1: static
159 * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
160 * sub-queue 3: iBGP, eBGP
161 * sub-queue 4: any other origin (if any)
165 struct list
*subq
[MQ_SIZE
];
166 uint32_t size
; /* sum of lengths of all subqueues */
170 * Structure that represents a single destination (prefix).
172 typedef struct rib_dest_t_
{
175 * Back pointer to the route node for this destination. This helps
176 * us get to the prefix that this structure is for.
178 struct route_node
*rnode
;
181 * Doubly-linked list of routes for this prefix.
183 struct re_list_head routes
;
185 struct route_entry
*selected_fib
;
193 * The list of nht prefixes that have ended up
194 * depending on this route node.
195 * After route processing is returned from
196 * the data plane we will run evaluate_rnh
199 struct rnh_list_head nht
;
202 * Linkage to put dest on the FPM processing queue.
204 TAILQ_ENTRY(rib_dest_t_
) fpm_q_entries
;
208 DECLARE_LIST(rnh_list
, struct rnh
, rnh_list_item
);
209 DECLARE_LIST(re_list
, struct route_entry
, next
);
211 #define RIB_ROUTE_QUEUED(x) (1 << (x))
212 // If MQ_SIZE is modified this value needs to be updated.
213 #define RIB_ROUTE_ANY_QUEUED 0x1F
216 * The maximum qindex that can be used.
218 #define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
221 * This flag indicates that a given prefix has been 'advertised' to
222 * the FPM to be installed in the forwarding plane.
224 #define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
227 * This flag is set when we need to send an update to the FPM about a
230 #define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
232 #define RIB_DEST_UPDATE_LSPS (1 << (ZEBRA_MAX_QINDEX + 3))
235 * Macro to iterate over each route for a destination (prefix).
237 #define RE_DEST_FOREACH_ROUTE(dest, re) \
238 for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; (re); \
239 (re) = re_list_next(&((dest)->routes), (re)))
242 * Same as above, but allows the current node to be unlinked.
244 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \
245 for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; \
246 (re) && ((next) = re_list_next(&((dest)->routes), (re)), 1); \
249 #define RNODE_FOREACH_RE(rn, re) \
250 RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
252 #define RNODE_FOREACH_RE_SAFE(rn, re, next) \
253 RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
255 #if defined(HAVE_RTADV)
256 /* Structure which hold status of router advertisement. */
261 int adv_msec_if_count
;
263 struct thread
*ra_read
;
264 struct thread
*ra_timer
;
266 #endif /* HAVE_RTADV */
271 * Structure that is hung off of a route_table that holds information about
274 typedef struct rib_table_info_t_
{
277 * Back pointer to zebra_vrf.
279 struct zebra_vrf
*zvrf
;
286 RIB_TABLES_ITER_S_INIT
,
287 RIB_TABLES_ITER_S_ITERATING
,
288 RIB_TABLES_ITER_S_DONE
289 } rib_tables_iter_state_t
;
292 * Structure that holds state for iterating over all tables in the
293 * Routing Information Base.
295 typedef struct rib_tables_iter_t_
{
299 rib_tables_iter_state_t state
;
302 /* Events/reasons triggering a RIB update. */
305 RIB_UPDATE_RMAP_CHANGE
,
308 } rib_update_event_t
;
310 extern struct nexthop
*route_entry_nexthop_ifindex_add(struct route_entry
*re
,
313 extern struct nexthop
*
314 route_entry_nexthop_blackhole_add(struct route_entry
*re
,
315 enum blackhole_type bh_type
);
316 extern struct nexthop
*route_entry_nexthop_ipv4_add(struct route_entry
*re
,
317 struct in_addr
*ipv4
,
320 extern struct nexthop
*
321 route_entry_nexthop_ipv4_ifindex_add(struct route_entry
*re
,
322 struct in_addr
*ipv4
, struct in_addr
*src
,
323 ifindex_t ifindex
, vrf_id_t nh_vrf_id
);
324 extern void route_entry_nexthop_delete(struct route_entry
*re
,
325 struct nexthop
*nexthop
);
326 extern struct nexthop
*route_entry_nexthop_ipv6_add(struct route_entry
*re
,
327 struct in6_addr
*ipv6
,
329 extern struct nexthop
*
330 route_entry_nexthop_ipv6_ifindex_add(struct route_entry
*re
,
331 struct in6_addr
*ipv6
, ifindex_t ifindex
,
333 extern void route_entry_nexthop_add(struct route_entry
*re
,
334 struct nexthop
*nexthop
);
335 extern void route_entry_copy_nexthops(struct route_entry
*re
,
338 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
339 extern void _route_entry_dump(const char *func
, union prefixconstptr pp
,
340 union prefixconstptr src_pp
,
341 const struct route_entry
*re
);
343 extern void rib_lookup_and_dump(struct prefix_ipv4
*p
, vrf_id_t vrf_id
);
344 extern void rib_lookup_and_pushup(struct prefix_ipv4
*p
, vrf_id_t vrf_id
);
346 #define ZEBRA_RIB_LOOKUP_ERROR -1
347 #define ZEBRA_RIB_FOUND_EXACT 0
348 #define ZEBRA_RIB_FOUND_NOGATE 1
349 #define ZEBRA_RIB_FOUND_CONNECTED 2
350 #define ZEBRA_RIB_NOTFOUND 3
352 extern int is_zebra_valid_kernel_table(uint32_t table_id
);
353 extern int is_zebra_main_routing_table(uint32_t table_id
);
354 extern int zebra_check_addr(const struct prefix
*p
);
356 extern void rib_delnode(struct route_node
*rn
, struct route_entry
*re
);
357 extern void rib_install_kernel(struct route_node
*rn
, struct route_entry
*re
,
358 struct route_entry
*old
);
359 extern void rib_uninstall_kernel(struct route_node
*rn
, struct route_entry
*re
);
362 * All rib_add function will not just add prefix into RIB, but
363 * also implicitly withdraw equal prefix of same type. */
364 extern int rib_add(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
365 unsigned short instance
, int flags
, struct prefix
*p
,
366 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
367 uint32_t table_id
, uint32_t metric
, uint32_t mtu
,
368 uint8_t distance
, route_tag_t tag
);
370 extern int rib_add_multipath(afi_t afi
, safi_t safi
, struct prefix
*p
,
371 struct prefix_ipv6
*src_p
, struct route_entry
*re
);
373 extern void rib_delete(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
374 unsigned short instance
, int flags
, struct prefix
*p
,
375 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
376 uint32_t table_id
, uint32_t metric
, uint8_t distance
,
379 extern struct route_entry
*rib_match(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
,
381 struct route_node
**rn_out
);
382 extern struct route_entry
*rib_match_ipv4_multicast(vrf_id_t vrf_id
,
384 struct route_node
**rn_out
);
386 extern struct route_entry
*rib_lookup_ipv4(struct prefix_ipv4
*p
,
389 extern void rib_update(rib_update_event_t event
);
390 extern void rib_update_vrf(vrf_id_t vrf_id
, rib_update_event_t event
);
391 extern void rib_update_table(struct route_table
*table
,
392 rib_update_event_t event
);
393 extern int rib_sweep_route(struct thread
*t
);
394 extern void rib_sweep_table(struct route_table
*table
);
395 extern void rib_close_table(struct route_table
*table
);
396 extern void rib_init(void);
397 extern unsigned long rib_score_proto(uint8_t proto
, unsigned short instance
);
398 extern unsigned long rib_score_proto_table(uint8_t proto
,
399 unsigned short instance
,
400 struct route_table
*table
);
401 extern void rib_queue_add(struct route_node
*rn
);
402 extern void meta_queue_free(struct meta_queue
*mq
);
403 extern int zebra_rib_labeled_unicast(struct route_entry
*re
);
404 extern struct route_table
*rib_table_ipv6
;
406 extern void rib_unlink(struct route_node
*rn
, struct route_entry
*re
);
407 extern int rib_gc_dest(struct route_node
*rn
);
408 extern struct route_table
*rib_tables_iter_next(rib_tables_iter_t
*iter
);
410 extern uint8_t route_distance(int type
);
412 extern void zebra_rib_evaluate_rn_nexthops(struct route_node
*rn
, uint32_t seq
);
421 static inline rib_table_info_t
*rib_table_info(struct route_table
*table
)
423 return (rib_table_info_t
*)route_table_get_info(table
);
427 * rib_dest_from_rnode
429 static inline rib_dest_t
*rib_dest_from_rnode(struct route_node
*rn
)
431 return (rib_dest_t
*)rn
->info
;
437 * Returns a pointer to the list of routes corresponding to the given
440 static inline struct route_entry
*rnode_to_ribs(struct route_node
*rn
)
444 dest
= rib_dest_from_rnode(rn
);
448 return re_list_first(&dest
->routes
);
454 static inline struct prefix
*rib_dest_prefix(rib_dest_t
*dest
)
456 return &dest
->rnode
->p
;
462 * Returns the address family that the destination is for.
464 static inline uint8_t rib_dest_af(rib_dest_t
*dest
)
466 return dest
->rnode
->p
.family
;
472 static inline struct route_table
*rib_dest_table(rib_dest_t
*dest
)
474 return srcdest_rnode_table(dest
->rnode
);
480 static inline struct zebra_vrf
*rib_dest_vrf(rib_dest_t
*dest
)
482 return rib_table_info(rib_dest_table(dest
))->zvrf
;
486 * Create the rib_dest_t and attach it to the specified node
488 extern rib_dest_t
*zebra_rib_create_dest(struct route_node
*rn
);
491 * rib_tables_iter_init
493 static inline void rib_tables_iter_init(rib_tables_iter_t
*iter
)
496 memset(iter
, 0, sizeof(*iter
));
497 iter
->state
= RIB_TABLES_ITER_S_INIT
;
501 * rib_tables_iter_started
503 * Returns true if this iterator has started iterating over the set of
506 static inline int rib_tables_iter_started(rib_tables_iter_t
*iter
)
508 return iter
->state
!= RIB_TABLES_ITER_S_INIT
;
512 * rib_tables_iter_cleanup
514 static inline void rib_tables_iter_cleanup(rib_tables_iter_t
*iter
)
516 iter
->state
= RIB_TABLES_ITER_S_DONE
;
519 DECLARE_HOOK(rib_update
, (struct route_node
* rn
, const char *reason
),
523 * Access active nexthop-group, either RIB or FIB version
525 static inline struct nexthop_group
*rib_active_nhg(struct route_entry
*re
)
527 if (re
->fib_ng
.nexthop
)
528 return &(re
->fib_ng
);
533 extern void zebra_vty_init(void);
537 extern bool v6_rr_semantics
;
543 #endif /*_ZEBRA_RIB_H */