]>
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 SW |
42 | /* |
43 | * Hashtables contiaining entries found in `zebra_router`. | |
44 | */ | |
45 | ||
69171da2 | 46 | struct nhg_hash_entry { |
a95b8020 | 47 | uint32_t id; |
77b76fc9 | 48 | afi_t afi; |
69171da2 | 49 | vrf_id_t vrf_id; |
38e40db1 | 50 | int type; |
69171da2 | 51 | |
8e401b25 | 52 | struct nexthop_group *nhg; |
69171da2 | 53 | |
2614bf87 SW |
54 | /* If this is not a group, it |
55 | * will be a single nexthop | |
56 | * and must have an interface | |
57 | * associated with it. | |
58 | * Otherwise, this will be null. | |
59 | */ | |
60 | struct interface *ifp; | |
61 | ||
69171da2 DS |
62 | uint32_t refcnt; |
63 | uint32_t dplane_ref; | |
c8ee3cdb DS |
64 | |
65 | uint32_t flags; | |
3119f6a1 | 66 | |
0c8215cb | 67 | /* Dependency tree for other entries. |
3119f6a1 SW |
68 | * For instance a group with two |
69 | * nexthops will have two dependencies | |
70 | * pointing to those nhg_hash_entries. | |
0c8215cb SW |
71 | * |
72 | * Using a rb tree here to make lookups | |
73 | * faster with ID's. | |
3119f6a1 | 74 | */ |
37c6708b | 75 | struct nhg_connected_tree_head nhg_depends, nhg_dependents; |
c8ee3cdb DS |
76 | /* |
77 | * Is this nexthop group valid, ie all nexthops are fully resolved. | |
78 | * What is fully resolved? It's a nexthop that is either self contained | |
79 | * and correct( ie no recursive pointer ) or a nexthop that is recursively | |
80 | * resolved and correct. | |
81 | */ | |
38e40db1 | 82 | #define NEXTHOP_GROUP_VALID (1 << 0) |
c8ee3cdb DS |
83 | /* |
84 | * Has this nexthop group been installed? At this point in time, this | |
85 | * means that the data-plane has been told about this nexthop group | |
86 | * and it's possible usage by a route entry. | |
87 | */ | |
38e40db1 | 88 | #define NEXTHOP_GROUP_INSTALLED (1 << 1) |
7f6077d0 SW |
89 | /* |
90 | * Has the nexthop group been queued to be send to the FIB? | |
91 | * The NEXTHOP_GROUP_VALID flag should also be set by this point. | |
92 | */ | |
38e40db1 | 93 | #define NEXTHOP_GROUP_QUEUED (1 << 2) |
98cda54a SW |
94 | /* |
95 | * Is this a nexthop that is recursively resolved? | |
96 | */ | |
38e40db1 SW |
97 | #define NEXTHOP_GROUP_RECURSIVE (1 << 3) |
98 | /* | |
c1da832a SW |
99 | * This is a nexthop group we got from the kernel, it is identical to |
100 | * one we already have. (The kernel allows duplicate nexthops, we don't | |
101 | * since we hash on them). We are only tracking it in our ID table, | |
102 | * it is unusable by our created routes but may be used by routes we get | |
103 | * from the kernel. Therefore, it is unhashable. | |
38e40db1 | 104 | */ |
c1da832a | 105 | #define NEXTHOP_GROUP_UNHASHABLE (1 << 4) |
69171da2 DS |
106 | }; |
107 | ||
38e40db1 SW |
108 | /* Was this one we created, either this session or previously? */ |
109 | #define ZEBRA_NHG_CREATED(NHE) ((NHE->type) == ZEBRA_ROUTE_NHG) | |
110 | ||
e22e8001 SW |
111 | |
112 | enum nhg_ctx_op_e { | |
113 | NHG_CTX_OP_NONE = 0, | |
114 | NHG_CTX_OP_NEW, | |
115 | NHG_CTX_OP_DEL, | |
116 | }; | |
117 | ||
1b366e63 | 118 | enum nhg_ctx_status { |
e22e8001 SW |
119 | NHG_CTX_NONE = 0, |
120 | NHG_CTX_QUEUED, | |
1b366e63 | 121 | NHG_CTX_REQUEUED, |
e22e8001 SW |
122 | NHG_CTX_SUCCESS, |
123 | NHG_CTX_FAILURE, | |
124 | }; | |
125 | ||
126 | /* | |
127 | * Context needed to queue nhg updates on the | |
128 | * work queue. | |
129 | */ | |
130 | struct nhg_ctx { | |
131 | ||
132 | /* Unique ID */ | |
133 | uint32_t id; | |
134 | ||
135 | vrf_id_t vrf_id; | |
136 | afi_t afi; | |
38e40db1 SW |
137 | /* |
138 | * This should only every be ZEBRA_ROUTE_NHG unless we get a a kernel | |
139 | * created nexthop not made by us. | |
140 | */ | |
141 | int type; | |
e22e8001 SW |
142 | |
143 | /* If its a group array, how many? */ | |
144 | uint8_t count; | |
145 | ||
146 | /* Its either a single nexthop or an array of ID's */ | |
147 | union { | |
148 | struct nexthop nh; | |
149 | struct nh_grp grp[MULTIPATH_NUM]; | |
150 | } u; | |
151 | ||
152 | enum nhg_ctx_op_e op; | |
1b366e63 | 153 | enum nhg_ctx_status status; |
e22e8001 SW |
154 | }; |
155 | ||
156 | ||
fe593b78 SW |
157 | /** |
158 | * NHE abstracted tree functions. | |
159 | * Use these where possible instead of the direct ones access ones. | |
160 | */ | |
0eb97b86 MS |
161 | struct nhg_hash_entry *zebra_nhg_alloc(void); |
162 | void zebra_nhg_free(struct nhg_hash_entry *nhe); | |
163 | /* In order to clear a generic hash, we need a generic api, sigh. */ | |
164 | void zebra_nhg_hash_free(void *p); | |
165 | ||
98cda54a | 166 | extern struct nhg_hash_entry *zebra_nhg_resolve(struct nhg_hash_entry *nhe); |
98cda54a | 167 | |
fe593b78 | 168 | extern unsigned int zebra_nhg_depends_count(const struct nhg_hash_entry *nhe); |
0c8215cb | 169 | extern bool zebra_nhg_depends_is_empty(const struct nhg_hash_entry *nhe); |
5948f013 | 170 | |
fe593b78 SW |
171 | extern unsigned int |
172 | zebra_nhg_dependents_count(const struct nhg_hash_entry *nhe); | |
173 | extern bool zebra_nhg_dependents_is_empty(const struct nhg_hash_entry *nhe); | |
3119f6a1 | 174 | |
5948f013 | 175 | /* Lookup ID, doesn't create */ |
d9f5b2f5 | 176 | extern struct nhg_hash_entry *zebra_nhg_lookup_id(uint32_t id); |
d9f5b2f5 | 177 | |
5948f013 | 178 | /* Hash functions */ |
69171da2 | 179 | extern uint32_t zebra_nhg_hash_key(const void *arg); |
a95b8020 | 180 | extern uint32_t zebra_nhg_id_key(const void *arg); |
69171da2 DS |
181 | |
182 | extern bool zebra_nhg_hash_equal(const void *arg1, const void *arg2); | |
d9f5b2f5 | 183 | extern bool zebra_nhg_hash_id_equal(const void *arg1, const void *arg2); |
69171da2 | 184 | |
e22e8001 SW |
185 | /* |
186 | * Process a context off of a queue. | |
187 | * Specifically this should be from | |
188 | * the rib meta queue. | |
189 | */ | |
190 | extern int nhg_ctx_process(struct nhg_ctx *ctx); | |
85f5e761 | 191 | |
e22e8001 SW |
192 | /* Find via kernel nh creation */ |
193 | extern int zebra_nhg_kernel_find(uint32_t id, struct nexthop *nh, | |
194 | struct nh_grp *grp, uint8_t count, | |
38e40db1 SW |
195 | vrf_id_t vrf_id, afi_t afi, int type, |
196 | int startup); | |
9a1588c4 SW |
197 | /* Del via kernel */ |
198 | extern int zebra_nhg_kernel_del(uint32_t id); | |
e22e8001 SW |
199 | |
200 | /* Find via route creation */ | |
7f997721 SW |
201 | extern struct nhg_hash_entry * |
202 | zebra_nhg_rib_find(uint32_t id, struct nexthop_group *nhg, afi_t rt_afi); | |
3057df51 | 203 | |
5948f013 SW |
204 | /* Reference counter functions */ |
205 | extern void zebra_nhg_decrement_ref(struct nhg_hash_entry *nhe); | |
206 | extern void zebra_nhg_increment_ref(struct nhg_hash_entry *nhe); | |
144a1b34 | 207 | |
5948f013 SW |
208 | /* Check validity of nhe, if invalid will update dependents as well */ |
209 | extern void zebra_nhg_check_valid(struct nhg_hash_entry *nhe); | |
210 | ||
211 | /* Convert nhe depends to a grp context that can be passed around safely */ | |
8dbc800f SW |
212 | extern uint8_t zebra_nhg_nhe2grp(struct nh_grp *grp, struct nhg_hash_entry *nhe, |
213 | int size); | |
98cda54a | 214 | |
5948f013 SW |
215 | /* Dataplane install/uninstall */ |
216 | extern void zebra_nhg_install_kernel(struct nhg_hash_entry *nhe); | |
217 | extern void zebra_nhg_uninstall_kernel(struct nhg_hash_entry *nhe); | |
147bad16 | 218 | |
0c8215cb SW |
219 | /* Forward ref of dplane update context type */ |
220 | struct zebra_dplane_ctx; | |
5948f013 SW |
221 | extern void zebra_nhg_dplane_result(struct zebra_dplane_ctx *ctx); |
222 | ||
38e40db1 | 223 | |
5948f013 SW |
224 | /* Sweet the nhg hash tables for old entries on restart */ |
225 | extern void zebra_nhg_sweep_table(struct hash *hash); | |
226 | ||
227 | /* Nexthop resolution processing */ | |
5463ce26 | 228 | struct route_entry; /* Forward ref to avoid circular includes */ |
5948f013 | 229 | extern int nexthop_active_update(struct route_node *rn, struct route_entry *re); |
ad28e79a | 230 | #endif |