1c398230bSWarner Losh /*- 251369649SPedro F. Giffuni * SPDX-License-Identifier: BSD-3-Clause 351369649SPedro F. Giffuni * 4f889d2efSBrooks Davis * Copyright (c) 1982, 1986, 1989, 1993 5f889d2efSBrooks Davis * The Regents of the University of California. All rights reserved. 6f889d2efSBrooks Davis * 7f889d2efSBrooks Davis * Redistribution and use in source and binary forms, with or without 8f889d2efSBrooks Davis * modification, are permitted provided that the following conditions 9f889d2efSBrooks Davis * are met: 10f889d2efSBrooks Davis * 1. Redistributions of source code must retain the above copyright 11f889d2efSBrooks Davis * notice, this list of conditions and the following disclaimer. 12f889d2efSBrooks Davis * 2. Redistributions in binary form must reproduce the above copyright 13f889d2efSBrooks Davis * notice, this list of conditions and the following disclaimer in the 14f889d2efSBrooks Davis * documentation and/or other materials provided with the distribution. 15fbbd9655SWarner Losh * 3. Neither the name of the University nor the names of its contributors 16f889d2efSBrooks Davis * may be used to endorse or promote products derived from this software 17f889d2efSBrooks Davis * without specific prior written permission. 18f889d2efSBrooks Davis * 19f889d2efSBrooks Davis * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20f889d2efSBrooks Davis * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21f889d2efSBrooks Davis * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22f889d2efSBrooks Davis * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23f889d2efSBrooks Davis * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24f889d2efSBrooks Davis * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25f889d2efSBrooks Davis * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26f889d2efSBrooks Davis * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27f889d2efSBrooks Davis * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28f889d2efSBrooks Davis * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29f889d2efSBrooks Davis * SUCH DAMAGE. 30f889d2efSBrooks Davis * 31f889d2efSBrooks Davis * From: @(#)if.h 8.1 (Berkeley) 6/10/93 32f889d2efSBrooks Davis * $FreeBSD$ 33f889d2efSBrooks Davis */ 34f889d2efSBrooks Davis 35f889d2efSBrooks Davis #ifndef _NET_IF_CLONE_H_ 36f889d2efSBrooks Davis #define _NET_IF_CLONE_H_ 37f889d2efSBrooks Davis 38f889d2efSBrooks Davis #ifdef _KERNEL 39f889d2efSBrooks Davis 40e2e050c8SConrad Meyer #include <sys/_eventhandler.h> 41e2e050c8SConrad Meyer 4209ee0fc0SAlexander V. Chernikov #define CLONE_COMPAT_13 4309f6ff4fSMatt Macy 4442a58907SGleb Smirnoff struct if_clone; 45f889d2efSBrooks Davis 4609ee0fc0SAlexander V. Chernikov /* Public KPI */ 4709ee0fc0SAlexander V. Chernikov struct ifc_data { 4809ee0fc0SAlexander V. Chernikov uint32_t flags; 4909ee0fc0SAlexander V. Chernikov uint32_t unit; /* Selected unit when IFC_C_AUTOUNIT set */ 5009ee0fc0SAlexander V. Chernikov void *params; 5109ee0fc0SAlexander V. Chernikov struct vnet *vnet; 5209ee0fc0SAlexander V. Chernikov }; 5309ee0fc0SAlexander V. Chernikov 5409ee0fc0SAlexander V. Chernikov typedef int ifc_match_f(struct if_clone *ifc, const char *name); 5509ee0fc0SAlexander V. Chernikov typedef int ifc_create_f(struct if_clone *ifc, char *name, size_t maxlen, 5609ee0fc0SAlexander V. Chernikov struct ifc_data *ifd, struct ifnet **ifpp); 5709ee0fc0SAlexander V. Chernikov typedef int ifc_destroy_f(struct if_clone *ifc, struct ifnet *ifp, uint32_t flags); 5809ee0fc0SAlexander V. Chernikov 5909ee0fc0SAlexander V. Chernikov struct if_clone_addreq { 6009ee0fc0SAlexander V. Chernikov uint16_t version; /* Always 0 for now */ 6109ee0fc0SAlexander V. Chernikov uint16_t spare; 6209ee0fc0SAlexander V. Chernikov uint32_t flags; 6309ee0fc0SAlexander V. Chernikov uint32_t maxunit; /* Maximum allowed unit number */ 6409ee0fc0SAlexander V. Chernikov ifc_match_f *match_f; 6509ee0fc0SAlexander V. Chernikov ifc_create_f *create_f; 6609ee0fc0SAlexander V. Chernikov ifc_destroy_f *destroy_f; 6709ee0fc0SAlexander V. Chernikov }; 6809ee0fc0SAlexander V. Chernikov 6909ee0fc0SAlexander V. Chernikov #define IFC_F_NOGROUP 0x01 /* Creation flag: don't add unit group */ 7009ee0fc0SAlexander V. Chernikov #define IFC_F_AUTOUNIT 0x02 /* Creation flag: automatically select unit */ 7109ee0fc0SAlexander V. Chernikov #define IFC_F_SYSSPACE 0x04 /* Cloner callback: params pointer is in kernel memory */ 7209ee0fc0SAlexander V. Chernikov #define IFC_F_FORCE 0x08 /* Deletion flag: force interface deletion */ 7309ee0fc0SAlexander V. Chernikov 7409ee0fc0SAlexander V. Chernikov #define IFC_NOGROUP IFC_F_NOGROUP 7509ee0fc0SAlexander V. Chernikov 7609ee0fc0SAlexander V. Chernikov struct if_clone *ifc_attach_cloner(const char *name, struct if_clone_addreq *req); 7709ee0fc0SAlexander V. Chernikov void ifc_detach_cloner(struct if_clone *ifc); 7809ee0fc0SAlexander V. Chernikov int ifc_create_ifp(const char *name, struct ifc_data *ifd, 7909ee0fc0SAlexander V. Chernikov struct ifnet **ifpp); 8009ee0fc0SAlexander V. Chernikov 8109ee0fc0SAlexander V. Chernikov int ifc_copyin(const struct ifc_data *ifd, void *target, size_t len); 8209ee0fc0SAlexander V. Chernikov #ifdef CLONE_COMPAT_13 8309ee0fc0SAlexander V. Chernikov 8442a58907SGleb Smirnoff /* Methods. */ 8542a58907SGleb Smirnoff typedef int ifc_match_t(struct if_clone *, const char *); 8642a58907SGleb Smirnoff typedef int ifc_create_t(struct if_clone *, char *, size_t, caddr_t); 8742a58907SGleb Smirnoff typedef int ifc_destroy_t(struct if_clone *, struct ifnet *); 88f889d2efSBrooks Davis 8942a58907SGleb Smirnoff typedef int ifcs_create_t(struct if_clone *, int, caddr_t); 9042a58907SGleb Smirnoff typedef void ifcs_destroy_t(struct ifnet *); 91f889d2efSBrooks Davis 9242a58907SGleb Smirnoff /* Interface cloner (de)allocating functions. */ 9342a58907SGleb Smirnoff struct if_clone * 9442a58907SGleb Smirnoff if_clone_advanced(const char *, u_int, ifc_match_t, ifc_create_t, 9542a58907SGleb Smirnoff ifc_destroy_t); 9642a58907SGleb Smirnoff struct if_clone * 9742a58907SGleb Smirnoff if_clone_simple(const char *, ifcs_create_t, ifcs_destroy_t, u_int); 98f889d2efSBrooks Davis void if_clone_detach(struct if_clone *); 9909ee0fc0SAlexander V. Chernikov #endif 100f889d2efSBrooks Davis 101e8b7972cSGordon Bergling /* Unit (de)allocating functions. */ 102f889d2efSBrooks Davis int ifc_name2unit(const char *name, int *unit); 103f889d2efSBrooks Davis int ifc_alloc_unit(struct if_clone *, int *); 104f889d2efSBrooks Davis void ifc_free_unit(struct if_clone *, int); 10509f6ff4fSMatt Macy const char *ifc_name(struct if_clone *); 10609f6ff4fSMatt Macy void ifc_flags_set(struct if_clone *, int flags); 10709f6ff4fSMatt Macy int ifc_flags_get(struct if_clone *); 108f889d2efSBrooks Davis 10942a58907SGleb Smirnoff /* Interface clone event. */ 110f889d2efSBrooks Davis typedef void (*if_clone_event_handler_t)(void *, struct if_clone *); 111f889d2efSBrooks Davis EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t); 112f889d2efSBrooks Davis 11342a58907SGleb Smirnoff /* The below interfaces used only by net/if.c. */ 11442a58907SGleb Smirnoff void vnet_if_clone_init(void); 11542a58907SGleb Smirnoff int if_clone_create(char *, size_t, caddr_t); 11642a58907SGleb Smirnoff int if_clone_destroy(const char *); 11742a58907SGleb Smirnoff int if_clone_list(struct if_clonereq *); 11854712fc4SGleb Smirnoff void if_clone_restoregroup(struct ifnet *); 119f889d2efSBrooks Davis 120b02fd8b7SKristof Provost /* The below interfaces are used only by epair(4). */ 121b02fd8b7SKristof Provost void if_clone_addif(struct if_clone *, struct ifnet *); 12242a58907SGleb Smirnoff int if_clone_destroyif(struct if_clone *, struct ifnet *); 123f889d2efSBrooks Davis 124f889d2efSBrooks Davis #endif /* _KERNEL */ 125f889d2efSBrooks Davis #endif /* !_NET_IF_CLONE_H_ */ 126