2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2002 Mark Santcroos <marks@ripe.net>
5 * Copyright (c) 2004-2005 Gleb Smirnoff <glebius@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 * Netgraph "device" node
29 * This node presents a /dev/ngd%d device that interfaces to an other
37 #define DBG do { printf("ng_device: %s\n", __func__ ); } while (0)
39 #define DBG do {} while (0)
42 #include <sys/param.h>
44 #include <sys/ioccom.h>
45 #include <sys/kernel.h>
46 #include <sys/malloc.h>
49 #include <sys/queue.h>
50 #include <sys/socket.h>
51 #include <sys/systm.h>
53 #include <sys/vnode.h>
56 #include <net/if_var.h>
57 #include <netinet/in.h>
58 #include <netinet/in_systm.h>
59 #include <netinet/ip.h>
61 #include <netgraph/ng_message.h>
62 #include <netgraph/netgraph.h>
63 #include <netgraph/ng_device.h>
65 #define ERROUT(x) do { error = (x); goto done; } while (0)
67 /* Netgraph methods */
68 static int ng_device_mod_event(module_t, int, void *);
69 static ng_constructor_t ng_device_constructor;
70 static ng_rcvmsg_t ng_device_rcvmsg;
71 static ng_shutdown_t ng_device_shutdown;
72 static ng_newhook_t ng_device_newhook;
73 static ng_rcvdata_t ng_device_rcvdata;
74 static ng_disconnect_t ng_device_disconnect;
77 static struct ng_type ngd_typestruct = {
78 .version = NG_ABI_VERSION,
79 .name = NG_DEVICE_NODE_TYPE,
80 .mod_event = ng_device_mod_event,
81 .constructor = ng_device_constructor,
82 .rcvmsg = ng_device_rcvmsg,
83 .shutdown = ng_device_shutdown,
84 .newhook = ng_device_newhook,
85 .rcvdata = ng_device_rcvdata,
86 .disconnect = ng_device_disconnect,
88 NETGRAPH_INIT(device, &ngd_typestruct);
99 #define NGDF_OPEN 0x0001
100 #define NGDF_RWAIT 0x0002
102 typedef struct ngd_private *priv_p;
104 /* unit number allocator entity */
105 static struct unrhdr *ngd_unit;
107 /* Maximum number of NGD devices */
110 static d_close_t ngdclose;
111 static d_open_t ngdopen;
112 static d_read_t ngdread;
113 static d_write_t ngdwrite;
115 static d_ioctl_t ngdioctl;
117 static d_poll_t ngdpoll;
119 static struct cdevsw ngd_cdevsw = {
120 .d_version = D_VERSION,
129 .d_name = NG_DEVICE_DEVNAME,
132 /******************************************************************************
134 ******************************************************************************/
137 * Handle loading and unloading for this node type.
140 ng_device_mod_event(module_t mod, int event, void *data)
146 ngd_unit = new_unrhdr(0, MAX_NGD, NULL);
149 delete_unrhdr(ngd_unit);
162 ng_device_constructor(node_p node)
168 priv = malloc(sizeof(*priv), M_NETGRAPH, M_WAITOK | M_ZERO);
170 /* Allocate unit number */
171 priv->unit = alloc_unr(ngd_unit);
173 /* Initialize mutexes and queue */
174 mtx_init(&priv->ngd_mtx, "ng_device", NULL, MTX_DEF);
175 mtx_init(&priv->readq.ifq_mtx, "ng_device queue", NULL, MTX_DEF);
176 IFQ_SET_MAXLEN(&priv->readq, ifqmaxlen);
178 /* Link everything together */
179 NG_NODE_SET_PRIVATE(node, priv);
182 priv->ngddev = make_dev(&ngd_cdevsw, priv->unit, UID_ROOT,
183 GID_WHEEL, 0600, NG_DEVICE_DEVNAME "%d", priv->unit);
184 if(priv->ngddev == NULL) {
185 printf("%s(): make_dev() failed\n",__func__);
186 mtx_destroy(&priv->ngd_mtx);
187 mtx_destroy(&priv->readq.ifq_mtx);
188 free_unr(ngd_unit, priv->unit);
189 free(priv, M_NETGRAPH);
192 /* XXX: race here? */
193 priv->ngddev->si_drv1 = priv;
199 * Process control message.
203 ng_device_rcvmsg(node_p node, item_p item, hook_p lasthook)
205 const priv_p priv = NG_NODE_PRIVATE(node);
207 struct ng_mesg *resp = NULL;
211 NGI_GET_MSG(item, msg);
213 if (msg->header.typecookie == NGM_DEVICE_COOKIE) {
214 switch (msg->header.cmd) {
215 case NGM_DEVICE_GET_DEVNAME:
216 /* XXX: Fix when MAX_NGD us bigger */
217 NG_MKRESPONSE(resp, msg,
218 strlen(NG_DEVICE_DEVNAME) + 4, M_NOWAIT);
223 dn = devtoname(priv->ngddev);
224 strlcpy((char *)resp->data, dn, strlen(dn) + 1);
235 NG_RESPOND_MSG(error, node, item, resp);
241 * Accept incoming hook. We support only one hook per node.
244 ng_device_newhook(node_p node, hook_p hook, const char *name)
246 priv_p priv = NG_NODE_PRIVATE(node);
250 /* We have only one hook per node */
251 if (priv->hook != NULL)
260 * Receive data from hook, write it to device.
263 ng_device_rcvdata(hook_p hook, item_p item)
265 priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
273 IF_LOCK(&priv->readq);
274 if (_IF_QFULL(&priv->readq)) {
275 IF_UNLOCK(&priv->readq);
280 _IF_ENQUEUE(&priv->readq, m);
281 IF_UNLOCK(&priv->readq);
282 mtx_lock(&priv->ngd_mtx);
283 if (priv->flags & NGDF_RWAIT) {
284 priv->flags &= ~NGDF_RWAIT;
287 mtx_unlock(&priv->ngd_mtx);
293 * Removal of the hook destroys the node.
296 ng_device_disconnect(hook_p hook)
298 priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
302 destroy_dev(priv->ngddev);
303 mtx_destroy(&priv->ngd_mtx);
305 IF_DRAIN(&priv->readq);
306 mtx_destroy(&(priv)->readq.ifq_mtx);
308 free_unr(ngd_unit, priv->unit);
310 free(priv, M_NETGRAPH);
312 ng_rmnode_self(NG_HOOK_NODE(hook));
318 * Node shutdown. Everything is already done in disconnect method.
321 ng_device_shutdown(node_p node)
327 /******************************************************************************
329 ******************************************************************************/
332 * the device is opened
335 ngdopen(struct cdev *dev, int flag, int mode, struct thread *td)
337 priv_p priv = (priv_p )dev->si_drv1;
341 mtx_lock(&priv->ngd_mtx);
342 priv->flags |= NGDF_OPEN;
343 mtx_unlock(&priv->ngd_mtx);
349 * the device is closed
352 ngdclose(struct cdev *dev, int flag, int mode, struct thread *td)
354 priv_p priv = (priv_p )dev->si_drv1;
357 mtx_lock(&priv->ngd_mtx);
358 priv->flags &= ~NGDF_OPEN;
359 mtx_unlock(&priv->ngd_mtx);
365 * The ioctl is transformed into netgraph control message.
366 * We do not process them, yet.
371 * they are translated into netgraph messages and passed on
375 ngdioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
377 struct ngd_softc *sc = &ngd_softc;
378 struct ngd_connection * connection = NULL;
379 struct ngd_connection * tmp;
382 struct ngd_param_s * datap;
386 NG_MKMESSAGE(msg, NGM_DEVICE_COOKIE, cmd, sizeof(struct ngd_param_s),
389 printf("%s(): msg == NULL\n",__func__);
393 /* pass the ioctl data into the ->data area */
394 datap = (struct ngd_param_s *)msg->data;
397 NG_SEND_MSG_HOOK(error, sc->node, msg, connection->active_hook, 0);
399 printf("%s(): NG_SEND_MSG_HOOK error: %d\n",__func__,error);
408 * This function is called when a read(2) is done to our device.
409 * We process one mbuf from queue.
412 ngdread(struct cdev *dev, struct uio *uio, int flag)
414 priv_p priv = (priv_p )dev->si_drv1;
422 IF_DEQUEUE(&priv->readq, m);
424 if (flag & IO_NDELAY)
425 return (EWOULDBLOCK);
426 mtx_lock(&priv->ngd_mtx);
427 priv->flags |= NGDF_RWAIT;
428 if ((error = msleep(priv, &priv->ngd_mtx,
429 PDROP | PCATCH | (PZERO + 1),
435 while (m && uio->uio_resid > 0 && error == 0) {
436 len = MIN(uio->uio_resid, m->m_len);
438 error = uiomove(mtod(m, void *), len, uio);
450 * This function is called when our device is written to.
451 * We read the data from userland into mbuf chain and pass it to the remote hook.
455 ngdwrite(struct cdev *dev, struct uio *uio, int flag)
457 priv_p priv = (priv_p )dev->si_drv1;
463 if (uio->uio_resid == 0)
466 if (uio->uio_resid < 0 || uio->uio_resid > IP_MAXPACKET)
469 if ((m = m_uiotombuf(uio, M_NOWAIT, 0, 0, M_PKTHDR)) == NULL)
472 NG_SEND_DATA_ONLY(error, priv->hook, m);
478 * we are being polled/selected
479 * check if there is data available for read
482 ngdpoll(struct cdev *dev, int events, struct thread *td)
484 priv_p priv = (priv_p )dev->si_drv1;
487 if (events & (POLLIN | POLLRDNORM) &&
488 !IFQ_IS_EMPTY(&priv->readq))
489 revents |= events & (POLLIN | POLLRDNORM);