]>
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" |
8736158a | 29 | |
b72ede27 | 30 | /* The default VRF ID */ |
a9ff90c4 | 31 | #define VRF_UNKNOWN UINT32_MAX |
b72ede27 | 32 | |
216b18ef DS |
33 | /* Pending: May need to refine this. */ |
34 | #ifndef IFLA_VRF_MAX | |
d62a17ae | 35 | enum { IFLA_VRF_UNSPEC, IFLA_VRF_TABLE, __IFLA_VRF_MAX }; |
216b18ef DS |
36 | |
37 | #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1) | |
38 | #endif | |
39 | ||
40 | #define VRF_NAMSIZ 36 | |
4691b65a | 41 | #define NS_NAMSIZ 16 |
216b18ef DS |
42 | |
43 | #define VRF_DEFAULT_NAME "Default-IP-Routing-Table" | |
44 | ||
8736158a FL |
45 | /* |
46 | * The command strings | |
47 | */ | |
216b18ef | 48 | #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n" |
8736158a | 49 | #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n" |
ecffa493 | 50 | #define VRF_FULL_CMD_HELP_STR "Specify the VRF\nThe VRF name\nAll VRFs\n" |
8736158a | 51 | |
1da29456 DS |
52 | /* |
53 | * Pass some OS specific data up through | |
54 | * to the daemons | |
55 | */ | |
d62a17ae | 56 | struct vrf_data { |
57 | union { | |
58 | struct { | |
59 | uint32_t table_id; | |
4691b65a | 60 | char netns_name[NS_NAMSIZ]; |
d62a17ae | 61 | } l; |
62 | }; | |
1da29456 DS |
63 | }; |
64 | ||
d62a17ae | 65 | struct vrf { |
66 | RB_ENTRY(vrf) id_entry, name_entry; | |
1a1a7065 | 67 | |
d62a17ae | 68 | /* Identifier, same as the vector index */ |
69 | vrf_id_t vrf_id; | |
216b18ef | 70 | |
d62a17ae | 71 | /* Name */ |
72 | char name[VRF_NAMSIZ + 1]; | |
216b18ef | 73 | |
d62a17ae | 74 | /* Zebra internal VRF status */ |
75 | u_char status; | |
84915b0a | 76 | #define VRF_ACTIVE (1 << 0) /* VRF is up in kernel */ |
22bd3e94 | 77 | #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */ |
216b18ef | 78 | |
f4e14fdb RW |
79 | /* Interfaces belonging to this VRF */ |
80 | struct if_name_head ifaces_by_name; | |
ff880b78 | 81 | struct if_index_head ifaces_by_index; |
216b18ef | 82 | |
d62a17ae | 83 | /* User data */ |
84 | void *info; | |
e80e7cce | 85 | |
d62a17ae | 86 | /* The table_id from the kernel */ |
87 | struct vrf_data data; | |
1da29456 | 88 | |
b95c1883 PG |
89 | /* Back pointer to namespace context */ |
90 | void *ns_ctxt; | |
91 | ||
d62a17ae | 92 | QOBJ_FIELDS |
216b18ef | 93 | }; |
d62a17ae | 94 | RB_HEAD(vrf_id_head, vrf); |
95 | RB_PROTOTYPE(vrf_id_head, vrf, id_entry, vrf_id_compare) | |
96 | RB_HEAD(vrf_name_head, vrf); | |
97 | RB_PROTOTYPE(vrf_name_head, vrf, name_entry, vrf_name_compare) | |
e80e7cce | 98 | DECLARE_QOBJ_TYPE(vrf) |
216b18ef | 99 | |
78dd30b2 PG |
100 | /* Allow VRF with netns as backend */ |
101 | #define VRF_BACKEND_VRF_LITE 0 | |
102 | #define VRF_BACKEND_NETNS 1 | |
216b18ef | 103 | |
1a1a7065 | 104 | extern struct vrf_id_head vrfs_by_id; |
806f8760 | 105 | extern struct vrf_name_head vrfs_by_name; |
216b18ef | 106 | |
d62a17ae | 107 | extern struct vrf *vrf_lookup_by_id(vrf_id_t); |
108 | extern struct vrf *vrf_lookup_by_name(const char *); | |
109 | extern struct vrf *vrf_get(vrf_id_t, const char *); | |
523cafc4 | 110 | extern const char *vrf_id_to_name(vrf_id_t vrf_id); |
d62a17ae | 111 | extern vrf_id_t vrf_name_to_id(const char *); |
112 | ||
113 | #define VRF_GET_ID(V, NAME) \ | |
114 | do { \ | |
115 | struct vrf *vrf; \ | |
116 | if (!(vrf = vrf_lookup_by_name(NAME))) { \ | |
117 | vty_out(vty, "%% VRF %s not found\n", NAME); \ | |
118 | return CMD_WARNING; \ | |
119 | } \ | |
120 | if (vrf->vrf_id == VRF_UNKNOWN) { \ | |
121 | vty_out(vty, "%% VRF %s not active\n", NAME); \ | |
122 | return CMD_WARNING; \ | |
123 | } \ | |
124 | (V) = vrf->vrf_id; \ | |
125 | } while (0) | |
216b18ef | 126 | |
84915b0a | 127 | /* |
128 | * Check whether the VRF is enabled. | |
129 | */ | |
130 | static inline int vrf_is_enabled(struct vrf *vrf) | |
131 | { | |
132 | return vrf && CHECK_FLAG(vrf->status, VRF_ACTIVE); | |
133 | } | |
134 | ||
135 | /* check if the vrf is user configured */ | |
136 | static inline int vrf_is_user_cfged(struct vrf *vrf) | |
137 | { | |
138 | return vrf && CHECK_FLAG(vrf->status, VRF_CONFIGURED); | |
139 | } | |
140 | ||
22bd3e94 | 141 | /* Mark that VRF has user configuration */ |
142 | static inline void vrf_set_user_cfged(struct vrf *vrf) | |
143 | { | |
144 | SET_FLAG(vrf->status, VRF_CONFIGURED); | |
145 | } | |
146 | ||
147 | /* Mark that VRF no longer has any user configuration */ | |
148 | static inline void vrf_reset_user_cfged(struct vrf *vrf) | |
149 | { | |
150 | UNSET_FLAG(vrf->status, VRF_CONFIGURED); | |
151 | } | |
152 | ||
b72ede27 FL |
153 | /* |
154 | * Utilities to obtain the user data | |
155 | */ | |
156 | ||
157 | /* Get the data pointer of the specified VRF. If not found, create one. */ | |
d62a17ae | 158 | extern void *vrf_info_get(vrf_id_t); |
b72ede27 | 159 | /* Look up the data pointer of the specified VRF. */ |
d62a17ae | 160 | extern void *vrf_info_lookup(vrf_id_t); |
b72ede27 | 161 | |
7076bb2f FL |
162 | /* |
163 | * VRF bit-map: maintaining flags, one bit per VRF ID | |
164 | */ | |
165 | ||
d62a17ae | 166 | typedef void *vrf_bitmap_t; |
7076bb2f FL |
167 | #define VRF_BITMAP_NULL NULL |
168 | ||
d62a17ae | 169 | extern vrf_bitmap_t vrf_bitmap_init(void); |
170 | extern void vrf_bitmap_free(vrf_bitmap_t); | |
171 | extern void vrf_bitmap_set(vrf_bitmap_t, vrf_id_t); | |
172 | extern void vrf_bitmap_unset(vrf_bitmap_t, vrf_id_t); | |
173 | extern int vrf_bitmap_check(vrf_bitmap_t, vrf_id_t); | |
7076bb2f | 174 | |
b72ede27 FL |
175 | /* |
176 | * VRF initializer/destructor | |
97b1a80c DS |
177 | * |
178 | * create -> Called back when a new VRF is created. This | |
179 | * can be either through these 3 options: | |
180 | * 1) CLI mentions a vrf before OS knows about it | |
181 | * 2) OS calls zebra and we create the vrf from OS | |
182 | * callback | |
183 | * 3) zebra calls individual protocols to notify | |
184 | * about the new vrf | |
185 | * | |
186 | * enable -> Called back when a VRF is actually usable from | |
187 | * an OS perspective ( 2 and 3 above ) | |
188 | * | |
189 | * disable -> Called back when a VRF is being deleted from | |
190 | * the system ( 2 and 3 ) above | |
191 | * | |
192 | * delete -> Called back when a vrf is being deleted from | |
193 | * the system ( 2 and 3 ) above. | |
b72ede27 | 194 | */ |
d62a17ae | 195 | extern void vrf_init(int (*create)(struct vrf *), int (*enable)(struct vrf *), |
196 | int (*disable)(struct vrf *), int (*delete)(struct vrf *)); | |
97b1a80c DS |
197 | /* |
198 | * Call vrf_terminate when the protocol is being shutdown | |
b72ede27 | 199 | */ |
d62a17ae | 200 | extern void vrf_terminate(void); |
b72ede27 | 201 | |
d62a17ae | 202 | extern void vrf_cmd_init(int (*writefunc)(struct vty *vty)); |
7ddcfca4 | 203 | |
e5bf3e1e FL |
204 | /* |
205 | * VRF utilities | |
206 | */ | |
ec31f30d | 207 | extern vrf_id_t vrf_get_default_id(void); |
e5bf3e1e FL |
208 | |
209 | /* Create a socket serving for the given VRF */ | |
d62a17ae | 210 | extern int vrf_socket(int, int, int, vrf_id_t); |
78dd30b2 PG |
211 | extern void vrf_configure_backend(int vrf_backend_netns); |
212 | extern int vrf_get_backend(void); | |
213 | extern int vrf_is_backend_netns(void); | |
697d3ec7 PG |
214 | extern int vrf_handler_create(struct vty *vty, |
215 | const char *name, | |
216 | struct vrf **vrf); | |
217 | ||
ce1be369 PG |
218 | /* VRF is mapped on netns or not ? */ |
219 | int vrf_is_mapped_on_netns(vrf_id_t vrf_id); | |
220 | ||
221 | /* VRF switch from NETNS */ | |
222 | extern int vrf_switch_to_netns(vrf_id_t vrf_id); | |
223 | extern int vrf_switchback_to_initial(void); | |
224 | ||
697d3ec7 PG |
225 | /* used by NS when vrf backend is NS. |
226 | * Notify a change in the VRF ID of the VRF | |
227 | */ | |
228 | extern int vrf_update_vrf_id(vrf_id_t vrf_id, struct vrf *vrf); | |
229 | extern void vrf_disable(struct vrf *vrf); | |
230 | extern int vrf_enable(struct vrf *vrf); | |
e5bf3e1e | 231 | |
19dc275e DS |
232 | /* |
233 | * VRF Debugging | |
234 | */ | |
d62a17ae | 235 | extern void vrf_install_commands(void); |
ec31f30d PG |
236 | |
237 | ||
238 | /* The default VRF ID */ | |
239 | #define VRF_DEFAULT vrf_get_default_id() | |
240 | ||
b72ede27 | 241 | #endif /*_ZEBRA_VRF_H*/ |