sys/dev/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$
  34  */
  35
  36 #include <sys/param.h>
  37 #include <sys/systm.h>
  38 #include <sys/kernel.h>         /* SYSINIT stuff */
  39 #include <sys/conf.h>           /* cdevsw stuff */
  40 #include <sys/malloc.h>         /* malloc region definitions */
  41 #include <sys/file.h>
  42 #include <sys/filedesc.h>
  43 #include <sys/unistd.h>
  44 #include <sys/fcntl.h>
  45 #include <sys/socket.h>
  46 #include <sys/protosw.h>
  47 #include <sys/socketvar.h>
  48 #include <sys/un.h>
  49 #include <sys/domain.h>
  50 #include <net/if.h>
  51 #include <netinet/in.h>
  52 #include <sys/proc.h>
  53 #include <sys/uio.h>
  54
  55 #include <sys/sysproto.h>
  56
  57 #include <compat/svr4/svr4_types.h>
  58 #include <compat/svr4/svr4_util.h>
  59 #include <compat/svr4/svr4_signal.h>
  60 #include <compat/svr4/svr4_ioctl.h>
  61 #include <compat/svr4/svr4_stropts.h>
  62 #include <compat/svr4/svr4_socket.h>
  63
  64 static int svr4_soo_close(struct file *, struct thread *);
  65 static int svr4_ptm_alloc(struct thread *);
  66 static  d_open_t        streamsopen;
  67
  68 struct svr4_sockcache_entry {
  69         struct proc *p;         /* Process for the socket               */
  70         void *cookie;           /* Internal cookie used for matching    */
  71         struct sockaddr_un sock;/* Pathname for the socket              */
  72         dev_t dev;              /* Device where the socket lives on     */
  73         ino_t ino;              /* Inode where the socket lives on      */
  74         TAILQ_ENTRY(svr4_sockcache_entry) entries;
  75 };
  76
  77 TAILQ_HEAD(svr4_sockcache_head, svr4_sockcache_entry) svr4_head;
  78
  79 /* Initialization flag (set/queried by svr4_mod LKM) */
  80 int svr4_str_initialized = 0;
  81
  82 /*
  83  * Device minor numbers
  84  */
  85 enum {
  86         dev_ptm                 = 10,
  87         dev_arp                 = 26,
  88         dev_icmp                = 27,
  89         dev_ip                  = 28,
  90         dev_tcp                 = 35,
  91         dev_udp                 = 36,
  92         dev_rawip               = 37,
  93         dev_unix_dgram          = 38,
  94         dev_unix_stream         = 39,
  95         dev_unix_ord_stream     = 40
  96 };
  97
  98 static dev_t dt_ptm, dt_arp, dt_icmp, dt_ip, dt_tcp, dt_udp, dt_rawip,
  99         dt_unix_dgram, dt_unix_stream, dt_unix_ord_stream;
 100
 101 static struct fileops svr4_netops = {
 102         soo_read, soo_write, soo_ioctl, soo_poll, sokqfilter,
 103         soo_stat, svr4_soo_close
 104 };
 105
 106 #define CDEV_MAJOR 103
 107 static struct cdevsw streams_cdevsw = {
 108         /* open */      streamsopen,
 109         /* close */     noclose,
 110         /* read */      noread,
 111         /* write */     nowrite,
 112         /* ioctl */     noioctl,
 113         /* poll */      nopoll,
 114         /* mmap */      nommap,
 115         /* strategy */  nostrategy,
 116         /* name */      "streams",
 117         /* maj */       CDEV_MAJOR,
 118         /* dump */      nodump,
 119         /* psize */     nopsize,
 120         /* flags */     0,
 121 };
 122
 123 struct streams_softc {
 124         struct isa_device *dev;
 125 } ;
 126
 127 #define UNIT(dev) minor(dev)    /* assume one minor number per unit */
 128
 129 typedef struct streams_softc *sc_p;
 130
 131 static  int
 132 streams_modevent(module_t mod, int type, void *unused)
 133 {
 134         switch (type) {
 135         case MOD_LOAD:
 136                 /* XXX should make sure it isn't already loaded first */
 137                 dt_ptm = make_dev(&streams_cdevsw, dev_ptm, 0, 0, 0666,
 138                         "ptm");
 139                 dt_arp = make_dev(&streams_cdevsw, dev_arp, 0, 0, 0666,
 140                         "arp");
 141                 dt_icmp = make_dev(&streams_cdevsw, dev_icmp, 0, 0, 0666,
 142                         "icmp");
 143                 dt_ip = make_dev(&streams_cdevsw, dev_ip, 0, 0, 0666,
 144                         "ip");
 145                 dt_tcp = make_dev(&streams_cdevsw, dev_tcp, 0, 0, 0666,
 146                         "tcp");
 147                 dt_udp = make_dev(&streams_cdevsw, dev_udp, 0, 0, 0666,
 148                         "udp");
 149                 dt_rawip = make_dev(&streams_cdevsw, dev_rawip, 0, 0, 0666,
 150                         "rawip");
 151                 dt_unix_dgram = make_dev(&streams_cdevsw, dev_unix_dgram,
 152                         0, 0, 0666, "ticlts");
 153                 dt_unix_stream = make_dev(&streams_cdevsw, dev_unix_stream,
 154                         0, 0, 0666, "ticots");
 155                 dt_unix_ord_stream = make_dev(&streams_cdevsw,
 156                         dev_unix_ord_stream, 0, 0, 0666, "ticotsord");
 157
 158                 if (! (dt_ptm && dt_arp && dt_icmp && dt_ip && dt_tcp &&
 159                                 dt_udp && dt_rawip && dt_unix_dgram &&
 160                                 dt_unix_stream && dt_unix_ord_stream)) {
 161                         printf("WARNING: device config for STREAMS failed\n");
 162                         printf("Suggest unloading streams KLD\n");
 163                 }
 164                 return 0;
 165         case MOD_UNLOAD:
 166                 /* XXX should check to see if it's busy first */
 167                 destroy_dev(dt_ptm);
 168                 destroy_dev(dt_arp);
 169                 destroy_dev(dt_icmp);
 170                 destroy_dev(dt_ip);
 171                 destroy_dev(dt_tcp);
 172                 destroy_dev(dt_udp);
 173                 destroy_dev(dt_rawip);
 174                 destroy_dev(dt_unix_dgram);
 175                 destroy_dev(dt_unix_stream);
 176                 destroy_dev(dt_unix_ord_stream);
 177
 178                 return 0;
 179         default:
 180                 break;
 181         }
 182         return 0;
 183 }
 184
 185 static moduledata_t streams_mod = {
 186         "streams",
 187         streams_modevent,
 188         0
 189 };
 190 DECLARE_MODULE(streams, streams_mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
 191 MODULE_VERSION(streams, 1);
 192
 193 /*
 194  * We only need open() and close() routines.  open() calls socreate()
 195  * to allocate a "real" object behind the stream and mallocs some state
 196  * info for use by the svr4 emulator;  close() deallocates the state
 197  * information and passes the underlying object to the normal socket close
 198  * routine.
 199  */
 200 static  int
 201 streamsopen(dev_t dev, int oflags, int devtype, struct thread *td)
 202 {
 203         int type, protocol;
 204         int fd;
 205         struct file *fp;
 206         struct socket *so;
 207         int error;
 208         int family;
 209         struct proc *p = td->td_proc;
 210
 211         PROC_LOCK(p);
 212         if (td->td_dupfd >= 0) {
 213           PROC_UNLOCK(p);
 214           return ENODEV;
 215         }
 216         PROC_UNLOCK(p);
 217
 218         switch (minor(dev)) {
 219         case dev_udp:
 220           family = AF_INET;
 221           type = SOCK_DGRAM;
 222           protocol = IPPROTO_UDP;
 223           break;
 224
 225         case dev_tcp:
 226           family = AF_INET;
 227           type = SOCK_STREAM;
 228           protocol = IPPROTO_TCP;
 229           break;
 230
 231         case dev_ip:
 232         case dev_rawip:
 233           family = AF_INET;
 234           type = SOCK_RAW;
 235           protocol = IPPROTO_IP;
 236           break;
 237
 238         case dev_icmp:
 239           family = AF_INET;
 240           type = SOCK_RAW;
 241           protocol = IPPROTO_ICMP;
 242           break;
 243
 244         case dev_unix_dgram:
 245           family = AF_LOCAL;
 246           type = SOCK_DGRAM;
 247           protocol = 0;
 248           break;
 249
 250         case dev_unix_stream:
 251         case dev_unix_ord_stream:
 252           family = AF_LOCAL;
 253           type = SOCK_STREAM;
 254           protocol = 0;
 255           break;
 256
 257         case dev_ptm:
 258           return svr4_ptm_alloc(td);
 259
 260         default:
 261           return EOPNOTSUPP;
 262         }
 263
 264         if ((error = falloc(td, &fp, &fd)) != 0)
 265           return error;
 266
 267         if ((error = socreate(family, &so, type, protocol,
 268             td->td_ucred, td)) != 0) {
 269           FILEDESC_LOCK(p->p_fd);
 270           p->p_fd->fd_ofiles[fd] = 0;
 271           FILEDESC_UNLOCK(p->p_fd);
 272           ffree(fp);
 273           return error;
 274         }
 275
 276         FILEDESC_LOCK(p->p_fd);
 277         fp->f_data = (caddr_t)so;
 278         fp->f_flag = FREAD|FWRITE;
 279         fp->f_ops = &svr4_netops;
 280         fp->f_type = DTYPE_SOCKET;
 281         FILEDESC_UNLOCK(p->p_fd);
 282
 283         (void)svr4_stream_get(fp);
 284         PROC_LOCK(p);
 285         td->td_dupfd = fd;
 286         PROC_UNLOCK(p);
 287         return ENXIO;
 288 }
 289
 290 static int
 291 svr4_ptm_alloc(td)
 292         struct thread *td;
 293 {
 294         struct proc *p = td->td_proc;
 295         /*
 296          * XXX this is very, very ugly.  But I can't find a better
 297          * way that won't duplicate a big amount of code from
 298          * sys_open().  Ho hum...
 299          *
 300          * Fortunately for us, Solaris (at least 2.5.1) makes the
 301          * /dev/ptmx open automatically just open a pty, that (after
 302          * STREAMS I_PUSHes), is just a plain pty.  fstat() is used
 303          * to get the minor device number to map to a tty.
 304          *
 305          * Cycle through the names. If sys_open() returns ENOENT (or
 306          * ENXIO), short circuit the cycle and exit.
 307          */
 308         static char ptyname[] = "/dev/ptyXX";
 309         static char ttyletters[] = "pqrstuwxyzPQRST";
 310         static char ttynumbers[] = "0123456789abcdef";
 311         caddr_t sg = stackgap_init();
 312         char *path = stackgap_alloc(&sg, sizeof(ptyname));
 313         struct open_args oa;
 314         int l = 0, n = 0;
 315         register_t fd = -1;
 316         int error;
 317
 318         SCARG(&oa, path) = path;
 319         SCARG(&oa, flags) = O_RDWR;
 320         SCARG(&oa, mode) = 0;
 321
 322         while (fd == -1) {
 323                 ptyname[8] = ttyletters[l];
 324                 ptyname[9] = ttynumbers[n];
 325
 326                 if ((error = copyout(ptyname, path, sizeof(ptyname))) != 0)
 327                         return error;
 328
 329                 switch (error = open(td, &oa)) {
 330                 case ENOENT:
 331                 case ENXIO:
 332                         return error;
 333                 case 0:
 334                         PROC_LOCK(p);
 335                         td->td_dupfd = td->td_retval[0];
 336                         PROC_UNLOCK(p);
 337                         return ENXIO;
 338                 default:
 339                         if (ttynumbers[++n] == '\0') {
 340                                 if (ttyletters[++l] == '\0')
 341                                         break;
 342                                 n = 0;
 343                         }
 344                 }
 345         }
 346         return ENOENT;
 347 }
 348
 349
 350 struct svr4_strm *
 351 svr4_stream_get(fp)
 352         struct file *fp;
 353 {
 354         struct socket *so;
 355         struct svr4_strm *st;
 356
 357         if (fp == NULL || fp->f_type != DTYPE_SOCKET)
 358                 return NULL;
 359
 360         so = (struct socket *) fp->f_data;
 361
 362         /*
 363          * mpfixme: lock socketbuffer here
 364          */
 365         if (so->so_emuldata) {
 366                 return so->so_emuldata;
 367         }
 368
 369         /* Allocate a new one. */
 370         st = malloc(sizeof(struct svr4_strm), M_TEMP, M_WAITOK);
 371         st->s_family = so->so_proto->pr_domain->dom_family;
 372         st->s_cmd = ~0;
 373         st->s_afd = -1;
 374         st->s_eventmask = 0;
 375         /*
 376          * avoid a race where we loose due to concurrancy issues
 377          * of two threads trying to allocate the so_emuldata.
 378          */
 379         if (so->so_emuldata) {
 380                 /* lost the race, use the existing emuldata */
 381                 FREE(st, M_TEMP);
 382                 st = so->so_emuldata;
 383         } else {
 384                 /* we won, or there was no race, use our copy */
 385                 so->so_emuldata = st;
 386                 fp->f_ops = &svr4_netops;
 387         }
 388
 389         return st;
 390 }
 391
 392 void
 393 svr4_delete_socket(p, fp)
 394         struct proc *p;
 395         struct file *fp;
 396 {
 397         struct svr4_sockcache_entry *e;
 398         void *cookie = ((struct socket *) fp->f_data)->so_emuldata;
 399
 400         while (svr4_str_initialized != 2) {
 401                 if (atomic_cmpset_acq_int(&svr4_str_initialized, 0, 1)) {
 402                         TAILQ_INIT(&svr4_head);
 403                         atomic_store_rel_int(&svr4_str_initialized, 2);
 404                 }
 405                 return;
 406         }
 407
 408         TAILQ_FOREACH(e, &svr4_head, entries)
 409                 if (e->p == p && e->cookie == cookie) {
 410                         TAILQ_REMOVE(&svr4_head, e, entries);
 411                         DPRINTF(("svr4_delete_socket: %s [%p,%d,%d]\n",
 412                                  e->sock.sun_path, p, (int)e->dev, e->ino));
 413                         free(e, M_TEMP);
 414                         return;
 415                 }
 416 }
 417
 418 static int
 419 svr4_soo_close(struct file *fp, struct thread *td)
 420 {
 421         struct socket *so = (struct socket *)fp->f_data;
 422
 423         /*      CHECKUNIT_DIAG(ENXIO);*/
 424
 425         svr4_delete_socket(td->td_proc, fp);
 426         free(so->so_emuldata, M_TEMP);
 427         return soo_close(fp, td);
 428 }