]>
git.proxmox.com Git - mirror_frr.git/blob - lib/netns_linux.c
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
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 #define CLONE_NEWNET 0x40000000
64 /* New network namespace (lo, device, names sockets, etc) */
68 static inline int setns(int fd
, int nstype
)
71 return syscall(__NR_setns
, fd
, nstype
);
77 #endif /* !HAVE_SETNS */
80 static int have_netns_enabled
= -1;
81 #endif /* HAVE_NETNS */
83 /* default NS ID value used when VRF backend is not NETNS */
84 #define NS_DEFAULT_INTERNAL 0
86 static int have_netns(void)
89 if (have_netns_enabled
< 0) {
90 int fd
= open(NS_DEFAULT_NAME
, O_RDONLY
);
93 have_netns_enabled
= 0;
95 have_netns_enabled
= 1;
99 return have_netns_enabled
;
105 /* Holding NS hooks */
107 int (*ns_new_hook
)(struct ns
*ns
);
108 int (*ns_delete_hook
)(struct ns
*ns
);
109 int (*ns_enable_hook
)(struct ns
*ns
);
110 int (*ns_disable_hook
)(struct ns
*ns
);
115 static int ns_is_enabled(struct ns
*ns
);
117 static inline int ns_compare(const struct ns
*a
, const struct ns
*b
)
119 return (a
->ns_id
- b
->ns_id
);
122 /* Look up a NS by identifier. */
123 static struct ns
*ns_lookup_internal(ns_id_t ns_id
)
128 return RB_FIND(ns_head
, &ns_tree
, &ns
);
131 /* Look up a NS by name */
132 static struct ns
*ns_lookup_name_internal(const char *name
)
134 struct ns
*ns
= NULL
;
136 RB_FOREACH (ns
, ns_head
, &ns_tree
) {
137 if (ns
->name
!= NULL
) {
138 if (strcmp(name
, ns
->name
) == 0)
145 static struct ns
*ns_get_created_internal(struct ns
*ns
, char *name
,
150 * Initialize interfaces.
152 if (!ns
&& !name
&& ns_id
!= NS_UNKNOWN
)
153 ns
= ns_lookup_internal(ns_id
);
155 ns
= ns_lookup_name_internal(name
);
157 ns
= XCALLOC(MTYPE_NS
, sizeof(struct ns
));
160 ns
->name
= XSTRDUP(MTYPE_NS_NAME
, name
);
162 RB_INSERT(ns_head
, &ns_tree
, ns
);
165 if (ns_id
!= ns
->ns_id
) {
166 RB_REMOVE(ns_head
, &ns_tree
, ns
);
168 RB_INSERT(ns_head
, &ns_tree
, ns
);
173 if (ns
->ns_id
!= NS_UNKNOWN
)
174 zlog_info("NS %u is created.", ns
->ns_id
);
176 zlog_info("NS %s is created.", ns
->name
);
178 if (ns_master
.ns_new_hook
)
179 (*ns_master
.ns_new_hook
)(ns
);
184 * Enable a NS - that is, let the NS be ready to use.
185 * The NS_ENABLE_HOOK callback will be called to inform
186 * that they can allocate resources in this NS.
188 * RETURN: 1 - enabled successfully; otherwise, 0.
190 static int ns_enable_internal(struct ns
*ns
, void (*func
)(ns_id_t
, void *))
192 if (!ns_is_enabled(ns
)) {
194 ns
->fd
= open(ns
->name
, O_RDONLY
);
197 /* Remember ns_enable_hook has been called */
201 if (!ns_is_enabled(ns
)) {
202 zlog_err("Can not enable NS %u: %s!", ns
->ns_id
,
203 safe_strerror(errno
));
207 /* Non default NS. leave */
208 if (ns
->ns_id
== NS_UNKNOWN
) {
209 zlog_err("Can not enable NS %s %u: Invalid NSID",
210 ns
->name
, ns
->ns_id
);
214 func(ns
->ns_id
, (void *)ns
->vrf_ctxt
);
217 zlog_info("NS %u is associated with NETNS %s.",
218 ns
->ns_id
, ns
->name
);
219 zlog_info("NS %u is enabled.", ns
->ns_id
);
221 /* zebra first receives NS enable event,
222 * then VRF enable event
224 if (ns_master
.ns_enable_hook
)
225 (*ns_master
.ns_enable_hook
)(ns
);
232 * Check whether the NS is enabled - that is, whether the NS
233 * is ready to allocate resources. Currently there's only one
234 * type of resource: socket.
236 static int ns_is_enabled(struct ns
*ns
)
239 return ns
&& ns
->fd
>= 0;
241 return ns
&& ns
->fd
== -2 && ns
->ns_id
== NS_DEFAULT
;
245 * Disable a NS - that is, let the NS be unusable.
246 * The NS_DELETE_HOOK callback will be called to inform
247 * that they must release the resources in the NS.
249 static void ns_disable_internal(struct ns
*ns
)
251 if (ns_is_enabled(ns
)) {
253 zlog_info("NS %u is to be disabled.", ns
->ns_id
);
255 if (ns_master
.ns_disable_hook
)
256 (*ns_master
.ns_disable_hook
)(ns
);
265 struct ns
*ns_get_created(struct ns
*ns
, char *name
, ns_id_t ns_id
)
267 return ns_get_created_internal(ns
, name
, ns_id
);
270 int ns_have_netns(void)
275 /* Delete a NS. This is called in ns_terminate(). */
276 void ns_delete(struct ns
*ns
)
279 zlog_info("NS %u is to be deleted.", ns
->ns_id
);
283 if (ns_master
.ns_delete_hook
)
284 (*ns_master
.ns_delete_hook
)(ns
);
287 * I'm not entirely sure if the vrf->iflist
288 * needs to be moved into here or not.
290 // if_terminate (&ns->iflist);
292 RB_REMOVE(ns_head
, &ns_tree
, ns
);
294 XFREE(MTYPE_NS_NAME
, ns
->name
);
299 /* Look up the data pointer of the specified VRF. */
300 void *ns_info_lookup(ns_id_t ns_id
)
302 struct ns
*ns
= ns_lookup_internal(ns_id
);
304 return ns
? ns
->info
: NULL
;
307 /* Look up a NS by name */
308 struct ns
*ns_lookup_name(const char *name
)
310 return ns_lookup_name_internal(name
);
313 int ns_enable(struct ns
*ns
, void (*func
)(ns_id_t
, void *))
315 return ns_enable_internal(ns
, func
);
318 void ns_disable(struct ns
*ns
)
320 return ns_disable_internal(ns
);
323 struct ns
*ns_lookup(ns_id_t ns_id
)
325 return ns_lookup_internal(ns_id
);
328 void ns_walk_func(int (*func
)(struct ns
*))
330 struct ns
*ns
= NULL
;
332 RB_FOREACH (ns
, ns_head
, &ns_tree
)
336 const char *ns_get_name(struct ns
*ns
)
343 /* Add a NS hook. Please add hooks before calling ns_init(). */
344 void ns_add_hook(int type
, int (*func
)(struct ns
*))
348 ns_master
.ns_new_hook
= func
;
351 ns_master
.ns_delete_hook
= func
;
354 ns_master
.ns_enable_hook
= func
;
356 case NS_DISABLE_HOOK
:
357 ns_master
.ns_disable_hook
= func
;
365 * NS realization with NETNS
368 char *ns_netns_pathname(struct vty
*vty
, const char *name
)
370 static char pathname
[PATH_MAX
];
374 if (name
[0] == '/') /* absolute pathname */
375 result
= realpath(name
, pathname
);
377 /* relevant pathname */
378 char tmp_name
[PATH_MAX
];
380 snprintf(tmp_name
, PATH_MAX
, "%s/%s", NS_RUN_DIR
, name
);
381 result
= realpath(tmp_name
, pathname
);
386 vty_out(vty
, "Invalid pathname: %s\n",
387 safe_strerror(errno
));
389 zlog_warn("Invalid pathname: %s", safe_strerror(errno
));
392 check_base
= basename(pathname
);
393 if (check_base
!= NULL
&& strlen(check_base
) + 1 > NS_NAMSIZ
) {
395 vty_out(vty
, "NS name (%s) invalid: too long (>%d)\n",
396 check_base
, NS_NAMSIZ
- 1);
398 zlog_warn("NS name (%s) invalid: too long (>%d)",
399 check_base
, NS_NAMSIZ
- 1);
407 static int ns_initialised
;
410 /* silently return as initialisation done */
411 if (ns_initialised
== 1)
415 if (have_netns_enabled
< 0)
416 ns_default_ns_fd
= open(NS_DEFAULT_NAME
, O_RDONLY
);
418 ns_default_ns_fd
= -1;
422 ns_default_ns_fd
= -1;
424 #endif /* HAVE_NETNS */
425 if (ns_default_ns_fd
== -1)
426 zlog_err("NS initialisation failure (%s)",
427 safe_strerror(errno
));
428 ns_current_ns_fd
= -1;
432 /* Initialize NS module. */
433 void ns_init_management(ns_id_t default_ns_id
)
438 default_ns
= ns_get_created_internal(NULL
, NULL
, default_ns_id
);
440 zlog_err("%s: failed to create the default NS!", __func__
);
444 fd
= open(NS_DEFAULT_NAME
, O_RDONLY
);
447 /* Set the default NS name. */
448 default_ns
->name
= XSTRDUP(MTYPE_NS_NAME
, NS_DEFAULT_NAME
);
450 zlog_info("%s: default NSID is %u", __func__
,
453 /* Enable the default NS. */
454 if (!ns_enable(default_ns
, NULL
)) {
455 zlog_err("%s: failed to enable the default NS!", __func__
);
460 /* Terminate NS module. */
461 void ns_terminate(void)
465 while (!RB_EMPTY(ns_head
, &ns_tree
)) {
466 ns
= RB_ROOT(ns_head
, &ns_tree
);
472 int ns_switch_to_netns(const char *name
)
479 if (ns_default_ns_fd
== -1)
481 fd
= open(name
, O_RDONLY
);
486 ret
= setns(fd
, CLONE_NEWNET
);
487 ns_current_ns_fd
= fd
;
492 /* returns 1 if switch() was not called before
493 * return status of setns() otherwise
495 int ns_switchback_to_initial(void)
497 if (ns_current_ns_fd
!= -1 && ns_default_ns_fd
!= -1) {
500 ret
= setns(ns_default_ns_fd
, CLONE_NEWNET
);
501 ns_current_ns_fd
= -1;
504 /* silently ignore if setns() is not called */
508 /* Create a socket for the NS. */
509 int ns_socket(int domain
, int type
, int protocol
, ns_id_t ns_id
)
511 struct ns
*ns
= ns_lookup(ns_id
);
514 if (!ns
|| !ns_is_enabled(ns
)) {
519 ret
= (ns_id
!= NS_DEFAULT
) ? setns(ns
->fd
, CLONE_NEWNET
) : 0;
521 ret
= socket(domain
, type
, protocol
);
522 if (ns_id
!= NS_DEFAULT
) {
523 setns(ns_lookup(NS_DEFAULT
)->fd
, CLONE_NEWNET
);
524 ns_current_ns_fd
= ns_id
;
528 ret
= socket(domain
, type
, protocol
);
533 ns_id_t
ns_get_default_id(void)
536 return default_ns
->ns_id
;
537 return NS_DEFAULT_INTERNAL
;