]>
Commit | Line | Data |
---|---|---|
ad28e79a SW |
1 | /* Zebra Nexthop Group header. |
2 | * Copyright (C) 2019 Cumulus Networks, Inc. | |
3 | * Donald Sharp | |
4 | * Stephen Worley | |
5 | * | |
6 | * This file is part of FRR. | |
7 | * | |
8 | * FRR is free software; you can redistribute it and/or modify it | |
9 | * under the terms of the GNU General Public License as published by the | |
10 | * Free Software Foundation; either version 2, or (at your option) any | |
11 | * later version. | |
12 | * | |
13 | * FRR is distributed in the hope that it will be useful, but | |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | * General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with FRR; see the file COPYING. If not, write to the Free | |
20 | * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
21 | * 02111-1307, USA. | |
22 | */ | |
23 | #ifndef __ZEBRA_NHG_H__ | |
24 | #define __ZEBRA_NHG_H__ | |
25 | ||
5463ce26 | 26 | #include "lib/nexthop.h" |
69171da2 | 27 | #include "lib/nexthop_group.h" |
ad28e79a | 28 | |
0c8215cb SW |
29 | /* This struct is used exclusively for dataplane |
30 | * interaction via a dataplane context. | |
31 | * | |
32 | * It is designed to mimic the netlink nexthop_grp | |
33 | * struct in include/linux/nexthop.h | |
34 | */ | |
e22e8001 | 35 | struct nh_grp { |
0c8215cb SW |
36 | uint32_t id; |
37 | uint8_t weight; | |
38 | }; | |
39 | ||
37c6708b | 40 | PREDECL_RBTREE_UNIQ(nhg_connected_tree); |
0c8215cb | 41 | |
53ac1fbb | 42 | /* |
c415d895 | 43 | * Hashtables containing nhg entries is in `zebra_router`. |
53ac1fbb | 44 | */ |
69171da2 | 45 | struct nhg_hash_entry { |
a95b8020 | 46 | uint32_t id; |
77b76fc9 | 47 | afi_t afi; |
69171da2 | 48 | vrf_id_t vrf_id; |
38e40db1 | 49 | int type; |
69171da2 | 50 | |
c415d895 | 51 | struct nexthop_group nhg; |
69171da2 | 52 | |
1d48702e MS |
53 | /* If supported, a mapping of backup nexthops. */ |
54 | struct nhg_backup_info *backup_info; | |
55 | ||
2614bf87 SW |
56 | /* If this is not a group, it |
57 | * will be a single nexthop | |
58 | * and must have an interface | |
59 | * associated with it. | |
60 | * Otherwise, this will be null. | |
61 | */ | |
62 | struct interface *ifp; | |
63 | ||
69171da2 DS |
64 | uint32_t refcnt; |
65 | uint32_t dplane_ref; | |
c8ee3cdb DS |
66 | |
67 | uint32_t flags; | |
3119f6a1 | 68 | |
0c8215cb | 69 | /* Dependency tree for other entries. |
3119f6a1 SW |
70 | * For instance a group with two |
71 | * nexthops will have two dependencies | |
72 | * pointing to those nhg_hash_entries. | |
0c8215cb SW |
73 | * |
74 | * Using a rb tree here to make lookups | |
75 | * faster with ID's. | |
3119f6a1 | 76 | */ |
37c6708b | 77 | struct nhg_connected_tree_head nhg_depends, nhg_dependents; |
1d48702e | 78 | |
c8ee3cdb DS |
79 | /* |
80 | * Is this nexthop group valid, ie all nexthops are fully resolved. | |
81 | * What is fully resolved? It's a nexthop that is either self contained | |
82 | * and correct( ie no recursive pointer ) or a nexthop that is recursively | |
83 | * resolved and correct. | |
84 | */ | |
38e40db1 | 85 | #define NEXTHOP_GROUP_VALID (1 << 0) |
c8ee3cdb DS |
86 | /* |
87 | * Has this nexthop group been installed? At this point in time, this | |
88 | * means that the data-plane has been told about this nexthop group | |
89 | * and it's possible usage by a route entry. | |
90 | */ | |
38e40db1 | 91 | #define NEXTHOP_GROUP_INSTALLED (1 << 1) |
7f6077d0 SW |
92 | /* |
93 | * Has the nexthop group been queued to be send to the FIB? | |
94 | * The NEXTHOP_GROUP_VALID flag should also be set by this point. | |
95 | */ | |
38e40db1 | 96 | #define NEXTHOP_GROUP_QUEUED (1 << 2) |
98cda54a SW |
97 | /* |
98 | * Is this a nexthop that is recursively resolved? | |
99 | */ | |
38e40db1 SW |
100 | #define NEXTHOP_GROUP_RECURSIVE (1 << 3) |
101 | /* | |
c1da832a SW |
102 | * This is a nexthop group we got from the kernel, it is identical to |
103 | * one we already have. (The kernel allows duplicate nexthops, we don't | |
104 | * since we hash on them). We are only tracking it in our ID table, | |
105 | * it is unusable by our created routes but may be used by routes we get | |
106 | * from the kernel. Therefore, it is unhashable. | |
38e40db1 | 107 | */ |
c1da832a | 108 | #define NEXTHOP_GROUP_UNHASHABLE (1 << 4) |
1d48702e MS |
109 | |
110 | /* | |
111 | * Backup nexthop support - identify groups that are backups for | |
112 | * another group. | |
113 | */ | |
114 | #define NEXTHOP_GROUP_BACKUP (1 << 5) | |
115 | ||
69171da2 DS |
116 | }; |
117 | ||
38e40db1 SW |
118 | /* Was this one we created, either this session or previously? */ |
119 | #define ZEBRA_NHG_CREATED(NHE) ((NHE->type) == ZEBRA_ROUTE_NHG) | |
120 | ||
1d48702e MS |
121 | /* |
122 | * Backup nexthops: this is a group object itself, so | |
123 | * that the backup nexthops can use the same code as a normal object. | |
124 | */ | |
125 | struct nhg_backup_info { | |
126 | struct nhg_hash_entry *nhe; | |
127 | }; | |
e22e8001 SW |
128 | |
129 | enum nhg_ctx_op_e { | |
130 | NHG_CTX_OP_NONE = 0, | |
131 | NHG_CTX_OP_NEW, | |
132 | NHG_CTX_OP_DEL, | |
133 | }; | |
134 | ||
1b366e63 | 135 | enum nhg_ctx_status { |
e22e8001 SW |
136 | NHG_CTX_NONE = 0, |
137 | NHG_CTX_QUEUED, | |
1b366e63 | 138 | NHG_CTX_REQUEUED, |
e22e8001 SW |
139 | NHG_CTX_SUCCESS, |
140 | NHG_CTX_FAILURE, | |
141 | }; | |
142 | ||
143 | /* | |
144 | * Context needed to queue nhg updates on the | |
145 | * work queue. | |
146 | */ | |
147 | struct nhg_ctx { | |
148 | ||
149 | /* Unique ID */ | |
150 | uint32_t id; | |
151 | ||
152 | vrf_id_t vrf_id; | |
153 | afi_t afi; | |
38e40db1 SW |
154 | /* |
155 | * This should only every be ZEBRA_ROUTE_NHG unless we get a a kernel | |
156 | * created nexthop not made by us. | |
157 | */ | |
158 | int type; | |
e22e8001 SW |
159 | |
160 | /* If its a group array, how many? */ | |
161 | uint8_t count; | |
162 | ||
163 | /* Its either a single nexthop or an array of ID's */ | |
164 | union { | |
165 | struct nexthop nh; | |
166 | struct nh_grp grp[MULTIPATH_NUM]; | |
167 | } u; | |
168 | ||
169 | enum nhg_ctx_op_e op; | |
1b366e63 | 170 | enum nhg_ctx_status status; |
e22e8001 SW |
171 | }; |
172 | ||
7c99d51b MS |
173 | /* Global control to disable use of kernel nexthops, if available. We can't |
174 | * force the kernel to support nexthop ids, of course, but we can disable | |
175 | * zebra's use of them, for testing e.g. By default, if the kernel supports | |
176 | * nexthop ids, zebra uses them. | |
177 | */ | |
178 | void zebra_nhg_enable_kernel_nexthops(bool set); | |
179 | bool zebra_nhg_kernel_nexthops_enabled(void); | |
e22e8001 | 180 | |
fe593b78 SW |
181 | /** |
182 | * NHE abstracted tree functions. | |
1d48702e | 183 | * Use these where possible instead of direct access. |
fe593b78 | 184 | */ |
0eb97b86 MS |
185 | struct nhg_hash_entry *zebra_nhg_alloc(void); |
186 | void zebra_nhg_free(struct nhg_hash_entry *nhe); | |
187 | /* In order to clear a generic hash, we need a generic api, sigh. */ | |
188 | void zebra_nhg_hash_free(void *p); | |
189 | ||
1d48702e MS |
190 | /* Allocate, free backup nexthop info objects */ |
191 | struct nhg_backup_info *zebra_nhg_backup_alloc(void); | |
192 | void zebra_nhg_backup_free(struct nhg_backup_info **p); | |
193 | ||
194 | struct nhg_hash_entry *zebra_nhg_get_backup_nhe(struct nhg_hash_entry *nhe); | |
195 | struct nexthop_group *zebra_nhg_get_backup_nhg(struct nhg_hash_entry *nhe); | |
196 | ||
98cda54a | 197 | extern struct nhg_hash_entry *zebra_nhg_resolve(struct nhg_hash_entry *nhe); |
98cda54a | 198 | |
fe593b78 | 199 | extern unsigned int zebra_nhg_depends_count(const struct nhg_hash_entry *nhe); |
0c8215cb | 200 | extern bool zebra_nhg_depends_is_empty(const struct nhg_hash_entry *nhe); |
5948f013 | 201 | |
fe593b78 SW |
202 | extern unsigned int |
203 | zebra_nhg_dependents_count(const struct nhg_hash_entry *nhe); | |
204 | extern bool zebra_nhg_dependents_is_empty(const struct nhg_hash_entry *nhe); | |
3119f6a1 | 205 | |
5948f013 | 206 | /* Lookup ID, doesn't create */ |
d9f5b2f5 | 207 | extern struct nhg_hash_entry *zebra_nhg_lookup_id(uint32_t id); |
d9f5b2f5 | 208 | |
5948f013 | 209 | /* Hash functions */ |
69171da2 | 210 | extern uint32_t zebra_nhg_hash_key(const void *arg); |
a95b8020 | 211 | extern uint32_t zebra_nhg_id_key(const void *arg); |
69171da2 DS |
212 | |
213 | extern bool zebra_nhg_hash_equal(const void *arg1, const void *arg2); | |
d9f5b2f5 | 214 | extern bool zebra_nhg_hash_id_equal(const void *arg1, const void *arg2); |
69171da2 | 215 | |
e22e8001 SW |
216 | /* |
217 | * Process a context off of a queue. | |
218 | * Specifically this should be from | |
219 | * the rib meta queue. | |
220 | */ | |
221 | extern int nhg_ctx_process(struct nhg_ctx *ctx); | |
85f5e761 | 222 | |
e22e8001 SW |
223 | /* Find via kernel nh creation */ |
224 | extern int zebra_nhg_kernel_find(uint32_t id, struct nexthop *nh, | |
225 | struct nh_grp *grp, uint8_t count, | |
38e40db1 SW |
226 | vrf_id_t vrf_id, afi_t afi, int type, |
227 | int startup); | |
9a1588c4 | 228 | /* Del via kernel */ |
88cafda7 | 229 | extern int zebra_nhg_kernel_del(uint32_t id, vrf_id_t vrf_id); |
e22e8001 SW |
230 | |
231 | /* Find via route creation */ | |
7f997721 SW |
232 | extern struct nhg_hash_entry * |
233 | zebra_nhg_rib_find(uint32_t id, struct nexthop_group *nhg, afi_t rt_afi); | |
3057df51 | 234 | |
5948f013 SW |
235 | /* Reference counter functions */ |
236 | extern void zebra_nhg_decrement_ref(struct nhg_hash_entry *nhe); | |
237 | extern void zebra_nhg_increment_ref(struct nhg_hash_entry *nhe); | |
144a1b34 | 238 | |
5948f013 SW |
239 | /* Check validity of nhe, if invalid will update dependents as well */ |
240 | extern void zebra_nhg_check_valid(struct nhg_hash_entry *nhe); | |
241 | ||
242 | /* Convert nhe depends to a grp context that can be passed around safely */ | |
8dbc800f SW |
243 | extern uint8_t zebra_nhg_nhe2grp(struct nh_grp *grp, struct nhg_hash_entry *nhe, |
244 | int size); | |
98cda54a | 245 | |
5948f013 SW |
246 | /* Dataplane install/uninstall */ |
247 | extern void zebra_nhg_install_kernel(struct nhg_hash_entry *nhe); | |
248 | extern void zebra_nhg_uninstall_kernel(struct nhg_hash_entry *nhe); | |
147bad16 | 249 | |
0c8215cb SW |
250 | /* Forward ref of dplane update context type */ |
251 | struct zebra_dplane_ctx; | |
5948f013 SW |
252 | extern void zebra_nhg_dplane_result(struct zebra_dplane_ctx *ctx); |
253 | ||
38e40db1 | 254 | |
5948f013 SW |
255 | /* Sweet the nhg hash tables for old entries on restart */ |
256 | extern void zebra_nhg_sweep_table(struct hash *hash); | |
257 | ||
258 | /* Nexthop resolution processing */ | |
5463ce26 | 259 | struct route_entry; /* Forward ref to avoid circular includes */ |
5948f013 | 260 | extern int nexthop_active_update(struct route_node *rn, struct route_entry *re); |
7c99d51b MS |
261 | |
262 | #endif /* __ZEBRA_NHG_H__ */ |