2 * Copyright (c) 2012 Gleb Smirnoff <glebius@FreeBSD.org>
3 * Copyright (c) 1980, 1986, 1993
4 * The Regents of the University of California. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 4. Neither the name of the University nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * @(#)if.c 8.5 (Berkeley) 1/9/95
34 #include <sys/param.h>
35 #include <sys/malloc.h>
36 #include <sys/limits.h>
38 #include <sys/mutex.h>
39 #include <sys/kernel.h>
40 #include <sys/systm.h>
41 #include <sys/types.h>
42 #include <sys/socket.h>
45 #include <net/if_clone.h>
46 #include <net/if_var.h>
47 #include <net/radix.h>
48 #include <net/route.h>
51 /* Current IF_MAXUNIT expands maximum to 5 characters. */
52 #define IFCLOSIZ (IFNAMSIZ - 5)
55 * Structure describing a `cloning' interface.
58 * (c) const until freeing
59 * (d) driver specific data, may need external protection.
60 * (e) locked by if_cloners_mtx
61 * (i) locked by ifc_mtx mtx
64 char ifc_name[IFCLOSIZ]; /* (c) Name of device, e.g. `gif' */
65 struct unrhdr *ifc_unrhdr; /* (c) alloc_unr(9) header */
66 int ifc_maxunit; /* (c) maximum unit number */
67 long ifc_refcnt; /* (i) Reference count. */
68 LIST_HEAD(, ifnet) ifc_iflist; /* (i) List of cloned interfaces */
69 struct mtx ifc_mtx; /* Mutex to protect members. */
71 enum { SIMPLE, ADVANCED } ifc_type; /* (c) */
73 /* (c) Driver specific cloning functions. Called with no locks held. */
75 struct { /* advanced cloner */
76 ifc_match_t *_ifc_match;
77 ifc_create_t *_ifc_create;
78 ifc_destroy_t *_ifc_destroy;
80 struct { /* simple cloner */
81 ifcs_create_t *_ifcs_create;
82 ifcs_destroy_t *_ifcs_destroy;
83 int _ifcs_minifs; /* minimum ifs */
87 #define ifc_match U.A._ifc_match
88 #define ifc_create U.A._ifc_create
89 #define ifc_destroy U.A._ifc_destroy
90 #define ifcs_create U.S._ifcs_create
91 #define ifcs_destroy U.S._ifcs_destroy
92 #define ifcs_minifs U.S._ifcs_minifs
94 LIST_ENTRY(if_clone) ifc_list; /* (e) On list of cloners */
97 static void if_clone_free(struct if_clone *ifc);
98 static int if_clone_createif(struct if_clone *ifc, char *name, size_t len,
101 static int ifc_simple_match(struct if_clone *, const char *);
102 static int ifc_simple_create(struct if_clone *, char *, size_t, caddr_t);
103 static int ifc_simple_destroy(struct if_clone *, struct ifnet *);
105 static struct mtx if_cloners_mtx;
106 static VNET_DEFINE(int, if_cloners_count);
107 VNET_DEFINE(LIST_HEAD(, if_clone), if_cloners);
109 #define V_if_cloners_count VNET(if_cloners_count)
110 #define V_if_cloners VNET(if_cloners)
112 #define IF_CLONERS_LOCK_INIT() \
113 mtx_init(&if_cloners_mtx, "if_cloners lock", NULL, MTX_DEF)
114 #define IF_CLONERS_LOCK_ASSERT() mtx_assert(&if_cloners_mtx, MA_OWNED)
115 #define IF_CLONERS_LOCK() mtx_lock(&if_cloners_mtx)
116 #define IF_CLONERS_UNLOCK() mtx_unlock(&if_cloners_mtx)
118 #define IF_CLONE_LOCK_INIT(ifc) \
119 mtx_init(&(ifc)->ifc_mtx, "if_clone lock", NULL, MTX_DEF)
120 #define IF_CLONE_LOCK_DESTROY(ifc) mtx_destroy(&(ifc)->ifc_mtx)
121 #define IF_CLONE_LOCK_ASSERT(ifc) mtx_assert(&(ifc)->ifc_mtx, MA_OWNED)
122 #define IF_CLONE_LOCK(ifc) mtx_lock(&(ifc)->ifc_mtx)
123 #define IF_CLONE_UNLOCK(ifc) mtx_unlock(&(ifc)->ifc_mtx)
125 #define IF_CLONE_ADDREF(ifc) \
127 IF_CLONE_LOCK(ifc); \
128 IF_CLONE_ADDREF_LOCKED(ifc); \
129 IF_CLONE_UNLOCK(ifc); \
131 #define IF_CLONE_ADDREF_LOCKED(ifc) \
133 IF_CLONE_LOCK_ASSERT(ifc); \
134 KASSERT((ifc)->ifc_refcnt >= 0, \
135 ("negative refcnt %ld", (ifc)->ifc_refcnt)); \
136 (ifc)->ifc_refcnt++; \
138 #define IF_CLONE_REMREF(ifc) \
140 IF_CLONE_LOCK(ifc); \
141 IF_CLONE_REMREF_LOCKED(ifc); \
143 #define IF_CLONE_REMREF_LOCKED(ifc) \
145 IF_CLONE_LOCK_ASSERT(ifc); \
146 KASSERT((ifc)->ifc_refcnt > 0, \
147 ("bogus refcnt %ld", (ifc)->ifc_refcnt)); \
148 if (--(ifc)->ifc_refcnt == 0) { \
149 IF_CLONE_UNLOCK(ifc); \
150 if_clone_free(ifc); \
152 /* silently free the lock */ \
153 IF_CLONE_UNLOCK(ifc); \
157 #define IFC_IFLIST_INSERT(_ifc, _ifp) \
158 LIST_INSERT_HEAD(&_ifc->ifc_iflist, _ifp, if_clones)
159 #define IFC_IFLIST_REMOVE(_ifc, _ifp) \
160 LIST_REMOVE(_ifp, if_clones)
162 static MALLOC_DEFINE(M_CLONE, "clone", "interface cloning framework");
165 vnet_if_clone_init(void)
168 LIST_INIT(&V_if_cloners);
175 IF_CLONERS_LOCK_INIT();
179 * Lookup and create a clone network interface.
182 if_clone_create(char *name, size_t len, caddr_t params)
184 struct if_clone *ifc;
186 /* Try to find an applicable cloner for this request */
188 LIST_FOREACH(ifc, &V_if_cloners, ifc_list)
189 if (ifc->ifc_type == SIMPLE) {
190 if (ifc_simple_match(ifc, name))
193 if (ifc->ifc_match(ifc, name))
197 if (ifc == NULL && !IS_DEFAULT_VNET(curvnet)) {
198 CURVNET_SET_QUIET(vnet0);
199 LIST_FOREACH(ifc, &V_if_cloners, ifc_list)
200 if (ifc->ifc_type == SIMPLE) {
201 if (ifc_simple_match(ifc, name))
204 if (ifc->ifc_match(ifc, name))
215 return (if_clone_createif(ifc, name, len, params));
219 * Create a clone network interface.
222 if_clone_createif(struct if_clone *ifc, char *name, size_t len, caddr_t params)
227 if (ifunit(name) != NULL)
230 if (ifc->ifc_type == SIMPLE)
231 err = ifc_simple_create(ifc, name, len, params);
233 err = (*ifc->ifc_create)(ifc, name, len, params);
238 panic("%s: lookup failed for %s", __func__, name);
240 if_addgroup(ifp, ifc->ifc_name);
243 IFC_IFLIST_INSERT(ifc, ifp);
244 IF_CLONE_UNLOCK(ifc);
251 * Lookup and destroy a clone network interface.
254 if_clone_destroy(const char *name)
257 struct if_clone *ifc;
260 ifp = ifunit_ref(name);
264 /* Find the cloner for this interface */
266 LIST_FOREACH(ifc, &V_if_cloners, ifc_list) {
267 if (strcmp(ifc->ifc_name, ifp->if_dname) == 0) {
272 if (ifc == NULL && !IS_DEFAULT_VNET(curvnet)) {
273 CURVNET_SET_QUIET(vnet0);
274 LIST_FOREACH(ifc, &V_if_cloners, ifc_list)
275 if (ifc->ifc_type == SIMPLE) {
276 if (ifc_simple_match(ifc, name))
279 if (ifc->ifc_match(ifc, name))
291 err = if_clone_destroyif(ifc, ifp);
297 * Destroy a clone network interface.
300 if_clone_destroyif(struct if_clone *ifc, struct ifnet *ifp)
303 struct ifnet *ifcifp;
305 if (ifc->ifc_type == ADVANCED && ifc->ifc_destroy == NULL)
309 * Given that the cloned ifnet might be attached to a different
310 * vnet from where its cloner was registered, we have to
311 * switch to the vnet context of the target vnet.
313 CURVNET_SET_QUIET(ifp->if_vnet);
316 LIST_FOREACH(ifcifp, &ifc->ifc_iflist, if_clones) {
318 IFC_IFLIST_REMOVE(ifc, ifp);
322 IF_CLONE_UNLOCK(ifc);
323 if (ifcifp == NULL) {
325 return (ENXIO); /* ifp is not on the list. */
328 if_delgroup(ifp, ifc->ifc_name);
330 if (ifc->ifc_type == SIMPLE)
331 err = ifc_simple_destroy(ifc, ifp);
333 err = (*ifc->ifc_destroy)(ifc, ifp);
336 if_addgroup(ifp, ifc->ifc_name);
339 IFC_IFLIST_INSERT(ifc, ifp);
340 IF_CLONE_UNLOCK(ifc);
346 static struct if_clone *
347 if_clone_alloc(const char *name, int maxunit)
349 struct if_clone *ifc;
351 KASSERT(name != NULL, ("%s: no name\n", __func__));
353 ifc = malloc(sizeof(struct if_clone), M_CLONE, M_WAITOK | M_ZERO);
354 strncpy(ifc->ifc_name, name, IFCLOSIZ-1);
355 IF_CLONE_LOCK_INIT(ifc);
356 IF_CLONE_ADDREF(ifc);
357 ifc->ifc_maxunit = maxunit ? maxunit : IF_MAXUNIT;
358 ifc->ifc_unrhdr = new_unrhdr(0, ifc->ifc_maxunit, &ifc->ifc_mtx);
359 LIST_INIT(&ifc->ifc_iflist);
365 if_clone_attach(struct if_clone *ifc)
367 struct if_clone *ifc1;
370 LIST_FOREACH(ifc1, &V_if_cloners, ifc_list)
371 if (strcmp(ifc->ifc_name, ifc1->ifc_name) == 0) {
373 IF_CLONE_REMREF(ifc);
376 LIST_INSERT_HEAD(&V_if_cloners, ifc, ifc_list);
377 V_if_cloners_count++;
384 if_clone_advanced(const char *name, u_int maxunit, ifc_match_t match,
385 ifc_create_t create, ifc_destroy_t destroy)
387 struct if_clone *ifc;
389 ifc = if_clone_alloc(name, maxunit);
390 ifc->ifc_type = ADVANCED;
391 ifc->ifc_match = match;
392 ifc->ifc_create = create;
393 ifc->ifc_destroy = destroy;
395 if (if_clone_attach(ifc) != 0) {
400 EVENTHANDLER_INVOKE(if_clone_event, ifc);
406 if_clone_simple(const char *name, ifcs_create_t create, ifcs_destroy_t destroy,
409 struct if_clone *ifc;
412 ifc = if_clone_alloc(name, 0);
413 ifc->ifc_type = SIMPLE;
414 ifc->ifcs_create = create;
415 ifc->ifcs_destroy = destroy;
416 ifc->ifcs_minifs = minifs;
418 if (if_clone_attach(ifc) != 0) {
423 for (unit = 0; unit < minifs; unit++) {
427 snprintf(name, IFNAMSIZ, "%s%d", ifc->ifc_name, unit);
428 error = if_clone_createif(ifc, name, IFNAMSIZ, NULL);
430 ("%s: failed to create required interface %s",
434 EVENTHANDLER_INVOKE(if_clone_event, ifc);
440 * Unregister a network interface cloner.
443 if_clone_detach(struct if_clone *ifc)
447 LIST_REMOVE(ifc, ifc_list);
448 V_if_cloners_count--;
451 /* Allow all simples to be destroyed */
452 if (ifc->ifc_type == SIMPLE)
453 ifc->ifcs_minifs = 0;
455 /* destroy all interfaces for this cloner */
456 while (!LIST_EMPTY(&ifc->ifc_iflist))
457 if_clone_destroyif(ifc, LIST_FIRST(&ifc->ifc_iflist));
459 IF_CLONE_REMREF(ifc);
463 if_clone_free(struct if_clone *ifc)
466 KASSERT(LIST_EMPTY(&ifc->ifc_iflist),
467 ("%s: ifc_iflist not empty", __func__));
469 IF_CLONE_LOCK_DESTROY(ifc);
470 delete_unrhdr(ifc->ifc_unrhdr);
475 * Provide list of interface cloners to userspace.
478 if_clone_list(struct if_clonereq *ifcr)
480 char *buf, *dst, *outbuf = NULL;
481 struct if_clone *ifc;
482 int buf_count, count, err = 0;
484 if (ifcr->ifcr_count < 0)
489 * Set our internal output buffer size. We could end up not
490 * reporting a cloner that is added between the unlock and lock
491 * below, but that's not a major problem. Not caping our
492 * allocation to the number of cloners actually in the system
493 * could be because that would let arbitrary users cause us to
494 * allocate abritrary amounts of kernel memory.
496 buf_count = (V_if_cloners_count < ifcr->ifcr_count) ?
497 V_if_cloners_count : ifcr->ifcr_count;
500 outbuf = malloc(IFNAMSIZ*buf_count, M_CLONE, M_WAITOK | M_ZERO);
504 ifcr->ifcr_total = V_if_cloners_count;
505 if ((dst = ifcr->ifcr_buffer) == NULL) {
506 /* Just asking how many there are. */
509 count = (V_if_cloners_count < buf_count) ?
510 V_if_cloners_count : buf_count;
512 for (ifc = LIST_FIRST(&V_if_cloners), buf = outbuf;
513 ifc != NULL && count != 0;
514 ifc = LIST_NEXT(ifc, ifc_list), count--, buf += IFNAMSIZ) {
515 strlcpy(buf, ifc->ifc_name, IFNAMSIZ);
521 err = copyout(outbuf, dst, buf_count*IFNAMSIZ);
523 free(outbuf, M_CLONE);
528 * if_clone_findifc() looks up ifnet from the current
529 * cloner list, and returns ifc if found. Note that ifc_refcnt
533 if_clone_findifc(struct ifnet *ifp)
535 struct if_clone *ifc, *ifc0;
536 struct ifnet *ifcifp;
540 LIST_FOREACH(ifc, &V_if_cloners, ifc_list) {
542 LIST_FOREACH(ifcifp, &ifc->ifc_iflist, if_clones) {
545 IF_CLONE_ADDREF_LOCKED(ifc);
549 IF_CLONE_UNLOCK(ifc);
559 * if_clone_addgroup() decrements ifc_refcnt because it is called after
560 * if_clone_findifc().
563 if_clone_addgroup(struct ifnet *ifp, struct if_clone *ifc)
566 if_addgroup(ifp, ifc->ifc_name);
567 IF_CLONE_REMREF(ifc);
571 * A utility function to extract unit numbers from interface names of
574 * Returns 0 on success and an error on failure.
577 ifc_name2unit(const char *name, int *unit)
580 int cutoff = INT_MAX / 10;
581 int cutlim = INT_MAX % 10;
583 for (cp = name; *cp != '\0' && (*cp < '0' || *cp > '9'); cp++);
586 } else if (cp[0] == '0' && cp[1] != '\0') {
587 /* Disallow leading zeroes. */
590 for (*unit = 0; *cp != '\0'; cp++) {
591 if (*cp < '0' || *cp > '9') {
592 /* Bogus unit number. */
595 if (*unit > cutoff ||
596 (*unit == cutoff && *cp - '0' > cutlim))
598 *unit = (*unit * 10) + (*cp - '0');
606 ifc_alloc_unit(struct if_clone *ifc, int *unit)
611 wildcard = (*unit < 0);
613 if (*unit > ifc->ifc_maxunit)
616 *unit = alloc_unr(ifc->ifc_unrhdr);
620 *unit = alloc_unr_specific(ifc->ifc_unrhdr, *unit);
630 snprintf(name, IFNAMSIZ, "%s%d", ifc->ifc_name, *unit);
631 if (ifunit(name) != NULL) {
632 free_unr(ifc->ifc_unrhdr, *unit);
640 IF_CLONE_ADDREF(ifc);
646 ifc_free_unit(struct if_clone *ifc, int unit)
649 free_unr(ifc->ifc_unrhdr, unit);
650 IF_CLONE_REMREF(ifc);
654 ifc_simple_match(struct if_clone *ifc, const char *name)
660 for (cp = name, i = 0; i < strlen(ifc->ifc_name); i++, cp++) {
661 if (ifc->ifc_name[i] != *cp)
665 /* Make sure there's a unit number or nothing after the name */
666 for (; *cp != '\0'; cp++) {
667 if (*cp < '0' || *cp > '9')
675 ifc_simple_create(struct if_clone *ifc, char *name, size_t len, caddr_t params)
682 err = ifc_name2unit(name, &unit);
686 wildcard = (unit < 0);
688 err = ifc_alloc_unit(ifc, &unit);
692 err = ifc->ifcs_create(ifc, unit, params);
694 ifc_free_unit(ifc, unit);
698 /* In the wildcard case, we need to update the name. */
700 for (dp = name; *dp != '\0'; dp++);
701 if (snprintf(dp, len - (dp-name), "%d", unit) >
702 len - (dp-name) - 1) {
704 * This can only be a programmer error and
705 * there's no straightforward way to recover if
708 panic("if_clone_create(): interface name too long");
717 ifc_simple_destroy(struct if_clone *ifc, struct ifnet *ifp)
721 unit = ifp->if_dunit;
723 if (unit < ifc->ifcs_minifs)
726 ifc->ifcs_destroy(ifp);
728 ifc_free_unit(ifc, unit);