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 32f889d2efSBrooks Davis #ifndef _NET_IF_CLONE_H_ 33f889d2efSBrooks Davis #define _NET_IF_CLONE_H_ 34f889d2efSBrooks Davis 35f889d2efSBrooks Davis #ifdef _KERNEL 36f889d2efSBrooks Davis 37e2e050c8SConrad Meyer #include <sys/_eventhandler.h> 38e2e050c8SConrad Meyer 3909ee0fc0SAlexander V. Chernikov #define CLONE_COMPAT_13 4009f6ff4fSMatt Macy 4142a58907SGleb Smirnoff struct if_clone; 42f889d2efSBrooks Davis 4309ee0fc0SAlexander V. Chernikov /* Public KPI */ 4409ee0fc0SAlexander V. Chernikov struct ifc_data { 4509ee0fc0SAlexander V. Chernikov uint32_t flags; 4609ee0fc0SAlexander V. Chernikov uint32_t unit; /* Selected unit when IFC_C_AUTOUNIT set */ 4709ee0fc0SAlexander V. Chernikov void *params; 4809ee0fc0SAlexander V. Chernikov struct vnet *vnet; 4909ee0fc0SAlexander V. Chernikov }; 5009ee0fc0SAlexander V. Chernikov 5109ee0fc0SAlexander V. Chernikov typedef int ifc_match_f(struct if_clone *ifc, const char *name); 5209ee0fc0SAlexander V. Chernikov typedef int ifc_create_f(struct if_clone *ifc, char *name, size_t maxlen, 5309ee0fc0SAlexander V. Chernikov struct ifc_data *ifd, struct ifnet **ifpp); 5409ee0fc0SAlexander V. Chernikov typedef int ifc_destroy_f(struct if_clone *ifc, struct ifnet *ifp, uint32_t flags); 5509ee0fc0SAlexander V. Chernikov 56089104e0SAlexander V. Chernikov struct nl_parsed_link; 57089104e0SAlexander V. Chernikov struct nlattr_bmask; 58089104e0SAlexander V. Chernikov struct nl_pstate; 59089104e0SAlexander V. Chernikov struct nl_writer; 60089104e0SAlexander V. Chernikov struct ifc_data_nl { 61089104e0SAlexander V. Chernikov struct nl_parsed_link *lattrs;/* (in) Parsed link attributes */ 62089104e0SAlexander V. Chernikov const struct nlattr_bmask *bm; /* (in) Bitmask of set link attributes */ 63089104e0SAlexander V. Chernikov struct nl_pstate *npt; /* (in) Netlink context */ 64089104e0SAlexander V. Chernikov void *params;/* (in) (Compat) data from ioctl */ 65089104e0SAlexander V. Chernikov uint32_t flags; /* (in) IFC_F flags */ 66089104e0SAlexander V. Chernikov uint32_t unit; /* (in/out) Selected unit when IFC_C_AUTOUNIT set */ 67089104e0SAlexander V. Chernikov int error; /* (out) Return error code */ 68089104e0SAlexander V. Chernikov struct ifnet *ifp; /* (out) Returned ifp */ 69089104e0SAlexander V. Chernikov }; 70089104e0SAlexander V. Chernikov 71089104e0SAlexander V. Chernikov typedef int ifc_create_nl_f(struct if_clone *ifc, char *name, size_t maxlen, 72089104e0SAlexander V. Chernikov struct ifc_data_nl *ifd); 73089104e0SAlexander V. Chernikov typedef int ifc_modify_nl_f(struct ifnet *ifp, struct ifc_data_nl *ifd); 74089104e0SAlexander V. Chernikov typedef void ifc_dump_nl_f(struct ifnet *ifp, struct nl_writer *nw); 75089104e0SAlexander V. Chernikov 7609ee0fc0SAlexander V. Chernikov struct if_clone_addreq { 7709ee0fc0SAlexander V. Chernikov uint16_t version; /* Always 0 for now */ 7809ee0fc0SAlexander V. Chernikov uint16_t spare; 7909ee0fc0SAlexander V. Chernikov uint32_t flags; 8009ee0fc0SAlexander V. Chernikov uint32_t maxunit; /* Maximum allowed unit number */ 8109ee0fc0SAlexander V. Chernikov ifc_match_f *match_f; 8209ee0fc0SAlexander V. Chernikov ifc_create_f *create_f; 8309ee0fc0SAlexander V. Chernikov ifc_destroy_f *destroy_f; 8409ee0fc0SAlexander V. Chernikov }; 8509ee0fc0SAlexander V. Chernikov 86089104e0SAlexander V. Chernikov struct if_clone_addreq_v2 { 87089104e0SAlexander V. Chernikov uint16_t version; /* 2 */ 88089104e0SAlexander V. Chernikov uint16_t spare; 89089104e0SAlexander V. Chernikov uint32_t flags; 90089104e0SAlexander V. Chernikov uint32_t maxunit; /* Maximum allowed unit number */ 91089104e0SAlexander V. Chernikov ifc_match_f *match_f; 92089104e0SAlexander V. Chernikov ifc_create_f *create_f; 93089104e0SAlexander V. Chernikov ifc_destroy_f *destroy_f; 94089104e0SAlexander V. Chernikov ifc_create_nl_f *create_nl_f; 95089104e0SAlexander V. Chernikov ifc_modify_nl_f *modify_nl_f; 96089104e0SAlexander V. Chernikov ifc_dump_nl_f *dump_nl_f; 97089104e0SAlexander V. Chernikov }; 98089104e0SAlexander V. Chernikov 997ff9ae90SMarius Strobl #define IFC_F_SPARE 0x01 10009ee0fc0SAlexander V. Chernikov #define IFC_F_AUTOUNIT 0x02 /* Creation flag: automatically select unit */ 10109ee0fc0SAlexander V. Chernikov #define IFC_F_SYSSPACE 0x04 /* Cloner callback: params pointer is in kernel memory */ 10209ee0fc0SAlexander V. Chernikov #define IFC_F_FORCE 0x08 /* Deletion flag: force interface deletion */ 103089104e0SAlexander V. Chernikov #define IFC_F_CREATE 0x10 /* Creation flag: indicate creation request */ 10409ee0fc0SAlexander V. Chernikov 10509ee0fc0SAlexander V. Chernikov struct if_clone *ifc_attach_cloner(const char *name, struct if_clone_addreq *req); 10609ee0fc0SAlexander V. Chernikov void ifc_detach_cloner(struct if_clone *ifc); 107089104e0SAlexander V. Chernikov int ifc_create_ifp(const char *name, struct ifc_data *ifd, struct ifnet **ifpp); 108089104e0SAlexander V. Chernikov 109089104e0SAlexander V. Chernikov bool ifc_create_ifp_nl(const char *name, struct ifc_data_nl *ifd); 110089104e0SAlexander V. Chernikov bool ifc_modify_ifp_nl(struct ifnet *ifp, struct ifc_data_nl *ifd); 111089104e0SAlexander V. Chernikov bool ifc_dump_ifp_nl(struct ifnet *ifp, struct nl_writer *nw); 11209ee0fc0SAlexander V. Chernikov 11326c190d2SAlexander V. Chernikov void ifc_link_ifp(struct if_clone *ifc, struct ifnet *ifp); 11426c190d2SAlexander V. Chernikov bool ifc_unlink_ifp(struct if_clone *ifc, struct ifnet *ifp); 11526c190d2SAlexander V. Chernikov 11609ee0fc0SAlexander V. Chernikov int ifc_copyin(const struct ifc_data *ifd, void *target, size_t len); 11709ee0fc0SAlexander V. Chernikov #ifdef CLONE_COMPAT_13 11809ee0fc0SAlexander V. Chernikov 11942a58907SGleb Smirnoff /* Methods. */ 12042a58907SGleb Smirnoff typedef int ifc_match_t(struct if_clone *, const char *); 12142a58907SGleb Smirnoff typedef int ifc_create_t(struct if_clone *, char *, size_t, caddr_t); 12242a58907SGleb Smirnoff typedef int ifc_destroy_t(struct if_clone *, struct ifnet *); 123f889d2efSBrooks Davis 12442a58907SGleb Smirnoff typedef int ifcs_create_t(struct if_clone *, int, caddr_t); 12542a58907SGleb Smirnoff typedef void ifcs_destroy_t(struct ifnet *); 126f889d2efSBrooks Davis 12742a58907SGleb Smirnoff /* Interface cloner (de)allocating functions. */ 12842a58907SGleb Smirnoff struct if_clone * 12942a58907SGleb Smirnoff if_clone_advanced(const char *, u_int, ifc_match_t, ifc_create_t, 13042a58907SGleb Smirnoff ifc_destroy_t); 13142a58907SGleb Smirnoff struct if_clone * 13242a58907SGleb Smirnoff if_clone_simple(const char *, ifcs_create_t, ifcs_destroy_t, u_int); 133f889d2efSBrooks Davis void if_clone_detach(struct if_clone *); 13409ee0fc0SAlexander V. Chernikov #endif 135f889d2efSBrooks Davis 136e8b7972cSGordon Bergling /* Unit (de)allocating functions. */ 137f889d2efSBrooks Davis int ifc_name2unit(const char *name, int *unit); 138f889d2efSBrooks Davis int ifc_alloc_unit(struct if_clone *, int *); 139f889d2efSBrooks Davis void ifc_free_unit(struct if_clone *, int); 140f889d2efSBrooks Davis 14142a58907SGleb Smirnoff /* Interface clone event. */ 142f889d2efSBrooks Davis typedef void (*if_clone_event_handler_t)(void *, struct if_clone *); 143f889d2efSBrooks Davis EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t); 144f889d2efSBrooks Davis 14542a58907SGleb Smirnoff /* The below interfaces used only by net/if.c. */ 14642a58907SGleb Smirnoff void vnet_if_clone_init(void); 14742a58907SGleb Smirnoff int if_clone_create(char *, size_t, caddr_t); 14842a58907SGleb Smirnoff int if_clone_destroy(const char *); 14942a58907SGleb Smirnoff int if_clone_list(struct if_clonereq *); 15054712fc4SGleb Smirnoff void if_clone_restoregroup(struct ifnet *); 151f889d2efSBrooks Davis 152b02fd8b7SKristof Provost /* The below interfaces are used only by epair(4). */ 153b02fd8b7SKristof Provost void if_clone_addif(struct if_clone *, struct ifnet *); 15442a58907SGleb Smirnoff int if_clone_destroyif(struct if_clone *, struct ifnet *); 155f889d2efSBrooks Davis 156f889d2efSBrooks Davis #endif /* _KERNEL */ 157f889d2efSBrooks Davis #endif /* !_NET_IF_CLONE_H_ */ 158