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 nl_parsed_link; 60 struct nlattr_bmask; 61 struct nl_pstate; 62 struct nl_writer; 63 struct ifc_data_nl { 64 struct nl_parsed_link *lattrs;/* (in) Parsed link attributes */ 65 const struct nlattr_bmask *bm; /* (in) Bitmask of set link attributes */ 66 struct nl_pstate *npt; /* (in) Netlink context */ 67 void *params;/* (in) (Compat) data from ioctl */ 68 uint32_t flags; /* (in) IFC_F flags */ 69 uint32_t unit; /* (in/out) Selected unit when IFC_C_AUTOUNIT set */ 70 int error; /* (out) Return error code */ 71 struct ifnet *ifp; /* (out) Returned ifp */ 72 }; 73 74 typedef int ifc_create_nl_f(struct if_clone *ifc, char *name, size_t maxlen, 75 struct ifc_data_nl *ifd); 76 typedef int ifc_modify_nl_f(struct ifnet *ifp, struct ifc_data_nl *ifd); 77 typedef void ifc_dump_nl_f(struct ifnet *ifp, struct nl_writer *nw); 78 79 struct if_clone_addreq { 80 uint16_t version; /* Always 0 for now */ 81 uint16_t spare; 82 uint32_t flags; 83 uint32_t maxunit; /* Maximum allowed unit number */ 84 ifc_match_f *match_f; 85 ifc_create_f *create_f; 86 ifc_destroy_f *destroy_f; 87 }; 88 89 struct if_clone_addreq_v2 { 90 uint16_t version; /* 2 */ 91 uint16_t spare; 92 uint32_t flags; 93 uint32_t maxunit; /* Maximum allowed unit number */ 94 ifc_match_f *match_f; 95 ifc_create_f *create_f; 96 ifc_destroy_f *destroy_f; 97 ifc_create_nl_f *create_nl_f; 98 ifc_modify_nl_f *modify_nl_f; 99 ifc_dump_nl_f *dump_nl_f; 100 }; 101 102 103 #define IFC_F_NOGROUP 0x01 /* Creation flag: don't add unit group */ 104 #define IFC_F_AUTOUNIT 0x02 /* Creation flag: automatically select unit */ 105 #define IFC_F_SYSSPACE 0x04 /* Cloner callback: params pointer is in kernel memory */ 106 #define IFC_F_FORCE 0x08 /* Deletion flag: force interface deletion */ 107 #define IFC_F_CREATE 0x10 /* Creation flag: indicate creation request */ 108 109 #define IFC_NOGROUP IFC_F_NOGROUP 110 111 struct if_clone *ifc_attach_cloner(const char *name, struct if_clone_addreq *req); 112 void ifc_detach_cloner(struct if_clone *ifc); 113 int ifc_create_ifp(const char *name, struct ifc_data *ifd, struct ifnet **ifpp); 114 115 bool ifc_create_ifp_nl(const char *name, struct ifc_data_nl *ifd); 116 bool ifc_modify_ifp_nl(struct ifnet *ifp, struct ifc_data_nl *ifd); 117 bool ifc_dump_ifp_nl(struct ifnet *ifp, struct nl_writer *nw); 118 119 void ifc_link_ifp(struct if_clone *ifc, struct ifnet *ifp); 120 bool ifc_unlink_ifp(struct if_clone *ifc, struct ifnet *ifp); 121 122 int ifc_copyin(const struct ifc_data *ifd, void *target, size_t len); 123 #ifdef CLONE_COMPAT_13 124 125 /* Methods. */ 126 typedef int ifc_match_t(struct if_clone *, const char *); 127 typedef int ifc_create_t(struct if_clone *, char *, size_t, caddr_t); 128 typedef int ifc_destroy_t(struct if_clone *, struct ifnet *); 129 130 typedef int ifcs_create_t(struct if_clone *, int, caddr_t); 131 typedef void ifcs_destroy_t(struct ifnet *); 132 133 /* Interface cloner (de)allocating functions. */ 134 struct if_clone * 135 if_clone_advanced(const char *, u_int, ifc_match_t, ifc_create_t, 136 ifc_destroy_t); 137 struct if_clone * 138 if_clone_simple(const char *, ifcs_create_t, ifcs_destroy_t, u_int); 139 void if_clone_detach(struct if_clone *); 140 #endif 141 142 /* Unit (de)allocating functions. */ 143 int ifc_name2unit(const char *name, int *unit); 144 int ifc_alloc_unit(struct if_clone *, int *); 145 void ifc_free_unit(struct if_clone *, int); 146 const char *ifc_name(struct if_clone *); 147 void ifc_flags_set(struct if_clone *, int flags); 148 int ifc_flags_get(struct if_clone *); 149 150 /* Interface clone event. */ 151 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *); 152 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t); 153 154 /* The below interfaces used only by net/if.c. */ 155 void vnet_if_clone_init(void); 156 int if_clone_create(char *, size_t, caddr_t); 157 int if_clone_destroy(const char *); 158 int if_clone_list(struct if_clonereq *); 159 void if_clone_restoregroup(struct ifnet *); 160 161 /* The below interfaces are used only by epair(4). */ 162 void if_clone_addif(struct if_clone *, struct ifnet *); 163 int if_clone_destroyif(struct if_clone *, struct ifnet *); 164 165 #endif /* _KERNEL */ 166 #endif /* !_NET_IF_CLONE_H_ */ 167