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>
50 #include <sys/epoch.h>
51 #include <sys/queue.h>
52 #include <sys/socket.h>
53 #include <sys/systm.h>
55 #include <sys/vnode.h>
58 #include <net/if_var.h>
59 #include <netinet/in.h>
60 #include <netinet/in_systm.h>
61 #include <netinet/ip.h>
63 #include <netgraph/ng_message.h>
64 #include <netgraph/netgraph.h>
65 #include <netgraph/ng_device.h>
67 #define ERROUT(x) do { error = (x); goto done; } while (0)
69 /* Netgraph methods */
70 static int ng_device_mod_event(module_t, int, void *);
71 static ng_constructor_t ng_device_constructor;
72 static ng_rcvmsg_t ng_device_rcvmsg;
73 static ng_shutdown_t ng_device_shutdown;
74 static ng_newhook_t ng_device_newhook;
75 static ng_rcvdata_t ng_device_rcvdata;
76 static ng_disconnect_t ng_device_disconnect;
79 static struct ng_type ngd_typestruct = {
80 .version = NG_ABI_VERSION,
81 .name = NG_DEVICE_NODE_TYPE,
82 .mod_event = ng_device_mod_event,
83 .constructor = ng_device_constructor,
84 .rcvmsg = ng_device_rcvmsg,
85 .shutdown = ng_device_shutdown,
86 .newhook = ng_device_newhook,
87 .rcvdata = ng_device_rcvdata,
88 .disconnect = ng_device_disconnect,
90 NETGRAPH_INIT(device, &ngd_typestruct);
101 #define NGDF_OPEN 0x0001
102 #define NGDF_RWAIT 0x0002
104 typedef struct ngd_private *priv_p;
106 /* unit number allocator entity */
107 static struct unrhdr *ngd_unit;
109 /* Maximum number of NGD devices */
112 static d_close_t ngdclose;
113 static d_open_t ngdopen;
114 static d_read_t ngdread;
115 static d_write_t ngdwrite;
117 static d_ioctl_t ngdioctl;
119 static d_poll_t ngdpoll;
121 static struct cdevsw ngd_cdevsw = {
122 .d_version = D_VERSION,
131 .d_name = NG_DEVICE_DEVNAME,
134 /******************************************************************************
136 ******************************************************************************/
139 * Handle loading and unloading for this node type.
142 ng_device_mod_event(module_t mod, int event, void *data)
148 ngd_unit = new_unrhdr(0, MAX_NGD, NULL);
151 delete_unrhdr(ngd_unit);
164 ng_device_constructor(node_p node)
170 priv = malloc(sizeof(*priv), M_NETGRAPH, M_WAITOK | M_ZERO);
172 /* Allocate unit number */
173 priv->unit = alloc_unr(ngd_unit);
175 /* Initialize mutexes and queue */
176 mtx_init(&priv->ngd_mtx, "ng_device", NULL, MTX_DEF);
177 mtx_init(&priv->readq.ifq_mtx, "ng_device queue", NULL, MTX_DEF);
178 IFQ_SET_MAXLEN(&priv->readq, ifqmaxlen);
180 /* Link everything together */
181 NG_NODE_SET_PRIVATE(node, priv);
184 priv->ngddev = make_dev(&ngd_cdevsw, priv->unit, UID_ROOT,
185 GID_WHEEL, 0600, NG_DEVICE_DEVNAME "%d", priv->unit);
186 if(priv->ngddev == NULL) {
187 printf("%s(): make_dev() failed\n",__func__);
188 mtx_destroy(&priv->ngd_mtx);
189 mtx_destroy(&priv->readq.ifq_mtx);
190 free_unr(ngd_unit, priv->unit);
191 free(priv, M_NETGRAPH);
194 /* XXX: race here? */
195 priv->ngddev->si_drv1 = priv;
201 * Process control message.
205 ng_device_rcvmsg(node_p node, item_p item, hook_p lasthook)
207 const priv_p priv = NG_NODE_PRIVATE(node);
209 struct ng_mesg *resp = NULL;
213 NGI_GET_MSG(item, msg);
215 if (msg->header.typecookie == NGM_DEVICE_COOKIE) {
216 switch (msg->header.cmd) {
217 case NGM_DEVICE_GET_DEVNAME:
218 /* XXX: Fix when MAX_NGD us bigger */
219 NG_MKRESPONSE(resp, msg,
220 strlen(NG_DEVICE_DEVNAME) + 4, M_NOWAIT);
225 dn = devtoname(priv->ngddev);
226 strlcpy((char *)resp->data, dn, strlen(dn) + 1);
237 NG_RESPOND_MSG(error, node, item, resp);
243 * Accept incoming hook. We support only one hook per node.
246 ng_device_newhook(node_p node, hook_p hook, const char *name)
248 priv_p priv = NG_NODE_PRIVATE(node);
252 /* We have only one hook per node */
253 if (priv->hook != NULL)
262 * Receive data from hook, write it to device.
265 ng_device_rcvdata(hook_p hook, item_p item)
267 priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
275 IF_LOCK(&priv->readq);
276 if (_IF_QFULL(&priv->readq)) {
277 IF_UNLOCK(&priv->readq);
282 _IF_ENQUEUE(&priv->readq, m);
283 IF_UNLOCK(&priv->readq);
284 mtx_lock(&priv->ngd_mtx);
285 if (priv->flags & NGDF_RWAIT) {
286 priv->flags &= ~NGDF_RWAIT;
289 mtx_unlock(&priv->ngd_mtx);
295 * Removal of the hook destroys the node.
298 ng_device_disconnect(hook_p hook)
300 priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
304 destroy_dev(priv->ngddev);
305 mtx_destroy(&priv->ngd_mtx);
307 IF_DRAIN(&priv->readq);
308 mtx_destroy(&(priv)->readq.ifq_mtx);
310 free_unr(ngd_unit, priv->unit);
312 free(priv, M_NETGRAPH);
314 ng_rmnode_self(NG_HOOK_NODE(hook));
320 * Node shutdown. Everything is already done in disconnect method.
323 ng_device_shutdown(node_p node)
329 /******************************************************************************
331 ******************************************************************************/
334 * the device is opened
337 ngdopen(struct cdev *dev, int flag, int mode, struct thread *td)
339 priv_p priv = (priv_p )dev->si_drv1;
343 mtx_lock(&priv->ngd_mtx);
344 priv->flags |= NGDF_OPEN;
345 mtx_unlock(&priv->ngd_mtx);
351 * the device is closed
354 ngdclose(struct cdev *dev, int flag, int mode, struct thread *td)
356 priv_p priv = (priv_p )dev->si_drv1;
359 mtx_lock(&priv->ngd_mtx);
360 priv->flags &= ~NGDF_OPEN;
361 mtx_unlock(&priv->ngd_mtx);
367 * The ioctl is transformed into netgraph control message.
368 * We do not process them, yet.
373 * they are translated into netgraph messages and passed on
377 ngdioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
379 struct ngd_softc *sc = &ngd_softc;
380 struct ngd_connection * connection = NULL;
381 struct ngd_connection * tmp;
384 struct ngd_param_s * datap;
388 NG_MKMESSAGE(msg, NGM_DEVICE_COOKIE, cmd, sizeof(struct ngd_param_s),
391 printf("%s(): msg == NULL\n",__func__);
395 /* pass the ioctl data into the ->data area */
396 datap = (struct ngd_param_s *)msg->data;
399 NG_SEND_MSG_HOOK(error, sc->node, msg, connection->active_hook, 0);
401 printf("%s(): NG_SEND_MSG_HOOK error: %d\n",__func__,error);
410 * This function is called when a read(2) is done to our device.
411 * We process one mbuf from queue.
414 ngdread(struct cdev *dev, struct uio *uio, int flag)
416 priv_p priv = (priv_p )dev->si_drv1;
424 IF_DEQUEUE(&priv->readq, m);
426 if (flag & IO_NDELAY)
427 return (EWOULDBLOCK);
428 mtx_lock(&priv->ngd_mtx);
429 priv->flags |= NGDF_RWAIT;
430 if ((error = msleep(priv, &priv->ngd_mtx,
431 PDROP | PCATCH | (PZERO + 1),
437 while (m && uio->uio_resid > 0 && error == 0) {
438 len = MIN(uio->uio_resid, m->m_len);
440 error = uiomove(mtod(m, void *), len, uio);
451 * This function is called when our device is written to.
452 * We read the data from userland into mbuf chain and pass it to the remote hook.
456 ngdwrite(struct cdev *dev, struct uio *uio, int flag)
458 struct epoch_tracker et;
459 priv_p priv = (priv_p )dev->si_drv1;
465 if (uio->uio_resid == 0)
468 if (uio->uio_resid < 0 || uio->uio_resid > IP_MAXPACKET)
471 if ((m = m_uiotombuf(uio, M_NOWAIT, 0, 0, M_PKTHDR)) == NULL)
475 NG_SEND_DATA_ONLY(error, priv->hook, m);
482 * we are being polled/selected
483 * check if there is data available for read
486 ngdpoll(struct cdev *dev, int events, struct thread *td)
488 priv_p priv = (priv_p )dev->si_drv1;
491 if (events & (POLLIN | POLLRDNORM) &&
492 !IFQ_IS_EMPTY(&priv->readq))
493 revents |= events & (POLLIN | POLLRDNORM);