sys/kern/kern_memio.c

   1 /*-
   2  * Copyright (c) 1988 University of Utah.
   3  * Copyright (c) 1982, 1986, 1990 The Regents of the University of California.
   4  * All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * the Systems Programming Group of the University of Utah Computer
   8  * Science Department, and code derived from software contributed to
   9  * Berkeley by William Jolitz.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      from: Utah $Hdr: mem.c 1.13 89/10/08$
  40  *      from: @(#)mem.c 7.2 (Berkeley) 5/9/91
  41  * $FreeBSD: src/sys/i386/i386/mem.c,v 1.79.2.9 2003/01/04 22:58:01 njl Exp $
  42  */
  43
  44 /*
  45  * Memory special file
  46  */
  47
  48 #include <sys/param.h>
  49 #include <sys/systm.h>
  50 #include <sys/buf.h>
  51 #include <sys/conf.h>
  52 #include <sys/fcntl.h>
  53 #include <sys/filio.h>
  54 #include <sys/kernel.h>
  55 #include <sys/malloc.h>
  56 #include <sys/memrange.h>
  57 #include <sys/proc.h>
  58 #include <sys/priv.h>
  59 #include <sys/random.h>
  60 #include <sys/signalvar.h>
  61 #include <sys/uio.h>
  62 #include <sys/vnode.h>
  63
  64 #include <sys/signal2.h>
  65 #include <sys/mplock2.h>
  66
  67 #include <vm/vm.h>
  68 #include <vm/pmap.h>
  69 #include <vm/vm_extern.h>
  70
  71
  72 static  d_open_t        mmopen;
  73 static  d_close_t       mmclose;
  74 static  d_read_t        mmread;
  75 static  d_write_t       mmwrite;
  76 static  d_ioctl_t       mmioctl;
  77 static  d_mmap_t        memmmap;
  78 static  d_kqfilter_t    mmkqfilter;
  79
  80 #define CDEV_MAJOR 2
  81 static struct dev_ops mem_ops = {
  82         { "mem", 0, D_MPSAFE },
  83         .d_open =       mmopen,
  84         .d_close =      mmclose,
  85         .d_read =       mmread,
  86         .d_write =      mmwrite,
  87         .d_ioctl =      mmioctl,
  88         .d_kqfilter =   mmkqfilter,
  89         .d_mmap =       memmmap,
  90 };
  91
  92 static int rand_bolt;
  93 static caddr_t  zbuf;
  94 static cdev_t   zerodev = NULL;
  95
  96 MALLOC_DEFINE(M_MEMDESC, "memdesc", "memory range descriptors");
  97 static int mem_ioctl (cdev_t, u_long, caddr_t, int, struct ucred *);
  98 static int random_ioctl (cdev_t, u_long, caddr_t, int, struct ucred *);
  99
 100 struct mem_range_softc mem_range_softc;
 101
 102
 103 static int
 104 mmopen(struct dev_open_args *ap)
 105 {
 106         cdev_t dev = ap->a_head.a_dev;
 107         int error;
 108
 109         switch (minor(dev)) {
 110         case 0:
 111         case 1:
 112                 if (ap->a_oflags & FWRITE) {
 113                         if (securelevel > 0 || kernel_mem_readonly)
 114                                 return (EPERM);
 115                 }
 116                 error = 0;
 117                 break;
 118         case 14:
 119                 error = priv_check_cred(ap->a_cred, PRIV_ROOT, 0);
 120                 if (error != 0)
 121                         break;
 122                 if (securelevel > 0 || kernel_mem_readonly) {
 123                         error = EPERM;
 124                         break;
 125                 }
 126                 error = cpu_set_iopl();
 127                 break;
 128         default:
 129                 error = 0;
 130                 break;
 131         }
 132         return (error);
 133 }
 134
 135 static int
 136 mmclose(struct dev_close_args *ap)
 137 {
 138         cdev_t dev = ap->a_head.a_dev;
 139         int error;
 140
 141         switch (minor(dev)) {
 142         case 14:
 143                 error = cpu_clr_iopl();
 144                 break;
 145         default:
 146                 error = 0;
 147                 break;
 148         }
 149         return (error);
 150 }
 151
 152
 153 static int
 154 mmrw(cdev_t dev, struct uio *uio, int flags)
 155 {
 156         int o;
 157         u_int c;
 158         u_int poolsize;
 159         u_long v;
 160         struct iovec *iov;
 161         int error = 0;
 162         caddr_t buf = NULL;
 163
 164         while (uio->uio_resid > 0 && error == 0) {
 165                 iov = uio->uio_iov;
 166                 if (iov->iov_len == 0) {
 167                         uio->uio_iov++;
 168                         uio->uio_iovcnt--;
 169                         if (uio->uio_iovcnt < 0)
 170                                 panic("mmrw");
 171                         continue;
 172                 }
 173                 switch (minor(dev)) {
 174                 case 0:
 175                         /*
 176                          * minor device 0 is physical memory, /dev/mem
 177                          */
 178                         v = uio->uio_offset;
 179                         v &= ~(long)PAGE_MASK;
 180                         pmap_kenter((vm_offset_t)ptvmmap, v);
 181                         o = (int)uio->uio_offset & PAGE_MASK;
 182                         c = (u_int)(PAGE_SIZE - ((uintptr_t)iov->iov_base & PAGE_MASK));
 183                         c = min(c, (u_int)(PAGE_SIZE - o));
 184                         c = min(c, (u_int)iov->iov_len);
 185                         error = uiomove((caddr_t)&ptvmmap[o], (int)c, uio);
 186                         pmap_kremove((vm_offset_t)ptvmmap);
 187                         continue;
 188
 189                 case 1: {
 190                         /*
 191                          * minor device 1 is kernel memory, /dev/kmem
 192                          */
 193                         vm_offset_t saddr, eaddr;
 194                         int prot;
 195
 196                         c = iov->iov_len;
 197
 198                         /*
 199                          * Make sure that all of the pages are currently
 200                          * resident so that we don't create any zero-fill
 201                          * pages.
 202                          */
 203                         saddr = trunc_page(uio->uio_offset);
 204                         eaddr = round_page(uio->uio_offset + c);
 205                         if (saddr > eaddr)
 206                                 return EFAULT;
 207
 208                         /*
 209                          * Make sure the kernel addresses are mapped.
 210                          * platform_direct_mapped() can be used to bypass
 211                          * default mapping via the page table (virtual kernels
 212                          * contain a lot of out-of-band data).
 213                          */
 214                         prot = VM_PROT_READ;
 215                         if (uio->uio_rw != UIO_READ)
 216                                 prot |= VM_PROT_WRITE;
 217                         error = kvm_access_check(saddr, eaddr, prot);
 218                         if (error)
 219                                 return (error);
 220                         error = uiomove((caddr_t)(vm_offset_t)uio->uio_offset,
 221                                         (int)c, uio);
 222                         continue;
 223                 }
 224                 case 2:
 225                         /*
 226                          * minor device 2 (/dev/null) is EOF/RATHOLE
 227                          */
 228                         if (uio->uio_rw == UIO_READ)
 229                                 return (0);
 230                         c = iov->iov_len;
 231                         break;
 232                 case 3:
 233                         /*
 234                          * minor device 3 (/dev/random) is source of filth
 235                          * on read, seeder on write
 236                          */
 237                         if (buf == NULL)
 238                                 buf = kmalloc(PAGE_SIZE, M_TEMP, M_WAITOK);
 239                         c = min(iov->iov_len, PAGE_SIZE);
 240                         if (uio->uio_rw == UIO_WRITE) {
 241                                 error = uiomove(buf, (int)c, uio);
 242                                 if (error == 0)
 243                                         error = add_buffer_randomness(buf, c);
 244                         } else {
 245                                 poolsize = read_random(buf, c);
 246                                 if (poolsize == 0) {
 247                                         if (buf)
 248                                                 kfree(buf, M_TEMP);
 249                                         if ((flags & IO_NDELAY) != 0)
 250                                                 return (EWOULDBLOCK);
 251                                         return (0);
 252                                 }
 253                                 c = min(c, poolsize);
 254                                 error = uiomove(buf, (int)c, uio);
 255                         }
 256                         continue;
 257                 case 4:
 258                         /*
 259                          * minor device 4 (/dev/urandom) is source of muck
 260                          * on read, writes are disallowed.
 261                          */
 262                         c = min(iov->iov_len, PAGE_SIZE);
 263                         if (uio->uio_rw == UIO_WRITE) {
 264                                 error = EPERM;
 265                                 break;
 266                         }
 267                         if (CURSIG(curthread->td_lwp) != 0) {
 268                                 /*
 269                                  * Use tsleep() to get the error code right.
 270                                  * It should return immediately.
 271                                  */
 272                                 error = tsleep(&rand_bolt, PCATCH, "urand", 1);
 273                                 if (error != 0 && error != EWOULDBLOCK)
 274                                         continue;
 275                         }
 276                         if (buf == NULL)
 277                                 buf = kmalloc(PAGE_SIZE, M_TEMP, M_WAITOK);
 278                         poolsize = read_random_unlimited(buf, c);
 279                         c = min(c, poolsize);
 280                         error = uiomove(buf, (int)c, uio);
 281                         continue;
 282                 case 12:
 283                         /*
 284                          * minor device 12 (/dev/zero) is source of nulls
 285                          * on read, write are disallowed.
 286                          */
 287                         if (uio->uio_rw == UIO_WRITE) {
 288                                 c = iov->iov_len;
 289                                 break;
 290                         }
 291                         if (zbuf == NULL) {
 292                                 zbuf = (caddr_t)kmalloc(PAGE_SIZE, M_TEMP,
 293                                     M_WAITOK | M_ZERO);
 294                         }
 295                         c = min(iov->iov_len, PAGE_SIZE);
 296                         error = uiomove(zbuf, (int)c, uio);
 297                         continue;
 298                 default:
 299                         return (ENODEV);
 300                 }
 301                 if (error)
 302                         break;
 303                 iov->iov_base = (char *)iov->iov_base + c;
 304                 iov->iov_len -= c;
 305                 uio->uio_offset += c;
 306                 uio->uio_resid -= c;
 307         }
 308         if (buf)
 309                 kfree(buf, M_TEMP);
 310         return (error);
 311 }
 312
 313 static int
 314 mmread(struct dev_read_args *ap)
 315 {
 316         return(mmrw(ap->a_head.a_dev, ap->a_uio, ap->a_ioflag));
 317 }
 318
 319 static int
 320 mmwrite(struct dev_write_args *ap)
 321 {
 322         return(mmrw(ap->a_head.a_dev, ap->a_uio, ap->a_ioflag));
 323 }
 324
 325
 326
 327
 328
 329 /*******************************************************\
 330 * allow user processes to MMAP some memory sections     *
 331 * instead of going through read/write                   *
 332 \*******************************************************/
 333
 334 static int
 335 memmmap(struct dev_mmap_args *ap)
 336 {
 337         cdev_t dev = ap->a_head.a_dev;
 338
 339         switch (minor(dev)) {
 340         case 0:
 341                 /*
 342                  * minor device 0 is physical memory
 343                  */
 344 #if defined(__i386__)
 345                 ap->a_result = i386_btop(ap->a_offset);
 346 #elif defined(__x86_64__)
 347                 ap->a_result = x86_64_btop(ap->a_offset);
 348 #endif
 349                 return 0;
 350         case 1:
 351                 /*
 352                  * minor device 1 is kernel memory
 353                  */
 354 #if defined(__i386__)
 355                 ap->a_result = i386_btop(vtophys(ap->a_offset));
 356 #elif defined(__x86_64__)
 357                 ap->a_result = x86_64_btop(vtophys(ap->a_offset));
 358 #endif
 359                 return 0;
 360
 361         default:
 362                 return EINVAL;
 363         }
 364 }
 365
 366 static int
 367 mmioctl(struct dev_ioctl_args *ap)
 368 {
 369         cdev_t dev = ap->a_head.a_dev;
 370         int error;
 371
 372         get_mplock();
 373
 374         switch (minor(dev)) {
 375         case 0:
 376                 error = mem_ioctl(dev, ap->a_cmd, ap->a_data,
 377                                   ap->a_fflag, ap->a_cred);
 378                 break;
 379         case 3:
 380         case 4:
 381                 error = random_ioctl(dev, ap->a_cmd, ap->a_data,
 382                                      ap->a_fflag, ap->a_cred);
 383                 break;
 384         default:
 385                 error = ENODEV;
 386                 break;
 387         }
 388
 389         rel_mplock();
 390         return (error);
 391 }
 392
 393 /*
 394  * Operations for changing memory attributes.
 395  *
 396  * This is basically just an ioctl shim for mem_range_attr_get
 397  * and mem_range_attr_set.
 398  */
 399 static int
 400 mem_ioctl(cdev_t dev, u_long cmd, caddr_t data, int flags, struct ucred *cred)
 401 {
 402         int nd, error = 0;
 403         struct mem_range_op *mo = (struct mem_range_op *)data;
 404         struct mem_range_desc *md;
 405
 406         /* is this for us? */
 407         if ((cmd != MEMRANGE_GET) &&
 408             (cmd != MEMRANGE_SET))
 409                 return (ENOTTY);
 410
 411         /* any chance we can handle this? */
 412         if (mem_range_softc.mr_op == NULL)
 413                 return (EOPNOTSUPP);
 414
 415         /* do we have any descriptors? */
 416         if (mem_range_softc.mr_ndesc == 0)
 417                 return (ENXIO);
 418
 419         switch (cmd) {
 420         case MEMRANGE_GET:
 421                 nd = imin(mo->mo_arg[0], mem_range_softc.mr_ndesc);
 422                 if (nd > 0) {
 423                         md = (struct mem_range_desc *)
 424                                 kmalloc(nd * sizeof(struct mem_range_desc),
 425                                        M_MEMDESC, M_WAITOK);
 426                         error = mem_range_attr_get(md, &nd);
 427                         if (!error)
 428                                 error = copyout(md, mo->mo_desc,
 429                                         nd * sizeof(struct mem_range_desc));
 430                         kfree(md, M_MEMDESC);
 431                 } else {
 432                         nd = mem_range_softc.mr_ndesc;
 433                 }
 434                 mo->mo_arg[0] = nd;
 435                 break;
 436
 437         case MEMRANGE_SET:
 438                 md = (struct mem_range_desc *)kmalloc(sizeof(struct mem_range_desc),
 439                                                     M_MEMDESC, M_WAITOK);
 440                 error = copyin(mo->mo_desc, md, sizeof(struct mem_range_desc));
 441                 /* clamp description string */
 442                 md->mr_owner[sizeof(md->mr_owner) - 1] = 0;
 443                 if (error == 0)
 444                         error = mem_range_attr_set(md, &mo->mo_arg[0]);
 445                 kfree(md, M_MEMDESC);
 446                 break;
 447         }
 448         return (error);
 449 }
 450
 451 /*
 452  * Implementation-neutral, kernel-callable functions for manipulating
 453  * memory range attributes.
 454  */
 455 int
 456 mem_range_attr_get(struct mem_range_desc *mrd, int *arg)
 457 {
 458         /* can we handle this? */
 459         if (mem_range_softc.mr_op == NULL)
 460                 return (EOPNOTSUPP);
 461
 462         if (*arg == 0) {
 463                 *arg = mem_range_softc.mr_ndesc;
 464         } else {
 465                 bcopy(mem_range_softc.mr_desc, mrd, (*arg) * sizeof(struct mem_range_desc));
 466         }
 467         return (0);
 468 }
 469
 470 int
 471 mem_range_attr_set(struct mem_range_desc *mrd, int *arg)
 472 {
 473         /* can we handle this? */
 474         if (mem_range_softc.mr_op == NULL)
 475                 return (EOPNOTSUPP);
 476
 477         return (mem_range_softc.mr_op->set(&mem_range_softc, mrd, arg));
 478 }
 479
 480 #ifdef SMP
 481 void
 482 mem_range_AP_init(void)
 483 {
 484         if (mem_range_softc.mr_op && mem_range_softc.mr_op->initAP)
 485                 return (mem_range_softc.mr_op->initAP(&mem_range_softc));
 486 }
 487 #endif
 488
 489 static int
 490 random_ioctl(cdev_t dev, u_long cmd, caddr_t data, int flags, struct ucred *cred)
 491 {
 492         int error;
 493         int intr;
 494
 495         /*
 496          * Even inspecting the state is privileged, since it gives a hint
 497          * about how easily the randomness might be guessed.
 498          */
 499         error = 0;
 500
 501         switch (cmd) {
 502         /* Really handled in upper layer */
 503         case FIOASYNC:
 504                 break;
 505         case MEM_SETIRQ:
 506                 intr = *(int16_t *)data;
 507                 if ((error = priv_check_cred(cred, PRIV_ROOT, 0)) != 0)
 508                         break;
 509                 if (intr < 0 || intr >= MAX_INTS)
 510                         return (EINVAL);
 511                 register_randintr(intr);
 512                 break;
 513         case MEM_CLEARIRQ:
 514                 intr = *(int16_t *)data;
 515                 if ((error = priv_check_cred(cred, PRIV_ROOT, 0)) != 0)
 516                         break;
 517                 if (intr < 0 || intr >= MAX_INTS)
 518                         return (EINVAL);
 519                 unregister_randintr(intr);
 520                 break;
 521         case MEM_RETURNIRQ:
 522                 error = ENOTSUP;
 523                 break;
 524         case MEM_FINDIRQ:
 525                 intr = *(int16_t *)data;
 526                 if ((error = priv_check_cred(cred, PRIV_ROOT, 0)) != 0)
 527                         break;
 528                 if (intr < 0 || intr >= MAX_INTS)
 529                         return (EINVAL);
 530                 intr = next_registered_randintr(intr);
 531                 if (intr == MAX_INTS)
 532                         return (ENOENT);
 533                 *(u_int16_t *)data = intr;
 534                 break;
 535         default:
 536                 error = ENOTSUP;
 537                 break;
 538         }
 539         return (error);
 540 }
 541
 542 static int
 543 mm_filter_read(struct knote *kn, long hint)
 544 {
 545         return (1);
 546 }
 547
 548 static int
 549 mm_filter_write(struct knote *kn, long hint)
 550 {
 551         return (1);
 552 }
 553
 554 static void
 555 dummy_filter_detach(struct knote *kn) {}
 556
 557 /* Implemented in kern_nrandom.c */
 558 static struct filterops random_read_filtops =
 559         { FILTEROP_ISFD|FILTEROP_MPSAFE, NULL, dummy_filter_detach, random_filter_read };
 560
 561 static struct filterops mm_read_filtops =
 562         { FILTEROP_ISFD|FILTEROP_MPSAFE, NULL, dummy_filter_detach, mm_filter_read };
 563
 564 static struct filterops mm_write_filtops =
 565         { FILTEROP_ISFD|FILTEROP_MPSAFE, NULL, dummy_filter_detach, mm_filter_write };
 566
 567 int
 568 mmkqfilter(struct dev_kqfilter_args *ap)
 569 {
 570         struct knote *kn = ap->a_kn;
 571         cdev_t dev = ap->a_head.a_dev;
 572
 573         ap->a_result = 0;
 574         switch (kn->kn_filter) {
 575         case EVFILT_READ:
 576                 switch (minor(dev)) {
 577                 case 3:
 578                         kn->kn_fop = &random_read_filtops;
 579                         break;
 580                 default:
 581                         kn->kn_fop = &mm_read_filtops;
 582                         break;
 583                 }
 584                 break;
 585         case EVFILT_WRITE:
 586                 kn->kn_fop = &mm_write_filtops;
 587                 break;
 588         default:
 589                 ap->a_result = EOPNOTSUPP;
 590                 return (0);
 591         }
 592
 593         return (0);
 594 }
 595
 596 int
 597 iszerodev(cdev_t dev)
 598 {
 599         return (zerodev == dev);
 600 }
 601
 602 static void
 603 mem_drvinit(void *unused)
 604 {
 605
 606         /* Initialise memory range handling */
 607         if (mem_range_softc.mr_op != NULL)
 608                 mem_range_softc.mr_op->init(&mem_range_softc);
 609
 610         make_dev(&mem_ops, 0, UID_ROOT, GID_KMEM, 0640, "mem");
 611         make_dev(&mem_ops, 1, UID_ROOT, GID_KMEM, 0640, "kmem");
 612         make_dev(&mem_ops, 2, UID_ROOT, GID_WHEEL, 0666, "null");
 613         make_dev(&mem_ops, 3, UID_ROOT, GID_WHEEL, 0644, "random");
 614         make_dev(&mem_ops, 4, UID_ROOT, GID_WHEEL, 0644, "urandom");
 615         zerodev = make_dev(&mem_ops, 12, UID_ROOT, GID_WHEEL, 0666, "zero");
 616         make_dev(&mem_ops, 14, UID_ROOT, GID_WHEEL, 0600, "io");
 617 }
 618
 619 SYSINIT(memdev,SI_SUB_DRIVERS,SI_ORDER_MIDDLE+CDEV_MAJOR,mem_drvinit,NULL)
 620