1 /*-
2 * Copyright (c) 2014-2018, Matthew Macy <[email protected]>
3 * Copyright (C) 2017-2018 Joyent Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * 2. Neither the name of Matthew Macy nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31
32 #include "opt_inet.h"
33 #include "opt_inet6.h"
34 #include "opt_acpi.h"
35 #include "opt_sched.h"
36
37 #include <sys/param.h>
38 #include <sys/types.h>
39 #include <sys/bus.h>
40 #include <sys/eventhandler.h>
41 #include <sys/event.h>
42 #include <sys/sockio.h>
43 #include <sys/kernel.h>
44 #include <sys/lock.h>
45 #include <sys/mutex.h>
46 #include <sys/module.h>
47 #include <sys/kobj.h>
48 #include <sys/rman.h>
49 #include <sys/sbuf.h>
50 #include <sys/smp.h>
51 #include <sys/socket.h>
52 #include <sys/sysctl.h>
53 #include <sys/syslog.h>
54 #include <sys/taskqueue.h>
55 #include <sys/limits.h>
56 #include <sys/queue.h>
57 #include <sys/jail.h>
58 #include <sys/md5.h>
59 #include <sys/proc.h>
60
61 #include <net/if.h>
62 #include <net/if_var.h>
63 #include <net/if_types.h>
64 #include <net/if_media.h>
65 #include <net/if_clone.h>
66 #include <net/bpf.h>
67 #include <net/ethernet.h>
68 #include <net/vnet.h>
69
70 #include <net/iflib.h>
71 #include <net/iflib_private.h>
72 #include "ifdi_if.h"
73
74 int
noop_attach(device_t dev)75 noop_attach(device_t dev)
76 {
77 return (0);
78 }
79
80 int
iflib_pseudo_detach(device_t dev)81 iflib_pseudo_detach(device_t dev)
82 {
83 if_ctx_t ctx;
84
85 ctx = device_get_softc(dev);
86 if ((iflib_get_flags(ctx) & IFC_IN_DETACH) == 0)
87 return (EBUSY);
88 return (0);
89 }
90
91 static device_t iflib_pseudodev;
92
93 static struct mtx pseudoif_mtx;
94 MTX_SYSINIT(pseudoif_mtx, &pseudoif_mtx, "pseudoif_mtx", MTX_DEF);
95
96 #define PSEUDO_LOCK() mtx_lock(&pseudoif_mtx);
97 #define PSEUDO_UNLOCK() mtx_unlock(&pseudoif_mtx);
98
99 struct if_pseudo {
100 eventhandler_tag ip_detach_tag;
101 eventhandler_tag ip_lladdr_tag;
102 struct if_clone *ip_ifc;
103 if_shared_ctx_t ip_sctx;
104 devclass_t ip_dc;
105 LIST_ENTRY(if_pseudo) ip_list;
106 int ip_on_list;
107 };
108
109 static LIST_HEAD(, if_pseudo) iflib_pseudos = LIST_HEAD_INITIALIZER(iflib_pseudos);
110
111 /*
112 * XXX this assumes that the rest of the
113 * code won't hang on to it after it's
114 * removed / unloaded
115 */
116 static if_pseudo_t
iflib_ip_lookup(const char * name)117 iflib_ip_lookup(const char *name)
118 {
119 if_pseudo_t ip = NULL;
120
121 PSEUDO_LOCK();
122 LIST_FOREACH(ip, &iflib_pseudos, ip_list) {
123 if (!strcmp(ip->ip_sctx->isc_name, name))
124 break;
125 }
126 PSEUDO_UNLOCK();
127 return (ip);
128 }
129
130 static void
iflib_ip_delete(if_pseudo_t ip)131 iflib_ip_delete(if_pseudo_t ip)
132 {
133 PSEUDO_LOCK();
134 if (ip->ip_on_list) {
135 LIST_REMOVE(ip, ip_list);
136 ip->ip_on_list = 0;
137 }
138 PSEUDO_UNLOCK();
139 }
140
141 static void
iflib_ip_insert(if_pseudo_t ip)142 iflib_ip_insert(if_pseudo_t ip)
143 {
144 PSEUDO_LOCK();
145 if (!ip->ip_on_list) {
146 LIST_INSERT_HEAD(&iflib_pseudos, ip, ip_list);
147 ip->ip_on_list = 1;
148 }
149 PSEUDO_UNLOCK();
150 }
151
152 static void
iflib_ifdetach(void * arg __unused,if_t ifp)153 iflib_ifdetach(void *arg __unused, if_t ifp)
154 {
155
156 /* If the ifnet is just being renamed, don't do anything. */
157 if (ifp->if_flags & IFF_RENAMING)
158 return;
159 }
160
161 static void
iflib_iflladdr(void * arg __unused,if_t ifp __unused)162 iflib_iflladdr(void *arg __unused, if_t ifp __unused)
163 {
164
165 }
166
167 static int
iflib_clone_create(struct if_clone * ifc,int unit,caddr_t params)168 iflib_clone_create(struct if_clone *ifc, int unit, caddr_t params)
169 {
170 const char *name = ifc_name(ifc);
171 struct iflib_cloneattach_ctx clctx;
172 if_ctx_t ctx;
173 if_pseudo_t ip;
174 device_t dev;
175 int rc;
176
177 clctx.cc_ifc = ifc;
178 clctx.cc_len = 0;
179 clctx.cc_params = params;
180 clctx.cc_name = name;
181
182 if (__predict_false(iflib_pseudodev == NULL)) {
183 /* SYSINIT initialization would panic !?! */
184 mtx_lock(&Giant);
185 iflib_pseudodev = device_add_child(root_bus, "ifpseudo", 0);
186 mtx_unlock(&Giant);
187 MPASS(iflib_pseudodev != NULL);
188 }
189 ip = iflib_ip_lookup(name);
190 if (ip == NULL) {
191 printf("no ip found for %s\n", name);
192 return (ENOENT);
193 }
194 if ((dev = devclass_get_device(ip->ip_dc, unit)) != NULL) {
195 printf("unit %d allocated\n", unit);
196 bus_generic_print_child(iflib_pseudodev, dev);
197 return (EBUSY);
198 }
199 PSEUDO_LOCK();
200 dev = device_add_child(iflib_pseudodev, name, unit);
201 device_set_driver(dev, &iflib_pseudodriver);
202 PSEUDO_UNLOCK();
203 device_quiet(dev);
204 rc = device_attach(dev);
205 MPASS(rc == 0);
206 MPASS(dev != NULL);
207 MPASS(devclass_get_device(ip->ip_dc, unit) == dev);
208 rc = iflib_pseudo_register(dev, ip->ip_sctx, &ctx, &clctx);
209 if (rc) {
210 mtx_lock(&Giant);
211 device_delete_child(iflib_pseudodev, dev);
212 mtx_unlock(&Giant);
213 } else
214 device_set_softc(dev, ctx);
215
216 return (rc);
217 }
218
219 static void
iflib_clone_destroy(if_t ifp)220 iflib_clone_destroy(if_t ifp)
221 {
222 if_ctx_t ctx;
223 device_t dev;
224 struct sx *ctx_lock;
225 int rc;
226
227 /*
228 * Detach device / free / free unit
229 */
230 ctx = if_getsoftc(ifp);
231 dev = iflib_get_dev(ctx);
232 ctx_lock = iflib_ctx_lock_get(ctx);
233 sx_xlock(ctx_lock);
234 iflib_set_detach(ctx);
235 iflib_stop(ctx);
236 sx_xunlock(ctx_lock);
237
238 mtx_lock(&Giant);
239 rc = device_delete_child(iflib_pseudodev, dev);
240 mtx_unlock(&Giant);
241 if (rc == 0)
242 iflib_pseudo_deregister(ctx);
243 }
244
245 if_pseudo_t
iflib_clone_register(if_shared_ctx_t sctx)246 iflib_clone_register(if_shared_ctx_t sctx)
247 {
248 if_pseudo_t ip;
249
250 if (sctx->isc_name == NULL) {
251 printf("iflib_clone_register failed - shared_ctx needs to have a device name\n");
252 return (NULL);
253 }
254 if (iflib_ip_lookup(sctx->isc_name) != NULL) {
255 printf("iflib_clone_register failed - shared_ctx %s alread registered\n",
256 sctx->isc_name);
257 return (NULL);
258 }
259 ip = malloc(sizeof(*ip), M_IFLIB, M_WAITOK|M_ZERO);
260 ip->ip_sctx = sctx;
261 ip->ip_dc = devclass_create(sctx->isc_name);
262 if (ip->ip_dc == NULL)
263 goto fail_clone;
264 /* XXX --- we can handle clone_advanced later */
265 ip->ip_ifc = if_clone_simple(sctx->isc_name, iflib_clone_create, iflib_clone_destroy, 0);
266 if (ip->ip_ifc == NULL) {
267 printf("clone_simple failed -- cloned %s devices will not be available\n", sctx->isc_name);
268 goto fail_clone;
269 }
270 ip->ip_lladdr_tag = EVENTHANDLER_REGISTER(iflladdr_event,
271 iflib_iflladdr, NULL, EVENTHANDLER_PRI_ANY);
272 if (ip->ip_lladdr_tag == NULL)
273 goto fail_addr;
274 ip->ip_detach_tag = EVENTHANDLER_REGISTER(ifnet_departure_event,
275 iflib_ifdetach, NULL, EVENTHANDLER_PRI_ANY);
276
277 if (ip->ip_detach_tag == NULL)
278 goto fail_depart;
279
280 iflib_ip_insert(ip);
281 return (ip);
282 fail_depart:
283 EVENTHANDLER_DEREGISTER(iflladdr_event, ip->ip_lladdr_tag);
284 fail_addr:
285 if_clone_detach(ip->ip_ifc);
286 fail_clone:
287 free(ip, M_IFLIB);
288 return (NULL);
289 }
290
291 void
iflib_clone_deregister(if_pseudo_t ip)292 iflib_clone_deregister(if_pseudo_t ip)
293 {
294 /* XXX check that is not still in use */
295 iflib_ip_delete(ip);
296 EVENTHANDLER_DEREGISTER(ifnet_departure_event, ip->ip_detach_tag);
297 EVENTHANDLER_DEREGISTER(iflladdr_event, ip->ip_lladdr_tag);
298 if_clone_detach(ip->ip_ifc);
299 /* XXX free devclass */
300 free(ip, M_IFLIB);
301 }
302