Change sendfile() to use the new m_ext callback scheme for cleaning up after
[dragonfly.git] / 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.10 2004/07/30 21:56:14 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_SUB_MBUF, 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
68 static __inline
69 int
70 sf_buf_hash(vm_page_t m)
71 {
72     int hv;
73
74     hv = ((int)m / sizeof(vm_page_t)) + ((int)m >> 12);
75     return(hv & sf_buf_hashmask);
76 }
77
78 /*
79  * Allocate a pool of sf_bufs (sendfile(2) or "super-fast" if you prefer. :-))
80  */
81 static void
82 sf_buf_init(void *arg)
83 {
84         int i;
85
86         sf_buf_hashtable = hashinit(nsfbufs, M_TEMP, &sf_buf_hashmask);
87         TAILQ_INIT(&sf_buf_freelist);
88         sf_base = kmem_alloc_nofault(kernel_map, nsfbufs * PAGE_SIZE);
89         sf_bufs = malloc(nsfbufs * sizeof(struct sf_buf), M_TEMP,
90                             M_WAITOK | M_ZERO);
91         for (i = 0; i < nsfbufs; i++) {
92                 sf_bufs[i].kva = sf_base + i * PAGE_SIZE;
93                 sf_bufs[i].flags |= SFBA_ONFREEQ;
94                 TAILQ_INSERT_TAIL(&sf_buf_freelist, &sf_bufs[i], free_entry);
95         }
96 }
97
98 /*
99  * Get an sf_buf from the freelist. Will block if none are available.
100  */
101 struct sf_buf *
102 sf_buf_alloc(struct vm_page *m, int flags)
103 {
104         struct sf_buf_list *hash_chain;
105         struct sf_buf *sf;
106         globaldata_t gd;
107         int error;
108         int pflags;
109
110         gd = mycpu;
111         crit_enter();
112         hash_chain = &sf_buf_hashtable[sf_buf_hash(m)];
113         LIST_FOREACH(sf, hash_chain, list_entry) {
114                 if (sf->m == m) {
115                         /*
116                          * cache hit
117                          *
118                          * We must invalidate the TLB entry based on whether
119                          * it need only be valid on the local cpu (SFBA_QUICK),
120                          * or on all cpus.  This is conditionalized and in
121                          * most cases no system-wide invalidation should be
122                          * needed.
123                          *
124                          * Note: we do not remove the entry from the freelist
125                          * on the 0->1 transition. 
126                          */
127                         ++sf->refcnt;
128                         if ((flags & SFBA_QUICK) && sfbuf_quick) {
129                                 if ((sf->cpumask & gd->gd_cpumask) == 0) {
130                                         pmap_kenter_sync_quick(sf->kva);
131                                         sf->cpumask |= gd->gd_cpumask;
132                                 }
133                         } else {
134                                 if (sf->cpumask != (cpumask_t)-1) {
135                                         pmap_kenter_sync(sf->kva);
136                                         sf->cpumask = (cpumask_t)-1;
137                                 }
138                         }
139                         goto done;      /* found existing mapping */
140                 }
141         }
142
143         /*
144          * Didn't find old mapping.  Get a buffer off the freelist.  We
145          * may have to remove and skip buffers with non-zero ref counts 
146          * that were lazily allocated.
147          */
148         for (;;) {
149                 if ((sf = TAILQ_FIRST(&sf_buf_freelist)) == NULL) {
150                         pflags = (flags & SFBA_PCATCH) ? PCATCH : 0;
151                         ++sf_buf_alloc_want;
152                         error = tsleep(&sf_buf_freelist, pflags, "sfbufa", 0);
153                         --sf_buf_alloc_want;
154                         if (error)
155                                 goto done;
156                 } else {
157                         /*
158                          * We may have to do delayed removals for referenced
159                          * sf_buf's here in addition to locating a sf_buf
160                          * to reuse.  The sf_bufs must be removed.
161                          *
162                          * We are finished when we find an sf_buf with a
163                          * refcnt of 0.  We theoretically do not have to
164                          * remove it from the freelist but it's a good idea
165                          * to do so to preserve LRU operation for the
166                          * (1) never before seen before case and (2) 
167                          * accidently recycled due to prior cached uses not
168                          * removing the buffer case.
169                          */
170                         KKASSERT(sf->flags & SFBA_ONFREEQ);
171                         TAILQ_REMOVE(&sf_buf_freelist, sf, free_entry);
172                         sf->flags &= ~SFBA_ONFREEQ;
173                         if (sf->refcnt == 0)
174                                 break;
175                 }
176         }
177         if (sf->m != NULL)      /* remove previous mapping from hash table */
178                 LIST_REMOVE(sf, list_entry);
179         LIST_INSERT_HEAD(hash_chain, sf, list_entry);
180         sf->refcnt = 1;
181         sf->m = m;
182         if ((flags & SFBA_QUICK) && sfbuf_quick) {
183                 pmap_kenter_quick(sf->kva, sf->m->phys_addr);
184                 sf->cpumask = gd->gd_cpumask;
185         } else {
186                 pmap_kenter(sf->kva, sf->m->phys_addr);
187                 sf->cpumask = (cpumask_t)-1;
188         }
189 done:
190         crit_exit();
191         return (sf);
192 }
193
194 #if 0
195
196 /*
197  * Add a reference to a buffer (currently unused)
198  */
199 void
200 sf_buf_ref(struct sf_buf *sf)
201 {
202         if (sf->refcnt == 0)
203                 panic("sf_buf_ref: referencing a free sf_buf");
204         crit_enter();
205         sf->refcnt++;
206         crit_exit();
207 }
208
209 #endif
210
211 /*
212  * Lose a reference to an sf_buf. When none left, detach mapped page
213  * and release resources back to the system.  Note that the sfbuf's
214  * removal from the freelist is delayed, so it may in fact already be
215  * on the free list.  This is the optimal (and most likely) scenario.
216  *
217  * Must be called at splimp.
218  */
219 void
220 sf_buf_free(struct sf_buf *sf)
221 {
222         if (sf->refcnt == 0)
223                 panic("sf_buf_free: freeing free sf_buf");
224         crit_enter();
225         sf->refcnt--;
226         if (sf->refcnt == 0 && (sf->flags & SFBA_ONFREEQ) == 0) {
227                 KKASSERT(sf->aux1 == 0 && sf->aux2 == 0);
228                 TAILQ_INSERT_TAIL(&sf_buf_freelist, sf, free_entry);
229                 sf->flags |= SFBA_ONFREEQ;
230                 if (sf_buf_alloc_want > 0)
231                         wakeup_one(&sf_buf_freelist);
232         }
233         crit_exit();
234 }
235