1c398230bSWarner Losh /*- 242a58907SGleb Smirnoff * Copyright (c) 2012 Gleb Smirnoff <glebius@FreeBSD.org> 3f889d2efSBrooks Davis * Copyright (c) 1980, 1986, 1993 4f889d2efSBrooks Davis * The Regents of the University of California. All rights reserved. 5f889d2efSBrooks Davis * 6f889d2efSBrooks Davis * Redistribution and use in source and binary forms, with or without 7f889d2efSBrooks Davis * modification, are permitted provided that the following conditions 8f889d2efSBrooks Davis * are met: 9f889d2efSBrooks Davis * 1. Redistributions of source code must retain the above copyright 10f889d2efSBrooks Davis * notice, this list of conditions and the following disclaimer. 11f889d2efSBrooks Davis * 2. Redistributions in binary form must reproduce the above copyright 12f889d2efSBrooks Davis * notice, this list of conditions and the following disclaimer in the 13f889d2efSBrooks Davis * documentation and/or other materials provided with the distribution. 14f889d2efSBrooks Davis * 4. Neither the name of the University nor the names of its contributors 15f889d2efSBrooks Davis * may be used to endorse or promote products derived from this software 16f889d2efSBrooks Davis * without specific prior written permission. 17f889d2efSBrooks Davis * 18f889d2efSBrooks Davis * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19f889d2efSBrooks Davis * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20f889d2efSBrooks Davis * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21f889d2efSBrooks Davis * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22f889d2efSBrooks Davis * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23f889d2efSBrooks Davis * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24f889d2efSBrooks Davis * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25f889d2efSBrooks Davis * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26f889d2efSBrooks Davis * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27f889d2efSBrooks Davis * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28f889d2efSBrooks Davis * SUCH DAMAGE. 29f889d2efSBrooks Davis * 30f889d2efSBrooks Davis * @(#)if.c 8.5 (Berkeley) 1/9/95 31f889d2efSBrooks Davis * $FreeBSD$ 32f889d2efSBrooks Davis */ 33f889d2efSBrooks Davis 34f889d2efSBrooks Davis #include <sys/param.h> 35c3322cb9SGleb Smirnoff #include <sys/eventhandler.h> 36f889d2efSBrooks Davis #include <sys/malloc.h> 37434dbbb3SRuslan Ermilov #include <sys/limits.h> 38f889d2efSBrooks Davis #include <sys/lock.h> 39f889d2efSBrooks Davis #include <sys/mutex.h> 40f889d2efSBrooks Davis #include <sys/kernel.h> 41f889d2efSBrooks Davis #include <sys/systm.h> 42f889d2efSBrooks Davis #include <sys/types.h> 43f889d2efSBrooks Davis #include <sys/socket.h> 44f889d2efSBrooks Davis 45f889d2efSBrooks Davis #include <net/if.h> 46f889d2efSBrooks Davis #include <net/if_var.h> 4776039bc8SGleb Smirnoff #include <net/if_clone.h> 48f889d2efSBrooks Davis #include <net/radix.h> 49f889d2efSBrooks Davis #include <net/route.h> 5021ca7b57SMarko Zec #include <net/vnet.h> 51f889d2efSBrooks Davis 5242a58907SGleb Smirnoff /* Current IF_MAXUNIT expands maximum to 5 characters. */ 5342a58907SGleb Smirnoff #define IFCLOSIZ (IFNAMSIZ - 5) 5442a58907SGleb Smirnoff 5542a58907SGleb Smirnoff /* 5642a58907SGleb Smirnoff * Structure describing a `cloning' interface. 5742a58907SGleb Smirnoff * 5842a58907SGleb Smirnoff * List of locks 5942a58907SGleb Smirnoff * (c) const until freeing 6042a58907SGleb Smirnoff * (d) driver specific data, may need external protection. 6142a58907SGleb Smirnoff * (e) locked by if_cloners_mtx 6242a58907SGleb Smirnoff * (i) locked by ifc_mtx mtx 6342a58907SGleb Smirnoff */ 6442a58907SGleb Smirnoff struct if_clone { 6542a58907SGleb Smirnoff char ifc_name[IFCLOSIZ]; /* (c) Name of device, e.g. `gif' */ 6642a58907SGleb Smirnoff struct unrhdr *ifc_unrhdr; /* (c) alloc_unr(9) header */ 6742a58907SGleb Smirnoff int ifc_maxunit; /* (c) maximum unit number */ 6842a58907SGleb Smirnoff long ifc_refcnt; /* (i) Reference count. */ 6942a58907SGleb Smirnoff LIST_HEAD(, ifnet) ifc_iflist; /* (i) List of cloned interfaces */ 7042a58907SGleb Smirnoff struct mtx ifc_mtx; /* Mutex to protect members. */ 7142a58907SGleb Smirnoff 7242a58907SGleb Smirnoff enum { SIMPLE, ADVANCED } ifc_type; /* (c) */ 7342a58907SGleb Smirnoff 7442a58907SGleb Smirnoff /* (c) Driver specific cloning functions. Called with no locks held. */ 7542a58907SGleb Smirnoff union { 7642a58907SGleb Smirnoff struct { /* advanced cloner */ 7742a58907SGleb Smirnoff ifc_match_t *_ifc_match; 7842a58907SGleb Smirnoff ifc_create_t *_ifc_create; 7942a58907SGleb Smirnoff ifc_destroy_t *_ifc_destroy; 8042a58907SGleb Smirnoff } A; 8142a58907SGleb Smirnoff struct { /* simple cloner */ 8242a58907SGleb Smirnoff ifcs_create_t *_ifcs_create; 8342a58907SGleb Smirnoff ifcs_destroy_t *_ifcs_destroy; 8442a58907SGleb Smirnoff int _ifcs_minifs; /* minimum ifs */ 8542a58907SGleb Smirnoff 8642a58907SGleb Smirnoff } S; 8742a58907SGleb Smirnoff } U; 8842a58907SGleb Smirnoff #define ifc_match U.A._ifc_match 8942a58907SGleb Smirnoff #define ifc_create U.A._ifc_create 9042a58907SGleb Smirnoff #define ifc_destroy U.A._ifc_destroy 9142a58907SGleb Smirnoff #define ifcs_create U.S._ifcs_create 9242a58907SGleb Smirnoff #define ifcs_destroy U.S._ifcs_destroy 9342a58907SGleb Smirnoff #define ifcs_minifs U.S._ifcs_minifs 9442a58907SGleb Smirnoff 9542a58907SGleb Smirnoff LIST_ENTRY(if_clone) ifc_list; /* (e) On list of cloners */ 9642a58907SGleb Smirnoff }; 9742a58907SGleb Smirnoff 98f889d2efSBrooks Davis static void if_clone_free(struct if_clone *ifc); 996b7330e2SSam Leffler static int if_clone_createif(struct if_clone *ifc, char *name, size_t len, 1006b7330e2SSam Leffler caddr_t params); 101f889d2efSBrooks Davis 10242a58907SGleb Smirnoff static int ifc_simple_match(struct if_clone *, const char *); 10342a58907SGleb Smirnoff static int ifc_simple_create(struct if_clone *, char *, size_t, caddr_t); 10442a58907SGleb Smirnoff static int ifc_simple_destroy(struct if_clone *, struct ifnet *); 10542a58907SGleb Smirnoff 106f889d2efSBrooks Davis static struct mtx if_cloners_mtx; 1073e288e62SDimitry Andric static VNET_DEFINE(int, if_cloners_count); 108eddfbb76SRobert Watson VNET_DEFINE(LIST_HEAD(, if_clone), if_cloners); 109eddfbb76SRobert Watson 1101e77c105SRobert Watson #define V_if_cloners_count VNET(if_cloners_count) 1111e77c105SRobert Watson #define V_if_cloners VNET(if_cloners) 112f889d2efSBrooks Davis 113f889d2efSBrooks Davis #define IF_CLONERS_LOCK_INIT() \ 114f889d2efSBrooks Davis mtx_init(&if_cloners_mtx, "if_cloners lock", NULL, MTX_DEF) 115f889d2efSBrooks Davis #define IF_CLONERS_LOCK_ASSERT() mtx_assert(&if_cloners_mtx, MA_OWNED) 116f889d2efSBrooks Davis #define IF_CLONERS_LOCK() mtx_lock(&if_cloners_mtx) 117f889d2efSBrooks Davis #define IF_CLONERS_UNLOCK() mtx_unlock(&if_cloners_mtx) 118f889d2efSBrooks Davis 119f889d2efSBrooks Davis #define IF_CLONE_LOCK_INIT(ifc) \ 120f889d2efSBrooks Davis mtx_init(&(ifc)->ifc_mtx, "if_clone lock", NULL, MTX_DEF) 121f889d2efSBrooks Davis #define IF_CLONE_LOCK_DESTROY(ifc) mtx_destroy(&(ifc)->ifc_mtx) 122f889d2efSBrooks Davis #define IF_CLONE_LOCK_ASSERT(ifc) mtx_assert(&(ifc)->ifc_mtx, MA_OWNED) 123f889d2efSBrooks Davis #define IF_CLONE_LOCK(ifc) mtx_lock(&(ifc)->ifc_mtx) 124f889d2efSBrooks Davis #define IF_CLONE_UNLOCK(ifc) mtx_unlock(&(ifc)->ifc_mtx) 125f889d2efSBrooks Davis 126f889d2efSBrooks Davis #define IF_CLONE_ADDREF(ifc) \ 127f889d2efSBrooks Davis do { \ 128f889d2efSBrooks Davis IF_CLONE_LOCK(ifc); \ 129f889d2efSBrooks Davis IF_CLONE_ADDREF_LOCKED(ifc); \ 130f889d2efSBrooks Davis IF_CLONE_UNLOCK(ifc); \ 131f889d2efSBrooks Davis } while (0) 132f889d2efSBrooks Davis #define IF_CLONE_ADDREF_LOCKED(ifc) \ 133f889d2efSBrooks Davis do { \ 134f889d2efSBrooks Davis IF_CLONE_LOCK_ASSERT(ifc); \ 135f889d2efSBrooks Davis KASSERT((ifc)->ifc_refcnt >= 0, \ 136f889d2efSBrooks Davis ("negative refcnt %ld", (ifc)->ifc_refcnt)); \ 137f889d2efSBrooks Davis (ifc)->ifc_refcnt++; \ 138f889d2efSBrooks Davis } while (0) 139f889d2efSBrooks Davis #define IF_CLONE_REMREF(ifc) \ 140f889d2efSBrooks Davis do { \ 141f889d2efSBrooks Davis IF_CLONE_LOCK(ifc); \ 142f889d2efSBrooks Davis IF_CLONE_REMREF_LOCKED(ifc); \ 143f889d2efSBrooks Davis } while (0) 144f889d2efSBrooks Davis #define IF_CLONE_REMREF_LOCKED(ifc) \ 145f889d2efSBrooks Davis do { \ 146f889d2efSBrooks Davis IF_CLONE_LOCK_ASSERT(ifc); \ 147f889d2efSBrooks Davis KASSERT((ifc)->ifc_refcnt > 0, \ 148f889d2efSBrooks Davis ("bogus refcnt %ld", (ifc)->ifc_refcnt)); \ 149f889d2efSBrooks Davis if (--(ifc)->ifc_refcnt == 0) { \ 150f889d2efSBrooks Davis IF_CLONE_UNLOCK(ifc); \ 151f889d2efSBrooks Davis if_clone_free(ifc); \ 152ca64c799SMax Laier } else { \ 153f889d2efSBrooks Davis /* silently free the lock */ \ 154f889d2efSBrooks Davis IF_CLONE_UNLOCK(ifc); \ 155ca64c799SMax Laier } \ 156f889d2efSBrooks Davis } while (0) 157f889d2efSBrooks Davis 1584e7e0183SAndrew Thompson #define IFC_IFLIST_INSERT(_ifc, _ifp) \ 1594e7e0183SAndrew Thompson LIST_INSERT_HEAD(&_ifc->ifc_iflist, _ifp, if_clones) 1604e7e0183SAndrew Thompson #define IFC_IFLIST_REMOVE(_ifc, _ifp) \ 1614e7e0183SAndrew Thompson LIST_REMOVE(_ifp, if_clones) 1624e7e0183SAndrew Thompson 163c711aea6SPoul-Henning Kamp static MALLOC_DEFINE(M_CLONE, "clone", "interface cloning framework"); 164f889d2efSBrooks Davis 165d0728d71SRobert Watson void 166d0728d71SRobert Watson vnet_if_clone_init(void) 16737f17770SMarko Zec { 16837f17770SMarko Zec 16937f17770SMarko Zec LIST_INIT(&V_if_cloners); 17037f17770SMarko Zec } 17137f17770SMarko Zec 172f889d2efSBrooks Davis void 173f889d2efSBrooks Davis if_clone_init(void) 174f889d2efSBrooks Davis { 17537f17770SMarko Zec 176f889d2efSBrooks Davis IF_CLONERS_LOCK_INIT(); 177f889d2efSBrooks Davis } 178f889d2efSBrooks Davis 179f889d2efSBrooks Davis /* 1804e7e0183SAndrew Thompson * Lookup and create a clone network interface. 181f889d2efSBrooks Davis */ 182f889d2efSBrooks Davis int 1836b7330e2SSam Leffler if_clone_create(char *name, size_t len, caddr_t params) 184f889d2efSBrooks Davis { 185f889d2efSBrooks Davis struct if_clone *ifc; 186f889d2efSBrooks Davis 187f889d2efSBrooks Davis /* Try to find an applicable cloner for this request */ 188f889d2efSBrooks Davis IF_CLONERS_LOCK(); 18942a58907SGleb Smirnoff LIST_FOREACH(ifc, &V_if_cloners, ifc_list) 19042a58907SGleb Smirnoff if (ifc->ifc_type == SIMPLE) { 19142a58907SGleb Smirnoff if (ifc_simple_match(ifc, name)) 192f889d2efSBrooks Davis break; 19342a58907SGleb Smirnoff } else { 19442a58907SGleb Smirnoff if (ifc->ifc_match(ifc, name)) 19542a58907SGleb Smirnoff break; 196f889d2efSBrooks Davis } 19737f17770SMarko Zec #ifdef VIMAGE 19837f17770SMarko Zec if (ifc == NULL && !IS_DEFAULT_VNET(curvnet)) { 19937f17770SMarko Zec CURVNET_SET_QUIET(vnet0); 20042a58907SGleb Smirnoff LIST_FOREACH(ifc, &V_if_cloners, ifc_list) 20142a58907SGleb Smirnoff if (ifc->ifc_type == SIMPLE) { 20242a58907SGleb Smirnoff if (ifc_simple_match(ifc, name)) 20342a58907SGleb Smirnoff break; 20442a58907SGleb Smirnoff } else { 20537f17770SMarko Zec if (ifc->ifc_match(ifc, name)) 20637f17770SMarko Zec break; 20737f17770SMarko Zec } 20837f17770SMarko Zec CURVNET_RESTORE(); 20937f17770SMarko Zec } 21037f17770SMarko Zec #endif 211f889d2efSBrooks Davis IF_CLONERS_UNLOCK(); 212f889d2efSBrooks Davis 213f889d2efSBrooks Davis if (ifc == NULL) 214f889d2efSBrooks Davis return (EINVAL); 215f889d2efSBrooks Davis 2166b7330e2SSam Leffler return (if_clone_createif(ifc, name, len, params)); 2174e7e0183SAndrew Thompson } 2184e7e0183SAndrew Thompson 2194e7e0183SAndrew Thompson /* 2204e7e0183SAndrew Thompson * Create a clone network interface. 2214e7e0183SAndrew Thompson */ 2224e7e0183SAndrew Thompson static int 2236b7330e2SSam Leffler if_clone_createif(struct if_clone *ifc, char *name, size_t len, caddr_t params) 2244e7e0183SAndrew Thompson { 2254e7e0183SAndrew Thompson int err; 2264e7e0183SAndrew Thompson struct ifnet *ifp; 2274e7e0183SAndrew Thompson 2284e7e0183SAndrew Thompson if (ifunit(name) != NULL) 2294e7e0183SAndrew Thompson return (EEXIST); 2304e7e0183SAndrew Thompson 23142a58907SGleb Smirnoff if (ifc->ifc_type == SIMPLE) 23242a58907SGleb Smirnoff err = ifc_simple_create(ifc, name, len, params); 23342a58907SGleb Smirnoff else 2346b7330e2SSam Leffler err = (*ifc->ifc_create)(ifc, name, len, params); 2354e7e0183SAndrew Thompson 2364e7e0183SAndrew Thompson if (!err) { 2374e7e0183SAndrew Thompson ifp = ifunit(name); 2384e7e0183SAndrew Thompson if (ifp == NULL) 2394e7e0183SAndrew Thompson panic("%s: lookup failed for %s", __func__, name); 2404e7e0183SAndrew Thompson 2410dad3f0eSMax Laier if_addgroup(ifp, ifc->ifc_name); 2420dad3f0eSMax Laier 2434e7e0183SAndrew Thompson IF_CLONE_LOCK(ifc); 2444e7e0183SAndrew Thompson IFC_IFLIST_INSERT(ifc, ifp); 2454e7e0183SAndrew Thompson IF_CLONE_UNLOCK(ifc); 2464e7e0183SAndrew Thompson } 2474e7e0183SAndrew Thompson 248f889d2efSBrooks Davis return (err); 249f889d2efSBrooks Davis } 250f889d2efSBrooks Davis 251f889d2efSBrooks Davis /* 2524e7e0183SAndrew Thompson * Lookup and destroy a clone network interface. 253f889d2efSBrooks Davis */ 254f889d2efSBrooks Davis int 255f889d2efSBrooks Davis if_clone_destroy(const char *name) 256f889d2efSBrooks Davis { 257d0088cdeSBjoern A. Zeeb int err; 258f889d2efSBrooks Davis struct if_clone *ifc; 259f889d2efSBrooks Davis struct ifnet *ifp; 260f889d2efSBrooks Davis 261d0088cdeSBjoern A. Zeeb ifp = ifunit_ref(name); 262f889d2efSBrooks Davis if (ifp == NULL) 263f889d2efSBrooks Davis return (ENXIO); 264f889d2efSBrooks Davis 265f889d2efSBrooks Davis /* Find the cloner for this interface */ 266f889d2efSBrooks Davis IF_CLONERS_LOCK(); 26737f17770SMarko Zec LIST_FOREACH(ifc, &V_if_cloners, ifc_list) { 268f889d2efSBrooks Davis if (strcmp(ifc->ifc_name, ifp->if_dname) == 0) { 269f889d2efSBrooks Davis break; 270f889d2efSBrooks Davis } 271f889d2efSBrooks Davis } 27237f17770SMarko Zec #ifdef VIMAGE 27337f17770SMarko Zec if (ifc == NULL && !IS_DEFAULT_VNET(curvnet)) { 27437f17770SMarko Zec CURVNET_SET_QUIET(vnet0); 27542a58907SGleb Smirnoff LIST_FOREACH(ifc, &V_if_cloners, ifc_list) 2763aaf0159SGleb Smirnoff if (ifc->ifc_type == SIMPLE) { 27742a58907SGleb Smirnoff if (ifc_simple_match(ifc, name)) 27842a58907SGleb Smirnoff break; 27942a58907SGleb Smirnoff } else { 28037f17770SMarko Zec if (ifc->ifc_match(ifc, name)) 28137f17770SMarko Zec break; 28237f17770SMarko Zec } 28337f17770SMarko Zec CURVNET_RESTORE(); 28437f17770SMarko Zec } 28537f17770SMarko Zec #endif 286f889d2efSBrooks Davis IF_CLONERS_UNLOCK(); 287d0088cdeSBjoern A. Zeeb if (ifc == NULL) { 288d0088cdeSBjoern A. Zeeb if_rele(ifp); 289f889d2efSBrooks Davis return (EINVAL); 290d0088cdeSBjoern A. Zeeb } 291f889d2efSBrooks Davis 292d0088cdeSBjoern A. Zeeb err = if_clone_destroyif(ifc, ifp); 293d0088cdeSBjoern A. Zeeb if_rele(ifp); 294d0088cdeSBjoern A. Zeeb return err; 2954e7e0183SAndrew Thompson } 2964e7e0183SAndrew Thompson 2974e7e0183SAndrew Thompson /* 2984e7e0183SAndrew Thompson * Destroy a clone network interface. 2994e7e0183SAndrew Thompson */ 300cb959fa2SAndrew Thompson int 3014e7e0183SAndrew Thompson if_clone_destroyif(struct if_clone *ifc, struct ifnet *ifp) 3024e7e0183SAndrew Thompson { 3034e7e0183SAndrew Thompson int err; 304c769e1beSBjoern A. Zeeb struct ifnet *ifcifp; 3054e7e0183SAndrew Thompson 30642a58907SGleb Smirnoff if (ifc->ifc_type == ADVANCED && ifc->ifc_destroy == NULL) 30721ca7b57SMarko Zec return(EOPNOTSUPP); 308f889d2efSBrooks Davis 30937f17770SMarko Zec /* 31037f17770SMarko Zec * Given that the cloned ifnet might be attached to a different 31137f17770SMarko Zec * vnet from where its cloner was registered, we have to 31237f17770SMarko Zec * switch to the vnet context of the target vnet. 31337f17770SMarko Zec */ 31437f17770SMarko Zec CURVNET_SET_QUIET(ifp->if_vnet); 31537f17770SMarko Zec 316434dbbb3SRuslan Ermilov IF_CLONE_LOCK(ifc); 317c769e1beSBjoern A. Zeeb LIST_FOREACH(ifcifp, &ifc->ifc_iflist, if_clones) { 318c769e1beSBjoern A. Zeeb if (ifcifp == ifp) { 319434dbbb3SRuslan Ermilov IFC_IFLIST_REMOVE(ifc, ifp); 320c769e1beSBjoern A. Zeeb break; 321c769e1beSBjoern A. Zeeb } 322c769e1beSBjoern A. Zeeb } 323434dbbb3SRuslan Ermilov IF_CLONE_UNLOCK(ifc); 324c769e1beSBjoern A. Zeeb if (ifcifp == NULL) { 325c769e1beSBjoern A. Zeeb CURVNET_RESTORE(); 326c769e1beSBjoern A. Zeeb return (ENXIO); /* ifp is not on the list. */ 327c769e1beSBjoern A. Zeeb } 328434dbbb3SRuslan Ermilov 3290dad3f0eSMax Laier if_delgroup(ifp, ifc->ifc_name); 3300dad3f0eSMax Laier 33142a58907SGleb Smirnoff if (ifc->ifc_type == SIMPLE) 33242a58907SGleb Smirnoff err = ifc_simple_destroy(ifc, ifp); 33342a58907SGleb Smirnoff else 334f889d2efSBrooks Davis err = (*ifc->ifc_destroy)(ifc, ifp); 335f889d2efSBrooks Davis 336434dbbb3SRuslan Ermilov if (err != 0) { 3370dad3f0eSMax Laier if_addgroup(ifp, ifc->ifc_name); 3380dad3f0eSMax Laier 339434dbbb3SRuslan Ermilov IF_CLONE_LOCK(ifc); 340434dbbb3SRuslan Ermilov IFC_IFLIST_INSERT(ifc, ifp); 341434dbbb3SRuslan Ermilov IF_CLONE_UNLOCK(ifc); 342434dbbb3SRuslan Ermilov } 34321ca7b57SMarko Zec CURVNET_RESTORE(); 344f889d2efSBrooks Davis return (err); 345f889d2efSBrooks Davis } 346f889d2efSBrooks Davis 34742a58907SGleb Smirnoff static struct if_clone * 34842a58907SGleb Smirnoff if_clone_alloc(const char *name, int maxunit) 34942a58907SGleb Smirnoff { 35042a58907SGleb Smirnoff struct if_clone *ifc; 35142a58907SGleb Smirnoff 35242a58907SGleb Smirnoff KASSERT(name != NULL, ("%s: no name\n", __func__)); 35342a58907SGleb Smirnoff 35442a58907SGleb Smirnoff ifc = malloc(sizeof(struct if_clone), M_CLONE, M_WAITOK | M_ZERO); 35542a58907SGleb Smirnoff strncpy(ifc->ifc_name, name, IFCLOSIZ-1); 35642a58907SGleb Smirnoff IF_CLONE_LOCK_INIT(ifc); 35742a58907SGleb Smirnoff IF_CLONE_ADDREF(ifc); 35842a58907SGleb Smirnoff ifc->ifc_maxunit = maxunit ? maxunit : IF_MAXUNIT; 35942a58907SGleb Smirnoff ifc->ifc_unrhdr = new_unrhdr(0, ifc->ifc_maxunit, &ifc->ifc_mtx); 36042a58907SGleb Smirnoff LIST_INIT(&ifc->ifc_iflist); 36142a58907SGleb Smirnoff 36242a58907SGleb Smirnoff return (ifc); 36342a58907SGleb Smirnoff } 36442a58907SGleb Smirnoff 36542a58907SGleb Smirnoff static int 366f889d2efSBrooks Davis if_clone_attach(struct if_clone *ifc) 367f889d2efSBrooks Davis { 3682e9fff5bSGleb Smirnoff struct if_clone *ifc1; 369f889d2efSBrooks Davis 370f889d2efSBrooks Davis IF_CLONERS_LOCK(); 3712e9fff5bSGleb Smirnoff LIST_FOREACH(ifc1, &V_if_cloners, ifc_list) 3722e9fff5bSGleb Smirnoff if (strcmp(ifc->ifc_name, ifc1->ifc_name) == 0) { 3732e9fff5bSGleb Smirnoff IF_CLONERS_UNLOCK(); 3742e9fff5bSGleb Smirnoff IF_CLONE_REMREF(ifc); 3752e9fff5bSGleb Smirnoff return (EEXIST); 3762e9fff5bSGleb Smirnoff } 37737f17770SMarko Zec LIST_INSERT_HEAD(&V_if_cloners, ifc, ifc_list); 37837f17770SMarko Zec V_if_cloners_count++; 379f889d2efSBrooks Davis IF_CLONERS_UNLOCK(); 380f889d2efSBrooks Davis 38142a58907SGleb Smirnoff return (0); 38242a58907SGleb Smirnoff } 38342a58907SGleb Smirnoff 38442a58907SGleb Smirnoff struct if_clone * 38542a58907SGleb Smirnoff if_clone_advanced(const char *name, u_int maxunit, ifc_match_t match, 38642a58907SGleb Smirnoff ifc_create_t create, ifc_destroy_t destroy) 38742a58907SGleb Smirnoff { 38842a58907SGleb Smirnoff struct if_clone *ifc; 38942a58907SGleb Smirnoff 39042a58907SGleb Smirnoff ifc = if_clone_alloc(name, maxunit); 39142a58907SGleb Smirnoff ifc->ifc_type = ADVANCED; 39242a58907SGleb Smirnoff ifc->ifc_match = match; 39342a58907SGleb Smirnoff ifc->ifc_create = create; 39442a58907SGleb Smirnoff ifc->ifc_destroy = destroy; 39542a58907SGleb Smirnoff 39642a58907SGleb Smirnoff if (if_clone_attach(ifc) != 0) { 39742a58907SGleb Smirnoff if_clone_free(ifc); 39842a58907SGleb Smirnoff return (NULL); 39942a58907SGleb Smirnoff } 40042a58907SGleb Smirnoff 401f889d2efSBrooks Davis EVENTHANDLER_INVOKE(if_clone_event, ifc); 4022e9fff5bSGleb Smirnoff 40342a58907SGleb Smirnoff return (ifc); 40442a58907SGleb Smirnoff } 40542a58907SGleb Smirnoff 40642a58907SGleb Smirnoff struct if_clone * 40742a58907SGleb Smirnoff if_clone_simple(const char *name, ifcs_create_t create, ifcs_destroy_t destroy, 40842a58907SGleb Smirnoff u_int minifs) 40942a58907SGleb Smirnoff { 41042a58907SGleb Smirnoff struct if_clone *ifc; 41142a58907SGleb Smirnoff u_int unit; 41242a58907SGleb Smirnoff 41342a58907SGleb Smirnoff ifc = if_clone_alloc(name, 0); 41442a58907SGleb Smirnoff ifc->ifc_type = SIMPLE; 41542a58907SGleb Smirnoff ifc->ifcs_create = create; 41642a58907SGleb Smirnoff ifc->ifcs_destroy = destroy; 41742a58907SGleb Smirnoff ifc->ifcs_minifs = minifs; 41842a58907SGleb Smirnoff 41942a58907SGleb Smirnoff if (if_clone_attach(ifc) != 0) { 42042a58907SGleb Smirnoff if_clone_free(ifc); 42142a58907SGleb Smirnoff return (NULL); 42242a58907SGleb Smirnoff } 42342a58907SGleb Smirnoff 42442a58907SGleb Smirnoff for (unit = 0; unit < minifs; unit++) { 42542a58907SGleb Smirnoff char name[IFNAMSIZ]; 42642a58907SGleb Smirnoff int error; 42742a58907SGleb Smirnoff 42842a58907SGleb Smirnoff snprintf(name, IFNAMSIZ, "%s%d", ifc->ifc_name, unit); 42942a58907SGleb Smirnoff error = if_clone_createif(ifc, name, IFNAMSIZ, NULL); 43042a58907SGleb Smirnoff KASSERT(error == 0, 43142a58907SGleb Smirnoff ("%s: failed to create required interface %s", 43242a58907SGleb Smirnoff __func__, name)); 43342a58907SGleb Smirnoff } 43442a58907SGleb Smirnoff 43542a58907SGleb Smirnoff EVENTHANDLER_INVOKE(if_clone_event, ifc); 43642a58907SGleb Smirnoff 43742a58907SGleb Smirnoff return (ifc); 438f889d2efSBrooks Davis } 439f889d2efSBrooks Davis 440f889d2efSBrooks Davis /* 441f889d2efSBrooks Davis * Unregister a network interface cloner. 442f889d2efSBrooks Davis */ 443f889d2efSBrooks Davis void 444f889d2efSBrooks Davis if_clone_detach(struct if_clone *ifc) 445f889d2efSBrooks Davis { 446f889d2efSBrooks Davis 447f889d2efSBrooks Davis IF_CLONERS_LOCK(); 448f889d2efSBrooks Davis LIST_REMOVE(ifc, ifc_list); 44937f17770SMarko Zec V_if_cloners_count--; 450f889d2efSBrooks Davis IF_CLONERS_UNLOCK(); 451f889d2efSBrooks Davis 452febd0759SAndrew Thompson /* Allow all simples to be destroyed */ 45342a58907SGleb Smirnoff if (ifc->ifc_type == SIMPLE) 45442a58907SGleb Smirnoff ifc->ifcs_minifs = 0; 455febd0759SAndrew Thompson 4564e7e0183SAndrew Thompson /* destroy all interfaces for this cloner */ 4574e7e0183SAndrew Thompson while (!LIST_EMPTY(&ifc->ifc_iflist)) 4584e7e0183SAndrew Thompson if_clone_destroyif(ifc, LIST_FIRST(&ifc->ifc_iflist)); 4594e7e0183SAndrew Thompson 460f889d2efSBrooks Davis IF_CLONE_REMREF(ifc); 461f889d2efSBrooks Davis } 462f889d2efSBrooks Davis 463f889d2efSBrooks Davis static void 464f889d2efSBrooks Davis if_clone_free(struct if_clone *ifc) 465f889d2efSBrooks Davis { 466f889d2efSBrooks Davis 4674e7e0183SAndrew Thompson KASSERT(LIST_EMPTY(&ifc->ifc_iflist), 4684e7e0183SAndrew Thompson ("%s: ifc_iflist not empty", __func__)); 4694e7e0183SAndrew Thompson 470f889d2efSBrooks Davis IF_CLONE_LOCK_DESTROY(ifc); 4712e9fff5bSGleb Smirnoff delete_unrhdr(ifc->ifc_unrhdr); 47242a58907SGleb Smirnoff free(ifc, M_CLONE); 473f889d2efSBrooks Davis } 474f889d2efSBrooks Davis 475f889d2efSBrooks Davis /* 476f889d2efSBrooks Davis * Provide list of interface cloners to userspace. 477f889d2efSBrooks Davis */ 478f889d2efSBrooks Davis int 479f889d2efSBrooks Davis if_clone_list(struct if_clonereq *ifcr) 480f889d2efSBrooks Davis { 481c859ef97SBrooks Davis char *buf, *dst, *outbuf = NULL; 482f889d2efSBrooks Davis struct if_clone *ifc; 483c859ef97SBrooks Davis int buf_count, count, err = 0; 484c859ef97SBrooks Davis 485a6d00835SMaxim Konovalov if (ifcr->ifcr_count < 0) 486a6d00835SMaxim Konovalov return (EINVAL); 487a6d00835SMaxim Konovalov 488c859ef97SBrooks Davis IF_CLONERS_LOCK(); 489c859ef97SBrooks Davis /* 490c859ef97SBrooks Davis * Set our internal output buffer size. We could end up not 491c859ef97SBrooks Davis * reporting a cloner that is added between the unlock and lock 492c859ef97SBrooks Davis * below, but that's not a major problem. Not caping our 493c859ef97SBrooks Davis * allocation to the number of cloners actually in the system 494c859ef97SBrooks Davis * could be because that would let arbitrary users cause us to 495c859ef97SBrooks Davis * allocate abritrary amounts of kernel memory. 496c859ef97SBrooks Davis */ 49737f17770SMarko Zec buf_count = (V_if_cloners_count < ifcr->ifcr_count) ? 49837f17770SMarko Zec V_if_cloners_count : ifcr->ifcr_count; 499c859ef97SBrooks Davis IF_CLONERS_UNLOCK(); 500c859ef97SBrooks Davis 501c859ef97SBrooks Davis outbuf = malloc(IFNAMSIZ*buf_count, M_CLONE, M_WAITOK | M_ZERO); 502f889d2efSBrooks Davis 503f889d2efSBrooks Davis IF_CLONERS_LOCK(); 504f889d2efSBrooks Davis 50537f17770SMarko Zec ifcr->ifcr_total = V_if_cloners_count; 506f889d2efSBrooks Davis if ((dst = ifcr->ifcr_buffer) == NULL) { 507f889d2efSBrooks Davis /* Just asking how many there are. */ 508f889d2efSBrooks Davis goto done; 509f889d2efSBrooks Davis } 51037f17770SMarko Zec count = (V_if_cloners_count < buf_count) ? 51137f17770SMarko Zec V_if_cloners_count : buf_count; 512f889d2efSBrooks Davis 51337f17770SMarko Zec for (ifc = LIST_FIRST(&V_if_cloners), buf = outbuf; 514c859ef97SBrooks Davis ifc != NULL && count != 0; 515c859ef97SBrooks Davis ifc = LIST_NEXT(ifc, ifc_list), count--, buf += IFNAMSIZ) { 516c859ef97SBrooks Davis strlcpy(buf, ifc->ifc_name, IFNAMSIZ); 517f889d2efSBrooks Davis } 518f889d2efSBrooks Davis 519f889d2efSBrooks Davis done: 520f889d2efSBrooks Davis IF_CLONERS_UNLOCK(); 521c859ef97SBrooks Davis if (err == 0) 522c859ef97SBrooks Davis err = copyout(outbuf, dst, buf_count*IFNAMSIZ); 523c859ef97SBrooks Davis if (outbuf != NULL) 524c859ef97SBrooks Davis free(outbuf, M_CLONE); 525f889d2efSBrooks Davis return (err); 526f889d2efSBrooks Davis } 527f889d2efSBrooks Davis 528f889d2efSBrooks Davis /* 529f889d2efSBrooks Davis * A utility function to extract unit numbers from interface names of 530f889d2efSBrooks Davis * the form name###. 531f889d2efSBrooks Davis * 532f889d2efSBrooks Davis * Returns 0 on success and an error on failure. 533f889d2efSBrooks Davis */ 534f889d2efSBrooks Davis int 535f889d2efSBrooks Davis ifc_name2unit(const char *name, int *unit) 536f889d2efSBrooks Davis { 537f889d2efSBrooks Davis const char *cp; 538434dbbb3SRuslan Ermilov int cutoff = INT_MAX / 10; 539434dbbb3SRuslan Ermilov int cutlim = INT_MAX % 10; 540f889d2efSBrooks Davis 541f889d2efSBrooks Davis for (cp = name; *cp != '\0' && (*cp < '0' || *cp > '9'); cp++); 542f889d2efSBrooks Davis if (*cp == '\0') { 543f889d2efSBrooks Davis *unit = -1; 544434dbbb3SRuslan Ermilov } else if (cp[0] == '0' && cp[1] != '\0') { 545434dbbb3SRuslan Ermilov /* Disallow leading zeroes. */ 546434dbbb3SRuslan Ermilov return (EINVAL); 547f889d2efSBrooks Davis } else { 548f889d2efSBrooks Davis for (*unit = 0; *cp != '\0'; cp++) { 549f889d2efSBrooks Davis if (*cp < '0' || *cp > '9') { 550f889d2efSBrooks Davis /* Bogus unit number. */ 551f889d2efSBrooks Davis return (EINVAL); 552f889d2efSBrooks Davis } 553434dbbb3SRuslan Ermilov if (*unit > cutoff || 554434dbbb3SRuslan Ermilov (*unit == cutoff && *cp - '0' > cutlim)) 555434dbbb3SRuslan Ermilov return (EINVAL); 556f889d2efSBrooks Davis *unit = (*unit * 10) + (*cp - '0'); 557f889d2efSBrooks Davis } 558f889d2efSBrooks Davis } 559f889d2efSBrooks Davis 560f889d2efSBrooks Davis return (0); 561f889d2efSBrooks Davis } 562f889d2efSBrooks Davis 563f889d2efSBrooks Davis int 564f889d2efSBrooks Davis ifc_alloc_unit(struct if_clone *ifc, int *unit) 565f889d2efSBrooks Davis { 5662e9fff5bSGleb Smirnoff char name[IFNAMSIZ]; 5672e9fff5bSGleb Smirnoff int wildcard; 568f889d2efSBrooks Davis 569f889d2efSBrooks Davis wildcard = (*unit < 0); 5702e9fff5bSGleb Smirnoff retry: 5713932d760SGleb Smirnoff if (*unit > ifc->ifc_maxunit) 5723932d760SGleb Smirnoff return (ENOSPC); 5733932d760SGleb Smirnoff if (*unit < 0) { 5742e9fff5bSGleb Smirnoff *unit = alloc_unr(ifc->ifc_unrhdr); 5752e9fff5bSGleb Smirnoff if (*unit == -1) 5762e9fff5bSGleb Smirnoff return (ENOSPC); 5772e9fff5bSGleb Smirnoff } else { 5782e9fff5bSGleb Smirnoff *unit = alloc_unr_specific(ifc->ifc_unrhdr, *unit); 5793932d760SGleb Smirnoff if (*unit == -1) { 5803932d760SGleb Smirnoff if (wildcard) { 5813932d760SGleb Smirnoff (*unit)++; 5823932d760SGleb Smirnoff goto retry; 5833932d760SGleb Smirnoff } else 5842e9fff5bSGleb Smirnoff return (EEXIST); 585f889d2efSBrooks Davis } 5863932d760SGleb Smirnoff } 587f889d2efSBrooks Davis 5882e9fff5bSGleb Smirnoff snprintf(name, IFNAMSIZ, "%s%d", ifc->ifc_name, *unit); 5892e9fff5bSGleb Smirnoff if (ifunit(name) != NULL) { 5903932d760SGleb Smirnoff free_unr(ifc->ifc_unrhdr, *unit); 5913932d760SGleb Smirnoff if (wildcard) { 5923932d760SGleb Smirnoff (*unit)++; 5933932d760SGleb Smirnoff goto retry; 5943932d760SGleb Smirnoff } else 5952e9fff5bSGleb Smirnoff return (EEXIST); 596f889d2efSBrooks Davis } 597f889d2efSBrooks Davis 5982e9fff5bSGleb Smirnoff IF_CLONE_ADDREF(ifc); 599f889d2efSBrooks Davis 6002e9fff5bSGleb Smirnoff return (0); 601f889d2efSBrooks Davis } 602f889d2efSBrooks Davis 603f889d2efSBrooks Davis void 604f889d2efSBrooks Davis ifc_free_unit(struct if_clone *ifc, int unit) 605f889d2efSBrooks Davis { 606f889d2efSBrooks Davis 6072e9fff5bSGleb Smirnoff free_unr(ifc->ifc_unrhdr, unit); 6082e9fff5bSGleb Smirnoff IF_CLONE_REMREF(ifc); 609f889d2efSBrooks Davis } 610f889d2efSBrooks Davis 61142a58907SGleb Smirnoff static int 612f889d2efSBrooks Davis ifc_simple_match(struct if_clone *ifc, const char *name) 613f889d2efSBrooks Davis { 614f889d2efSBrooks Davis const char *cp; 615f889d2efSBrooks Davis int i; 616f889d2efSBrooks Davis 617f889d2efSBrooks Davis /* Match the name */ 618f889d2efSBrooks Davis for (cp = name, i = 0; i < strlen(ifc->ifc_name); i++, cp++) { 619f889d2efSBrooks Davis if (ifc->ifc_name[i] != *cp) 620f889d2efSBrooks Davis return (0); 621f889d2efSBrooks Davis } 622f889d2efSBrooks Davis 623f889d2efSBrooks Davis /* Make sure there's a unit number or nothing after the name */ 624f889d2efSBrooks Davis for (; *cp != '\0'; cp++) { 625f889d2efSBrooks Davis if (*cp < '0' || *cp > '9') 626f889d2efSBrooks Davis return (0); 627f889d2efSBrooks Davis } 628f889d2efSBrooks Davis 629f889d2efSBrooks Davis return (1); 630f889d2efSBrooks Davis } 631f889d2efSBrooks Davis 63242a58907SGleb Smirnoff static int 6336b7330e2SSam Leffler ifc_simple_create(struct if_clone *ifc, char *name, size_t len, caddr_t params) 634f889d2efSBrooks Davis { 635f889d2efSBrooks Davis char *dp; 636f889d2efSBrooks Davis int wildcard; 637f889d2efSBrooks Davis int unit; 638f889d2efSBrooks Davis int err; 639f889d2efSBrooks Davis 640f889d2efSBrooks Davis err = ifc_name2unit(name, &unit); 641f889d2efSBrooks Davis if (err != 0) 642f889d2efSBrooks Davis return (err); 643f889d2efSBrooks Davis 644f889d2efSBrooks Davis wildcard = (unit < 0); 645f889d2efSBrooks Davis 646f889d2efSBrooks Davis err = ifc_alloc_unit(ifc, &unit); 647f889d2efSBrooks Davis if (err != 0) 648f889d2efSBrooks Davis return (err); 649f889d2efSBrooks Davis 65042a58907SGleb Smirnoff err = ifc->ifcs_create(ifc, unit, params); 651f889d2efSBrooks Davis if (err != 0) { 652f889d2efSBrooks Davis ifc_free_unit(ifc, unit); 653f889d2efSBrooks Davis return (err); 654f889d2efSBrooks Davis } 655f889d2efSBrooks Davis 656f889d2efSBrooks Davis /* In the wildcard case, we need to update the name. */ 657f889d2efSBrooks Davis if (wildcard) { 658f889d2efSBrooks Davis for (dp = name; *dp != '\0'; dp++); 659f889d2efSBrooks Davis if (snprintf(dp, len - (dp-name), "%d", unit) > 660f889d2efSBrooks Davis len - (dp-name) - 1) { 661f889d2efSBrooks Davis /* 662f889d2efSBrooks Davis * This can only be a programmer error and 663f889d2efSBrooks Davis * there's no straightforward way to recover if 664f889d2efSBrooks Davis * it happens. 665f889d2efSBrooks Davis */ 666f889d2efSBrooks Davis panic("if_clone_create(): interface name too long"); 667f889d2efSBrooks Davis } 668f889d2efSBrooks Davis 669f889d2efSBrooks Davis } 670f889d2efSBrooks Davis 671f889d2efSBrooks Davis return (0); 672f889d2efSBrooks Davis } 673f889d2efSBrooks Davis 67442a58907SGleb Smirnoff static int 675f889d2efSBrooks Davis ifc_simple_destroy(struct if_clone *ifc, struct ifnet *ifp) 676f889d2efSBrooks Davis { 677f889d2efSBrooks Davis int unit; 678f889d2efSBrooks Davis 679f889d2efSBrooks Davis unit = ifp->if_dunit; 680f889d2efSBrooks Davis 68142a58907SGleb Smirnoff if (unit < ifc->ifcs_minifs) 682f889d2efSBrooks Davis return (EINVAL); 683f889d2efSBrooks Davis 68442a58907SGleb Smirnoff ifc->ifcs_destroy(ifp); 685f889d2efSBrooks Davis 686f889d2efSBrooks Davis ifc_free_unit(ifc, unit); 687f889d2efSBrooks Davis 688f889d2efSBrooks Davis return (0); 689f889d2efSBrooks Davis } 690