3 * Copyright (C) 2014 6WIND S.A.
5 * This file is part of GNU Zebra.
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.
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.
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
25 #include "openbsd-tree.h"
35 /* The default VRF ID */
36 #define VRF_UNKNOWN UINT32_MAX
38 /* Pending: May need to refine this. */
40 enum { IFLA_VRF_UNSPEC
, IFLA_VRF_TABLE
, __IFLA_VRF_MAX
};
42 #define IFLA_VRF_MAX (__IFLA_VRF_MAX - 1)
51 #define VRF_CMD_HELP_STR "Specify the VRF\nThe VRF name\n"
52 #define VRF_ALL_CMD_HELP_STR "Specify the VRF\nAll VRFs\n"
53 #define VRF_FULL_CMD_HELP_STR "Specify the VRF\nThe VRF name\nAll VRFs\n"
56 * Pass some OS specific data up through
63 char netns_name
[NS_NAMSIZ
];
69 RB_ENTRY(vrf
) id_entry
, name_entry
;
71 /* Identifier, same as the vector index */
75 char name
[VRF_NAMSIZ
+ 1];
77 /* Zebra internal VRF status */
79 #define VRF_ACTIVE (1 << 0) /* VRF is up in kernel */
80 #define VRF_CONFIGURED (1 << 1) /* VRF has some FRR configuration */
82 /* Interfaces belonging to this VRF */
83 struct if_name_head ifaces_by_name
;
84 struct if_index_head ifaces_by_index
;
89 /* The table_id from the kernel */
92 /* Back pointer to namespace context */
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
)
101 DECLARE_QOBJ_TYPE(vrf
)
103 /* Allow VRF with netns as backend */
104 enum vrf_backend_type
{
105 VRF_BACKEND_VRF_LITE
,
111 extern struct vrf_id_head vrfs_by_id
;
112 extern struct vrf_name_head vrfs_by_name
;
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 *);
117 extern const char *vrf_id_to_name(vrf_id_t vrf_id
);
118 extern vrf_id_t
vrf_name_to_id(const char *);
120 #define VRF_LOGNAME(V) V ? V->name : "Unknown"
122 #define VRF_GET_ID(V, NAME, USE_JSON) \
125 if (!(_vrf = vrf_lookup_by_name(NAME))) { \
127 vty_out(vty, "{}\n"); \
129 vty_out(vty, "%% VRF %s not found\n", NAME); \
131 return CMD_WARNING; \
133 if (_vrf->vrf_id == VRF_UNKNOWN) { \
135 vty_out(vty, "{}\n"); \
137 vty_out(vty, "%% VRF %s not active\n", NAME); \
139 return CMD_WARNING; \
141 (V) = _vrf->vrf_id; \
145 * Check whether the VRF is enabled.
147 static inline int vrf_is_enabled(struct vrf
*vrf
)
149 return vrf
&& CHECK_FLAG(vrf
->status
, VRF_ACTIVE
);
152 /* check if the vrf is user configured */
153 static inline int vrf_is_user_cfged(struct vrf
*vrf
)
155 return vrf
&& CHECK_FLAG(vrf
->status
, VRF_CONFIGURED
);
158 /* Mark that VRF has user configuration */
159 static inline void vrf_set_user_cfged(struct vrf
*vrf
)
161 SET_FLAG(vrf
->status
, VRF_CONFIGURED
);
164 /* Mark that VRF no longer has any user configuration */
165 static inline void vrf_reset_user_cfged(struct vrf
*vrf
)
167 UNSET_FLAG(vrf
->status
, VRF_CONFIGURED
);
171 * Utilities to obtain the user data
174 /* Get the data pointer of the specified VRF. If not found, create one. */
175 extern void *vrf_info_get(vrf_id_t
);
176 /* Look up the data pointer of the specified VRF. */
177 extern void *vrf_info_lookup(vrf_id_t
);
180 * VRF bit-map: maintaining flags, one bit per VRF ID
183 typedef void *vrf_bitmap_t
;
184 #define VRF_BITMAP_NULL NULL
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
);
193 * VRF initializer/destructor
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
200 * 3) zebra calls individual protocols to notify
203 * enable -> Called back when a VRF is actually usable from
204 * an OS perspective ( 2 and 3 above )
206 * disable -> Called back when a VRF is being deleted from
207 * the system ( 2 and 3 ) above
209 * delete -> Called back when a vrf is being deleted from
210 * the system ( 2 and 3 ) above.
212 extern void vrf_init(int (*create
)(struct vrf
*vrf
), int (*enable
)(struct vrf
*vrf
),
213 int (*disable
)(struct vrf
*vrf
), int (*destroy
)(struct vrf
*vrf
),
214 int (*update
)(struct vrf
*vrf
));
217 * Call vrf_terminate when the protocol is being shutdown
219 extern void vrf_terminate(void);
222 * Utilities to create networks objects,
223 * or call network operations
227 * Create a new socket associated with a VRF.
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().
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.
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()
241 extern int vrf_socket(int domain
, int type
, int protocol
, vrf_id_t vrf_id
,
244 extern int vrf_sockunion_socket(const union sockunion
*su
, vrf_id_t vrf_id
,
248 * Binds a socket to a VRF device.
250 * If name is null, the socket is not bound, irrespective of any other
253 * name should be the name of the VRF device. vrf_id should be the
254 * corresponding vrf_id (the ifindex of the device).
256 extern int vrf_bind(vrf_id_t vrf_id
, int fd
, const char *name
);
258 /* VRF ioctl operations */
259 extern int vrf_getaddrinfo(const char *node
, const char *service
,
260 const struct addrinfo
*hints
, struct addrinfo
**res
,
263 extern int vrf_ioctl(vrf_id_t vrf_id
, int d
, unsigned long request
, char *args
);
265 /* function called by macro VRF_DEFAULT
266 * to get the default VRF_ID
268 extern vrf_id_t
vrf_get_default_id(void);
269 /* The default VRF ID */
270 #define VRF_DEFAULT vrf_get_default_id()
272 extern void vrf_set_default_name(const char *default_name
, bool force
);
273 extern const char *vrf_get_default_name(void);
274 #define VRF_DEFAULT_NAME vrf_get_default_name()
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);
281 * VRF backend routines
282 * should be called from zebra only
285 /* VRF vty command initialisation
287 extern void vrf_cmd_init(int (*writefunc
)(struct vty
*vty
),
288 struct zebra_privs_t
*daemon_priv
);
292 extern void vrf_install_commands(void);
299 * API for configuring VRF backend
301 extern int vrf_configure_backend(enum vrf_backend_type backend
);
302 extern int vrf_get_backend(void);
303 extern int vrf_is_backend_netns(void);
306 /* API to create a VRF. either from vty
307 * or through discovery
309 extern int vrf_handler_create(struct vty
*vty
, const char *name
,
312 /* API to associate a VRF with a NETNS.
313 * called either from vty or through discovery
314 * should be called from zebra only
316 extern int vrf_netns_handler_create(struct vty
*vty
, struct vrf
*vrf
,
317 char *pathname
, ns_id_t ext_ns_id
,
320 /* used internally to enable or disable VRF.
321 * Notify a change in the VRF ID of the VRF
323 extern void vrf_disable(struct vrf
*vrf
);
324 extern int vrf_enable(struct vrf
*vrf
);
325 extern void vrf_delete(struct vrf
*vrf
);
326 extern vrf_id_t
vrf_generate_id(void);
332 #endif /*_ZEBRA_VRF_H*/