sys/kern/kern_sfbuf.c

   1 /*
   2  * Copyright (c) 1998 David Greenman.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  *
  25  * $DragonFly: src/sys/kern/kern_sfbuf.c,v 1.15 2007/04/30 07:18:53 dillon Exp $
  26  */
  27
  28 #include <sys/param.h>
  29 #include <sys/types.h>
  30 #include <sys/systm.h>
  31 #include <sys/kernel.h>
  32 #include <sys/malloc.h>
  33 #include <sys/queue.h>
  34 #include <sys/sfbuf.h>
  35 #include <sys/globaldata.h>
  36 #include <sys/thread.h>
  37 #include <sys/sysctl.h>
  38 #include <vm/vm.h>
  39 #include <vm/vm_extern.h>
  40 #include <vm/vm_kern.h>
  41 #include <vm/vm_page.h>
  42 #include <vm/pmap.h>
  43 #include <sys/thread2.h>
  44
  45 static void sf_buf_init(void *arg);
  46 SYSINIT(sock_sf, SI_BOOT2_MACHDEP, SI_ORDER_ANY, sf_buf_init, NULL)
  47
  48 LIST_HEAD(sf_buf_list, sf_buf);
  49
  50 SYSCTL_INT(_kern_ipc, OID_AUTO, nsfbufs, CTLFLAG_RD, &nsfbufs, 0,
  51         "Maximum number of sf_bufs available to the system");
  52
  53 /*
  54  * A hash table of active sendfile(2) buffers
  55  */
  56 static struct sf_buf_list *sf_buf_hashtable;
  57 static u_long sf_buf_hashmask;
  58
  59 static TAILQ_HEAD(, sf_buf) sf_buf_freelist;
  60 static u_int sf_buf_alloc_want;
  61
  62 static vm_offset_t sf_base;
  63 static struct sf_buf *sf_bufs;
  64
  65 static int sfbuf_quick = 1;
  66 SYSCTL_INT(_debug, OID_AUTO, sfbuf_quick, CTLFLAG_RW, &sfbuf_quick, 0, "");
  67 static int nsffree;
  68 SYSCTL_INT(_kern_ipc, OID_AUTO, nsffree, CTLFLAG_RD, &nsffree, 0,
  69         "Number of free sf_bufs available to the system");
  70
  71 static __inline
  72 int
  73 sf_buf_hash(vm_page_t m)
  74 {
  75     int hv;
  76
  77     hv = ((int)(intptr_t)m / sizeof(vm_page_t)) + ((int)(intptr_t)m >> 12);
  78     return(hv & sf_buf_hashmask);
  79 }
  80
  81 /*
  82  * Allocate a pool of sf_bufs (sendfile(2) or "super-fast" if you prefer. :-))
  83  */
  84 static void
  85 sf_buf_init(void *arg)
  86 {
  87         int i;
  88
  89         sf_buf_hashtable = hashinit(nsfbufs, M_TEMP, &sf_buf_hashmask);
  90         TAILQ_INIT(&sf_buf_freelist);
  91         sf_base = kmem_alloc_nofault(&kernel_map, nsfbufs * PAGE_SIZE,
  92                                     PAGE_SIZE);
  93         sf_bufs = kmalloc(nsfbufs * sizeof(struct sf_buf), M_TEMP,
  94                             M_WAITOK | M_ZERO);
  95         for (i = 0; i < nsfbufs; i++) {
  96                 sf_bufs[i].kva = sf_base + i * PAGE_SIZE;
  97                 sf_bufs[i].flags |= SFBA_ONFREEQ;
  98                 TAILQ_INSERT_TAIL(&sf_buf_freelist, &sf_bufs[i], free_entry);
  99                 ++nsffree;
 100         }
 101 }
 102
 103 /*
 104  * Get an sf_buf from the freelist. Will block if none are available.
 105  */
 106 struct sf_buf *
 107 sf_buf_alloc(struct vm_page *m, int flags)
 108 {
 109         struct sf_buf_list *hash_chain;
 110         struct sf_buf *sf;
 111         globaldata_t gd;
 112         int error;
 113         int pflags;
 114
 115         gd = mycpu;
 116         crit_enter();
 117         hash_chain = &sf_buf_hashtable[sf_buf_hash(m)];
 118         LIST_FOREACH(sf, hash_chain, list_entry) {
 119                 if (sf->m == m) {
 120                         /*
 121                          * cache hit
 122                          *
 123                          * We must invalidate the TLB entry based on whether
 124                          * it need only be valid on the local cpu (SFB_CPUPRIVATE),
 125                          * or on all cpus.  This is conditionalized and in
 126                          * most cases no system-wide invalidation should be
 127                          * needed.
 128                          *
 129                          * Note: we do not remove the entry from the freelist
 130                          * on the 0->1 transition.
 131                          */
 132                         ++sf->refcnt;
 133                         if ((flags & SFB_CPUPRIVATE) && sfbuf_quick) {
 134                                 if ((sf->cpumask & gd->gd_cpumask) == 0) {
 135                                         pmap_kenter_sync_quick(sf->kva);
 136                                         sf->cpumask |= gd->gd_cpumask;
 137                                 }
 138                         } else {
 139                                 if (sf->cpumask != (cpumask_t)-1) {
 140                                         pmap_kenter_sync(sf->kva);
 141                                         sf->cpumask = (cpumask_t)-1;
 142                                 }
 143                         }
 144                         goto done;      /* found existing mapping */
 145                 }
 146         }
 147
 148         /*
 149          * Didn't find old mapping.  Get a buffer off the freelist.  We
 150          * may have to remove and skip buffers with non-zero ref counts
 151          * that were lazily allocated.
 152          */
 153         for (;;) {
 154                 if ((sf = TAILQ_FIRST(&sf_buf_freelist)) == NULL) {
 155                         pflags = (flags & SFB_CATCH) ? PCATCH : 0;
 156                         ++sf_buf_alloc_want;
 157                         error = tsleep(&sf_buf_freelist, pflags, "sfbufa", 0);
 158                         --sf_buf_alloc_want;
 159                         if (error)
 160                                 goto done;
 161                 } else {
 162                         /*
 163                          * We may have to do delayed removals for referenced
 164                          * sf_buf's here in addition to locating a sf_buf
 165                          * to reuse.  The sf_bufs must be removed.
 166                          *
 167                          * We are finished when we find an sf_buf with a
 168                          * refcnt of 0.  We theoretically do not have to
 169                          * remove it from the freelist but it's a good idea
 170                          * to do so to preserve LRU operation for the
 171                          * (1) never before seen before case and (2)
 172                          * accidently recycled due to prior cached uses not
 173                          * removing the buffer case.
 174                          */
 175                         KKASSERT(sf->flags & SFBA_ONFREEQ);
 176                         TAILQ_REMOVE(&sf_buf_freelist, sf, free_entry);
 177                         --nsffree;
 178                         sf->flags &= ~SFBA_ONFREEQ;
 179                         if (sf->refcnt == 0)
 180                                 break;
 181                 }
 182         }
 183         if (sf->m != NULL)      /* remove previous mapping from hash table */
 184                 LIST_REMOVE(sf, list_entry);
 185         LIST_INSERT_HEAD(hash_chain, sf, list_entry);
 186         sf->refcnt = 1;
 187         sf->m = m;
 188         if ((flags & SFB_CPUPRIVATE) && sfbuf_quick) {
 189                 pmap_kenter_quick(sf->kva, sf->m->phys_addr);
 190                 sf->cpumask = gd->gd_cpumask;
 191         } else {
 192                 pmap_kenter(sf->kva, sf->m->phys_addr);
 193                 sf->cpumask = (cpumask_t)-1;
 194         }
 195 done:
 196         crit_exit();
 197         return (sf);
 198 }
 199
 200 #if 0
 201
 202 /*
 203  * Add a reference to a buffer (currently unused)
 204  */
 205 void
 206 sf_buf_ref(struct sf_buf *sf)
 207 {
 208         if (sf->refcnt == 0)
 209                 panic("sf_buf_ref: referencing a free sf_buf");
 210         crit_enter();
 211         sf->refcnt++;
 212         crit_exit();
 213 }
 214
 215 #endif
 216
 217 /*
 218  * Lose a reference to an sf_buf. When none left, detach mapped page
 219  * and release resources back to the system.  Note that the sfbuf's
 220  * removal from the freelist is delayed, so it may in fact already be
 221  * on the free list.  This is the optimal (and most likely) scenario.
 222  *
 223  * Must be called at splimp.
 224  */
 225 void
 226 sf_buf_free(struct sf_buf *sf)
 227 {
 228         if (sf->refcnt == 0)
 229                 panic("sf_buf_free: freeing free sf_buf");
 230         crit_enter();
 231         sf->refcnt--;
 232         if (sf->refcnt == 0 && (sf->flags & SFBA_ONFREEQ) == 0) {
 233                 TAILQ_INSERT_TAIL(&sf_buf_freelist, sf, free_entry);
 234                 ++nsffree;
 235                 sf->flags |= SFBA_ONFREEQ;
 236                 if (sf_buf_alloc_want > 0)
 237                         wakeup_one(&sf_buf_freelist);
 238         }
 239         crit_exit();
 240 }
 241