1 /* Zebra Router header.
2 * Copyright (C) 2018 Cumulus Networks, Inc.
5 * This file is part of FRR.
7 * FRR 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 * FRR 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
18 * along with FRR; see the file COPYING. If not, write to the Free
19 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
22 #ifndef __ZEBRA_ROUTER_H__
23 #define __ZEBRA_ROUTER_H__
27 #include "zebra/zebra_ns.h"
34 * This header file contains the idea of a router and as such
35 * owns data that is associated with a router from zebra's
39 struct zebra_router_table
{
40 RB_ENTRY(zebra_router_table
) zebra_router_table_entry
;
47 struct route_table
*table
;
49 RB_HEAD(zebra_router_table_head
, zebra_router_table
);
50 RB_PROTOTYPE(zebra_router_table_head
, zebra_router_table
,
51 zebra_router_table_entry
, zebra_router_table_entry_compare
)
53 /* RPF lookup behaviour */
55 MCAST_NO_CONFIG
= 0, /* MIX_MRIB_FIRST, but no show in config write */
56 MCAST_MRIB_ONLY
, /* MRIB only */
57 MCAST_URIB_ONLY
, /* URIB only */
58 MCAST_MIX_MRIB_FIRST
, /* MRIB, if nothing at all then URIB */
59 MCAST_MIX_DISTANCE
, /* MRIB & URIB, lower distance wins */
60 MCAST_MIX_PFXLEN
, /* MRIB & URIB, longer prefix wins */
61 /* on equal value, MRIB wins for last 2 */
64 struct zebra_mlag_info
{
65 /* Role this zebra router is playing */
68 /* The peerlink being used for mlag */
70 ifindex_t peerlink_ifindex
;
72 /* The system mac being used */
77 atomic_bool in_shutdown
;
80 struct thread_master
*master
;
82 /* Lists of clients who have connected to us */
83 struct list
*client_list
;
85 struct zebra_router_table_head tables
;
87 /* L3-VNI hash table (for EVPN). Only in default instance */
88 struct hash
*l3vni_table
;
90 struct hash
*rules_hash
;
92 struct hash
*ipset_hash
;
94 struct hash
*ipset_entry_hash
;
96 struct hash
*iptable_hash
;
98 /* used if vrf backend is not network namespace */
101 /* A sequence number used for tracking routes */
102 _Atomic
uint32_t sequence_num
;
105 #define ZEBRA_RIB_PROCESS_HOLD_TIME 10
106 #define ZEBRA_RIB_PROCESS_RETRY_TIME 1
107 struct work_queue
*ribq
;
109 /* The nexthop group work queue */
110 #define ZEBRA_NHG_PROCESS_HOLD_TIME 1
111 #define ZEBRA_NHG_PROCESS_RETRY_TIME 10
112 struct work_queue
*nhgq
;
114 /* Meta Queue Information */
115 struct meta_queue
*mq
;
118 struct work_queue
*lsp_process_q
;
120 #define ZEBRA_ZAPI_PACKETS_TO_PROCESS 1000
121 _Atomic
uint32_t packets_to_process
;
123 /* Mlag information for the router */
124 struct zebra_mlag_info mlag_info
;
127 * The EVPN instance, if any
129 struct zebra_vrf
*evpn_vrf
;
131 uint32_t multipath_num
;
133 /* RPF Lookup behavior */
134 enum multicast_mode ipv4_multicast_mode
;
137 * Time for when we sweep the rib from old routes
142 * The hash of nexthop groups associated with this router
145 struct hash
*nhgs_id
;
148 #define GRACEFUL_RESTART_TIME 60
150 extern struct zebra_router zrouter
;
152 extern void zebra_router_init(void);
153 extern void zebra_router_terminate(void);
155 extern struct route_table
*zebra_router_find_table(struct zebra_vrf
*zvrf
,
156 uint32_t tableid
, afi_t afi
,
158 extern struct route_table
*zebra_router_get_table(struct zebra_vrf
*zvrf
,
159 uint32_t tableid
, afi_t afi
,
161 extern void zebra_router_release_table(struct zebra_vrf
*zvrf
, uint32_t tableid
,
162 afi_t afi
, safi_t safi
);
164 extern int zebra_router_config_write(struct vty
*vty
);
166 extern void zebra_router_sweep_route(void);
168 extern void zebra_router_show_table_summary(struct vty
*vty
);
170 extern uint32_t zebra_router_get_next_sequence(void);
172 static inline vrf_id_t
zebra_vrf_get_evpn_id(void)
174 return zrouter
.evpn_vrf
? zvrf_id(zrouter
.evpn_vrf
) : VRF_DEFAULT
;
176 static inline struct zebra_vrf
*zebra_vrf_get_evpn(void)
178 return zrouter
.evpn_vrf
? zrouter
.evpn_vrf
179 : zebra_vrf_lookup_by_id(VRF_DEFAULT
);
182 extern void multicast_mode_ipv4_set(enum multicast_mode mode
);
184 extern enum multicast_mode
multicast_mode_ipv4_get(void);