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 #define VRF_BACKEND_VRF_LITE 0
105 #define VRF_BACKEND_NETNS 1
106 #define VRF_BACKEND_UNKNOWN 2
108 extern struct vrf_id_head vrfs_by_id
;
109 extern struct vrf_name_head vrfs_by_name
;
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 *);
114 extern const char *vrf_id_to_name(vrf_id_t vrf_id
);
115 extern vrf_id_t
vrf_name_to_id(const char *);
116 extern vrf_id_t
vrf_to_id(struct vrf
*vrf
);
117 extern const char *vrf_to_name(struct vrf
*vrf
);
119 /* vrf context is searched and created
121 #define VRF_GET_INSTANCE(V, NAME, USE_JSON, FORCE_CREATION) \
125 if (!(_vrf = vrf_lookup_by_name(NAME))) { \
126 if (!FORCE_CREATION) { \
128 vty_out(vty, "{}\n"); \
130 vty_out(vty, "%% VRF %s not found\n", \
133 return CMD_WARNING; \
135 _vrf = vrf_get(VRF_UNKNOWN, NAME); \
137 if (_vrf->vrf_id == VRF_UNKNOWN) { \
139 vty_out(vty, "{}\n"); \
141 vty_out(vty, "%% VRF %s not active\n", NAME); \
147 #define VRF_GET_ID(V, NAME, USE_JSON) \
150 if (!(_vrf = vrf_lookup_by_name(NAME))) { \
152 vty_out(vty, "{}\n"); \
154 vty_out(vty, "%% VRF %s not found\n", NAME); \
156 return CMD_WARNING; \
158 if (_vrf->vrf_id == VRF_UNKNOWN) { \
160 vty_out(vty, "{}\n"); \
162 vty_out(vty, "%% VRF %s not active\n", NAME); \
164 return CMD_WARNING; \
166 (V) = _vrf->vrf_id; \
170 * Check whether the VRF is enabled.
172 static inline int vrf_is_enabled(struct vrf
*vrf
)
174 return vrf
&& CHECK_FLAG(vrf
->status
, VRF_ACTIVE
);
177 /* check if the vrf is user configured */
178 static inline int vrf_is_user_cfged(struct vrf
*vrf
)
180 return vrf
&& CHECK_FLAG(vrf
->status
, VRF_CONFIGURED
);
183 /* Mark that VRF has user configuration */
184 static inline void vrf_set_user_cfged(struct vrf
*vrf
)
186 SET_FLAG(vrf
->status
, VRF_CONFIGURED
);
189 /* Mark that VRF no longer has any user configuration */
190 static inline void vrf_reset_user_cfged(struct vrf
*vrf
)
192 UNSET_FLAG(vrf
->status
, VRF_CONFIGURED
);
196 * Utilities to obtain the user data
199 /* Get the data pointer of the specified VRF. If not found, create one. */
200 extern void *vrf_info_get(vrf_id_t
);
201 /* Look up the data pointer of the specified VRF. */
202 extern void *vrf_info_lookup(vrf_id_t
);
205 * VRF bit-map: maintaining flags, one bit per VRF ID
208 typedef void *vrf_bitmap_t
;
209 #define VRF_BITMAP_NULL NULL
211 extern vrf_bitmap_t
vrf_bitmap_init(void);
212 extern void vrf_bitmap_free(vrf_bitmap_t
);
213 extern void vrf_bitmap_set(vrf_bitmap_t
, vrf_id_t
);
214 extern void vrf_bitmap_unset(vrf_bitmap_t
, vrf_id_t
);
215 extern int vrf_bitmap_check(vrf_bitmap_t
, vrf_id_t
);
218 * VRF initializer/destructor
220 * create -> Called back when a new VRF is created. This
221 * can be either through these 3 options:
222 * 1) CLI mentions a vrf before OS knows about it
223 * 2) OS calls zebra and we create the vrf from OS
225 * 3) zebra calls individual protocols to notify
228 * enable -> Called back when a VRF is actually usable from
229 * an OS perspective ( 2 and 3 above )
231 * disable -> Called back when a VRF is being deleted from
232 * the system ( 2 and 3 ) above
234 * delete -> Called back when a vrf is being deleted from
235 * the system ( 2 and 3 ) above.
237 extern void vrf_init(int (*create
)(struct vrf
*vrf
), int (*enable
)(struct vrf
*vrf
),
238 int (*disable
)(struct vrf
*vrf
), int (*destroy
)(struct vrf
*vrf
),
239 int (*update
)(struct vrf
*vrf
));
242 * Call vrf_terminate when the protocol is being shutdown
244 extern void vrf_terminate(void);
247 * Utilities to create networks objects,
248 * or call network operations
251 /* Create a socket serving for the given VRF */
252 extern int vrf_socket(int domain
, int type
, int protocol
, vrf_id_t vrf_id
,
255 extern int vrf_sockunion_socket(const union sockunion
*su
, vrf_id_t vrf_id
,
258 extern int vrf_bind(vrf_id_t vrf_id
, int fd
, const char *name
);
260 /* VRF ioctl operations */
261 extern int vrf_getaddrinfo(const char *node
, const char *service
,
262 const struct addrinfo
*hints
, struct addrinfo
**res
,
265 extern int vrf_ioctl(vrf_id_t vrf_id
, int d
, unsigned long request
, char *args
);
267 /* function called by macro VRF_DEFAULT
268 * to get the default VRF_ID
270 extern vrf_id_t
vrf_get_default_id(void);
271 /* The default VRF ID */
272 #define VRF_DEFAULT vrf_get_default_id()
274 extern void vrf_set_default_name(const char *default_name
, bool force
);
275 extern const char *vrf_get_default_name(void);
276 #define VRF_DEFAULT_NAME vrf_get_default_name()
278 /* VRF switch from NETNS */
279 extern int vrf_switch_to_netns(vrf_id_t vrf_id
);
280 extern int vrf_switchback_to_initial(void);
283 * VRF backend routines
284 * should be called from zebra only
287 /* VRF vty command initialisation
289 extern void vrf_cmd_init(int (*writefunc
)(struct vty
*vty
),
290 struct zebra_privs_t
*daemon_priv
);
294 extern void vrf_install_commands(void);
300 /* API for configuring VRF backend
301 * should be called from zebra only
303 extern void vrf_configure_backend(int vrf_backend_netns
);
304 extern int vrf_get_backend(void);
305 extern int vrf_is_backend_netns(void);
308 /* API to create a VRF. either from vty
309 * or through discovery
311 extern int vrf_handler_create(struct vty
*vty
, const char *name
,
314 /* API to associate a VRF with a NETNS.
315 * called either from vty or through discovery
316 * should be called from zebra only
318 extern int vrf_netns_handler_create(struct vty
*vty
, struct vrf
*vrf
,
319 char *pathname
, ns_id_t ext_ns_id
,
322 /* used internally to enable or disable VRF.
323 * Notify a change in the VRF ID of the VRF
325 extern void vrf_disable(struct vrf
*vrf
);
326 extern int vrf_enable(struct vrf
*vrf
);
327 extern void vrf_delete(struct vrf
*vrf
);
328 extern vrf_id_t
vrf_generate_id(void);
334 #endif /*_ZEBRA_VRF_H*/