xref: /NextBSD/sys/dev/streams/streams.c (revision 287e3b14e9552995def1802ec9c5034f4adf28ec)
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  */
34 
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>		/* SYSINIT stuff */
41 #include <sys/conf.h>		/* cdevsw stuff */
42 #include <sys/malloc.h>		/* malloc region definitions */
43 #include <sys/file.h>
44 #include <sys/filedesc.h>
45 #include <sys/unistd.h>
46 #include <sys/fcntl.h>
47 #include <sys/socket.h>
48 #include <sys/protosw.h>
49 #include <sys/socketvar.h>
50 #include <sys/syscallsubr.h>
51 #include <sys/un.h>
52 #include <sys/domain.h>
53 #include <net/if.h>
54 #include <netinet/in.h>
55 #include <sys/proc.h>
56 #include <sys/uio.h>
57 
58 #include <sys/sysproto.h>
59 
60 #include <compat/svr4/svr4_types.h>
61 #include <compat/svr4/svr4_util.h>
62 #include <compat/svr4/svr4_signal.h>
63 #include <compat/svr4/svr4_ioctl.h>
64 #include <compat/svr4/svr4_stropts.h>
65 #include <compat/svr4/svr4_socket.h>
66 
67 static int svr4_soo_close(struct file *, struct thread *);
68 static int svr4_ptm_alloc(struct thread *);
69 static  d_open_t	streamsopen;
70 
71 /*
72  * Device minor numbers
73  */
74 enum {
75 	dev_ptm			= 10,
76 	dev_arp			= 26,
77 	dev_icmp		= 27,
78 	dev_ip			= 28,
79 	dev_tcp			= 35,
80 	dev_udp			= 36,
81 	dev_rawip		= 37,
82 	dev_unix_dgram		= 38,
83 	dev_unix_stream		= 39,
84 	dev_unix_ord_stream	= 40
85 };
86 
87 static struct cdev *dt_ptm, *dt_arp, *dt_icmp, *dt_ip, *dt_tcp, *dt_udp,
88 	*dt_rawip, *dt_unix_dgram, *dt_unix_stream, *dt_unix_ord_stream;
89 
90 static struct fileops svr4_netops;
91 
92 static struct cdevsw streams_cdevsw = {
93 	.d_version =	D_VERSION,
94 	.d_open =	streamsopen,
95 	.d_name =	"streams",
96 };
97 
98 struct streams_softc {
99 	struct isa_device *dev;
100 } ;
101 
102 #define UNIT(dev) dev2unit(dev)	/* assume one minor number per unit */
103 
104 typedef	struct streams_softc *sc_p;
105 
106 static	int
streams_modevent(module_t mod,int type,void * unused)107 streams_modevent(module_t mod, int type, void *unused)
108 {
109 	switch (type) {
110 	case MOD_LOAD:
111 		dt_ptm = make_dev(&streams_cdevsw, dev_ptm, 0, 0, 0666,
112 			"ptm");
113 		dt_arp = make_dev(&streams_cdevsw, dev_arp, 0, 0, 0666,
114 			"arp");
115 		dt_icmp = make_dev(&streams_cdevsw, dev_icmp, 0, 0, 0666,
116 			"icmp");
117 		dt_ip = make_dev(&streams_cdevsw, dev_ip, 0, 0, 0666,
118 			"ip");
119 		dt_tcp = make_dev(&streams_cdevsw, dev_tcp, 0, 0, 0666,
120 			"tcp");
121 		dt_udp = make_dev(&streams_cdevsw, dev_udp, 0, 0, 0666,
122 			"udp");
123 		dt_rawip = make_dev(&streams_cdevsw, dev_rawip, 0, 0, 0666,
124 			"rawip");
125 		dt_unix_dgram = make_dev(&streams_cdevsw, dev_unix_dgram,
126 			0, 0, 0666, "ticlts");
127 		dt_unix_stream = make_dev(&streams_cdevsw, dev_unix_stream,
128 			0, 0, 0666, "ticots");
129 		dt_unix_ord_stream = make_dev(&streams_cdevsw,
130 			dev_unix_ord_stream, 0, 0, 0666, "ticotsord");
131 
132 		if (! (dt_ptm && dt_arp && dt_icmp && dt_ip && dt_tcp &&
133 				dt_udp && dt_rawip && dt_unix_dgram &&
134 				dt_unix_stream && dt_unix_ord_stream)) {
135 			printf("WARNING: device config for STREAMS failed\n");
136 			printf("Suggest unloading streams KLD\n");
137 		}
138 
139 		/* Inherit generic socket file operations, except close(2). */
140 		bcopy(&socketops, &svr4_netops, sizeof(struct fileops));
141 		svr4_netops.fo_close = svr4_soo_close;
142 
143 		return 0;
144 	case MOD_UNLOAD:
145 	  	/* XXX should check to see if it's busy first */
146 		destroy_dev(dt_ptm);
147 		destroy_dev(dt_arp);
148 		destroy_dev(dt_icmp);
149 		destroy_dev(dt_ip);
150 		destroy_dev(dt_tcp);
151 		destroy_dev(dt_udp);
152 		destroy_dev(dt_rawip);
153 		destroy_dev(dt_unix_dgram);
154 		destroy_dev(dt_unix_stream);
155 		destroy_dev(dt_unix_ord_stream);
156 
157 		return 0;
158 	default:
159 		return EOPNOTSUPP;
160 		break;
161 	}
162 	return 0;
163 }
164 
165 static moduledata_t streams_mod = {
166 	"streams",
167 	streams_modevent,
168 	0
169 };
170 DECLARE_MODULE(streams, streams_mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
171 MODULE_VERSION(streams, 1);
172 
173 /*
174  * We only need open() and close() routines.  open() calls socreate()
175  * to allocate a "real" object behind the stream and mallocs some state
176  * info for use by the svr4 emulator;  close() deallocates the state
177  * information and passes the underlying object to the normal socket close
178  * routine.
179  */
180 static  int
streamsopen(struct cdev * dev,int oflags,int devtype,struct thread * td)181 streamsopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
182 {
183 	struct svr4_strm *st;
184 	struct socket *so;
185 	struct file *fp;
186 	int family, type, protocol;
187 	int error, fd;
188 
189 	if (td->td_dupfd >= 0)
190 	  return ENODEV;
191 
192 	switch (dev2unit(dev)) {
193 	case dev_udp:
194 	  family = AF_INET;
195 	  type = SOCK_DGRAM;
196 	  protocol = IPPROTO_UDP;
197 	  break;
198 
199 	case dev_tcp:
200 	  family = AF_INET;
201 	  type = SOCK_STREAM;
202 	  protocol = IPPROTO_TCP;
203 	  break;
204 
205 	case dev_ip:
206 	case dev_rawip:
207 	  family = AF_INET;
208 	  type = SOCK_RAW;
209 	  protocol = IPPROTO_IP;
210 	  break;
211 
212 	case dev_icmp:
213 	  family = AF_INET;
214 	  type = SOCK_RAW;
215 	  protocol = IPPROTO_ICMP;
216 	  break;
217 
218 	case dev_unix_dgram:
219 	  family = AF_LOCAL;
220 	  type = SOCK_DGRAM;
221 	  protocol = 0;
222 	  break;
223 
224 	case dev_unix_stream:
225 	case dev_unix_ord_stream:
226 	  family = AF_LOCAL;
227 	  type = SOCK_STREAM;
228 	  protocol = 0;
229 	  break;
230 
231 	case dev_ptm:
232 	  return svr4_ptm_alloc(td);
233 
234 	default:
235 	  return EOPNOTSUPP;
236 	}
237 
238 	if ((error = falloc(td, &fp, &fd, 0)) != 0)
239 	  return error;
240 	/* An extra reference on `fp' has been held for us by falloc(). */
241 
242 	error = socreate(family, &so, type, protocol, td->td_ucred, td);
243 	if (error) {
244 	   fdclose(td, fp, fd);
245 	   fdrop(fp, td);
246 	   return error;
247 	}
248 
249 	finit(fp, FREAD | FWRITE, DTYPE_SOCKET, so, &svr4_netops);
250 
251 	/*
252 	 * Allocate a stream structure and attach it to this socket.
253 	 * We don't bother locking so_emuldata for SVR4 stream sockets as
254 	 * its value is constant for the lifetime of the stream once it
255 	 * is initialized here.
256 	 */
257 	st = malloc(sizeof(struct svr4_strm), M_TEMP, M_WAITOK);
258 	st->s_family = so->so_proto->pr_domain->dom_family;
259 	st->s_cmd = ~0;
260 	st->s_afd = -1;
261 	st->s_eventmask = 0;
262 	so->so_emuldata = st;
263 
264 	fdrop(fp, td);
265 	td->td_dupfd = fd;
266 	return ENXIO;
267 }
268 
269 static int
svr4_ptm_alloc(td)270 svr4_ptm_alloc(td)
271 	struct thread *td;
272 {
273 	/*
274 	 * XXX this is very, very ugly.  But I can't find a better
275 	 * way that won't duplicate a big amount of code from
276 	 * sys_open().  Ho hum...
277 	 *
278 	 * Fortunately for us, Solaris (at least 2.5.1) makes the
279 	 * /dev/ptmx open automatically just open a pty, that (after
280 	 * STREAMS I_PUSHes), is just a plain pty.  fstat() is used
281 	 * to get the minor device number to map to a tty.
282 	 *
283 	 * Cycle through the names. If sys_open() returns ENOENT (or
284 	 * ENXIO), short circuit the cycle and exit.
285 	 *
286 	 * XXX: Maybe this can now be implemented by posix_openpt()?
287 	 */
288 	static char ptyname[] = "/dev/ptyXX";
289 	static char ttyletters[] = "pqrstuwxyzPQRST";
290 	static char ttynumbers[] = "0123456789abcdef";
291 	struct proc *p;
292 	register_t fd;
293 	int error, l, n;
294 
295 	fd = -1;
296 	n = 0;
297 	l = 0;
298 	p = td->td_proc;
299 	while (fd == -1) {
300 		ptyname[8] = ttyletters[l];
301 		ptyname[9] = ttynumbers[n];
302 
303 		error = kern_openat(td, AT_FDCWD, ptyname, UIO_SYSSPACE,
304 		    O_RDWR, 0);
305 		switch (error) {
306 		case ENOENT:
307 		case ENXIO:
308 			return error;
309 		case 0:
310 			td->td_dupfd = td->td_retval[0];
311 			return ENXIO;
312 		default:
313 			if (ttynumbers[++n] == '\0') {
314 				if (ttyletters[++l] == '\0')
315 					break;
316 				n = 0;
317 			}
318 		}
319 	}
320 	return ENOENT;
321 }
322 
323 
324 struct svr4_strm *
svr4_stream_get(fp)325 svr4_stream_get(fp)
326 	struct file *fp;
327 {
328 	struct socket *so;
329 
330 	if (fp == NULL || fp->f_type != DTYPE_SOCKET)
331 		return NULL;
332 
333 	so = fp->f_data;
334 	return so->so_emuldata;
335 }
336 
337 static int
svr4_soo_close(struct file * fp,struct thread * td)338 svr4_soo_close(struct file *fp, struct thread *td)
339 {
340 	struct socket *so = fp->f_data;
341 
342 	/*	CHECKUNIT_DIAG(ENXIO);*/
343 
344 	svr4_delete_socket(td->td_proc, fp);
345 	free(so->so_emuldata, M_TEMP);
346 
347 	fp->f_ops = &badfileops;
348 	fp->f_data = NULL;
349 
350 	return soclose(so);
351 }
352