1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1986, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * From: @(#)if.h 8.1 (Berkeley) 6/10/93 32 * $FreeBSD$ 33 */ 34 35 #ifndef _NET_IF_CLONE_H_ 36 #define _NET_IF_CLONE_H_ 37 38 #ifdef _KERNEL 39 40 #include <sys/_eventhandler.h> 41 42 #define CLONE_COMPAT_13 43 44 struct if_clone; 45 46 /* Public KPI */ 47 struct ifc_data { 48 uint32_t flags; 49 uint32_t unit; /* Selected unit when IFC_C_AUTOUNIT set */ 50 void *params; 51 struct vnet *vnet; 52 }; 53 54 typedef int ifc_match_f(struct if_clone *ifc, const char *name); 55 typedef int ifc_create_f(struct if_clone *ifc, char *name, size_t maxlen, 56 struct ifc_data *ifd, struct ifnet **ifpp); 57 typedef int ifc_destroy_f(struct if_clone *ifc, struct ifnet *ifp, uint32_t flags); 58 59 struct if_clone_addreq { 60 uint16_t version; /* Always 0 for now */ 61 uint16_t spare; 62 uint32_t flags; 63 uint32_t maxunit; /* Maximum allowed unit number */ 64 ifc_match_f *match_f; 65 ifc_create_f *create_f; 66 ifc_destroy_f *destroy_f; 67 }; 68 69 #define IFC_F_NOGROUP 0x01 /* Creation flag: don't add unit group */ 70 #define IFC_F_AUTOUNIT 0x02 /* Creation flag: automatically select unit */ 71 #define IFC_F_SYSSPACE 0x04 /* Cloner callback: params pointer is in kernel memory */ 72 #define IFC_F_FORCE 0x08 /* Deletion flag: force interface deletion */ 73 74 #define IFC_NOGROUP IFC_F_NOGROUP 75 76 struct if_clone *ifc_attach_cloner(const char *name, struct if_clone_addreq *req); 77 void ifc_detach_cloner(struct if_clone *ifc); 78 int ifc_create_ifp(const char *name, struct ifc_data *ifd, 79 struct ifnet **ifpp); 80 81 int ifc_copyin(const struct ifc_data *ifd, void *target, size_t len); 82 #ifdef CLONE_COMPAT_13 83 84 /* Methods. */ 85 typedef int ifc_match_t(struct if_clone *, const char *); 86 typedef int ifc_create_t(struct if_clone *, char *, size_t, caddr_t); 87 typedef int ifc_destroy_t(struct if_clone *, struct ifnet *); 88 89 typedef int ifcs_create_t(struct if_clone *, int, caddr_t); 90 typedef void ifcs_destroy_t(struct ifnet *); 91 92 /* Interface cloner (de)allocating functions. */ 93 struct if_clone * 94 if_clone_advanced(const char *, u_int, ifc_match_t, ifc_create_t, 95 ifc_destroy_t); 96 struct if_clone * 97 if_clone_simple(const char *, ifcs_create_t, ifcs_destroy_t, u_int); 98 void if_clone_detach(struct if_clone *); 99 #endif 100 101 /* Unit (de)allocating functions. */ 102 int ifc_name2unit(const char *name, int *unit); 103 int ifc_alloc_unit(struct if_clone *, int *); 104 void ifc_free_unit(struct if_clone *, int); 105 const char *ifc_name(struct if_clone *); 106 void ifc_flags_set(struct if_clone *, int flags); 107 int ifc_flags_get(struct if_clone *); 108 109 /* Interface clone event. */ 110 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *); 111 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t); 112 113 /* The below interfaces used only by net/if.c. */ 114 void vnet_if_clone_init(void); 115 int if_clone_create(char *, size_t, caddr_t); 116 int if_clone_destroy(const char *); 117 int if_clone_list(struct if_clonereq *); 118 void if_clone_restoregroup(struct ifnet *); 119 120 /* The below interfaces are used only by epair(4). */ 121 void if_clone_addif(struct if_clone *, struct ifnet *); 122 int if_clone_destroyif(struct if_clone *, struct ifnet *); 123 124 #endif /* _KERNEL */ 125 #endif /* !_NET_IF_CLONE_H_ */ 126