sys/kern/subr_uio.c

   1 /*-
   2  * Copyright (c) 1982, 1986, 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)kern_subr.c 8.3 (Berkeley) 1/21/94
  35  */
  36
  37 #include <sys/cdefs.h>
  38 __FBSDID("$FreeBSD$");
  39
  40 #include "opt_zero.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/kernel.h>
  45 #include <sys/limits.h>
  46 #include <sys/lock.h>
  47 #include <sys/mman.h>
  48 #include <sys/mutex.h>
  49 #include <sys/proc.h>
  50 #include <sys/resourcevar.h>
  51 #include <sys/sched.h>
  52 #include <sys/sysctl.h>
  53 #include <sys/vnode.h>
  54
  55 #include <vm/vm.h>
  56 #include <vm/vm_extern.h>
  57 #include <vm/vm_page.h>
  58 #include <vm/vm_map.h>
  59 #ifdef ZERO_COPY_SOCKETS
  60 #include <vm/vm_param.h>
  61 #include <vm/vm_object.h>
  62 #endif
  63
  64 SYSCTL_INT(_kern, KERN_IOV_MAX, iov_max, CTLFLAG_RD, NULL, UIO_MAXIOV,
  65         "Maximum number of elements in an I/O vector; sysconf(_SC_IOV_MAX)");
  66
  67 static int uiomove_faultflag(void *cp, int n, struct uio *uio, int nofault);
  68
  69 #ifdef ZERO_COPY_SOCKETS
  70 /* Declared in uipc_socket.c */
  71 extern int so_zero_copy_receive;
  72
  73 /*
  74  * Identify the physical page mapped at the given kernel virtual
  75  * address.  Insert this physical page into the given address space at
  76  * the given virtual address, replacing the physical page, if any,
  77  * that already exists there.
  78  */
  79 static int
  80 vm_pgmoveco(vm_map_t mapa, vm_offset_t kaddr, vm_offset_t uaddr)
  81 {
  82         vm_map_t map = mapa;
  83         vm_page_t kern_pg, user_pg;
  84         vm_object_t uobject;
  85         vm_map_entry_t entry;
  86         vm_pindex_t upindex;
  87         vm_prot_t prot;
  88         vm_page_bits_t vbits;
  89         boolean_t wired;
  90
  91         KASSERT((uaddr & PAGE_MASK) == 0,
  92             ("vm_pgmoveco: uaddr is not page aligned"));
  93
  94         /*
  95          * Herein the physical page is validated and dirtied.  It is
  96          * unwired in sf_buf_mext().
  97          */
  98         kern_pg = PHYS_TO_VM_PAGE(vtophys(kaddr));
  99         vbits = kern_pg->valid;
 100         kern_pg->valid = VM_PAGE_BITS_ALL;
 101         KASSERT(kern_pg->queue == PQ_NONE && kern_pg->wire_count == 1,
 102             ("vm_pgmoveco: kern_pg is not correctly wired"));
 103
 104         if ((vm_map_lookup(&map, uaddr,
 105                            VM_PROT_WRITE, &entry, &uobject,
 106                            &upindex, &prot, &wired)) != KERN_SUCCESS) {
 107                 return(EFAULT);
 108         }
 109         VM_OBJECT_LOCK(uobject);
 110         if (vm_page_insert(kern_pg, uobject, upindex) != 0) {
 111                 kern_pg->valid = vbits;
 112                 VM_OBJECT_UNLOCK(uobject);
 113                 vm_map_lookup_done(map, entry);
 114                 return(ENOMEM);
 115         }
 116         vm_page_dirty(kern_pg);
 117 retry:
 118         if ((user_pg = vm_page_lookup(uobject, upindex)) != NULL) {
 119                 if (vm_page_sleep_if_busy(user_pg, TRUE, "vm_pgmoveco"))
 120                         goto retry;
 121                 vm_page_lock(user_pg);
 122                 pmap_remove_all(user_pg);
 123                 vm_page_free(user_pg);
 124                 vm_page_unlock(user_pg);
 125         } else {
 126                 /*
 127                  * Even if a physical page does not exist in the
 128                  * object chain's first object, a physical page from a
 129                  * backing object may be mapped read only.
 130                  */
 131                 if (uobject->backing_object != NULL)
 132                         pmap_remove(map->pmap, uaddr, uaddr + PAGE_SIZE);
 133         }
 134         VM_OBJECT_UNLOCK(uobject);
 135         vm_map_lookup_done(map, entry);
 136         return(KERN_SUCCESS);
 137 }
 138 #endif /* ZERO_COPY_SOCKETS */
 139
 140 int
 141 copyin_nofault(const void *udaddr, void *kaddr, size_t len)
 142 {
 143         int error, save;
 144
 145         save = vm_fault_disable_pagefaults();
 146         error = copyin(udaddr, kaddr, len);
 147         vm_fault_enable_pagefaults(save);
 148         return (error);
 149 }
 150
 151 int
 152 copyout_nofault(const void *kaddr, void *udaddr, size_t len)
 153 {
 154         int error, save;
 155
 156         save = vm_fault_disable_pagefaults();
 157         error = copyout(kaddr, udaddr, len);
 158         vm_fault_enable_pagefaults(save);
 159         return (error);
 160 }
 161
 162 int
 163 uiomove(void *cp, int n, struct uio *uio)
 164 {
 165
 166         return (uiomove_faultflag(cp, n, uio, 0));
 167 }
 168
 169 int
 170 uiomove_nofault(void *cp, int n, struct uio *uio)
 171 {
 172
 173         return (uiomove_faultflag(cp, n, uio, 1));
 174 }
 175
 176 static int
 177 uiomove_faultflag(void *cp, int n, struct uio *uio, int nofault)
 178 {
 179         struct thread *td;
 180         struct iovec *iov;
 181         size_t cnt;
 182         int error, newflags, save;
 183
 184         td = curthread;
 185         error = 0;
 186
 187         KASSERT(uio->uio_rw == UIO_READ || uio->uio_rw == UIO_WRITE,
 188             ("uiomove: mode"));
 189         KASSERT(uio->uio_segflg != UIO_USERSPACE || uio->uio_td == td,
 190             ("uiomove proc"));
 191         if (!nofault)
 192                 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
 193                     "Calling uiomove()");
 194
 195         /* XXX does it make a sense to set TDP_DEADLKTREAT for UIO_SYSSPACE ? */
 196         newflags = TDP_DEADLKTREAT;
 197         if (uio->uio_segflg == UIO_USERSPACE && nofault) {
 198                 /*
 199                  * Fail if a non-spurious page fault occurs.
 200                  */
 201                 newflags |= TDP_NOFAULTING | TDP_RESETSPUR;
 202         }
 203         save = curthread_pflags_set(newflags);
 204
 205         while (n > 0 && uio->uio_resid) {
 206                 iov = uio->uio_iov;
 207                 cnt = iov->iov_len;
 208                 if (cnt == 0) {
 209                         uio->uio_iov++;
 210                         uio->uio_iovcnt--;
 211                         continue;
 212                 }
 213                 if (cnt > n)
 214                         cnt = n;
 215
 216                 switch (uio->uio_segflg) {
 217
 218                 case UIO_USERSPACE:
 219                         maybe_yield();
 220                         if (uio->uio_rw == UIO_READ)
 221                                 error = copyout(cp, iov->iov_base, cnt);
 222                         else
 223                                 error = copyin(iov->iov_base, cp, cnt);
 224                         if (error)
 225                                 goto out;
 226                         break;
 227
 228                 case UIO_SYSSPACE:
 229                         if (uio->uio_rw == UIO_READ)
 230                                 bcopy(cp, iov->iov_base, cnt);
 231                         else
 232                                 bcopy(iov->iov_base, cp, cnt);
 233                         break;
 234                 case UIO_NOCOPY:
 235                         break;
 236                 }
 237                 iov->iov_base = (char *)iov->iov_base + cnt;
 238                 iov->iov_len -= cnt;
 239                 uio->uio_resid -= cnt;
 240                 uio->uio_offset += cnt;
 241                 cp = (char *)cp + cnt;
 242                 n -= cnt;
 243         }
 244 out:
 245         curthread_pflags_restore(save);
 246         return (error);
 247 }
 248
 249 /*
 250  * Wrapper for uiomove() that validates the arguments against a known-good
 251  * kernel buffer.  Currently, uiomove accepts a signed (n) argument, which
 252  * is almost definitely a bad thing, so we catch that here as well.  We
 253  * return a runtime failure, but it might be desirable to generate a runtime
 254  * assertion failure instead.
 255  */
 256 int
 257 uiomove_frombuf(void *buf, int buflen, struct uio *uio)
 258 {
 259         size_t offset, n;
 260
 261         if (uio->uio_offset < 0 || uio->uio_resid < 0 ||
 262             (offset = uio->uio_offset) != uio->uio_offset)
 263                 return (EINVAL);
 264         if (buflen <= 0 || offset >= buflen)
 265                 return (0);
 266         if ((n = buflen - offset) > IOSIZE_MAX)
 267                 return (EINVAL);
 268         return (uiomove((char *)buf + offset, n, uio));
 269 }
 270
 271 #ifdef ZERO_COPY_SOCKETS
 272 /*
 273  * Experimental support for zero-copy I/O
 274  */
 275 static int
 276 userspaceco(void *cp, u_int cnt, struct uio *uio, int disposable)
 277 {
 278         struct iovec *iov;
 279         int error;
 280
 281         iov = uio->uio_iov;
 282         if (uio->uio_rw == UIO_READ) {
 283                 if ((so_zero_copy_receive != 0)
 284                  && ((cnt & PAGE_MASK) == 0)
 285                  && ((((intptr_t) iov->iov_base) & PAGE_MASK) == 0)
 286                  && ((uio->uio_offset & PAGE_MASK) == 0)
 287                  && ((((intptr_t) cp) & PAGE_MASK) == 0)
 288                  && (disposable != 0)) {
 289                         /* SOCKET: use page-trading */
 290                         /*
 291                          * We only want to call vm_pgmoveco() on
 292                          * disposeable pages, since it gives the
 293                          * kernel page to the userland process.
 294                          */
 295                         error = vm_pgmoveco(&curproc->p_vmspace->vm_map,
 296                             (vm_offset_t)cp, (vm_offset_t)iov->iov_base);
 297
 298                         /*
 299                          * If we get an error back, attempt
 300                          * to use copyout() instead.  The
 301                          * disposable page should be freed
 302                          * automatically if we weren't able to move
 303                          * it into userland.
 304                          */
 305                         if (error != 0)
 306                                 error = copyout(cp, iov->iov_base, cnt);
 307                 } else {
 308                         error = copyout(cp, iov->iov_base, cnt);
 309                 }
 310         } else {
 311                 error = copyin(iov->iov_base, cp, cnt);
 312         }
 313         return (error);
 314 }
 315
 316 int
 317 uiomoveco(void *cp, int n, struct uio *uio, int disposable)
 318 {
 319         struct iovec *iov;
 320         u_int cnt;
 321         int error;
 322
 323         KASSERT(uio->uio_rw == UIO_READ || uio->uio_rw == UIO_WRITE,
 324             ("uiomoveco: mode"));
 325         KASSERT(uio->uio_segflg != UIO_USERSPACE || uio->uio_td == curthread,
 326             ("uiomoveco proc"));
 327
 328         while (n > 0 && uio->uio_resid) {
 329                 iov = uio->uio_iov;
 330                 cnt = iov->iov_len;
 331                 if (cnt == 0) {
 332                         uio->uio_iov++;
 333                         uio->uio_iovcnt--;
 334                         continue;
 335                 }
 336                 if (cnt > n)
 337                         cnt = n;
 338
 339                 switch (uio->uio_segflg) {
 340
 341                 case UIO_USERSPACE:
 342                         maybe_yield();
 343                         error = userspaceco(cp, cnt, uio, disposable);
 344                         if (error)
 345                                 return (error);
 346                         break;
 347
 348                 case UIO_SYSSPACE:
 349                         if (uio->uio_rw == UIO_READ)
 350                                 bcopy(cp, iov->iov_base, cnt);
 351                         else
 352                                 bcopy(iov->iov_base, cp, cnt);
 353                         break;
 354                 case UIO_NOCOPY:
 355                         break;
 356                 }
 357                 iov->iov_base = (char *)iov->iov_base + cnt;
 358                 iov->iov_len -= cnt;
 359                 uio->uio_resid -= cnt;
 360                 uio->uio_offset += cnt;
 361                 cp = (char *)cp + cnt;
 362                 n -= cnt;
 363         }
 364         return (0);
 365 }
 366 #endif /* ZERO_COPY_SOCKETS */
 367
 368 /*
 369  * Give next character to user as result of read.
 370  */
 371 int
 372 ureadc(int c, struct uio *uio)
 373 {
 374         struct iovec *iov;
 375         char *iov_base;
 376
 377         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
 378             "Calling ureadc()");
 379
 380 again:
 381         if (uio->uio_iovcnt == 0 || uio->uio_resid == 0)
 382                 panic("ureadc");
 383         iov = uio->uio_iov;
 384         if (iov->iov_len == 0) {
 385                 uio->uio_iovcnt--;
 386                 uio->uio_iov++;
 387                 goto again;
 388         }
 389         switch (uio->uio_segflg) {
 390
 391         case UIO_USERSPACE:
 392                 if (subyte(iov->iov_base, c) < 0)
 393                         return (EFAULT);
 394                 break;
 395
 396         case UIO_SYSSPACE:
 397                 iov_base = iov->iov_base;
 398                 *iov_base = c;
 399                 iov->iov_base = iov_base;
 400                 break;
 401
 402         case UIO_NOCOPY:
 403                 break;
 404         }
 405         iov->iov_base = (char *)iov->iov_base + 1;
 406         iov->iov_len--;
 407         uio->uio_resid--;
 408         uio->uio_offset++;
 409         return (0);
 410 }
 411
 412 int
 413 copyinfrom(const void * __restrict src, void * __restrict dst, size_t len,
 414     int seg)
 415 {
 416         int error = 0;
 417
 418         switch (seg) {
 419         case UIO_USERSPACE:
 420                 error = copyin(src, dst, len);
 421                 break;
 422         case UIO_SYSSPACE:
 423                 bcopy(src, dst, len);
 424                 break;
 425         default:
 426                 panic("copyinfrom: bad seg %d\n", seg);
 427         }
 428         return (error);
 429 }
 430
 431 int
 432 copyinstrfrom(const void * __restrict src, void * __restrict dst, size_t len,
 433     size_t * __restrict copied, int seg)
 434 {
 435         int error = 0;
 436
 437         switch (seg) {
 438         case UIO_USERSPACE:
 439                 error = copyinstr(src, dst, len, copied);
 440                 break;
 441         case UIO_SYSSPACE:
 442                 error = copystr(src, dst, len, copied);
 443                 break;
 444         default:
 445                 panic("copyinstrfrom: bad seg %d\n", seg);
 446         }
 447         return (error);
 448 }
 449
 450 int
 451 copyiniov(const struct iovec *iovp, u_int iovcnt, struct iovec **iov, int error)
 452 {
 453         u_int iovlen;
 454
 455         *iov = NULL;
 456         if (iovcnt > UIO_MAXIOV)
 457                 return (error);
 458         iovlen = iovcnt * sizeof (struct iovec);
 459         *iov = malloc(iovlen, M_IOV, M_WAITOK);
 460         error = copyin(iovp, *iov, iovlen);
 461         if (error) {
 462                 free(*iov, M_IOV);
 463                 *iov = NULL;
 464         }
 465         return (error);
 466 }
 467
 468 int
 469 copyinuio(const struct iovec *iovp, u_int iovcnt, struct uio **uiop)
 470 {
 471         struct iovec *iov;
 472         struct uio *uio;
 473         u_int iovlen;
 474         int error, i;
 475
 476         *uiop = NULL;
 477         if (iovcnt > UIO_MAXIOV)
 478                 return (EINVAL);
 479         iovlen = iovcnt * sizeof (struct iovec);
 480         uio = malloc(iovlen + sizeof *uio, M_IOV, M_WAITOK);
 481         iov = (struct iovec *)(uio + 1);
 482         error = copyin(iovp, iov, iovlen);
 483         if (error) {
 484                 free(uio, M_IOV);
 485                 return (error);
 486         }
 487         uio->uio_iov = iov;
 488         uio->uio_iovcnt = iovcnt;
 489         uio->uio_segflg = UIO_USERSPACE;
 490         uio->uio_offset = -1;
 491         uio->uio_resid = 0;
 492         for (i = 0; i < iovcnt; i++) {
 493                 if (iov->iov_len > IOSIZE_MAX - uio->uio_resid) {
 494                         free(uio, M_IOV);
 495                         return (EINVAL);
 496                 }
 497                 uio->uio_resid += iov->iov_len;
 498                 iov++;
 499         }
 500         *uiop = uio;
 501         return (0);
 502 }
 503
 504 struct uio *
 505 cloneuio(struct uio *uiop)
 506 {
 507         struct uio *uio;
 508         int iovlen;
 509
 510         iovlen = uiop->uio_iovcnt * sizeof (struct iovec);
 511         uio = malloc(iovlen + sizeof *uio, M_IOV, M_WAITOK);
 512         *uio = *uiop;
 513         uio->uio_iov = (struct iovec *)(uio + 1);
 514         bcopy(uiop->uio_iov, uio->uio_iov, iovlen);
 515         return (uio);
 516 }
 517
 518 /*
 519  * Map some anonymous memory in user space of size sz, rounded up to the page
 520  * boundary.
 521  */
 522 int
 523 copyout_map(struct thread *td, vm_offset_t *addr, size_t sz)
 524 {
 525         struct vmspace *vms;
 526         int error;
 527         vm_size_t size;
 528
 529         vms = td->td_proc->p_vmspace;
 530
 531         /*
 532          * Map somewhere after heap in process memory.
 533          */
 534         PROC_LOCK(td->td_proc);
 535         *addr = round_page((vm_offset_t)vms->vm_daddr +
 536             lim_max(td->td_proc, RLIMIT_DATA));
 537         PROC_UNLOCK(td->td_proc);
 538
 539         /* round size up to page boundry */
 540         size = (vm_size_t)round_page(sz);
 541
 542         error = vm_mmap(&vms->vm_map, addr, size, PROT_READ | PROT_WRITE,
 543             VM_PROT_ALL, MAP_PRIVATE | MAP_ANON, OBJT_DEFAULT, NULL, 0);
 544
 545         return (error);
 546 }
 547
 548 /*
 549  * Unmap memory in user space.
 550  */
 551 int
 552 copyout_unmap(struct thread *td, vm_offset_t addr, size_t sz)
 553 {
 554         vm_map_t map;
 555         vm_size_t size;
 556
 557         if (sz == 0)
 558                 return (0);
 559
 560         map = &td->td_proc->p_vmspace->vm_map;
 561         size = (vm_size_t)round_page(sz);
 562
 563         if (vm_map_remove(map, addr, addr + size) != KERN_SUCCESS)
 564                 return (EINVAL);
 565
 566         return (0);
 567 }