2 * Copyright (c) 2002 Mark Santcroos <marks@ripe.net>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. The name of the author may not be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 * Netgraph "device" node
28 * This node presents a /dev/ngd%d device that interfaces to an other
31 * $FreeBSD: src/sys/netgraph/ng_device.c,v 1.1.2.1 2002/08/23 07:15:44 julian Exp $
32 * $DragonFly: src/sys/netgraph/ng_device.c,v 1.11 2007/06/03 20:51:10 dillon Exp $
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
41 #include <sys/queue.h>
42 #include <sys/malloc.h>
45 #include <sys/ioccom.h>
47 #include <netgraph/ng_message.h>
48 #include <netgraph/netgraph.h>
50 #include "ng_device.h"
52 /* turn this on for verbose messages */
55 /* Netgraph methods */
56 static ng_constructor_t ng_device_cons;
57 static ng_rcvmsg_t ng_device_rcvmsg;
58 static ng_newhook_t ng_device_newhook;
59 static ng_connect_t ng_device_connect;
60 static ng_rcvdata_t ng_device_rcvdata;
61 static ng_disconnect_t ng_device_disconnect;
62 static int ng_device_mod_event(module_t mod, int event, void *data);
64 static int ng_device_init(void);
65 static int get_free_unit(void);
68 static struct ng_type typestruct = {
69 NG_VERSION, /* version */
70 NG_DEVICE_NODE_TYPE, /* name */
71 ng_device_mod_event, /* modevent */
72 ng_device_cons, /* constructor */
73 ng_device_rcvmsg, /* receive msg */
75 ng_device_newhook, /* newhook */
77 ng_device_connect, /* connect */
78 ng_device_rcvdata, /* receive data */
79 ng_device_rcvdata, /* receive queued data */
80 ng_device_disconnect, /* disconnect */
83 NETGRAPH_INIT(device, &typestruct);
86 struct ngd_connection {
87 SLIST_ENTRY(ngd_connection) links;
90 struct ng_hook *active_hook;
98 SLIST_HEAD(, ngd_connection) head;
101 char nodename[NG_NODESIZ];
104 /* helper definition */
105 #define MIN(a, b) ((a) < (b) ? (a) : (b))
107 /* the per connection receiving queue maximum */
108 #define NGD_QUEUE_SIZE (1024*10)
110 /* Maximum number of NGD devices */
111 #define MAX_NGD 25 /* should be more than enough for now */
113 static d_close_t ngdclose;
114 static d_open_t ngdopen;
115 static d_read_t ngdread;
116 static d_write_t ngdwrite;
117 static d_ioctl_t ngdioctl;
118 static d_poll_t ngdpoll;
120 #define NGD_CDEV_MAJOR 20
121 static struct cdevsw ngd_cdevsw = {
123 /* maj */ NGD_CDEV_MAJOR,
129 /* close */ ngdclose,
131 /* write */ ngdwrite,
132 /* ioctl */ ngdioctl,
135 /* strategy */ nostrategy,
141 * this holds all the stuff that should be done at load time
144 ng_device_mod_event(module_t mod, int event, void *data)
149 kprintf("%s()\n", __func__);
150 #endif /* NGD_DEBUG */
154 cdevsw_add(&ngd_cdevsw, 0, 0);
159 /* XXX do we need to do something specific ? */
160 /* ng_device_breakdown */
161 cdevsw_remove(&ngd_cdevsw, 0, 0);
162 error = EBUSY; /* no unload! */
178 struct ngd_softc *sc = &ngd_softc;
181 kprintf("%s()\n", __func__);
182 #endif /* NGD_DEBUG */
184 SLIST_INIT(&sc->head);
186 if (ng_make_node_common(&typestruct, &sc->node) != 0) {
187 kprintf("%s(): ng_make_node_common failed\n", __func__);
190 ksprintf(sc->nodename, "%s", NG_DEVICE_NODE_TYPE);
191 if (ng_name_node(sc->node, sc->nodename)) {
192 NG_NODE_UNREF(sc->node); /* make it go away again */
193 kprintf("%s(): ng_name_node failed\n", __func__);
196 NG_NODE_SET_PRIVATE(sc->node, sc);
202 * don't allow to be created, only the device can do that
205 ng_device_cons(node_p node)
209 kprintf("%s()\n", __func__);
210 #endif /* NGD_DEBUG */
216 * Receive control message. We just free it.
219 ng_device_rcvmsg(node_p node,
220 struct ng_mesg *msg, const char *retaddr, struct ng_mesg **rptr)
222 FREE(msg, M_NETGRAPH);
229 struct ngd_connection *tmp = NULL;
230 struct ngd_softc *sc = &ngd_softc;
235 kprintf("%s()\n", __func__);
236 #endif /* NGD_DEBUG */
238 /* When there is no list yet, the first device unit is always 0. */
239 if SLIST_EMPTY(&sc->head) {
244 /* Just do a brute force loop to find the first free unit that is
245 * smaller than MAX_NGD.
246 * Set MAX_NGD to a large value, doesn't impact performance.
248 for(n = 0;n<MAX_NGD && unit == -1;n++) {
249 SLIST_FOREACH(tmp, &sc->head, links) {
266 ng_device_newhook(node_p node, hook_p hook, const char *name)
268 struct ngd_softc *sc = &ngd_softc;
269 struct ngd_connection * new_connection = NULL;
272 kprintf("%s()\n", __func__);
273 #endif /* NGD_DEBUG */
275 new_connection = kmalloc(sizeof(struct ngd_connection), M_DEVBUF, M_NOWAIT);
276 if(new_connection == NULL) {
277 kprintf("%s(): ERROR: new_connection == NULL\n", __func__);
281 new_connection->unit = get_free_unit();
282 if(new_connection->unit<0) {
283 kprintf("%s: No free unit found by get_free_unit(), "
284 "increas MAX_NGD\n", __func__);
285 kfree(new_connection, M_DEVBUF);
288 new_connection->ngddev = make_dev(&ngd_cdevsw,
289 new_connection->unit, 0, 0, 0600, "ngd%d", new_connection->unit);
290 if(new_connection->ngddev == NULL) {
291 kprintf("%s(): make_dev failed\n", __func__);
292 SLIST_REMOVE(&sc->head, new_connection, ngd_connection, links);
293 kfree(new_connection, M_DEVBUF);
297 new_connection->readq =
298 kmalloc(sizeof(char)*NGD_QUEUE_SIZE, M_DEVBUF, M_NOWAIT | M_ZERO);
299 if(new_connection->readq == NULL) {
300 kprintf("%s(): readq malloc failed\n", __func__);
301 destroy_dev(new_connection->ngddev);
302 SLIST_REMOVE(&sc->head, new_connection, ngd_connection, links);
303 kfree(new_connection, M_DEVBUF);
307 /* point to begin of buffer */
308 new_connection->loc = 0;
309 new_connection->active_hook = hook;
311 SLIST_INSERT_HEAD(&sc->head, new_connection, links);
317 * we gave ok to a new hook
321 ng_device_connect(hook_p hook)
325 kprintf("%s()\n", __func__);
326 #endif /* NGD_DEBUG */
333 * Receive data from hook
336 ng_device_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
338 struct ngd_softc *sc = &ngd_softc;
339 struct ngd_connection * connection = NULL;
340 struct ngd_connection * tmp;
344 kprintf("%s()\n", __func__);
345 #endif /* NGD_DEBUG */
347 SLIST_FOREACH(tmp, &sc->head, links) {
348 if(tmp->active_hook == hook) {
352 if(connection == NULL) {
353 kprintf("%s(): connection still NULL, no hook found\n", __func__);
359 m = m_pullup(m, m->m_len);
361 kprintf("%s(): ERROR: m_pullup failed\n", __func__);
365 buffer = kmalloc(sizeof(char)*m->m_len, M_DEVBUF, M_NOWAIT | M_ZERO);
367 kprintf("%s(): ERROR: buffer malloc failed\n", __func__);
371 buffer = mtod(m, char *);
373 if( (connection->loc+m->m_len) < NGD_QUEUE_SIZE) {
374 memcpy(connection->readq+connection->loc, buffer, m->m_len);
375 connection->loc += m->m_len;
377 kprintf("%s(): queue full, first read out a bit\n", __func__);
379 kfree(buffer, M_DEVBUF);
385 * Removal of the last link destroys the node
388 ng_device_disconnect(hook_p hook)
390 struct ngd_softc *sc = &ngd_softc;
391 struct ngd_connection * connection = NULL;
392 struct ngd_connection * tmp;
395 kprintf("%s()\n", __func__);
396 #endif /* NGD_DEBUG */
398 SLIST_FOREACH(tmp, &sc->head, links) {
399 if(tmp->active_hook == hook) {
403 if(connection == NULL) {
404 kprintf("%s(): connection still NULL, no hook found\n",
409 kfree(connection->readq, M_DEVBUF);
411 destroy_dev(connection->ngddev);
413 SLIST_REMOVE(&sc->head, connection, ngd_connection, links);
418 * the device is opened
421 ngdopen(cdev_t dev, int flag, int mode, struct thread *td)
425 kprintf("%s()\n", __func__);
426 #endif /* NGD_DEBUG */
432 * the device is closed
435 ngdclose(cdev_t dev, int flag, int mode, struct thread *td)
439 kprintf("%s()\n", __func__);
449 * they are translated into netgraph messages and passed on
453 ngdioctl(cdev_t dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
455 struct ngd_softc *sc = &ngd_softc;
456 struct ngd_connection * connection = NULL;
457 struct ngd_connection * tmp;
460 struct ngd_param_s * datap;
463 kprintf("%s()\n", __func__);
464 #endif /* NGD_DEBUG */
466 SLIST_FOREACH(tmp, &sc->head, links) {
467 if(tmp->ngddev == dev) {
471 if(connection == NULL) {
472 kprintf("%s(): connection still NULL, no dev found\n",
477 /* NG_MKMESSAGE(msg, cookie, cmdid, len, how) */
478 NG_MKMESSAGE(msg, NGM_DEVICE_COOKIE, cmd, sizeof(struct ngd_param_s),
481 kprintf("%s(): msg == NULL\n", __func__);
485 /* pass the ioctl data into the ->data area */
486 datap = (struct ngd_param_s *)msg->data;
489 /*ng_send_msg(node_p here, struct ng_mesg *msg,
490 const char *address, struct ng_mesg **resp); */
491 error = ng_send_msg(sc->node, msg,
492 NG_HOOK_NAME(connection->active_hook), NULL);
494 kprintf("%s(): ng_send_msg() error: %d\n", __func__, error);
503 * This function is called when a read(2) is done to our device.
504 * We pass the data available in kernelspace on into userland using
508 ngdread(cdev_t dev, struct uio *uio, int flag)
511 char buffer[uio->uio_resid+1];
512 struct ngd_softc *sc = &ngd_softc;
513 struct ngd_connection * connection = NULL;
514 struct ngd_connection * tmp;
517 kprintf("%s()\n", __func__);
518 #endif /* NGD_DEBUG */
520 SLIST_FOREACH(tmp, &sc->head, links) {
521 if(tmp->ngddev == dev) {
525 if(connection == NULL) {
526 kprintf("%s(): connection still NULL, no dev found\n", __func__);
530 while ( ( uio->uio_resid > 0 ) && ( connection->loc > 0 ) ) {
531 amnt = MIN(uio->uio_resid, connection->loc);
533 memcpy(buffer, connection->readq, amnt);
534 memcpy(connection->readq, connection->readq+amnt,
535 connection->loc-amnt);
536 connection->loc -= amnt;
538 ret = uiomove((caddr_t)buffer, amnt, uio);
546 kprintf("%s(): uiomove returns error %d\n", __func__, ret);
547 /* do error cleanup here */
553 * This function is called when our device is written to.
554 * We read the data from userland into our local buffer and pass it on
555 * into the remote hook.
559 ngdwrite(cdev_t dev, struct uio *uio, int flag)
564 char buffer[uio->uio_resid];
565 int len = uio->uio_resid;
566 struct ngd_softc *sc =& ngd_softc;
567 struct ngd_connection * connection = NULL;
568 struct ngd_connection * tmp;
571 kprintf("%s()\n", __func__);
572 #endif /* NGD_DEBUG */
574 SLIST_FOREACH(tmp, &sc->head, links) {
575 if(tmp->ngddev == dev) {
580 if(connection == NULL) {
581 kprintf("%s(): connection still NULL, no dev found\n", __func__);
586 if ((ret = uiomove((caddr_t)buffer, len, uio)) != 0)
589 kprintf("%s(): len <= 0 : supposed to happen?!\n", __func__);
591 m = m_devget(buffer, len, 0, NULL, NULL);
593 NG_SEND_DATA_ONLY(error, connection->active_hook, m);
598 /* do error cleanup here */
599 kprintf("%s(): uiomove returned err: %d\n", __func__, ret);
605 * we are being polled/selected
606 * check if there is data available for read
609 ngdpoll(cdev_t dev, int events, struct thread *td)
612 struct ngd_softc *sc = &ngd_softc;
613 struct ngd_connection * connection = NULL;
614 struct ngd_connection * tmp;
617 if (events & (POLLIN | POLLRDNORM)) {
618 /* get the connection we have to know the loc from */
619 SLIST_FOREACH(tmp, &sc->head, links) {
620 if(tmp->ngddev == dev) {
624 if(connection == NULL) {
625 kprintf("%s(): ERROR: connection still NULL, "
626 "no dev found\n", __func__);
630 if (connection->loc > 0)
631 revents |= events & (POLLIN | POLLRDNORM);