For kmalloc(), MALLOC() and contigmalloc(), use M_ZERO instead of
[dragonfly.git] / sys / netgraph / tty / ng_tty.c
1
2 /*
3  * ng_tty.c
4  *
5  * Copyright (c) 1996-1999 Whistle Communications, Inc.
6  * All rights reserved.
7  * 
8  * Subject to the following obligations and disclaimer of warranty, use and
9  * redistribution of this software, in source or object code forms, with or
10  * without modifications are expressly permitted by Whistle Communications;
11  * provided, however, that:
12  * 1. Any and all reproductions of the source or object code must include the
13  *    copyright notice above and the following disclaimer of warranties; and
14  * 2. No rights are granted, in any manner or form, to use Whistle
15  *    Communications, Inc. trademarks, including the mark "WHISTLE
16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17  *    such appears in the above copyright notice or in the software.
18  * 
19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
35  * OF SUCH DAMAGE.
36  *
37  * Author: Archie Cobbs <archie@freebsd.org>
38  *
39  * $FreeBSD: src/sys/netgraph/ng_tty.c,v 1.7.2.3 2002/02/13 00:43:12 dillon Exp $
40  * $DragonFly: src/sys/netgraph/tty/ng_tty.c,v 1.18 2008/01/05 14:02:40 swildner Exp $
41  * $Whistle: ng_tty.c,v 1.21 1999/11/01 09:24:52 julian Exp $
42  */
43
44 /*
45  * This file implements a terminal line discipline that is also a
46  * netgraph node. Installing this line discipline on a terminal device
47  * instantiates a new netgraph node of this type, which allows access
48  * to the device via the "hook" hook of the node.
49  *
50  * Once the line discipline is installed, you can find out the name
51  * of the corresponding netgraph node via a NGIOCGINFO ioctl().
52  *
53  * Incoming characters are delievered to the hook one at a time, each
54  * in its own mbuf. You may optionally define a ``hotchar,'' which causes
55  * incoming characters to be buffered up until either the hotchar is
56  * seen or the mbuf is full (MHLEN bytes). Then all buffered characters
57  * are immediately delivered.
58  *
59  * NOTE: This node operates at spltty().
60  */
61
62 #include <sys/param.h>
63 #include <sys/systm.h>
64 #include <sys/kernel.h>
65 #include <sys/conf.h>
66 #include <sys/proc.h>
67 #include <sys/mbuf.h>
68 #include <sys/malloc.h>
69 #include <sys/fcntl.h>
70 #include <sys/tty.h>
71 #include <sys/ttycom.h>
72 #include <sys/syslog.h>
73 #include <sys/errno.h>
74 #include <sys/ioccom.h>
75 #include <sys/thread2.h>
76
77 #include <netgraph/ng_message.h>
78 #include <netgraph/netgraph.h>
79 #include "ng_tty.h"
80
81 /* Misc defs */
82 #define MAX_MBUFQ               3       /* Max number of queued mbufs */
83 #define NGT_HIWATER             400     /* High water mark on output */
84
85 /* Per-node private info */
86 struct ngt_sc {
87         struct  tty *tp;                /* Terminal device */
88         node_p  node;                   /* Netgraph node */
89         hook_p  hook;                   /* Netgraph hook */
90         struct  mbuf *m;                /* Incoming data buffer */
91         struct  mbuf *qhead, **qtail;   /* Queue of outgoing mbuf's */
92         short   qlen;                   /* Length of queue */
93         short   hotchar;                /* Hotchar, or -1 if none */
94         u_int   flags;                  /* Flags */
95         struct  callout ctimeout;       /* See man timeout(9) */
96 };
97 typedef struct ngt_sc *sc_p;
98
99 /* Flags */
100 #define FLG_TIMEOUT             0x0001  /* A timeout is pending */
101 #define FLG_DEBUG               0x0002
102
103 /* Debugging */
104 #ifdef INVARIANTS
105 #define QUEUECHECK(sc)                                                  \
106     do {                                                                \
107       struct mbuf       **mp;                                           \
108       int               k;                                              \
109                                                                         \
110       for (k = 0, mp = &sc->qhead;                                      \
111         k <= MAX_MBUFQ && *mp;                                          \
112         k++, mp = &(*mp)->m_nextpkt);                                   \
113       if (k != sc->qlen || k > MAX_MBUFQ || *mp || mp != sc->qtail)     \
114         panic("%s: queue", __func__);                           \
115     } while (0)
116 #else
117 #define QUEUECHECK(sc)  do {} while (0)
118 #endif
119
120 /* Line discipline methods */
121 static int      ngt_open(cdev_t dev, struct tty *tp);
122 static int      ngt_close(struct tty *tp, int flag);
123 static int      ngt_read(struct tty *tp, struct uio *uio, int flag);
124 static int      ngt_write(struct tty *tp, struct uio *uio, int flag);
125 static int      ngt_tioctl(struct tty *tp,
126                     u_long cmd, caddr_t data, int flag, struct ucred *cred);
127 static int      ngt_input(int c, struct tty *tp);
128 static int      ngt_start(struct tty *tp);
129
130 /* Netgraph methods */
131 static ng_constructor_t ngt_constructor;
132 static ng_rcvmsg_t      ngt_rcvmsg;
133 static ng_shutdown_t    ngt_shutdown;
134 static ng_newhook_t     ngt_newhook;
135 static ng_rcvdata_t     ngt_rcvdata;
136 static ng_disconnect_t  ngt_disconnect;
137 static int      ngt_mod_event(module_t mod, int event, void *data);
138
139 /* Other stuff */
140 static void     ngt_timeout(void *arg);
141
142 #define ERROUT(x)               do { error = (x); goto done; } while (0)
143
144 /* Line discipline descriptor */
145 static struct linesw ngt_disc = {
146         ngt_open,
147         ngt_close,
148         ngt_read,
149         ngt_write,
150         ngt_tioctl,
151         ngt_input,
152         ngt_start,
153         ttymodem,
154         NG_TTY_DFL_HOTCHAR      /* XXX can't change this in serial driver */
155 };
156
157 /* Netgraph node type descriptor */
158 static struct ng_type typestruct = {
159         NG_VERSION,
160         NG_TTY_NODE_TYPE,
161         ngt_mod_event,
162         ngt_constructor,
163         ngt_rcvmsg,
164         ngt_shutdown,
165         ngt_newhook,
166         NULL,
167         NULL,
168         ngt_rcvdata,
169         ngt_rcvdata,
170         ngt_disconnect,
171         NULL
172 };
173 NETGRAPH_INIT(tty, &typestruct);
174
175 static int ngt_unit;
176 static int ngt_nodeop_ok;       /* OK to create/remove node */
177 static int ngt_ldisc;
178
179 /******************************************************************
180                     LINE DISCIPLINE METHODS
181 ******************************************************************/
182
183 /*
184  * Set our line discipline on the tty.
185  * Called from device open routine or ttioctl() at >= splsofttty()
186  */
187 static int
188 ngt_open(cdev_t dev, struct tty *tp)
189 {
190         struct thread *td = curthread;  /* XXX */
191         char name[sizeof(NG_TTY_NODE_TYPE) + 8];
192         sc_p sc;
193         int error;
194
195         /* Super-user only */
196         if ((error = suser(td)))
197                 return (error);
198         crit_enter();
199
200         /* Already installed? */
201         if (tp->t_line == NETGRAPHDISC) {
202                 sc = (sc_p) tp->t_sc;
203                 if (sc != NULL && sc->tp == tp)
204                         goto done;
205         }
206
207         /* Initialize private struct */
208         MALLOC(sc, sc_p, sizeof(*sc), M_NETGRAPH, M_WAITOK | M_ZERO);
209         if (sc == NULL) {
210                 error = ENOMEM;
211                 goto done;
212         }
213         sc->tp = tp;
214         sc->hotchar = NG_TTY_DFL_HOTCHAR;
215         sc->qtail = &sc->qhead;
216         QUEUECHECK(sc);
217         callout_init(&sc->ctimeout);
218
219         /* Setup netgraph node */
220         ngt_nodeop_ok = 1;
221         error = ng_make_node_common(&typestruct, &sc->node);
222         ngt_nodeop_ok = 0;
223         if (error) {
224                 FREE(sc, M_NETGRAPH);
225                 goto done;
226         }
227         ksnprintf(name, sizeof(name), "%s%d", typestruct.name, ngt_unit++);
228
229         /* Set back pointers */
230         sc->node->private = sc;
231         tp->t_sc = (caddr_t) sc;
232
233         /* Assign node its name */
234         if ((error = ng_name_node(sc->node, name))) {
235                 log(LOG_ERR, "%s: node name exists?\n", name);
236                 ngt_nodeop_ok = 1;
237                 ng_rmnode(sc->node);
238                 ngt_nodeop_ok = 0;
239                 goto done;
240         }
241
242         /*
243          * Pre-allocate cblocks to the an appropriate amount.
244          * I'm not sure what is appropriate.
245          */
246         ttyflush(tp, FREAD | FWRITE);
247         clist_alloc_cblocks(&tp->t_canq, 0, 0);
248         clist_alloc_cblocks(&tp->t_rawq, 0, 0);
249         clist_alloc_cblocks(&tp->t_outq,
250             MLEN + NGT_HIWATER, MLEN + NGT_HIWATER);
251
252 done:
253         /* Done */
254         crit_exit();
255         return (error);
256 }
257
258 /*
259  * Line specific close routine, called from device close routine
260  * and from ttioctl at >= splsofttty(). This causes the node to
261  * be destroyed as well.
262  */
263 static int
264 ngt_close(struct tty *tp, int flag)
265 {
266         const sc_p sc = (sc_p) tp->t_sc;
267
268         crit_enter();
269         ttyflush(tp, FREAD | FWRITE);
270         clist_free_cblocks(&tp->t_outq);
271         tp->t_line = 0;
272         if (sc != NULL) {
273                 if (sc->flags & FLG_TIMEOUT) {
274                         callout_stop(&sc->ctimeout);
275                         sc->flags &= ~FLG_TIMEOUT;
276                 }
277                 ngt_nodeop_ok = 1;
278                 ng_rmnode(sc->node);
279                 ngt_nodeop_ok = 0;
280                 tp->t_sc = NULL;
281         }
282         crit_exit();
283         return (0);
284 }
285
286 /*
287  * Once the device has been turned into a node, we don't allow reading.
288  */
289 static int
290 ngt_read(struct tty *tp, struct uio *uio, int flag)
291 {
292         return (EIO);
293 }
294
295 /*
296  * Once the device has been turned into a node, we don't allow writing.
297  */
298 static int
299 ngt_write(struct tty *tp, struct uio *uio, int flag)
300 {
301         return (EIO);
302 }
303
304 /*
305  * We implement the NGIOCGINFO ioctl() defined in ng_message.h.
306  */
307 static int
308 ngt_tioctl(struct tty *tp, u_long cmd, caddr_t data, int flag, struct ucred *cred)
309 {
310         const sc_p sc = (sc_p) tp->t_sc;
311         int error = 0;
312
313         crit_enter();
314         switch (cmd) {
315         case NGIOCGINFO:
316             {
317                 struct nodeinfo *const ni = (struct nodeinfo *) data;
318                 const node_p node = sc->node;
319
320                 bzero(ni, sizeof(*ni));
321                 if (node->name)
322                         strncpy(ni->name, node->name, sizeof(ni->name) - 1);
323                 strncpy(ni->type, node->type->name, sizeof(ni->type) - 1);
324                 ni->id = (u_int32_t) node;
325                 ni->hooks = node->numhooks;
326                 break;
327             }
328         default:
329                 ERROUT(ENOIOCTL);
330         }
331 done:
332         crit_exit();
333         return (error);
334 }
335
336 /*
337  * Receive data coming from the device. We get one character at
338  * a time, which is kindof silly.
339  * Only guaranteed to be at splsofttty() or spltty().
340  */
341 static int
342 ngt_input(int c, struct tty *tp)
343 {
344         const sc_p sc = (sc_p) tp->t_sc;
345         const node_p node = sc->node;
346         struct mbuf *m;
347         int error = 0;
348
349         if (!sc || tp != sc->tp)
350                 return (0);
351         crit_enter();
352         if (!sc->hook)
353                 ERROUT(0);
354
355         /* Check for error conditions */
356         if ((tp->t_state & TS_CONNECTED) == 0) {
357                 if (sc->flags & FLG_DEBUG)
358                         log(LOG_DEBUG, "%s: no carrier\n", node->name);
359                 ERROUT(0);
360         }
361         if (c & TTY_ERRORMASK) {
362                 /* framing error or overrun on this char */
363                 if (sc->flags & FLG_DEBUG)
364                         log(LOG_DEBUG, "%s: line error %x\n",
365                             node->name, c & TTY_ERRORMASK);
366                 ERROUT(0);
367         }
368         c &= TTY_CHARMASK;
369
370         /* Get a new header mbuf if we need one */
371         if (!(m = sc->m)) {
372                 MGETHDR(m, MB_DONTWAIT, MT_DATA);
373                 if (!m) {
374                         if (sc->flags & FLG_DEBUG)
375                                 log(LOG_ERR,
376                                     "%s: can't get mbuf\n", node->name);
377                         ERROUT(ENOBUFS);
378                 }
379                 m->m_len = m->m_pkthdr.len = 0;
380                 m->m_pkthdr.rcvif = NULL;
381                 sc->m = m;
382         }
383
384         /* Add char to mbuf */
385         *mtod(m, u_char *) = c;
386         m->m_data++;
387         m->m_len++;
388         m->m_pkthdr.len++;
389
390         /* Ship off mbuf if it's time */
391         if (sc->hotchar == -1 || c == sc->hotchar || m->m_len >= MHLEN) {
392                 m->m_data = m->m_pktdat;
393                 error = ng_queue_data(sc->hook, m, NULL);
394                 sc->m = NULL;
395         }
396 done:
397         crit_exit();
398         return (error);
399 }
400
401 /*
402  * This is called when the device driver is ready for more output.
403  * Called from tty system at splsofttty() or spltty().
404  * Also call from ngt_rcv_data() when a new mbuf is available for output.
405  */
406 static int
407 ngt_start(struct tty *tp)
408 {
409         const sc_p sc = (sc_p) tp->t_sc;
410
411         crit_enter();
412         while (tp->t_outq.c_cc < NGT_HIWATER) { /* XXX 2.2 specific ? */
413                 struct mbuf *m = sc->qhead;
414
415                 /* Remove first mbuf from queue */
416                 if (!m)
417                         break;
418                 if ((sc->qhead = m->m_nextpkt) == NULL)
419                         sc->qtail = &sc->qhead;
420                 sc->qlen--;
421                 QUEUECHECK(sc);
422
423                 /* Send as much of it as possible */
424                 while (m) {
425                         int     sent;
426
427                         sent = m->m_len
428                             - b_to_q(mtod(m, u_char *), m->m_len, &tp->t_outq);
429                         m->m_data += sent;
430                         m->m_len -= sent;
431                         if (m->m_len > 0)
432                                 break;  /* device can't take no more */
433                         m = m_free(m);
434                 }
435
436                 /* Put remainder of mbuf chain (if any) back on queue */
437                 if (m) {
438                         m->m_nextpkt = sc->qhead;
439                         sc->qhead = m;
440                         if (sc->qtail == &sc->qhead)
441                                 sc->qtail = &m->m_nextpkt;
442                         sc->qlen++;
443                         QUEUECHECK(sc);
444                         break;
445                 }
446         }
447
448         /* Call output process whether or not there is any output. We are
449          * being called in lieu of ttstart and must do what it would. */
450         if (tp->t_oproc != NULL)
451                 (*tp->t_oproc) (tp);
452
453         /* This timeout is needed for operation on a pseudo-tty, because the
454          * pty code doesn't call pppstart after it has drained the t_outq. */
455         if (sc->qhead && (sc->flags & FLG_TIMEOUT) == 0) {
456                 callout_reset(&sc->ctimeout, 1, ngt_timeout, sc);
457                 sc->flags |= FLG_TIMEOUT;
458         }
459         crit_exit();
460         return (0);
461 }
462
463 /*
464  * We still have data to output to the device, so try sending more.
465  */
466 static void
467 ngt_timeout(void *arg)
468 {
469         const sc_p sc = (sc_p) arg;
470
471         crit_enter();
472         sc->flags &= ~FLG_TIMEOUT;
473         ngt_start(sc->tp);
474         crit_exit();
475 }
476
477 /******************************************************************
478                     NETGRAPH NODE METHODS
479 ******************************************************************/
480
481 /*
482  * Initialize a new node of this type.
483  *
484  * We only allow nodes to be created as a result of setting
485  * the line discipline on a tty, so always return an error if not.
486  */
487 static int
488 ngt_constructor(node_p *nodep)
489 {
490         if (!ngt_nodeop_ok)
491                 return (EOPNOTSUPP);
492         return (ng_make_node_common(&typestruct, nodep));
493 }
494
495 /*
496  * Add a new hook. There can only be one.
497  */
498 static int
499 ngt_newhook(node_p node, hook_p hook, const char *name)
500 {
501         const sc_p sc = node->private;
502         int error = 0;
503
504         if (strcmp(name, NG_TTY_HOOK))
505                 return (EINVAL);
506         crit_enter();
507         if (sc->hook)
508                 ERROUT(EISCONN);
509         sc->hook = hook;
510 done:
511         crit_exit();
512         return (error);
513 }
514
515 /*
516  * Disconnect the hook
517  */
518 static int
519 ngt_disconnect(hook_p hook)
520 {
521         const sc_p sc = hook->node->private;
522
523         crit_enter();
524         if (hook != sc->hook)
525                 panic(__func__);
526         sc->hook = NULL;
527         m_freem(sc->m);
528         sc->m = NULL;
529         crit_exit();
530         return (0);
531 }
532
533 /*
534  * Remove this node. The does the netgraph portion of the shutdown.
535  * This should only be called indirectly from ngt_close().
536  */
537 static int
538 ngt_shutdown(node_p node)
539 {
540         const sc_p sc = node->private;
541
542         if (!ngt_nodeop_ok)
543                 return (EOPNOTSUPP);
544         ng_unname(node);
545         ng_cutlinks(node);
546         node->private = NULL;
547         ng_unref(sc->node);
548         m_freem(sc->qhead);
549         m_freem(sc->m);
550         bzero(sc, sizeof(*sc));
551         FREE(sc, M_NETGRAPH);
552         return (0);
553 }
554
555 /*
556  * Receive incoming data from netgraph system. Put it on our
557  * output queue and start output if necessary.
558  */
559 static int
560 ngt_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
561 {
562         const sc_p sc = hook->node->private;
563         int error = 0;
564
565         if (hook != sc->hook)
566                 panic(__func__);
567         NG_FREE_META(meta);
568         crit_enter();
569         if (sc->qlen >= MAX_MBUFQ)
570                 ERROUT(ENOBUFS);
571         m->m_nextpkt = NULL;
572         *sc->qtail = m;
573         sc->qtail = &m->m_nextpkt;
574         sc->qlen++;
575         QUEUECHECK(sc);
576         m = NULL;
577         if (sc->qlen == 1)
578                 ngt_start(sc->tp);
579 done:
580         crit_exit();
581         if (m)
582                 m_freem(m);
583         return (error);
584 }
585
586 /*
587  * Receive control message
588  */
589 static int
590 ngt_rcvmsg(node_p node, struct ng_mesg *msg, const char *retaddr,
591            struct ng_mesg **rptr)
592 {
593         const sc_p sc = (sc_p) node->private;
594         struct ng_mesg *resp = NULL;
595         int error = 0;
596
597         switch (msg->header.typecookie) {
598         case NGM_TTY_COOKIE:
599                 switch (msg->header.cmd) {
600                 case NGM_TTY_SET_HOTCHAR:
601                     {
602                         int     hotchar;
603
604                         if (msg->header.arglen != sizeof(int))
605                                 ERROUT(EINVAL);
606                         hotchar = *((int *) msg->data);
607                         if (hotchar != (u_char) hotchar && hotchar != -1)
608                                 ERROUT(EINVAL);
609                         sc->hotchar = hotchar;  /* race condition is OK */
610                         break;
611                     }
612                 case NGM_TTY_GET_HOTCHAR:
613                         NG_MKRESPONSE(resp, msg, sizeof(int), M_NOWAIT);
614                         if (!resp)
615                                 ERROUT(ENOMEM);
616                         /* Race condition here is OK */
617                         *((int *) resp->data) = sc->hotchar;
618                         break;
619                 default:
620                         ERROUT(EINVAL);
621                 }
622                 break;
623         default:
624                 ERROUT(EINVAL);
625         }
626         if (rptr)
627                 *rptr = resp;
628         else if (resp)
629                 FREE(resp, M_NETGRAPH);
630
631 done:
632         FREE(msg, M_NETGRAPH);
633         return (error);
634 }
635
636 /******************************************************************
637                         INITIALIZATION
638 ******************************************************************/
639
640 /*
641  * Handle loading and unloading for this node type
642  */
643 static int
644 ngt_mod_event(module_t mod, int event, void *data)
645 {
646         /* struct ng_type *const type = data;*/
647         int error = 0;
648
649         switch (event) {
650         case MOD_LOAD:
651                 /* Register line discipline */
652                 crit_enter();
653                 if ((ngt_ldisc = ldisc_register(NETGRAPHDISC, &ngt_disc)) < 0) {
654                         crit_exit();
655                         log(LOG_ERR, "%s: can't register line discipline",
656                             __func__);
657                         return (EIO);
658                 }
659                 crit_exit();
660                 break;
661
662         case MOD_UNLOAD:
663
664                 /* Unregister line discipline */
665                 crit_enter();
666                 ldisc_deregister(ngt_ldisc);
667                 crit_exit();
668                 break;
669
670         default:
671                 error = EOPNOTSUPP;
672                 break;
673         }
674         return (error);
675 }
676