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
33 DEFINE_MTYPE_STATIC(LIB
, VRF
, "VRF")
34 DEFINE_MTYPE_STATIC(LIB
, VRF_BITMAP
, "VRF bit-map")
38 static __inline
int vrf_id_compare(const struct vrf
*, const struct vrf
*);
39 static __inline
int vrf_name_compare(const struct vrf
*, const struct vrf
*);
41 RB_GENERATE(vrf_id_head
, vrf
, id_entry
, vrf_id_compare
);
42 RB_GENERATE(vrf_name_head
, vrf
, name_entry
, vrf_name_compare
);
44 struct vrf_id_head vrfs_by_id
= RB_INITIALIZER(&vrfs_by_id
);
45 struct vrf_name_head vrfs_by_name
= RB_INITIALIZER(&vrfs_by_name
);
48 * Turn on/off debug code
53 /* Holding VRF hooks */
55 int (*vrf_new_hook
)(struct vrf
*);
56 int (*vrf_delete_hook
)(struct vrf
*);
57 int (*vrf_enable_hook
)(struct vrf
*);
58 int (*vrf_disable_hook
)(struct vrf
*);
63 static int vrf_is_enabled(struct vrf
*vrf
);
64 static void vrf_disable(struct vrf
*vrf
);
66 /* VRF list existance check by name. */
67 struct vrf
*vrf_lookup_by_name(const char *name
)
70 strlcpy(vrf
.name
, name
, sizeof(vrf
.name
));
71 return (RB_FIND(vrf_name_head
, &vrfs_by_name
, &vrf
));
74 static __inline
int vrf_id_compare(const struct vrf
*a
, const struct vrf
*b
)
76 return (a
->vrf_id
- b
->vrf_id
);
79 static int vrf_name_compare(const struct vrf
*a
, const struct vrf
*b
)
81 return strcmp(a
->name
, b
->name
);
84 /* Get a VRF. If not found, create one.
86 * name - The name of the vrf. May be NULL if unknown.
87 * vrf_id - The vrf_id of the vrf. May be VRF_UNKNOWN if unknown
88 * Description: Please note that this routine can be called with just the name
91 struct vrf
*vrf_get(vrf_id_t vrf_id
, const char *name
)
93 struct vrf
*vrf
= NULL
;
97 zlog_debug("VRF_GET: %s(%u)", name
, vrf_id
);
99 /* Nothing to see, move along here */
100 if (!name
&& vrf_id
== VRF_UNKNOWN
)
103 /* Try to find VRF both by ID and name */
104 if (vrf_id
!= VRF_UNKNOWN
)
105 vrf
= vrf_lookup_by_id(vrf_id
);
107 vrf
= vrf_lookup_by_name(name
);
110 vrf
= XCALLOC(MTYPE_VRF
, sizeof(struct vrf
));
111 vrf
->vrf_id
= VRF_UNKNOWN
;
112 RB_INIT(if_name_head
, &vrf
->ifaces_by_name
);
113 RB_INIT(if_index_head
, &vrf
->ifaces_by_index
);
118 zlog_debug("VRF(%u) %s is created.", vrf_id
,
119 (name
) ? name
: "(NULL)");
123 if (vrf_id
!= VRF_UNKNOWN
&& vrf
->vrf_id
== VRF_UNKNOWN
) {
124 vrf
->vrf_id
= vrf_id
;
125 RB_INSERT(vrf_id_head
, &vrfs_by_id
, vrf
);
129 if (name
&& vrf
->name
[0] != '\0' && strcmp(name
, vrf
->name
)) {
130 RB_REMOVE(vrf_name_head
, &vrfs_by_name
, vrf
);
131 strlcpy(vrf
->name
, name
, sizeof(vrf
->name
));
132 RB_INSERT(vrf_name_head
, &vrfs_by_name
, vrf
);
133 } else if (name
&& vrf
->name
[0] == '\0') {
134 strlcpy(vrf
->name
, name
, sizeof(vrf
->name
));
135 RB_INSERT(vrf_name_head
, &vrfs_by_name
, vrf
);
138 if (new &&vrf_master
.vrf_new_hook
)
139 (*vrf_master
.vrf_new_hook
)(vrf
);
144 /* Delete a VRF. This is called when the underlying VRF goes away, a
145 * pre-configured VRF is deleted or when shutting down (vrf_terminate()).
147 void vrf_delete(struct vrf
*vrf
)
150 zlog_debug("VRF %u is to be deleted.", vrf
->vrf_id
);
152 if (vrf_is_enabled(vrf
))
155 /* If the VRF is user configured, it'll stick around, just remove
156 * the ID mapping. Interfaces assigned to this VRF should've been
157 * removed already as part of the VRF going down.
159 if (vrf_is_user_cfged(vrf
)) {
160 if (vrf
->vrf_id
!= VRF_UNKNOWN
) {
161 /* Delete any VRF interfaces - should be only
162 * the VRF itself, other interfaces should've
163 * been moved out of the VRF.
166 RB_REMOVE(vrf_id_head
, &vrfs_by_id
, vrf
);
167 vrf
->vrf_id
= VRF_UNKNOWN
;
172 if (vrf_master
.vrf_delete_hook
)
173 (*vrf_master
.vrf_delete_hook
)(vrf
);
178 if (vrf
->vrf_id
!= VRF_UNKNOWN
)
179 RB_REMOVE(vrf_id_head
, &vrfs_by_id
, vrf
);
180 if (vrf
->name
[0] != '\0')
181 RB_REMOVE(vrf_name_head
, &vrfs_by_name
, vrf
);
183 XFREE(MTYPE_VRF
, vrf
);
186 /* Look up a VRF by identifier. */
187 struct vrf
*vrf_lookup_by_id(vrf_id_t vrf_id
)
191 return (RB_FIND(vrf_id_head
, &vrfs_by_id
, &vrf
));
195 * Enable a VRF - that is, let the VRF be ready to use.
196 * The VRF_ENABLE_HOOK callback will be called to inform
197 * that they can allocate resources in this VRF.
199 * RETURN: 1 - enabled successfully; otherwise, 0.
201 int vrf_enable(struct vrf
*vrf
)
203 if (vrf_is_enabled(vrf
))
207 zlog_debug("VRF %u is enabled.", vrf
->vrf_id
);
209 SET_FLAG(vrf
->status
, VRF_ACTIVE
);
211 if (vrf_master
.vrf_enable_hook
)
212 (*vrf_master
.vrf_enable_hook
)(vrf
);
218 * Disable a VRF - that is, let the VRF be unusable.
219 * The VRF_DELETE_HOOK callback will be called to inform
220 * that they must release the resources in the VRF.
222 static void vrf_disable(struct vrf
*vrf
)
224 if (!vrf_is_enabled(vrf
))
227 UNSET_FLAG(vrf
->status
, VRF_ACTIVE
);
230 zlog_debug("VRF %u is to be disabled.", vrf
->vrf_id
);
232 /* Till now, nothing to be done for the default VRF. */
233 // Pending: see why this statement.
235 if (vrf_master
.vrf_disable_hook
)
236 (*vrf_master
.vrf_disable_hook
)(vrf
);
239 const char *vrf_id_to_name(vrf_id_t vrf_id
)
243 vrf
= vrf_lookup_by_id(vrf_id
);
250 vrf_id_t
vrf_name_to_id(const char *name
)
253 vrf_id_t vrf_id
= VRF_DEFAULT
; // Pending: need a way to return invalid
254 // id/ routine not used.
256 vrf
= vrf_lookup_by_name(name
);
258 vrf_id
= vrf
->vrf_id
;
263 /* Get the data pointer of the specified VRF. If not found, create one. */
264 void *vrf_info_get(vrf_id_t vrf_id
)
266 struct vrf
*vrf
= vrf_get(vrf_id
, NULL
);
270 /* Look up the data pointer of the specified VRF. */
271 void *vrf_info_lookup(vrf_id_t vrf_id
)
273 struct vrf
*vrf
= vrf_lookup_by_id(vrf_id
);
274 return vrf
? vrf
->info
: NULL
;
281 #define VRF_BITMAP_NUM_OF_GROUPS 1024
282 #define VRF_BITMAP_NUM_OF_BITS_IN_GROUP (UINT32_MAX / VRF_BITMAP_NUM_OF_GROUPS)
283 #define VRF_BITMAP_NUM_OF_BYTES_IN_GROUP \
284 (VRF_BITMAP_NUM_OF_BITS_IN_GROUP / CHAR_BIT + 1) /* +1 for ensure */
286 #define VRF_BITMAP_GROUP(_id) ((_id) / VRF_BITMAP_NUM_OF_BITS_IN_GROUP)
287 #define VRF_BITMAP_BIT_OFFSET(_id) ((_id) % VRF_BITMAP_NUM_OF_BITS_IN_GROUP)
289 #define VRF_BITMAP_INDEX_IN_GROUP(_bit_offset) ((_bit_offset) / CHAR_BIT)
290 #define VRF_BITMAP_FLAG(_bit_offset) (((u_char)1) << ((_bit_offset) % CHAR_BIT))
293 u_char
*groups
[VRF_BITMAP_NUM_OF_GROUPS
];
296 vrf_bitmap_t
vrf_bitmap_init(void)
298 return (vrf_bitmap_t
)XCALLOC(MTYPE_VRF_BITMAP
,
299 sizeof(struct vrf_bitmap
));
302 void vrf_bitmap_free(vrf_bitmap_t bmap
)
304 struct vrf_bitmap
*bm
= (struct vrf_bitmap
*)bmap
;
307 if (bmap
== VRF_BITMAP_NULL
)
310 for (i
= 0; i
< VRF_BITMAP_NUM_OF_GROUPS
; i
++)
312 XFREE(MTYPE_VRF_BITMAP
, bm
->groups
[i
]);
314 XFREE(MTYPE_VRF_BITMAP
, bm
);
317 void vrf_bitmap_set(vrf_bitmap_t bmap
, vrf_id_t vrf_id
)
319 struct vrf_bitmap
*bm
= (struct vrf_bitmap
*)bmap
;
320 u_char group
= VRF_BITMAP_GROUP(vrf_id
);
321 u_char offset
= VRF_BITMAP_BIT_OFFSET(vrf_id
);
323 if (bmap
== VRF_BITMAP_NULL
|| vrf_id
== VRF_UNKNOWN
)
326 if (bm
->groups
[group
] == NULL
)
327 bm
->groups
[group
] = XCALLOC(MTYPE_VRF_BITMAP
,
328 VRF_BITMAP_NUM_OF_BYTES_IN_GROUP
);
330 SET_FLAG(bm
->groups
[group
][VRF_BITMAP_INDEX_IN_GROUP(offset
)],
331 VRF_BITMAP_FLAG(offset
));
334 void vrf_bitmap_unset(vrf_bitmap_t bmap
, vrf_id_t vrf_id
)
336 struct vrf_bitmap
*bm
= (struct vrf_bitmap
*)bmap
;
337 u_char group
= VRF_BITMAP_GROUP(vrf_id
);
338 u_char offset
= VRF_BITMAP_BIT_OFFSET(vrf_id
);
340 if (bmap
== VRF_BITMAP_NULL
|| vrf_id
== VRF_UNKNOWN
341 || bm
->groups
[group
] == NULL
)
344 UNSET_FLAG(bm
->groups
[group
][VRF_BITMAP_INDEX_IN_GROUP(offset
)],
345 VRF_BITMAP_FLAG(offset
));
348 int vrf_bitmap_check(vrf_bitmap_t bmap
, vrf_id_t vrf_id
)
350 struct vrf_bitmap
*bm
= (struct vrf_bitmap
*)bmap
;
351 u_char group
= VRF_BITMAP_GROUP(vrf_id
);
352 u_char offset
= VRF_BITMAP_BIT_OFFSET(vrf_id
);
354 if (bmap
== VRF_BITMAP_NULL
|| vrf_id
== VRF_UNKNOWN
355 || bm
->groups
[group
] == NULL
)
358 return CHECK_FLAG(bm
->groups
[group
][VRF_BITMAP_INDEX_IN_GROUP(offset
)],
359 VRF_BITMAP_FLAG(offset
))
364 static void vrf_autocomplete(vector comps
, struct cmd_token
*token
)
366 struct vrf
*vrf
= NULL
;
368 RB_FOREACH (vrf
, vrf_name_head
, &vrfs_by_name
) {
369 if (vrf
->vrf_id
!= VRF_DEFAULT
)
370 vector_set(comps
, XSTRDUP(MTYPE_COMPLETION
, vrf
->name
));
374 static const struct cmd_variable_handler vrf_var_handlers
[] = {
377 .completions
= vrf_autocomplete
,
379 {.completions
= NULL
},
382 /* Initialize VRF module. */
383 void vrf_init(int (*create
)(struct vrf
*), int (*enable
)(struct vrf
*),
384 int (*disable
)(struct vrf
*), int (*delete)(struct vrf
*))
386 struct vrf
*default_vrf
;
389 zlog_debug("%s: Initializing VRF subsystem",
390 __PRETTY_FUNCTION__
);
392 vrf_master
.vrf_new_hook
= create
;
393 vrf_master
.vrf_enable_hook
= enable
;
394 vrf_master
.vrf_disable_hook
= disable
;
395 vrf_master
.vrf_delete_hook
= delete;
397 /* The default VRF always exists. */
398 default_vrf
= vrf_get(VRF_DEFAULT
, VRF_DEFAULT_NAME
);
400 zlog_err("vrf_init: failed to create the default VRF!");
404 /* Enable the default VRF. */
405 if (!vrf_enable(default_vrf
)) {
406 zlog_err("vrf_init: failed to enable the default VRF!");
410 cmd_variable_handler_register(vrf_var_handlers
);
413 /* Terminate VRF module. */
414 void vrf_terminate(void)
419 zlog_debug("%s: Shutting down vrf subsystem",
420 __PRETTY_FUNCTION__
);
422 while ((vrf
= RB_ROOT(vrf_id_head
, &vrfs_by_id
)) != NULL
) {
423 /* Clear configured flag and invoke delete. */
424 UNSET_FLAG(vrf
->status
, VRF_CONFIGURED
);
427 while ((vrf
= RB_ROOT(vrf_name_head
, &vrfs_by_name
)) != NULL
) {
428 /* Clear configured flag and invoke delete. */
429 UNSET_FLAG(vrf
->status
, VRF_CONFIGURED
);
434 /* Create a socket for the VRF. */
435 int vrf_socket(int domain
, int type
, int protocol
, vrf_id_t vrf_id
)
439 ret
= socket(domain
, type
, protocol
);
444 /* vrf CLI commands */
448 "Select a VRF to configure\n"
452 const char *vrfname
= argv
[idx_name
]->arg
;
455 if (strlen(vrfname
) > VRF_NAMSIZ
) {
457 "%% VRF name %s is invalid: length exceeds "
459 vrfname
, VRF_NAMSIZ
);
460 return CMD_WARNING_CONFIG_FAILED
;
463 vrfp
= vrf_get(VRF_UNKNOWN
, vrfname
);
465 /* Mark as user configured. */
466 SET_FLAG(vrfp
->status
, VRF_CONFIGURED
);
468 VTY_PUSH_CONTEXT(VRF_NODE
, vrfp
);
477 "Delete a pseudo VRF's configuration\n"
480 const char *vrfname
= argv
[2]->arg
;
484 vrfp
= vrf_lookup_by_name(vrfname
);
487 vty_out(vty
, "%% VRF %s does not exist\n", vrfname
);
488 return CMD_WARNING_CONFIG_FAILED
;
491 if (CHECK_FLAG(vrfp
->status
, VRF_ACTIVE
)) {
492 vty_out(vty
, "%% Only inactive VRFs can be deleted\n");
493 return CMD_WARNING_CONFIG_FAILED
;
496 /* Clear configured flag and invoke delete. */
497 UNSET_FLAG(vrfp
->status
, VRF_CONFIGURED
);
504 struct cmd_node vrf_node
= {VRF_NODE
, "%s(config-vrf)# ", 1};
507 * Debug CLI for vrf's
532 static int vrf_write_host(struct vty
*vty
)
535 vty_out(vty
, "debug vrf\n");
540 static struct cmd_node vrf_debug_node
= {VRF_DEBUG_NODE
, "", 1};
542 void vrf_install_commands(void)
544 install_node(&vrf_debug_node
, vrf_write_host
);
546 install_element(CONFIG_NODE
, &vrf_debug_cmd
);
547 install_element(ENABLE_NODE
, &vrf_debug_cmd
);
548 install_element(CONFIG_NODE
, &no_vrf_debug_cmd
);
549 install_element(ENABLE_NODE
, &no_vrf_debug_cmd
);
552 void vrf_cmd_init(int (*writefunc
)(struct vty
*vty
))
554 install_element(CONFIG_NODE
, &vrf_cmd
);
555 install_element(CONFIG_NODE
, &no_vrf_cmd
);
556 install_node(&vrf_node
, writefunc
);
557 install_default(VRF_NODE
);