]>
Commit | Line | Data |
---|---|---|
b72ede27 FL |
1 | /* |
2 | * VRF related header. | |
3 | * Copyright (C) 2014 6WIND S.A. | |
4 | * | |
5 | * This file is part of GNU Zebra. | |
6 | * | |
7 | * GNU Zebra is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published | |
9 | * by the Free Software Foundation; either version 2, or (at your | |
10 | * option) any later version. | |
11 | * | |
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. | |
16 | * | |
896014f4 DL |
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 | |
b72ede27 FL |
20 | */ |
21 | ||
22 | #ifndef _ZEBRA_VRF_H | |
23 | #define _ZEBRA_VRF_H | |
24 | ||
1a1a7065 | 25 | #include "openbsd-tree.h" |
8736158a | 26 | #include "linklist.h" |
e80e7cce | 27 | #include "qobj.h" |
7ddcfca4 | 28 | #include "vty.h" |
e26aedbe | 29 | #include "ns.h" |
8736158a | 30 | |
5e244469 RW |
31 | #ifdef __cplusplus |
32 | extern "C" { | |
33 | #endif | |
34 | ||
b72ede27 | 35 | /* The default VRF ID */ |
a9ff90c4 | 36 | #define VRF_UNKNOWN UINT32_MAX |
b72ede27 | 37 | |
216b18ef DS |
38 | /* Pending: May need to refine this. */ |
39 | #ifndef IFLA_VRF_MAX | |
d62a17ae | 40 | enum { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX }; |
216b18ef DS |
41 | |
42 | #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1) | |
43 | #endif | |
44 | ||
45 | #define VRF_NAMSIZ 36 | |
990374e1 | 46 | #define NS_NAMSIZ 36 |
216b18ef | 47 | |
8736158a FL |
48 | /* |
49 | * The command strings | |
50 | */ | |
216b18ef | 51 | #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n" |
8736158a | 52 | #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n" |
ecffa493 | 53 | #define VRF_FULL_CMD_HELP_STR "Specify the VRF\nThe VRF name\nAll VRFs\n" |
8736158a | 54 | |
09b150ef IR |
55 | #define FRR_VRF_XPATH "/frr-vrf:lib/vrf" |
56 | #define FRR_VRF_KEY_XPATH "/frr-vrf:lib/vrf[name='%s']" | |
57 | ||
1da29456 DS |
58 | /* |
59 | * Pass some OS specific data up through | |
60 | * to the daemons | |
61 | */ | |
d62a17ae | 62 | struct vrf_data { |
63 | union { | |
64 | struct { | |
65 | uint32_t table_id; | |
4691b65a | 66 | char netns_name[NS_NAMSIZ]; |
d62a17ae | 67 | } l; |
68 | }; | |
1da29456 DS |
69 | }; |
70 | ||
d62a17ae | 71 | struct vrf { |
72 | RB_ENTRY(vrf) id_entry, name_entry; | |
1a1a7065 | 73 | |
d62a17ae | 74 | /* Identifier, same as the vector index */ |
75 | vrf_id_t vrf_id; | |
216b18ef | 76 | |
d62a17ae | 77 | /* Name */ |
78 | char name[VRF_NAMSIZ + 1]; | |
216b18ef | 79 | |
d62a17ae | 80 | /* Zebra internal VRF status */ |
d7c0a89a | 81 | uint8_t status; |
84915b0a | 82 | #define VRF_ACTIVE (1 << 0) /* VRF is up in kernel */ |
22bd3e94 | 83 | #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */ |
216b18ef | 84 | |
f4e14fdb RW |
85 | /* Interfaces belonging to this VRF */ |
86 | struct if_name_head ifaces_by_name; | |
ff880b78 | 87 | struct if_index_head ifaces_by_index; |
216b18ef | 88 | |
d62a17ae | 89 | /* User data */ |
90 | void *info; | |
e80e7cce | 91 | |
d62a17ae | 92 | /* The table_id from the kernel */ |
93 | struct vrf_data data; | |
1da29456 | 94 | |
b95c1883 PG |
95 | /* Back pointer to namespace context */ |
96 | void *ns_ctxt; | |
97 | ||
96244aca | 98 | QOBJ_FIELDS; |
216b18ef | 99 | }; |
d62a17ae | 100 | RB_HEAD(vrf_id_head, vrf); |
101 | RB_PROTOTYPE(vrf_id_head, vrf, id_entry, vrf_id_compare) | |
102 | RB_HEAD(vrf_name_head, vrf); | |
103 | RB_PROTOTYPE(vrf_name_head, vrf, name_entry, vrf_name_compare) | |
96244aca | 104 | DECLARE_QOBJ_TYPE(vrf); |
216b18ef | 105 | |
78dd30b2 | 106 | /* Allow VRF with netns as backend */ |
7239d3d9 QY |
107 | enum vrf_backend_type { |
108 | VRF_BACKEND_VRF_LITE, | |
109 | VRF_BACKEND_NETNS, | |
110 | VRF_BACKEND_UNKNOWN, | |
111 | VRF_BACKEND_MAX, | |
112 | }; | |
216b18ef | 113 | |
1a1a7065 | 114 | extern struct vrf_id_head vrfs_by_id; |
806f8760 | 115 | extern struct vrf_name_head vrfs_by_name; |
216b18ef | 116 | |
d62a17ae | 117 | extern struct vrf *vrf_lookup_by_id(vrf_id_t); |
118 | extern struct vrf *vrf_lookup_by_name(const char *); | |
119 | extern struct vrf *vrf_get(vrf_id_t, const char *); | |
75d26fb3 | 120 | extern struct vrf *vrf_update(vrf_id_t new_vrf_id, const char *name); |
523cafc4 | 121 | extern const char *vrf_id_to_name(vrf_id_t vrf_id); |
d62a17ae | 122 | extern vrf_id_t vrf_name_to_id(const char *); |
ac6c2a11 | 123 | |
b7e48f21 DS |
124 | #define VRF_LOGNAME(V) V ? V->name : "Unknown" |
125 | ||
ec1db588 | 126 | #define VRF_GET_ID(V, NAME, USE_JSON) \ |
d62a17ae | 127 | do { \ |
7fe96307 A |
128 | struct vrf *_vrf; \ |
129 | if (!(_vrf = vrf_lookup_by_name(NAME))) { \ | |
ec1db588 NVG |
130 | if (USE_JSON) { \ |
131 | vty_out(vty, "{}\n"); \ | |
132 | } else { \ | |
133 | vty_out(vty, "%% VRF %s not found\n", NAME); \ | |
134 | } \ | |
d62a17ae | 135 | return CMD_WARNING; \ |
136 | } \ | |
7fe96307 | 137 | if (_vrf->vrf_id == VRF_UNKNOWN) { \ |
ec1db588 NVG |
138 | if (USE_JSON) { \ |
139 | vty_out(vty, "{}\n"); \ | |
140 | } else { \ | |
141 | vty_out(vty, "%% VRF %s not active\n", NAME); \ | |
142 | } \ | |
d62a17ae | 143 | return CMD_WARNING; \ |
144 | } \ | |
7fe96307 | 145 | (V) = _vrf->vrf_id; \ |
d62a17ae | 146 | } while (0) |
216b18ef | 147 | |
84915b0a | 148 | /* |
149 | * Check whether the VRF is enabled. | |
150 | */ | |
151 | static inline int vrf_is_enabled(struct vrf *vrf) | |
152 | { | |
153 | return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE); | |
154 | } | |
155 | ||
156 | /* check if the vrf is user configured */ | |
157 | static inline int vrf_is_user_cfged(struct vrf *vrf) | |
158 | { | |
159 | return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED); | |
160 | } | |
161 | ||
8e037331 PR |
162 | static inline uint32_t vrf_interface_count(struct vrf *vrf) |
163 | { | |
164 | uint32_t count = 0; | |
165 | struct interface *ifp; | |
166 | ||
167 | RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name) { | |
168 | /* skip the l3mdev */ | |
169 | if (strncmp(ifp->name, vrf->name, VRF_NAMSIZ) == 0) | |
170 | continue; | |
171 | count++; | |
172 | } | |
173 | return count; | |
174 | } | |
175 | ||
b72ede27 FL |
176 | /* |
177 | * Utilities to obtain the user data | |
178 | */ | |
179 | ||
180 | /* Get the data pointer of the specified VRF. If not found, create one. */ | |
d62a17ae | 181 | extern void *vrf_info_get(vrf_id_t); |
b72ede27 | 182 | /* Look up the data pointer of the specified VRF. */ |
d62a17ae | 183 | extern void *vrf_info_lookup(vrf_id_t); |
b72ede27 | 184 | |
7076bb2f FL |
185 | /* |
186 | * VRF bit-map: maintaining flags, one bit per VRF ID | |
187 | */ | |
188 | ||
d62a17ae | 189 | typedef void *vrf_bitmap_t; |
7076bb2f FL |
190 | #define VRF_BITMAP_NULL NULL |
191 | ||
d62a17ae | 192 | extern vrf_bitmap_t vrf_bitmap_init(void); |
193 | extern void vrf_bitmap_free(vrf_bitmap_t); | |
194 | extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t); | |
195 | extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t); | |
196 | extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t); | |
7076bb2f | 197 | |
b72ede27 FL |
198 | /* |
199 | * VRF initializer/destructor | |
97b1a80c DS |
200 | * |
201 | * create -> Called back when a new VRF is created. This | |
202 | * can be either through these 3 options: | |
203 | * 1) CLI mentions a vrf before OS knows about it | |
204 | * 2) OS calls zebra and we create the vrf from OS | |
205 | * callback | |
206 | * 3) zebra calls individual protocols to notify | |
207 | * about the new vrf | |
208 | * | |
209 | * enable -> Called back when a VRF is actually usable from | |
210 | * an OS perspective ( 2 and 3 above ) | |
211 | * | |
212 | * disable -> Called back when a VRF is being deleted from | |
213 | * the system ( 2 and 3 ) above | |
214 | * | |
215 | * delete -> Called back when a vrf is being deleted from | |
216 | * the system ( 2 and 3 ) above. | |
b72ede27 | 217 | */ |
ecbc5a37 | 218 | extern void vrf_init(int (*create)(struct vrf *vrf), int (*enable)(struct vrf *vrf), |
d01b92fd | 219 | int (*disable)(struct vrf *vrf), int (*destroy)(struct vrf *vrf), |
1768243e | 220 | int (*update)(struct vrf *vrf)); |
ecbc5a37 | 221 | |
97b1a80c DS |
222 | /* |
223 | * Call vrf_terminate when the protocol is being shutdown | |
b72ede27 | 224 | */ |
d62a17ae | 225 | extern void vrf_terminate(void); |
b72ede27 | 226 | |
e5bf3e1e | 227 | /* |
e26aedbe PG |
228 | * Utilities to create networks objects, |
229 | * or call network operations | |
e5bf3e1e FL |
230 | */ |
231 | ||
79a80af8 QY |
232 | /* |
233 | * Create a new socket associated with a VRF. | |
234 | * | |
235 | * This is a wrapper that ensures correct behavior when using namespace VRFs. | |
236 | * In the namespace case, the socket is created within the namespace. In the | |
237 | * non-namespace case, this is equivalent to socket(). | |
238 | * | |
239 | * If name is provided, this is provided to vrf_bind() to bind the socket to | |
240 | * the VRF. This is only relevant when using VRF-lite. | |
241 | * | |
242 | * Summary: | |
243 | * - Namespace: pass vrf_id but not name | |
244 | * - VRF-lite: pass vrf_id and name of VRF device to bind to | |
245 | * - VRF-lite, no binding: pass vrf_id but not name, or just use socket() | |
246 | */ | |
996c9314 | 247 | extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id, |
02fe07c7 | 248 | const char *name); |
0f4977c6 | 249 | |
996c9314 | 250 | extern int vrf_sockunion_socket(const union sockunion *su, vrf_id_t vrf_id, |
02fe07c7 | 251 | const char *name); |
0f4977c6 | 252 | |
79a80af8 | 253 | /* |
36eef858 | 254 | * Binds a socket to an interface (ifname) in a VRF (vrf_id). |
79a80af8 | 255 | * |
36eef858 IR |
256 | * If ifname is NULL or is equal to the VRF name then bind to a VRF device. |
257 | * Otherwise, bind to the specified interface in the specified VRF. | |
79a80af8 | 258 | * |
36eef858 | 259 | * Returns 0 on success and -1 on failure. |
79a80af8 | 260 | */ |
36eef858 | 261 | extern int vrf_bind(vrf_id_t vrf_id, int fd, const char *ifname); |
ce1be369 | 262 | |
2e0d2b3d PG |
263 | /* VRF ioctl operations */ |
264 | extern int vrf_getaddrinfo(const char *node, const char *service, | |
996c9314 LB |
265 | const struct addrinfo *hints, struct addrinfo **res, |
266 | vrf_id_t vrf_id); | |
e26aedbe | 267 | |
516d7591 PG |
268 | extern int vrf_ioctl(vrf_id_t vrf_id, int d, unsigned long request, char *args); |
269 | ||
e26aedbe | 270 | /* The default VRF ID */ |
1eb92f06 | 271 | #define VRF_DEFAULT 0 |
e26aedbe | 272 | |
4fe52e76 | 273 | extern void vrf_set_default_name(const char *default_name, bool force); |
c200f5e1 PG |
274 | extern const char *vrf_get_default_name(void); |
275 | #define VRF_DEFAULT_NAME vrf_get_default_name() | |
276 | ||
2e0d2b3d PG |
277 | /* VRF switch from NETNS */ |
278 | extern int vrf_switch_to_netns(vrf_id_t vrf_id); | |
279 | extern int vrf_switchback_to_initial(void); | |
280 | ||
e26aedbe PG |
281 | /* |
282 | * VRF backend routines | |
283 | * should be called from zebra only | |
697d3ec7 | 284 | */ |
e5bf3e1e | 285 | |
e26aedbe PG |
286 | /* VRF vty command initialisation |
287 | */ | |
3bc34908 PG |
288 | extern void vrf_cmd_init(int (*writefunc)(struct vty *vty), |
289 | struct zebra_privs_t *daemon_priv); | |
e26aedbe PG |
290 | |
291 | /* VRF vty debugging | |
19dc275e | 292 | */ |
d62a17ae | 293 | extern void vrf_install_commands(void); |
ec31f30d | 294 | |
e26aedbe PG |
295 | /* |
296 | * VRF utilities | |
297 | */ | |
ec31f30d | 298 | |
7239d3d9 QY |
299 | /* |
300 | * API for configuring VRF backend | |
e26aedbe | 301 | */ |
7239d3d9 | 302 | extern int vrf_configure_backend(enum vrf_backend_type backend); |
e26aedbe PG |
303 | extern int vrf_get_backend(void); |
304 | extern int vrf_is_backend_netns(void); | |
305 | ||
306 | ||
307 | /* API to create a VRF. either from vty | |
308 | * or through discovery | |
309 | */ | |
996c9314 | 310 | extern int vrf_handler_create(struct vty *vty, const char *name, |
e26aedbe PG |
311 | struct vrf **vrf); |
312 | ||
313 | /* API to associate a VRF with a NETNS. | |
314 | * called either from vty or through discovery | |
315 | * should be called from zebra only | |
316 | */ | |
317 | extern int vrf_netns_handler_create(struct vty *vty, struct vrf *vrf, | |
03aff2d8 | 318 | char *pathname, ns_id_t ext_ns_id, |
20f4b2b0 | 319 | ns_id_t ns_id, ns_id_t rel_def_ns_id); |
e26aedbe PG |
320 | |
321 | /* used internally to enable or disable VRF. | |
322 | * Notify a change in the VRF ID of the VRF | |
323 | */ | |
324 | extern void vrf_disable(struct vrf *vrf); | |
325 | extern int vrf_enable(struct vrf *vrf); | |
0c902ba5 | 326 | extern void vrf_delete(struct vrf *vrf); |
0b014ea6 | 327 | extern vrf_id_t vrf_generate_id(void); |
ec31f30d | 328 | |
bc867a5d CS |
329 | extern const struct frr_yang_module_info frr_vrf_info; |
330 | ||
5e244469 RW |
331 | #ifdef __cplusplus |
332 | } | |
333 | #endif | |
334 | ||
b72ede27 | 335 | #endif /*_ZEBRA_VRF_H*/ |