proc->thread stage 4: rework the VFS and DEVICE subsystems to take thread
[dragonfly.git] / sys / dev / misc / streams / streams.c
1 /*
2  * Copyright (c) 1998 Mark Newton
3  * Copyright (c) 1994 Christos Zoulas
4  * Copyright (c) 1997 Todd Vierling
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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.
15  * 3. The names of the authors may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * Stolen from NetBSD /sys/compat/svr4/svr4_net.c.  Pseudo-device driver
30  * skeleton produced from /usr/share/examples/drivers/make_pseudo_driver.sh
31  * in 3.0-980524-SNAP then hacked a bit (but probably not enough :-).
32  *
33  * $FreeBSD: src/sys/dev/streams/streams.c,v 1.16.2.1 2001/02/26 04:23:07 jlemon Exp $
34  * $DragonFly: src/sys/dev/misc/streams/Attic/streams.c,v 1.4 2003/06/25 03:55:49 dillon Exp $
35  */
36
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>         /* SYSINIT stuff */
40 #include <sys/conf.h>           /* cdevsw stuff */
41 #include <sys/malloc.h>         /* malloc region definitions */
42 #include <sys/file.h>
43 #include <sys/filedesc.h>
44 #include <sys/unistd.h>
45 #include <sys/fcntl.h>
46 #include <sys/socket.h>
47 #include <sys/protosw.h>
48 #include <sys/socketvar.h>
49 #include <sys/un.h>
50 #include <sys/domain.h>
51 #include <net/if.h>
52 #include <netinet/in.h>
53 #include <sys/proc.h>
54 #include <sys/uio.h>
55
56 #include <sys/sysproto.h>
57
58 #include <svr4/svr4_types.h>
59 #include <svr4/svr4_util.h>
60 #include <svr4/svr4_signal.h>
61 #include <svr4/svr4_ioctl.h>
62 #include <svr4/svr4_stropts.h>
63 #include <svr4/svr4_socket.h>
64
65 static int svr4_soo_close __P((struct file *, struct thread *));
66 static int svr4_ptm_alloc __P((struct thread *));
67 static  d_open_t        streamsopen;
68
69 struct svr4_sockcache_entry {
70         struct thread *td;      /* Thread for the socket                */
71         void *cookie;           /* Internal cookie used for matching    */
72         struct sockaddr_un sock;/* Pathname for the socket              */
73         dev_t dev;              /* Device where the socket lives on     */
74         ino_t ino;              /* Inode where the socket lives on      */
75         TAILQ_ENTRY(svr4_sockcache_entry) entries;
76 };
77
78 TAILQ_HEAD(svr4_sockcache_head, svr4_sockcache_entry) svr4_head;
79
80 /* Initialization flag (set/queried by svr4_mod LKM) */
81 int svr4_str_initialized = 0;
82
83 /*
84  * Device minor numbers
85  */
86 enum {
87         dev_ptm                 = 10,
88         dev_arp                 = 26,
89         dev_icmp                = 27,
90         dev_ip                  = 28,
91         dev_tcp                 = 35,
92         dev_udp                 = 36,
93         dev_rawip               = 37,
94         dev_unix_dgram          = 38,
95         dev_unix_stream         = 39,
96         dev_unix_ord_stream     = 40
97 };
98
99 dev_t dt_ptm, dt_arp, dt_icmp, dt_ip, dt_tcp, dt_udp, dt_rawip,
100         dt_unix_dgram, dt_unix_stream, dt_unix_ord_stream;
101
102 static struct fileops svr4_netops = {
103         soo_read, soo_write, soo_ioctl, soo_poll, sokqfilter,
104         soo_stat, svr4_soo_close
105 };
106  
107 #define CDEV_MAJOR 103
108 static struct cdevsw streams_cdevsw = {
109         /* open */      streamsopen,
110         /* close */     noclose,
111         /* read */      noread,
112         /* write */     nowrite,
113         /* ioctl */     noioctl,
114         /* poll */      nopoll,
115         /* mmap */      nommap,
116         /* strategy */  nostrategy,
117         /* name */      "streams",
118         /* maj */       CDEV_MAJOR,
119         /* dump */      nodump,
120         /* psize */     nopsize,
121         /* flags */     0,
122         /* bmaj */      -1
123 };
124  
125 struct streams_softc {
126         struct isa_device *dev;
127 } ;
128
129 #define UNIT(dev) minor(dev)    /* assume one minor number per unit */
130
131 typedef struct streams_softc *sc_p;
132
133 static  int
134 streams_modevent(module_t mod, int type, void *unused)
135 {
136         switch (type) {
137         case MOD_LOAD:
138                 /* XXX should make sure it isn't already loaded first */
139                 dt_ptm = make_dev(&streams_cdevsw, dev_ptm, 0, 0, 0666,
140                         "ptm");
141                 dt_arp = make_dev(&streams_cdevsw, dev_arp, 0, 0, 0666,
142                         "arp");
143                 dt_icmp = make_dev(&streams_cdevsw, dev_icmp, 0, 0, 0666,
144                         "icmp");
145                 dt_ip = make_dev(&streams_cdevsw, dev_ip, 0, 0, 0666,
146                         "ip");
147                 dt_tcp = make_dev(&streams_cdevsw, dev_tcp, 0, 0, 0666,
148                         "tcp");
149                 dt_udp = make_dev(&streams_cdevsw, dev_udp, 0, 0, 0666,
150                         "udp");
151                 dt_rawip = make_dev(&streams_cdevsw, dev_rawip, 0, 0, 0666,
152                         "rawip");
153                 dt_unix_dgram = make_dev(&streams_cdevsw, dev_unix_dgram,
154                         0, 0, 0666, "ticlts");
155                 dt_unix_stream = make_dev(&streams_cdevsw, dev_unix_stream,
156                         0, 0, 0666, "ticots");
157                 dt_unix_ord_stream = make_dev(&streams_cdevsw,
158                         dev_unix_ord_stream, 0, 0, 0666, "ticotsord");
159
160                 if (! (dt_ptm && dt_arp && dt_icmp && dt_ip && dt_tcp &&
161                                 dt_udp && dt_rawip && dt_unix_dgram &&
162                                 dt_unix_stream && dt_unix_ord_stream)) {
163                         printf("WARNING: device config for STREAMS failed\n");
164                         printf("Suggest unloading streams KLD\n");
165                 }
166                 return 0;
167         case MOD_UNLOAD:
168                 /* XXX should check to see if it's busy first */
169                 destroy_dev(dt_ptm);
170                 destroy_dev(dt_arp);
171                 destroy_dev(dt_icmp);
172                 destroy_dev(dt_ip);
173                 destroy_dev(dt_tcp);
174                 destroy_dev(dt_udp);
175                 destroy_dev(dt_rawip);
176                 destroy_dev(dt_unix_dgram);
177                 destroy_dev(dt_unix_stream);
178                 destroy_dev(dt_unix_ord_stream);
179
180                 return 0;
181         default:
182                 break;
183         }
184         return 0;
185 }
186
187 static moduledata_t streams_mod = {
188         "streams",
189         streams_modevent,
190         0
191 };
192 DECLARE_MODULE(streams, streams_mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
193
194 /*
195  * We only need open() and close() routines.  open() calls socreate()
196  * to allocate a "real" object behind the stream and mallocs some state
197  * info for use by the svr4 emulator;  close() deallocates the state
198  * information and passes the underlying object to the normal socket close
199  * routine.
200  */
201 static  int
202 streamsopen(dev_t dev, int oflags, int devtype, d_thread_t *td)
203 {
204         struct proc *p = td->td_proc;
205         int type, protocol;
206         int fd;
207         struct file *fp;
208         struct socket *so;
209         int error;
210         int family;
211
212         KKASSERT(p != NULL);
213         
214         if (p->p_dupfd >= 0)
215           return ENODEV;
216
217         switch (minor(dev)) {
218         case dev_udp:
219           family = AF_INET;
220           type = SOCK_DGRAM;
221           protocol = IPPROTO_UDP;
222           break;
223
224         case dev_tcp:
225           family = AF_INET;
226           type = SOCK_STREAM;
227           protocol = IPPROTO_TCP;
228           break;
229
230         case dev_ip:
231         case dev_rawip:
232           family = AF_INET;
233           type = SOCK_RAW;
234           protocol = IPPROTO_IP;
235           break;
236
237         case dev_icmp:
238           family = AF_INET;
239           type = SOCK_RAW;
240           protocol = IPPROTO_ICMP;
241           break;
242
243         case dev_unix_dgram:
244           family = AF_LOCAL;
245           type = SOCK_DGRAM;
246           protocol = 0;
247           break;
248
249         case dev_unix_stream:
250         case dev_unix_ord_stream:
251           family = AF_LOCAL;
252           type = SOCK_STREAM;
253           protocol = 0;
254           break;
255
256         case dev_ptm:
257           return svr4_ptm_alloc(td);
258
259         default:
260           return EOPNOTSUPP;
261         }
262
263         if ((error = falloc(p, &fp, &fd)) != 0)
264           return error;
265
266         if ((error = socreate(family, &so, type, protocol, td)) != 0) {
267           p->p_fd->fd_ofiles[fd] = 0;
268           ffree(fp);
269           return error;
270         }
271
272         fp->f_data = (caddr_t)so;
273         fp->f_flag = FREAD|FWRITE;
274         fp->f_ops = &svr4_netops;
275         fp->f_type = DTYPE_SOCKET;
276
277         (void)svr4_stream_get(fp);
278         p->p_dupfd = fd;
279         return ENXIO;
280 }
281
282 static int
283 svr4_ptm_alloc(struct thread *td)
284 {
285         /*
286          * XXX this is very, very ugly.  But I can't find a better
287          * way that won't duplicate a big amount of code from
288          * sys_open().  Ho hum...
289          *
290          * Fortunately for us, Solaris (at least 2.5.1) makes the
291          * /dev/ptmx open automatically just open a pty, that (after
292          * STREAMS I_PUSHes), is just a plain pty.  fstat() is used
293          * to get the minor device number to map to a tty.
294          * 
295          * Cycle through the names. If sys_open() returns ENOENT (or
296          * ENXIO), short circuit the cycle and exit.
297          */
298         static char ptyname[] = "/dev/ptyXX";
299         static char ttyletters[] = "pqrstuwxyzPQRST";
300         static char ttynumbers[] = "0123456789abcdef";
301         caddr_t sg = stackgap_init();
302         char *path = stackgap_alloc(&sg, sizeof(ptyname));
303         struct open_args oa;
304         int l = 0, n = 0;
305         register_t fd = -1;
306         int error;
307         struct proc *p = td->td_proc;
308
309         KKASSERT(p);
310
311         SCARG(&oa, path) = path;
312         SCARG(&oa, flags) = O_RDWR;
313         SCARG(&oa, mode) = 0;
314
315         while (fd == -1) {
316                 ptyname[8] = ttyletters[l];
317                 ptyname[9] = ttynumbers[n];
318
319                 if ((error = copyout(ptyname, path, sizeof(ptyname))) != 0)
320                         return error;
321
322                 switch (error = open(&oa)) {
323                 case ENOENT:
324                 case ENXIO:
325                         return error;
326                 case 0:
327                         p->p_dupfd = p->p_retval[0];
328                         return ENXIO;
329                 default:
330                         if (ttynumbers[++n] == '\0') {
331                                 if (ttyletters[++l] == '\0')
332                                         break;
333                                 n = 0;
334                         }
335                 }
336         }
337         return ENOENT;
338 }
339
340
341 struct svr4_strm *
342 svr4_stream_get(fp)
343         struct file *fp;
344 {
345         struct socket *so;
346         struct svr4_strm *st;
347
348         if (fp == NULL || fp->f_type != DTYPE_SOCKET)
349                 return NULL;
350
351         so = (struct socket *) fp->f_data;
352
353         if (so->so_emuldata)
354                 return so->so_emuldata;
355
356         /* Allocate a new one. */
357         st = malloc(sizeof(struct svr4_strm), M_TEMP, M_WAITOK);
358         st->s_family = so->so_proto->pr_domain->dom_family;
359         st->s_cmd = ~0;
360         st->s_afd = -1;
361         st->s_eventmask = 0;
362         so->so_emuldata = st;
363         fp->f_ops = &svr4_netops;
364
365         return st;
366 }
367
368 void
369 svr4_delete_socket(struct thread *td, struct file *fp)
370 {
371         struct svr4_sockcache_entry *e;
372         void *cookie = ((struct socket *) fp->f_data)->so_emuldata;
373
374         if (!svr4_str_initialized) {
375                 TAILQ_INIT(&svr4_head);
376                 svr4_str_initialized = 1;
377                 return;
378         }
379
380         for (e = svr4_head.tqh_first; e != NULL; e = e->entries.tqe_next)
381                 if (e->td == td && e->cookie == cookie) {
382                         TAILQ_REMOVE(&svr4_head, e, entries);
383                         DPRINTF(("svr4_delete_socket: %s [%p,%d,%d]\n",
384                                  e->sock.sun_path, td, (int)e->dev,
385                                  (int)e->ino));
386                         free(e, M_TEMP);
387                         return;
388                 }
389 }
390
391 static int
392 svr4_soo_close(struct file *fp, struct thread *td)
393 {
394         struct socket *so = (struct socket *)fp->f_data;
395         
396         /*      CHECKUNIT_DIAG(ENXIO);*/
397
398         svr4_delete_socket(td, fp);
399         free(so->so_emuldata, M_TEMP);
400         return soo_close(fp, td);
401         return (0);
402 }