]>
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 */ |
72261ecd PG |
104 | #define VRF_BACKEND_VRF_LITE 0 |
105 | #define VRF_BACKEND_NETNS 1 | |
106 | #define VRF_BACKEND_UNKNOWN 2 | |
216b18ef | 107 | |
1a1a7065 | 108 | extern struct vrf_id_head vrfs_by_id; |
806f8760 | 109 | extern struct vrf_name_head vrfs_by_name; |
216b18ef | 110 | |
d62a17ae | 111 | extern struct vrf *vrf_lookup_by_id(vrf_id_t); |
112 | extern struct vrf *vrf_lookup_by_name(const char *); | |
113 | extern struct vrf *vrf_get(vrf_id_t, const char *); | |
523cafc4 | 114 | extern const char *vrf_id_to_name(vrf_id_t vrf_id); |
d62a17ae | 115 | extern vrf_id_t vrf_name_to_id(const char *); |
116 | ||
ec1db588 | 117 | #define VRF_GET_ID(V, NAME, USE_JSON) \ |
d62a17ae | 118 | do { \ |
7fe96307 A |
119 | struct vrf *_vrf; \ |
120 | if (!(_vrf = vrf_lookup_by_name(NAME))) { \ | |
ec1db588 NVG |
121 | if (USE_JSON) { \ |
122 | vty_out(vty, "{}\n"); \ | |
123 | } else { \ | |
124 | vty_out(vty, "%% VRF %s not found\n", NAME); \ | |
125 | } \ | |
d62a17ae | 126 | return CMD_WARNING; \ |
127 | } \ | |
7fe96307 | 128 | if (_vrf->vrf_id == VRF_UNKNOWN) { \ |
ec1db588 NVG |
129 | if (USE_JSON) { \ |
130 | vty_out(vty, "{}\n"); \ | |
131 | } else { \ | |
132 | vty_out(vty, "%% VRF %s not active\n", NAME); \ | |
133 | } \ | |
d62a17ae | 134 | return CMD_WARNING; \ |
135 | } \ | |
7fe96307 | 136 | (V) = _vrf->vrf_id; \ |
d62a17ae | 137 | } while (0) |
216b18ef | 138 | |
84915b0a | 139 | /* |
140 | * Check whether the VRF is enabled. | |
141 | */ | |
142 | static inline int vrf_is_enabled(struct vrf *vrf) | |
143 | { | |
144 | return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE); | |
145 | } | |
146 | ||
147 | /* check if the vrf is user configured */ | |
148 | static inline int vrf_is_user_cfged(struct vrf *vrf) | |
149 | { | |
150 | return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED); | |
151 | } | |
152 | ||
22bd3e94 | 153 | /* Mark that VRF has user configuration */ |
154 | static inline void vrf_set_user_cfged(struct vrf *vrf) | |
155 | { | |
156 | SET_FLAG(vrf->status, VRF_CONFIGURED); | |
157 | } | |
158 | ||
159 | /* Mark that VRF no longer has any user configuration */ | |
160 | static inline void vrf_reset_user_cfged(struct vrf *vrf) | |
161 | { | |
162 | UNSET_FLAG(vrf->status, VRF_CONFIGURED); | |
163 | } | |
164 | ||
b72ede27 FL |
165 | /* |
166 | * Utilities to obtain the user data | |
167 | */ | |
168 | ||
169 | /* Get the data pointer of the specified VRF. If not found, create one. */ | |
d62a17ae | 170 | extern void *vrf_info_get(vrf_id_t); |
b72ede27 | 171 | /* Look up the data pointer of the specified VRF. */ |
d62a17ae | 172 | extern void *vrf_info_lookup(vrf_id_t); |
b72ede27 | 173 | |
7076bb2f FL |
174 | /* |
175 | * VRF bit-map: maintaining flags, one bit per VRF ID | |
176 | */ | |
177 | ||
d62a17ae | 178 | typedef void *vrf_bitmap_t; |
7076bb2f FL |
179 | #define VRF_BITMAP_NULL NULL |
180 | ||
d62a17ae | 181 | extern vrf_bitmap_t vrf_bitmap_init(void); |
182 | extern void vrf_bitmap_free(vrf_bitmap_t); | |
183 | extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t); | |
184 | extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t); | |
185 | extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t); | |
7076bb2f | 186 | |
b72ede27 FL |
187 | /* |
188 | * VRF initializer/destructor | |
97b1a80c DS |
189 | * |
190 | * create -> Called back when a new VRF is created. This | |
191 | * can be either through these 3 options: | |
192 | * 1) CLI mentions a vrf before OS knows about it | |
193 | * 2) OS calls zebra and we create the vrf from OS | |
194 | * callback | |
195 | * 3) zebra calls individual protocols to notify | |
196 | * about the new vrf | |
197 | * | |
198 | * enable -> Called back when a VRF is actually usable from | |
199 | * an OS perspective ( 2 and 3 above ) | |
200 | * | |
201 | * disable -> Called back when a VRF is being deleted from | |
202 | * the system ( 2 and 3 ) above | |
203 | * | |
204 | * delete -> Called back when a vrf is being deleted from | |
205 | * the system ( 2 and 3 ) above. | |
b72ede27 | 206 | */ |
ecbc5a37 | 207 | extern void vrf_init(int (*create)(struct vrf *vrf), int (*enable)(struct vrf *vrf), |
d01b92fd | 208 | int (*disable)(struct vrf *vrf), int (*destroy)(struct vrf *vrf), |
1768243e | 209 | int (*update)(struct vrf *vrf)); |
ecbc5a37 | 210 | |
97b1a80c DS |
211 | /* |
212 | * Call vrf_terminate when the protocol is being shutdown | |
b72ede27 | 213 | */ |
d62a17ae | 214 | extern void vrf_terminate(void); |
b72ede27 | 215 | |
e5bf3e1e | 216 | /* |
e26aedbe PG |
217 | * Utilities to create networks objects, |
218 | * or call network operations | |
e5bf3e1e FL |
219 | */ |
220 | ||
221 | /* Create a socket serving for the given VRF */ | |
996c9314 | 222 | extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id, |
02fe07c7 | 223 | const char *name); |
0f4977c6 | 224 | |
996c9314 | 225 | extern int vrf_sockunion_socket(const union sockunion *su, vrf_id_t vrf_id, |
02fe07c7 | 226 | const char *name); |
0f4977c6 | 227 | |
02fe07c7 | 228 | extern int vrf_bind(vrf_id_t vrf_id, int fd, const char *name); |
ce1be369 | 229 | |
2e0d2b3d PG |
230 | /* VRF ioctl operations */ |
231 | extern int vrf_getaddrinfo(const char *node, const char *service, | |
996c9314 LB |
232 | const struct addrinfo *hints, struct addrinfo **res, |
233 | vrf_id_t vrf_id); | |
e26aedbe | 234 | |
516d7591 PG |
235 | extern int vrf_ioctl(vrf_id_t vrf_id, int d, unsigned long request, char *args); |
236 | ||
e26aedbe PG |
237 | /* function called by macro VRF_DEFAULT |
238 | * to get the default VRF_ID | |
239 | */ | |
240 | extern vrf_id_t vrf_get_default_id(void); | |
241 | /* The default VRF ID */ | |
242 | #define VRF_DEFAULT vrf_get_default_id() | |
243 | ||
4fe52e76 | 244 | extern void vrf_set_default_name(const char *default_name, bool force); |
c200f5e1 PG |
245 | extern const char *vrf_get_default_name(void); |
246 | #define VRF_DEFAULT_NAME vrf_get_default_name() | |
247 | ||
2e0d2b3d PG |
248 | /* VRF switch from NETNS */ |
249 | extern int vrf_switch_to_netns(vrf_id_t vrf_id); | |
250 | extern int vrf_switchback_to_initial(void); | |
251 | ||
e26aedbe PG |
252 | /* |
253 | * VRF backend routines | |
254 | * should be called from zebra only | |
697d3ec7 | 255 | */ |
e5bf3e1e | 256 | |
e26aedbe PG |
257 | /* VRF vty command initialisation |
258 | */ | |
3bc34908 PG |
259 | extern void vrf_cmd_init(int (*writefunc)(struct vty *vty), |
260 | struct zebra_privs_t *daemon_priv); | |
e26aedbe PG |
261 | |
262 | /* VRF vty debugging | |
19dc275e | 263 | */ |
d62a17ae | 264 | extern void vrf_install_commands(void); |
ec31f30d | 265 | |
e26aedbe PG |
266 | /* |
267 | * VRF utilities | |
268 | */ | |
ec31f30d | 269 | |
e26aedbe PG |
270 | /* API for configuring VRF backend |
271 | * should be called from zebra only | |
272 | */ | |
273 | extern void vrf_configure_backend(int vrf_backend_netns); | |
274 | extern int vrf_get_backend(void); | |
275 | extern int vrf_is_backend_netns(void); | |
276 | ||
277 | ||
278 | /* API to create a VRF. either from vty | |
279 | * or through discovery | |
280 | */ | |
996c9314 | 281 | extern int vrf_handler_create(struct vty *vty, const char *name, |
e26aedbe PG |
282 | struct vrf **vrf); |
283 | ||
284 | /* API to associate a VRF with a NETNS. | |
285 | * called either from vty or through discovery | |
286 | * should be called from zebra only | |
287 | */ | |
288 | extern int vrf_netns_handler_create(struct vty *vty, struct vrf *vrf, | |
03aff2d8 PG |
289 | char *pathname, ns_id_t ext_ns_id, |
290 | ns_id_t ns_id); | |
e26aedbe PG |
291 | |
292 | /* used internally to enable or disable VRF. | |
293 | * Notify a change in the VRF ID of the VRF | |
294 | */ | |
295 | extern void vrf_disable(struct vrf *vrf); | |
296 | extern int vrf_enable(struct vrf *vrf); | |
0c902ba5 | 297 | extern void vrf_delete(struct vrf *vrf); |
0b014ea6 | 298 | extern vrf_id_t vrf_generate_id(void); |
ec31f30d | 299 | |
5e244469 RW |
300 | #ifdef __cplusplus |
301 | } | |
302 | #endif | |
303 | ||
b72ede27 | 304 | #endif /*_ZEBRA_VRF_H*/ |