2 * Copyright (c) 2002 Mark Santcroos <marks@ripe.net>
3 * Copyright (c) 2004-2005 Gleb Smirnoff <glebius@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 * Netgraph "device" node
27 * This node presents a /dev/ngd%d device that interfaces to an other
30 * $FreeBSD: src/sys/netgraph/ng_device.c,v 1.22 2006/11/02 17:37:21 andre Exp $
35 #define DBG do { kprintf("ng_device: %s\n", __func__ ); } while (0)
37 #define DBG do {} while (0)
40 #include <sys/param.h>
42 #include <sys/kernel.h>
43 #include <sys/malloc.h>
46 #include <sys/queue.h>
47 #include <sys/socket.h>
48 #include <sys/systm.h>
50 #include <sys/vnode.h>
53 #include <net/if_var.h>
54 #include <netinet/in.h>
55 #include <netinet/in_systm.h>
56 #include <netinet/ip.h>
58 #include "ng_message.h"
60 #include "ng_device.h"
62 #define ERROUT(x) do { error = (x); goto done; } while (0)
64 /* Netgraph methods */
65 static int ng_device_mod_event(module_t, int, void *);
66 static ng_constructor_t ng_device_constructor;
67 static ng_rcvmsg_t ng_device_rcvmsg;
68 static ng_shutdown_t ng_device_shutdown;
69 static ng_newhook_t ng_device_newhook;
70 static ng_rcvdata_t ng_device_rcvdata;
71 static ng_disconnect_t ng_device_disconnect;
74 static struct ng_type ngd_typestruct = {
75 .version = NG_ABI_VERSION,
76 .name = NG_DEVICE_NODE_TYPE,
77 .mod_event = ng_device_mod_event,
78 .constructor = ng_device_constructor,
79 .rcvmsg = ng_device_rcvmsg,
80 .shutdown = ng_device_shutdown,
81 .newhook = ng_device_newhook,
82 .rcvdata = ng_device_rcvdata,
83 .disconnect = ng_device_disconnect,
85 NETGRAPH_INIT(device, &ngd_typestruct);
96 #define NGDF_OPEN 0x0001
97 #define NGDF_RWAIT 0x0002
99 typedef struct ngd_private *priv_p;
101 /* unit number allocator entity */
102 static struct unrhdr *ngd_unit;
104 /* Maximum number of NGD devices */
107 static d_close_t ngdclose;
108 static d_open_t ngdopen;
109 static d_read_t ngdread;
110 static d_write_t ngdwrite;
112 static d_ioctl_t ngdioctl;
114 static d_poll_t ngdpoll;
116 static struct cdevsw ngd_cdevsw = {
117 .d_version = D_VERSION,
126 .d_name = NG_DEVICE_DEVNAME,
129 /******************************************************************************
131 ******************************************************************************/
134 * Handle loading and unloading for this node type.
137 ng_device_mod_event(module_t mod, int event, void *data)
143 ngd_unit = new_unrhdr(0, MAX_NGD, NULL);
146 delete_unrhdr(ngd_unit);
159 ng_device_constructor(node_p node)
165 priv = kmalloc(sizeof(*priv), M_NETGRAPH, M_WAITOK | M_ZERO);
167 /* Allocate unit number */
168 priv->unit = alloc_unr(ngd_unit);
170 /* Initialize mutexes and queue */
171 mtx_init(&priv->ngd_mtx, "ng_device", NULL, MTX_DEF);
172 mtx_init(&priv->readq.ifq_mtx, "ng_device queue", NULL, MTX_DEF);
173 IFQ_SET_MAXLEN(&priv->readq, ifqmaxlen);
175 /* Link everything together */
176 NG_NODE_SET_PRIVATE(node, priv);
179 priv->ngddev = make_dev(&ngd_cdevsw, unit2minor(priv->unit), UID_ROOT,
180 GID_WHEEL, 0600, NG_DEVICE_DEVNAME "%d", priv->unit);
181 if(priv->ngddev == NULL) {
182 kprintf("%s(): make_dev() failed\n",__func__);
183 mtx_destroy(&priv->ngd_mtx);
184 mtx_destroy(&priv->readq.ifq_mtx);
185 free_unr(ngd_unit, priv->unit);
186 kfree(priv, M_NETGRAPH);
189 /* XXX: race here? */
190 priv->ngddev->si_drv1 = priv;
196 * Process control message.
200 ng_device_rcvmsg(node_p node, item_p item, hook_p lasthook)
202 const priv_p priv = NG_NODE_PRIVATE(node);
204 struct ng_mesg *resp = NULL;
207 NGI_GET_MSG(item, msg);
209 if (msg->header.typecookie == NGM_DEVICE_COOKIE) {
210 switch (msg->header.cmd) {
211 case NGM_DEVICE_GET_DEVNAME:
212 /* XXX: Fix when MAX_NGD us bigger */
213 NG_MKRESPONSE(resp, msg,
214 strlen(NG_DEVICE_DEVNAME) + 4, M_WAITOK);
219 strlcpy((char *)resp->data, priv->ngddev->si_name,
220 strlen(priv->ngddev->si_name) + 1);
231 NG_RESPOND_MSG(error, node, item, resp);
237 * Accept incoming hook. We support only one hook per node.
240 ng_device_newhook(node_p node, hook_p hook, const char *name)
242 priv_p priv = NG_NODE_PRIVATE(node);
246 /* We have only one hook per node */
247 if (priv->hook != NULL)
256 * Receive data from hook, write it to device.
259 ng_device_rcvdata(hook_p hook, item_p item)
261 priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
269 IF_LOCK(&priv->readq);
270 if (_IF_QFULL(&priv->readq)) {
271 _IF_DROP(&priv->readq);
272 IF_UNLOCK(&priv->readq);
277 _IF_ENQUEUE(&priv->readq, m);
278 IF_UNLOCK(&priv->readq);
279 mtx_lock(&priv->ngd_mtx);
280 if (priv->flags & NGDF_RWAIT) {
281 priv->flags &= ~NGDF_RWAIT;
284 mtx_unlock(&priv->ngd_mtx);
290 * Removal of the hook destroys the node.
293 ng_device_disconnect(hook_p hook)
295 priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
299 destroy_dev(priv->ngddev);
300 mtx_destroy(&priv->ngd_mtx);
302 IF_DRAIN(&priv->readq);
303 mtx_destroy(&(priv)->readq.ifq_mtx);
305 free_unr(ngd_unit, priv->unit);
307 kfree(priv, M_NETGRAPH);
309 ng_rmnode_self(NG_HOOK_NODE(hook));
315 * Node shutdown. Everything is already done in disconnect method.
318 ng_device_shutdown(node_p node)
324 /******************************************************************************
326 ******************************************************************************/
329 * the device is opened
332 ngdopen(struct cdev *dev, int flag, int mode, struct thread *td)
334 priv_p priv = (priv_p )dev->si_drv1;
338 mtx_lock(&priv->ngd_mtx);
339 priv->flags |= NGDF_OPEN;
340 mtx_unlock(&priv->ngd_mtx);
346 * the device is closed
349 ngdclose(struct cdev *dev, int flag, int mode, struct thread *td)
351 priv_p priv = (priv_p )dev->si_drv1;
354 mtx_lock(&priv->ngd_mtx);
355 priv->flags &= ~NGDF_OPEN;
356 mtx_unlock(&priv->ngd_mtx);
362 * The ioctl is transformed into netgraph control message.
363 * We do not process them, yet.
368 * they are translated into netgraph messages and passed on
372 ngdioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
374 struct ngd_softc *sc = &ngd_softc;
375 struct ngd_connection * connection = NULL;
376 struct ngd_connection * tmp;
379 struct ngd_param_s * datap;
383 NG_MKMESSAGE(msg, NGM_DEVICE_COOKIE, cmd, sizeof(struct ngd_param_s),
386 kprintf("%s(): msg == NULL\n",__func__);
390 /* pass the ioctl data into the ->data area */
391 datap = (struct ngd_param_s *)msg->data;
394 NG_SEND_MSG_HOOK(error, sc->node, msg, connection->active_hook, 0);
396 kprintf("%s(): NG_SEND_MSG_HOOK error: %d\n",__func__,error);
405 * This function is called when a read(2) is done to our device.
406 * We process one mbuf from queue.
409 ngdread(struct cdev *dev, struct uio *uio, int flag)
411 priv_p priv = (priv_p )dev->si_drv1;
419 IF_DEQUEUE(&priv->readq, m);
421 if (flag & IO_NDELAY)
422 return (EWOULDBLOCK);
423 mtx_lock(&priv->ngd_mtx);
424 priv->flags |= NGDF_RWAIT;
425 if ((error = msleep(priv, &priv->ngd_mtx,
426 PDROP | PCATCH | (PZERO + 1),
432 while (m && uio->uio_resid > 0 && error == 0) {
433 len = MIN(uio->uio_resid, m->m_len);
435 error = uiomove(mtod(m, void *), len, uio);
447 * This function is called when our device is written to.
448 * We read the data from userland into mbuf chain and pass it to the remote hook.
452 ngdwrite(struct cdev *dev, struct uio *uio, int flag)
454 priv_p priv = (priv_p )dev->si_drv1;
460 if (uio->uio_resid == 0)
463 if (uio->uio_resid > IP_MAXPACKET)
466 if ((m = m_uiotombuf(uio, MB_DONTWAIT, 0, 0, M_PKTHDR)) == NULL)
469 NG_SEND_DATA_ONLY(error, priv->hook, m);
475 * we are being polled/selected
476 * check if there is data available for read
479 ngdpoll(struct cdev *dev, int events, struct thread *td)
481 priv_p priv = (priv_p )dev->si_drv1;
484 if (events & (POLLIN | POLLRDNORM) &&
485 !IFQ_IS_EMPTY(&priv->readq))
486 revents |= events & (POLLIN | POLLRDNORM);