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
41 #include "lib_errors.h"
43 DEFINE_MTYPE_STATIC(LIB
, NS
, "NetNS Context")
44 DEFINE_MTYPE_STATIC(LIB
, NS_NAME
, "NetNS Name")
46 /* default NS ID value used when VRF backend is not NETNS */
47 #define NS_DEFAULT_INTERNAL 0
49 static inline int ns_compare(const struct ns
*ns
, const struct ns
*ns2
);
50 static struct ns
*ns_lookup_name_internal(const char *name
);
52 RB_GENERATE(ns_head
, ns
, entry
, ns_compare
)
54 struct ns_head ns_tree
= RB_INITIALIZER(&ns_tree
);
56 static struct ns
*default_ns
;
57 static int ns_current_ns_fd
;
58 static int ns_default_ns_fd
;
63 RB_ENTRY(ns_map_nsid
) id_entry
;
64 ns_id_t ns_id_external
;
68 static inline int ns_map_compare(const struct ns_map_nsid
*a
,
69 const struct ns_map_nsid
*b
)
71 return (a
->ns_id
- b
->ns_id
);
74 RB_HEAD(ns_map_nsid_head
, ns_map_nsid
);
75 RB_PROTOTYPE(ns_map_nsid_head
, ns_map_nsid
, id_entry
, ns_map_compare
);
76 RB_GENERATE(ns_map_nsid_head
, ns_map_nsid
, id_entry
, ns_map_compare
);
77 struct ns_map_nsid_head ns_map_nsid_list
= RB_INITIALIZER(&ns_map_nsid_list
);
79 static ns_id_t ns_id_external_numbering
;
83 #define CLONE_NEWNET 0x40000000
84 /* New network namespace (lo, device, names sockets, etc) */
88 static inline int setns(int fd
, int nstype
)
91 return syscall(__NR_setns
, fd
, nstype
);
97 #endif /* !HAVE_SETNS */
100 static int have_netns_enabled
= -1;
101 #endif /* HAVE_NETNS */
103 /* default NS ID value used when VRF backend is not NETNS */
104 #define NS_DEFAULT_INTERNAL 0
106 static int have_netns(void)
109 if (have_netns_enabled
< 0) {
110 int fd
= open(NS_DEFAULT_NAME
, O_RDONLY
);
113 have_netns_enabled
= 0;
115 have_netns_enabled
= 1;
119 return have_netns_enabled
;
125 /* Holding NS hooks */
127 int (*ns_new_hook
)(struct ns
*ns
);
128 int (*ns_delete_hook
)(struct ns
*ns
);
129 int (*ns_enable_hook
)(struct ns
*ns
);
130 int (*ns_disable_hook
)(struct ns
*ns
);
135 static int ns_is_enabled(struct ns
*ns
);
137 static inline int ns_compare(const struct ns
*a
, const struct ns
*b
)
139 return (a
->ns_id
- b
->ns_id
);
142 /* Look up a NS by identifier. */
143 static struct ns
*ns_lookup_internal(ns_id_t ns_id
)
148 return RB_FIND(ns_head
, &ns_tree
, &ns
);
151 /* Look up a NS by name */
152 static struct ns
*ns_lookup_name_internal(const char *name
)
154 struct ns
*ns
= NULL
;
156 RB_FOREACH (ns
, ns_head
, &ns_tree
) {
157 if (ns
->name
!= NULL
) {
158 if (strcmp(name
, ns
->name
) == 0)
165 static struct ns
*ns_get_created_internal(struct ns
*ns
, char *name
,
170 * Initialize interfaces.
172 if (!ns
&& !name
&& ns_id
!= NS_UNKNOWN
)
173 ns
= ns_lookup_internal(ns_id
);
175 ns
= ns_lookup_name_internal(name
);
177 ns
= XCALLOC(MTYPE_NS
, sizeof(struct ns
));
180 ns
->name
= XSTRDUP(MTYPE_NS_NAME
, name
);
182 RB_INSERT(ns_head
, &ns_tree
, ns
);
185 if (ns_id
!= ns
->ns_id
) {
186 RB_REMOVE(ns_head
, &ns_tree
, ns
);
188 RB_INSERT(ns_head
, &ns_tree
, ns
);
193 if (ns
->ns_id
!= NS_UNKNOWN
)
194 zlog_info("NS %u is created.", ns
->ns_id
);
196 zlog_info("NS %s is created.", ns
->name
);
198 if (ns_master
.ns_new_hook
)
199 (*ns_master
.ns_new_hook
)(ns
);
204 * Enable a NS - that is, let the NS be ready to use.
205 * The NS_ENABLE_HOOK callback will be called to inform
206 * that they can allocate resources in this NS.
208 * RETURN: 1 - enabled successfully; otherwise, 0.
210 static int ns_enable_internal(struct ns
*ns
, void (*func
)(ns_id_t
, void *))
212 if (!ns_is_enabled(ns
)) {
214 ns
->fd
= open(ns
->name
, O_RDONLY
);
217 /* Remember ns_enable_hook has been called */
221 if (!ns_is_enabled(ns
)) {
222 zlog_ferr(LIB_ERR_SYSTEM_CALL
,
223 "Can not enable NS %u: %s!", ns
->ns_id
,
224 safe_strerror(errno
));
228 /* Non default NS. leave */
229 if (ns
->ns_id
== NS_UNKNOWN
) {
230 zlog_ferr(LIB_ERR_NS
,
231 "Can not enable NS %s %u: Invalid NSID",
232 ns
->name
, ns
->ns_id
);
236 func(ns
->ns_id
, (void *)ns
->vrf_ctxt
);
239 zlog_info("NS %u is associated with NETNS %s.",
240 ns
->ns_id
, ns
->name
);
241 zlog_info("NS %u is enabled.", ns
->ns_id
);
243 /* zebra first receives NS enable event,
244 * then VRF enable event
246 if (ns_master
.ns_enable_hook
)
247 (*ns_master
.ns_enable_hook
)(ns
);
254 * Check whether the NS is enabled - that is, whether the NS
255 * is ready to allocate resources. Currently there's only one
256 * type of resource: socket.
258 static int ns_is_enabled(struct ns
*ns
)
261 return ns
&& ns
->fd
>= 0;
263 return ns
&& ns
->fd
== -2 && ns
->ns_id
== NS_DEFAULT
;
267 * Disable a NS - that is, let the NS be unusable.
268 * The NS_DELETE_HOOK callback will be called to inform
269 * that they must release the resources in the NS.
271 static void ns_disable_internal(struct ns
*ns
)
273 if (ns_is_enabled(ns
)) {
275 zlog_info("NS %u is to be disabled.", ns
->ns_id
);
277 if (ns_master
.ns_disable_hook
)
278 (*ns_master
.ns_disable_hook
)(ns
);
287 /* VRF list existance check by name. */
288 static struct ns_map_nsid
*ns_map_nsid_lookup_by_nsid(ns_id_t ns_id
)
290 struct ns_map_nsid ns_map
;
292 ns_map
.ns_id
= ns_id
;
293 return RB_FIND(ns_map_nsid_head
, &ns_map_nsid_list
, &ns_map
);
296 ns_id_t
ns_map_nsid_with_external(ns_id_t ns_id
, bool map
)
298 struct ns_map_nsid
*ns_map
;
299 vrf_id_t ns_id_external
;
301 ns_map
= ns_map_nsid_lookup_by_nsid(ns_id
);
302 if (ns_map
&& !map
) {
303 ns_id_external
= ns_map
->ns_id_external
;
304 RB_REMOVE(ns_map_nsid_head
, &ns_map_nsid_list
, ns_map
);
305 return ns_id_external
;
308 return ns_map
->ns_id_external
;
309 ns_map
= XCALLOC(MTYPE_NS
, sizeof(struct ns_map_nsid
));
311 * default vrf is the first one : 0
313 ns_map
->ns_id_external
= ns_id_external_numbering
++;
314 ns_map
->ns_id
= ns_id
;
315 RB_INSERT(ns_map_nsid_head
, &ns_map_nsid_list
, ns_map
);
316 return ns_map
->ns_id_external
;
319 struct ns
*ns_get_created(struct ns
*ns
, char *name
, ns_id_t ns_id
)
321 return ns_get_created_internal(ns
, name
, ns_id
);
324 int ns_have_netns(void)
329 /* Delete a NS. This is called in ns_terminate(). */
330 void ns_delete(struct ns
*ns
)
333 zlog_info("NS %u is to be deleted.", ns
->ns_id
);
337 if (ns_master
.ns_delete_hook
)
338 (*ns_master
.ns_delete_hook
)(ns
);
341 * I'm not entirely sure if the vrf->iflist
342 * needs to be moved into here or not.
344 // if_terminate (&ns->iflist);
346 RB_REMOVE(ns_head
, &ns_tree
, ns
);
348 XFREE(MTYPE_NS_NAME
, ns
->name
);
353 /* Look up the data pointer of the specified VRF. */
354 void *ns_info_lookup(ns_id_t ns_id
)
356 struct ns
*ns
= ns_lookup_internal(ns_id
);
358 return ns
? ns
->info
: NULL
;
361 /* Look up a NS by name */
362 struct ns
*ns_lookup_name(const char *name
)
364 return ns_lookup_name_internal(name
);
367 int ns_enable(struct ns
*ns
, void (*func
)(ns_id_t
, void *))
369 return ns_enable_internal(ns
, func
);
372 void ns_disable(struct ns
*ns
)
374 return ns_disable_internal(ns
);
377 struct ns
*ns_lookup(ns_id_t ns_id
)
379 return ns_lookup_internal(ns_id
);
382 void ns_walk_func(int (*func
)(struct ns
*))
384 struct ns
*ns
= NULL
;
386 RB_FOREACH (ns
, ns_head
, &ns_tree
)
390 const char *ns_get_name(struct ns
*ns
)
397 /* Add a NS hook. Please add hooks before calling ns_init(). */
398 void ns_add_hook(int type
, int (*func
)(struct ns
*))
402 ns_master
.ns_new_hook
= func
;
405 ns_master
.ns_delete_hook
= func
;
408 ns_master
.ns_enable_hook
= func
;
410 case NS_DISABLE_HOOK
:
411 ns_master
.ns_disable_hook
= func
;
419 * NS realization with NETNS
422 char *ns_netns_pathname(struct vty
*vty
, const char *name
)
424 static char pathname
[PATH_MAX
];
428 if (name
[0] == '/') /* absolute pathname */
429 result
= realpath(name
, pathname
);
431 /* relevant pathname */
432 char tmp_name
[PATH_MAX
];
434 snprintf(tmp_name
, PATH_MAX
, "%s/%s", NS_RUN_DIR
, name
);
435 result
= realpath(tmp_name
, pathname
);
440 vty_out(vty
, "Invalid pathname for %s: %s\n",
442 safe_strerror(errno
));
444 zlog_warn("Invalid pathname for %s: %s",
446 safe_strerror(errno
));
449 check_base
= basename(pathname
);
450 if (check_base
!= NULL
&& strlen(check_base
) + 1 > NS_NAMSIZ
) {
452 vty_out(vty
, "NS name (%s) invalid: too long (>%d)\n",
453 check_base
, NS_NAMSIZ
- 1);
455 zlog_warn("NS name (%s) invalid: too long (>%d)",
456 check_base
, NS_NAMSIZ
- 1);
464 static int ns_initialised
;
467 /* silently return as initialisation done */
468 if (ns_initialised
== 1)
472 if (have_netns_enabled
< 0) {
473 ns_default_ns_fd
= open(NS_DEFAULT_NAME
, O_RDONLY
);
474 if (ns_default_ns_fd
== -1)
475 zlog_ferr(LIB_ERR_NS
,
476 "NS initialization failure %d(%s)", errno
,
477 safe_strerror(errno
));
479 ns_default_ns_fd
= -1;
483 ns_default_ns_fd
= -1;
485 #endif /* HAVE_NETNS */
486 ns_current_ns_fd
= -1;
490 /* Initialize NS module. */
491 void ns_init_management(ns_id_t default_ns_id
, ns_id_t internal_ns
)
496 default_ns
= ns_get_created_internal(NULL
, NULL
, default_ns_id
);
498 zlog_ferr(LIB_ERR_NS
, "%s: failed to create the default NS!",
503 fd
= open(NS_DEFAULT_NAME
, O_RDONLY
);
506 default_ns
->internal_ns_id
= internal_ns
;
508 /* Set the default NS name. */
509 default_ns
->name
= XSTRDUP(MTYPE_NS_NAME
, NS_DEFAULT_NAME
);
511 zlog_info("%s: default NSID is %u", __func__
,
514 /* Enable the default NS. */
515 if (!ns_enable(default_ns
, NULL
)) {
516 zlog_ferr(LIB_ERR_NS
, "%s: failed to enable the default NS!",
522 /* Terminate NS module. */
523 void ns_terminate(void)
527 while (!RB_EMPTY(ns_head
, &ns_tree
)) {
528 ns
= RB_ROOT(ns_head
, &ns_tree
);
534 int ns_switch_to_netns(const char *name
)
541 if (ns_default_ns_fd
== -1)
543 fd
= open(name
, O_RDONLY
);
548 ret
= setns(fd
, CLONE_NEWNET
);
549 ns_current_ns_fd
= fd
;
554 /* returns 1 if switch() was not called before
555 * return status of setns() otherwise
557 int ns_switchback_to_initial(void)
559 if (ns_current_ns_fd
!= -1 && ns_default_ns_fd
!= -1) {
562 ret
= setns(ns_default_ns_fd
, CLONE_NEWNET
);
563 ns_current_ns_fd
= -1;
566 /* silently ignore if setns() is not called */
570 /* Create a socket for the NS. */
571 int ns_socket(int domain
, int type
, int protocol
, ns_id_t ns_id
)
573 struct ns
*ns
= ns_lookup(ns_id
);
576 if (!ns
|| !ns_is_enabled(ns
)) {
581 ret
= (ns_id
!= NS_DEFAULT
) ? setns(ns
->fd
, CLONE_NEWNET
) : 0;
583 ret
= socket(domain
, type
, protocol
);
584 if (ns_id
!= NS_DEFAULT
) {
585 setns(ns_lookup(NS_DEFAULT
)->fd
, CLONE_NEWNET
);
586 ns_current_ns_fd
= ns_id
;
590 ret
= socket(domain
, type
, protocol
);
595 ns_id_t
ns_get_default_id(void)
598 return default_ns
->ns_id
;
599 return NS_DEFAULT_INTERNAL
;