]>
Commit | Line | Data |
---|---|---|
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 | * | |
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 | |
20 | */ | |
21 | ||
22 | #ifndef _ZEBRA_VRF_H | |
23 | #define _ZEBRA_VRF_H | |
24 | ||
25 | #include "openbsd-tree.h" | |
26 | #include "linklist.h" | |
27 | #include "qobj.h" | |
28 | #include "vty.h" | |
29 | #include "ns.h" | |
30 | ||
31 | /* The default VRF ID */ | |
32 | #define VRF_UNKNOWN UINT32_MAX | |
33 | ||
34 | /* Pending: May need to refine this. */ | |
35 | #ifndef IFLA_VRF_MAX | |
36 | enum { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX }; | |
37 | ||
38 | #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1) | |
39 | #endif | |
40 | ||
41 | #define VRF_NAMSIZ 36 | |
42 | #define NS_NAMSIZ 16 | |
43 | ||
44 | /* | |
45 | * The command strings | |
46 | */ | |
47 | #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n" | |
48 | #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n" | |
49 | #define VRF_FULL_CMD_HELP_STR "Specify the VRF\nThe VRF name\nAll VRFs\n" | |
50 | ||
51 | /* | |
52 | * Pass some OS specific data up through | |
53 | * to the daemons | |
54 | */ | |
55 | struct vrf_data { | |
56 | union { | |
57 | struct { | |
58 | uint32_t table_id; | |
59 | char netns_name[NS_NAMSIZ]; | |
60 | } l; | |
61 | }; | |
62 | }; | |
63 | ||
64 | struct vrf { | |
65 | RB_ENTRY(vrf) id_entry, name_entry; | |
66 | ||
67 | /* Identifier, same as the vector index */ | |
68 | vrf_id_t vrf_id; | |
69 | ||
70 | /* Name */ | |
71 | char name[VRF_NAMSIZ + 1]; | |
72 | ||
73 | /* Zebra internal VRF status */ | |
74 | uint8_t status; | |
75 | #define VRF_ACTIVE (1 << 0) /* VRF is up in kernel */ | |
76 | #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */ | |
77 | ||
78 | /* Interfaces belonging to this VRF */ | |
79 | struct if_name_head ifaces_by_name; | |
80 | struct if_index_head ifaces_by_index; | |
81 | ||
82 | /* User data */ | |
83 | void *info; | |
84 | ||
85 | /* The table_id from the kernel */ | |
86 | struct vrf_data data; | |
87 | ||
88 | /* Back pointer to namespace context */ | |
89 | void *ns_ctxt; | |
90 | ||
91 | QOBJ_FIELDS | |
92 | }; | |
93 | RB_HEAD(vrf_id_head, vrf); | |
94 | RB_PROTOTYPE(vrf_id_head, vrf, id_entry, vrf_id_compare) | |
95 | RB_HEAD(vrf_name_head, vrf); | |
96 | RB_PROTOTYPE(vrf_name_head, vrf, name_entry, vrf_name_compare) | |
97 | DECLARE_QOBJ_TYPE(vrf) | |
98 | ||
99 | /* Allow VRF with netns as backend */ | |
100 | #define VRF_BACKEND_VRF_LITE 0 | |
101 | #define VRF_BACKEND_NETNS 1 | |
102 | ||
103 | extern struct vrf_id_head vrfs_by_id; | |
104 | extern struct vrf_name_head vrfs_by_name; | |
105 | ||
106 | extern struct vrf *vrf_lookup_by_id(vrf_id_t); | |
107 | extern struct vrf *vrf_lookup_by_name(const char *); | |
108 | extern struct vrf *vrf_get(vrf_id_t, const char *); | |
109 | extern const char *vrf_id_to_name(vrf_id_t vrf_id); | |
110 | extern vrf_id_t vrf_name_to_id(const char *); | |
111 | ||
112 | #define VRF_GET_ID(V, NAME, USE_JSON) \ | |
113 | do { \ | |
114 | struct vrf *_vrf; \ | |
115 | if (!(_vrf = vrf_lookup_by_name(NAME))) { \ | |
116 | if (USE_JSON) { \ | |
117 | vty_out(vty, "{}\n"); \ | |
118 | } else { \ | |
119 | vty_out(vty, "%% VRF %s not found\n", NAME); \ | |
120 | } \ | |
121 | return CMD_WARNING; \ | |
122 | } \ | |
123 | if (_vrf->vrf_id == VRF_UNKNOWN) { \ | |
124 | if (USE_JSON) { \ | |
125 | vty_out(vty, "{}\n"); \ | |
126 | } else { \ | |
127 | vty_out(vty, "%% VRF %s not active\n", NAME); \ | |
128 | } \ | |
129 | return CMD_WARNING; \ | |
130 | } \ | |
131 | (V) = _vrf->vrf_id; \ | |
132 | } while (0) | |
133 | ||
134 | /* | |
135 | * Check whether the VRF is enabled. | |
136 | */ | |
137 | static inline int vrf_is_enabled(struct vrf *vrf) | |
138 | { | |
139 | return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE); | |
140 | } | |
141 | ||
142 | /* check if the vrf is user configured */ | |
143 | static inline int vrf_is_user_cfged(struct vrf *vrf) | |
144 | { | |
145 | return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED); | |
146 | } | |
147 | ||
148 | /* Mark that VRF has user configuration */ | |
149 | static inline void vrf_set_user_cfged(struct vrf *vrf) | |
150 | { | |
151 | SET_FLAG(vrf->status, VRF_CONFIGURED); | |
152 | } | |
153 | ||
154 | /* Mark that VRF no longer has any user configuration */ | |
155 | static inline void vrf_reset_user_cfged(struct vrf *vrf) | |
156 | { | |
157 | UNSET_FLAG(vrf->status, VRF_CONFIGURED); | |
158 | } | |
159 | ||
160 | /* | |
161 | * Utilities to obtain the user data | |
162 | */ | |
163 | ||
164 | /* Get the data pointer of the specified VRF. If not found, create one. */ | |
165 | extern void *vrf_info_get(vrf_id_t); | |
166 | /* Look up the data pointer of the specified VRF. */ | |
167 | extern void *vrf_info_lookup(vrf_id_t); | |
168 | ||
169 | /* | |
170 | * VRF bit-map: maintaining flags, one bit per VRF ID | |
171 | */ | |
172 | ||
173 | typedef void *vrf_bitmap_t; | |
174 | #define VRF_BITMAP_NULL NULL | |
175 | ||
176 | extern vrf_bitmap_t vrf_bitmap_init(void); | |
177 | extern void vrf_bitmap_free(vrf_bitmap_t); | |
178 | extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t); | |
179 | extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t); | |
180 | extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t); | |
181 | ||
182 | /* | |
183 | * VRF initializer/destructor | |
184 | * | |
185 | * create -> Called back when a new VRF is created. This | |
186 | * can be either through these 3 options: | |
187 | * 1) CLI mentions a vrf before OS knows about it | |
188 | * 2) OS calls zebra and we create the vrf from OS | |
189 | * callback | |
190 | * 3) zebra calls individual protocols to notify | |
191 | * about the new vrf | |
192 | * | |
193 | * enable -> Called back when a VRF is actually usable from | |
194 | * an OS perspective ( 2 and 3 above ) | |
195 | * | |
196 | * disable -> Called back when a VRF is being deleted from | |
197 | * the system ( 2 and 3 ) above | |
198 | * | |
199 | * delete -> Called back when a vrf is being deleted from | |
200 | * the system ( 2 and 3 ) above. | |
201 | */ | |
202 | extern void vrf_init(int (*create)(struct vrf *vrf), int (*enable)(struct vrf *vrf), | |
203 | int (*disable)(struct vrf *vrf), int (*delete)(struct vrf *vrf), | |
204 | int (*update)(struct vrf *vrf)); | |
205 | ||
206 | /* | |
207 | * Call vrf_terminate when the protocol is being shutdown | |
208 | */ | |
209 | extern void vrf_terminate(void); | |
210 | ||
211 | /* | |
212 | * Utilities to create networks objects, | |
213 | * or call network operations | |
214 | */ | |
215 | ||
216 | /* Create a socket serving for the given VRF */ | |
217 | extern int vrf_socket(int domain, int type, int protocol, vrf_id_t vrf_id, | |
218 | char *name); | |
219 | ||
220 | extern int vrf_sockunion_socket(const union sockunion *su, vrf_id_t vrf_id, | |
221 | char *name); | |
222 | ||
223 | extern int vrf_bind(vrf_id_t vrf_id, int fd, char *name); | |
224 | ||
225 | /* VRF ioctl operations */ | |
226 | extern int vrf_getaddrinfo(const char *node, const char *service, | |
227 | const struct addrinfo *hints, struct addrinfo **res, | |
228 | vrf_id_t vrf_id); | |
229 | ||
230 | extern int vrf_ioctl(vrf_id_t vrf_id, int d, unsigned long request, char *args); | |
231 | ||
232 | /* function called by macro VRF_DEFAULT | |
233 | * to get the default VRF_ID | |
234 | */ | |
235 | extern vrf_id_t vrf_get_default_id(void); | |
236 | /* The default VRF ID */ | |
237 | #define VRF_DEFAULT vrf_get_default_id() | |
238 | ||
239 | extern void vrf_set_default_name(const char *default_name); | |
240 | extern const char *vrf_get_default_name(void); | |
241 | #define VRF_DEFAULT_NAME vrf_get_default_name() | |
242 | ||
243 | /* VRF is mapped on netns or not ? */ | |
244 | int vrf_is_mapped_on_netns(struct vrf *vrf); | |
245 | ||
246 | /* VRF switch from NETNS */ | |
247 | extern int vrf_switch_to_netns(vrf_id_t vrf_id); | |
248 | extern int vrf_switchback_to_initial(void); | |
249 | ||
250 | /* | |
251 | * VRF backend routines | |
252 | * should be called from zebra only | |
253 | */ | |
254 | ||
255 | /* VRF vty command initialisation | |
256 | */ | |
257 | extern void vrf_cmd_init(int (*writefunc)(struct vty *vty), | |
258 | struct zebra_privs_t *daemon_priv); | |
259 | ||
260 | /* VRF vty debugging | |
261 | */ | |
262 | extern void vrf_install_commands(void); | |
263 | ||
264 | /* | |
265 | * VRF utilities | |
266 | */ | |
267 | ||
268 | /* API for configuring VRF backend | |
269 | * should be called from zebra only | |
270 | */ | |
271 | extern void vrf_configure_backend(int vrf_backend_netns); | |
272 | extern int vrf_get_backend(void); | |
273 | extern int vrf_is_backend_netns(void); | |
274 | ||
275 | ||
276 | /* API to create a VRF. either from vty | |
277 | * or through discovery | |
278 | */ | |
279 | extern int vrf_handler_create(struct vty *vty, const char *name, | |
280 | struct vrf **vrf); | |
281 | ||
282 | /* API to associate a VRF with a NETNS. | |
283 | * called either from vty or through discovery | |
284 | * should be called from zebra only | |
285 | */ | |
286 | extern int vrf_netns_handler_create(struct vty *vty, struct vrf *vrf, | |
287 | char *pathname, ns_id_t ext_ns_id, | |
288 | ns_id_t ns_id); | |
289 | ||
290 | /* used internally to enable or disable VRF. | |
291 | * Notify a change in the VRF ID of the VRF | |
292 | */ | |
293 | extern void vrf_disable(struct vrf *vrf); | |
294 | extern int vrf_enable(struct vrf *vrf); | |
295 | extern void vrf_delete(struct vrf *vrf); | |
296 | extern vrf_id_t vrf_generate_id(void); | |
297 | ||
298 | #endif /*_ZEBRA_VRF_H*/ |