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