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 $
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
40 #include <sys/queue.h>
41 #include <sys/malloc.h>
45 #include <netgraph/ng_message.h>
46 #include <netgraph/netgraph.h>
48 #include "ng_device.h"
50 /* turn this on for verbose messages */
53 /* Netgraph methods */
54 static ng_constructor_t ng_device_cons;
55 static ng_rcvmsg_t ng_device_rcvmsg;
56 static ng_newhook_t ng_device_newhook;
57 static ng_connect_t ng_device_connect;
58 static ng_rcvdata_t ng_device_rcvdata;
59 static ng_disconnect_t ng_device_disconnect;
60 static int ng_device_mod_event(module_t mod, int event, void *data);
62 static int ng_device_init(void);
63 static int get_free_unit(void);
66 static struct ng_type typestruct = {
67 NG_VERSION, /* version */
68 NG_DEVICE_NODE_TYPE, /* name */
69 ng_device_mod_event, /* modevent */
70 ng_device_cons, /* constructor */
71 ng_device_rcvmsg, /* receive msg */
73 ng_device_newhook, /* newhook */
75 ng_device_connect, /* connect */
76 ng_device_rcvdata, /* receive data */
77 ng_device_rcvdata, /* receive queued data */
78 ng_device_disconnect, /* disconnect */
81 NETGRAPH_INIT(device, &typestruct);
84 struct ngd_connection {
85 SLIST_ENTRY(ngd_connection) links;
88 struct ng_hook *active_hook;
96 SLIST_HEAD(, ngd_connection) head;
99 char nodename[NG_NODESIZ];
102 /* helper definition */
103 #define MIN(a, b) ((a) < (b) ? (a) : (b))
105 /* the per connection receiving queue maximum */
106 #define NGD_QUEUE_SIZE (1024*10)
108 /* Maximum number of NGD devices */
109 #define MAX_NGD 25 /* should be more than enough for now */
111 static d_close_t ngdclose;
112 static d_open_t ngdopen;
113 static d_read_t ngdread;
114 static d_write_t ngdwrite;
115 static d_ioctl_t ngdioctl;
116 static d_poll_t ngdpoll;
118 #define NGD_CDEV_MAJOR 20
119 static struct cdevsw ngd_cdevsw = {
121 /* maj */ NGD_CDEV_MAJOR,
127 /* close */ ngdclose,
129 /* write */ ngdwrite,
130 /* ioctl */ ngdioctl,
133 /* strategy */ nostrategy,
139 * this holds all the stuff that should be done at load time
142 ng_device_mod_event(module_t mod, int event, void *data)
147 kprintf("%s()\n", __func__);
148 #endif /* NGD_DEBUG */
152 cdevsw_add(&ngd_cdevsw, 0, 0);
157 /* XXX do we need to do something specific ? */
158 /* ng_device_breakdown */
159 cdevsw_remove(&ngd_cdevsw, 0, 0);
160 error = EBUSY; /* no unload! */
176 struct ngd_softc *sc = &ngd_softc;
179 kprintf("%s()\n", __func__);
180 #endif /* NGD_DEBUG */
182 SLIST_INIT(&sc->head);
184 if (ng_make_node_common(&typestruct, &sc->node) != 0) {
185 kprintf("%s(): ng_make_node_common failed\n", __func__);
188 ksprintf(sc->nodename, "%s", NG_DEVICE_NODE_TYPE);
189 if (ng_name_node(sc->node, sc->nodename)) {
190 NG_NODE_UNREF(sc->node); /* make it go away again */
191 kprintf("%s(): ng_name_node failed\n", __func__);
194 NG_NODE_SET_PRIVATE(sc->node, sc);
200 * don't allow to be created, only the device can do that
203 ng_device_cons(node_p node)
207 kprintf("%s()\n", __func__);
208 #endif /* NGD_DEBUG */
214 * Receive control message. We just free it.
217 ng_device_rcvmsg(node_p node,
218 struct ng_mesg *msg, const char *retaddr, struct ng_mesg **rptr)
220 kfree(msg, M_NETGRAPH);
227 struct ngd_connection *tmp = NULL;
228 struct ngd_softc *sc = &ngd_softc;
233 kprintf("%s()\n", __func__);
234 #endif /* NGD_DEBUG */
236 /* When there is no list yet, the first device unit is always 0. */
237 if (SLIST_EMPTY(&sc->head)) {
242 /* Just do a brute force loop to find the first free unit that is
243 * smaller than MAX_NGD.
244 * Set MAX_NGD to a large value, doesn't impact performance.
246 for(n = 0;n<MAX_NGD && unit == -1;n++) {
247 SLIST_FOREACH(tmp, &sc->head, links) {
264 ng_device_newhook(node_p node, hook_p hook, const char *name)
266 struct ngd_softc *sc = &ngd_softc;
267 struct ngd_connection * new_connection = NULL;
270 kprintf("%s()\n", __func__);
271 #endif /* NGD_DEBUG */
273 new_connection = kmalloc(sizeof(struct ngd_connection), M_DEVBUF, M_NOWAIT);
274 if(new_connection == NULL) {
275 kprintf("%s(): ERROR: new_connection == NULL\n", __func__);
279 new_connection->unit = get_free_unit();
280 if(new_connection->unit<0) {
281 kprintf("%s: No free unit found by get_free_unit(), "
282 "increas MAX_NGD\n", __func__);
283 kfree(new_connection, M_DEVBUF);
286 new_connection->ngddev = make_dev(&ngd_cdevsw,
287 new_connection->unit, 0, 0, 0600, "ngd%d", new_connection->unit);
288 if(new_connection->ngddev == NULL) {
289 kprintf("%s(): make_dev failed\n", __func__);
290 SLIST_REMOVE(&sc->head, new_connection, ngd_connection, links);
291 kfree(new_connection, M_DEVBUF);
295 new_connection->readq =
296 kmalloc(sizeof(char)*NGD_QUEUE_SIZE, M_DEVBUF, M_NOWAIT | M_ZERO);
297 if(new_connection->readq == NULL) {
298 kprintf("%s(): readq malloc failed\n", __func__);
299 destroy_dev(new_connection->ngddev);
300 SLIST_REMOVE(&sc->head, new_connection, ngd_connection, links);
301 kfree(new_connection, M_DEVBUF);
305 /* point to begin of buffer */
306 new_connection->loc = 0;
307 new_connection->active_hook = hook;
309 SLIST_INSERT_HEAD(&sc->head, new_connection, links);
315 * we gave ok to a new hook
319 ng_device_connect(hook_p hook)
323 kprintf("%s()\n", __func__);
324 #endif /* NGD_DEBUG */
331 * Receive data from hook
334 ng_device_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
336 struct ngd_softc *sc = &ngd_softc;
337 struct ngd_connection * connection = NULL;
338 struct ngd_connection * tmp;
342 kprintf("%s()\n", __func__);
343 #endif /* NGD_DEBUG */
345 SLIST_FOREACH(tmp, &sc->head, links) {
346 if(tmp->active_hook == hook) {
350 if(connection == NULL) {
351 kprintf("%s(): connection still NULL, no hook found\n", __func__);
357 m = m_pullup(m, m->m_len);
359 kprintf("%s(): ERROR: m_pullup failed\n", __func__);
363 buffer = kmalloc(sizeof(char)*m->m_len, M_DEVBUF, M_NOWAIT | M_ZERO);
365 kprintf("%s(): ERROR: buffer malloc failed\n", __func__);
369 buffer = mtod(m, char *);
371 if( (connection->loc+m->m_len) < NGD_QUEUE_SIZE) {
372 memcpy(connection->readq+connection->loc, buffer, m->m_len);
373 connection->loc += m->m_len;
375 kprintf("%s(): queue full, first read out a bit\n", __func__);
377 kfree(buffer, M_DEVBUF);
383 * Removal of the last link destroys the node
386 ng_device_disconnect(hook_p hook)
388 struct ngd_softc *sc = &ngd_softc;
389 struct ngd_connection * connection = NULL;
390 struct ngd_connection * tmp;
393 kprintf("%s()\n", __func__);
394 #endif /* NGD_DEBUG */
396 SLIST_FOREACH(tmp, &sc->head, links) {
397 if(tmp->active_hook == hook) {
401 if(connection == NULL) {
402 kprintf("%s(): connection still NULL, no hook found\n",
407 kfree(connection->readq, M_DEVBUF);
409 destroy_dev(connection->ngddev);
411 SLIST_REMOVE(&sc->head, connection, ngd_connection, links);
416 * the device is opened
419 ngdopen(cdev_t dev, int flag, int mode, struct thread *td)
423 kprintf("%s()\n", __func__);
424 #endif /* NGD_DEBUG */
430 * the device is closed
433 ngdclose(cdev_t dev, int flag, int mode, struct thread *td)
437 kprintf("%s()\n", __func__);
447 * they are translated into netgraph messages and passed on
451 ngdioctl(cdev_t dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
453 struct ngd_softc *sc = &ngd_softc;
454 struct ngd_connection * connection = NULL;
455 struct ngd_connection * tmp;
458 struct ngd_param_s * datap;
461 kprintf("%s()\n", __func__);
462 #endif /* NGD_DEBUG */
464 SLIST_FOREACH(tmp, &sc->head, links) {
465 if(tmp->ngddev == dev) {
469 if(connection == NULL) {
470 kprintf("%s(): connection still NULL, no dev found\n",
475 /* NG_MKMESSAGE(msg, cookie, cmdid, len, how) */
476 NG_MKMESSAGE(msg, NGM_DEVICE_COOKIE, cmd, sizeof(struct ngd_param_s),
479 kprintf("%s(): msg == NULL\n", __func__);
483 /* pass the ioctl data into the ->data area */
484 datap = (struct ngd_param_s *)msg->data;
487 /*ng_send_msg(node_p here, struct ng_mesg *msg,
488 const char *address, struct ng_mesg **resp); */
489 error = ng_send_msg(sc->node, msg,
490 NG_HOOK_NAME(connection->active_hook), NULL);
492 kprintf("%s(): ng_send_msg() error: %d\n", __func__, error);
501 * This function is called when a read(2) is done to our device.
502 * We pass the data available in kernelspace on into userland using
506 ngdread(cdev_t dev, struct uio *uio, int flag)
509 char buffer[uio->uio_resid+1];
510 struct ngd_softc *sc = &ngd_softc;
511 struct ngd_connection * connection = NULL;
512 struct ngd_connection * tmp;
515 kprintf("%s()\n", __func__);
516 #endif /* NGD_DEBUG */
518 SLIST_FOREACH(tmp, &sc->head, links) {
519 if(tmp->ngddev == dev) {
523 if(connection == NULL) {
524 kprintf("%s(): connection still NULL, no dev found\n", __func__);
528 while ( ( uio->uio_resid > 0 ) && ( connection->loc > 0 ) ) {
529 amnt = MIN(uio->uio_resid, connection->loc);
531 memcpy(buffer, connection->readq, amnt);
532 memcpy(connection->readq, connection->readq+amnt,
533 connection->loc-amnt);
534 connection->loc -= amnt;
536 ret = uiomove((caddr_t)buffer, amnt, uio);
544 kprintf("%s(): uiomove returns error %d\n", __func__, ret);
545 /* do error cleanup here */
551 * This function is called when our device is written to.
552 * We read the data from userland into our local buffer and pass it on
553 * into the remote hook.
557 ngdwrite(cdev_t dev, struct uio *uio, int flag)
562 char buffer[uio->uio_resid];
563 int len = uio->uio_resid;
564 struct ngd_softc *sc =& ngd_softc;
565 struct ngd_connection * connection = NULL;
566 struct ngd_connection * tmp;
569 kprintf("%s()\n", __func__);
570 #endif /* NGD_DEBUG */
572 SLIST_FOREACH(tmp, &sc->head, links) {
573 if(tmp->ngddev == dev) {
578 if(connection == NULL) {
579 kprintf("%s(): connection still NULL, no dev found\n", __func__);
584 if ((ret = uiomove((caddr_t)buffer, len, uio)) != 0)
587 kprintf("%s(): len <= 0 : supposed to happen?!\n", __func__);
589 m = m_devget(buffer, len, 0, NULL);
591 NG_SEND_DATA_ONLY(error, connection->active_hook, m);
596 /* do error cleanup here */
597 kprintf("%s(): uiomove returned err: %d\n", __func__, ret);
603 * we are being polled/selected
604 * check if there is data available for read
607 ngdpoll(cdev_t dev, int events, struct thread *td)
610 struct ngd_softc *sc = &ngd_softc;
611 struct ngd_connection * connection = NULL;
612 struct ngd_connection * tmp;
615 if (events & (POLLIN | POLLRDNORM)) {
616 /* get the connection we have to know the loc from */
617 SLIST_FOREACH(tmp, &sc->head, links) {
618 if(tmp->ngddev == dev) {
622 if(connection == NULL) {
623 kprintf("%s(): ERROR: connection still NULL, "
624 "no dev found\n", __func__);
628 if (connection->loc > 0)
629 revents |= events & (POLLIN | POLLRDNORM);