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