kernel - Improve contiguous DMA memory allocation
[dragonfly.git] / sys / vm / vm_contig.c
1 /*
2  * Copyright (c) 2003, 2004 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Hiten Pandya <hmp@backplane.com>.
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  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  */
35 /*
36  * Copyright (c) 1991 Regents of the University of California.
37  * All rights reserved.
38  *
39  * This code is derived from software contributed to Berkeley by
40  * The Mach Operating System project at Carnegie-Mellon University.
41  *
42  * Redistribution and use in source and binary forms, with or without
43  * modification, are permitted provided that the following conditions
44  * are met:
45  * 1. Redistributions of source code must retain the above copyright
46  *    notice, this list of conditions and the following disclaimer.
47  * 2. Redistributions in binary form must reproduce the above copyright
48  *    notice, this list of conditions and the following disclaimer in the
49  *    documentation and/or other materials provided with the distribution.
50  * 3. Neither the name of the University nor the names of its contributors
51  *    may be used to endorse or promote products derived from this software
52  *    without specific prior written permission.
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64  * SUCH DAMAGE.
65  *
66  *      from: @(#)vm_page.c     7.4 (Berkeley) 5/7/91
67  * $DragonFly: src/sys/vm/vm_contig.c,v 1.21 2006/12/28 21:24:02 dillon Exp $
68  */
69
70 /*
71  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
72  * All rights reserved.
73  *
74  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
75  *
76  * Permission to use, copy, modify and distribute this software and
77  * its documentation is hereby granted, provided that both the copyright
78  * notice and this permission notice appear in all copies of the
79  * software, derivative works or modified versions, and any portions
80  * thereof, and that both notices appear in supporting documentation.
81  *
82  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
83  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
84  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
85  *
86  * Carnegie Mellon requests users of this software to return to
87  *
88  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
89  *  School of Computer Science
90  *  Carnegie Mellon University
91  *  Pittsburgh PA 15213-3890
92  *
93  * any improvements or extensions that they make and grant Carnegie the
94  * rights to redistribute these changes.
95  */
96
97 /*
98  * Contiguous memory allocation API.
99  */
100
101 #include <sys/param.h>
102 #include <sys/systm.h>
103 #include <sys/malloc.h>
104 #include <sys/proc.h>
105 #include <sys/lock.h>
106 #include <sys/vmmeter.h>
107 #include <sys/vnode.h>
108
109 #include <vm/vm.h>
110 #include <vm/vm_param.h>
111 #include <vm/vm_kern.h>
112 #include <vm/pmap.h>
113 #include <vm/vm_map.h>
114 #include <vm/vm_object.h>
115 #include <vm/vm_page.h>
116 #include <vm/vm_pageout.h>
117 #include <vm/vm_pager.h>
118 #include <vm/vm_extern.h>
119
120 #include <sys/thread2.h>
121 #include <sys/spinlock2.h>
122 #include <vm/vm_page2.h>
123
124 #include <machine/bus_dma.h>
125
126 static void vm_contig_pg_free(vm_pindex_t start, u_long size);
127
128 /*
129  * vm_contig_pg_clean:
130  * 
131  * Do a thorough cleanup of the specified 'queue', which can be either
132  * PQ_ACTIVE or PQ_INACTIVE by doing a walkthrough.  If the page is not
133  * marked dirty, it is shoved into the page cache, provided no one has
134  * currently aqcuired it, otherwise localized action per object type
135  * is taken for cleanup:
136  *
137  *      In the OBJT_VNODE case, the whole page range is cleaned up
138  *      using the vm_object_page_clean() routine, by specyfing a
139  *      start and end of '0'.
140  *
141  *      Otherwise if the object is of any other type, the generic
142  *      pageout (daemon) flush routine is invoked.
143  */
144 static void
145 vm_contig_pg_clean(int queue, vm_pindex_t count)
146 {
147         vm_object_t object;
148         vm_page_t m, m_tmp;
149         struct vm_page marker;
150         struct vpgqueues *pq = &vm_page_queues[queue];
151
152         /*
153          * Setup a local marker
154          */
155         bzero(&marker, sizeof(marker));
156         marker.flags = PG_FICTITIOUS | PG_MARKER;
157         marker.busy_count = PBUSY_LOCKED;
158         marker.queue = queue;
159         marker.wire_count = 1;
160
161         vm_page_queues_spin_lock(queue);
162         TAILQ_INSERT_HEAD(&pq->pl, &marker, pageq);
163         vm_page_queues_spin_unlock(queue);
164
165         /*
166          * Iterate the queue.  Note that the vm_page spinlock must be
167          * acquired before the pageq spinlock so it's easiest to simply
168          * not hold it in the loop iteration.
169          */
170         while ((long)count-- > 0 &&
171                (m = TAILQ_NEXT(&marker, pageq)) != NULL) {
172                 vm_page_and_queue_spin_lock(m);
173                 if (m != TAILQ_NEXT(&marker, pageq)) {
174                         vm_page_and_queue_spin_unlock(m);
175                         ++count;
176                         continue;
177                 }
178                 KKASSERT(m->queue == queue);
179
180                 TAILQ_REMOVE(&pq->pl, &marker, pageq);
181                 TAILQ_INSERT_AFTER(&pq->pl, m, &marker, pageq);
182
183                 if (m->flags & PG_MARKER) {
184                         vm_page_and_queue_spin_unlock(m);
185                         continue;
186                 }
187                 if (vm_page_busy_try(m, TRUE)) {
188                         vm_page_and_queue_spin_unlock(m);
189                         continue;
190                 }
191                 vm_page_and_queue_spin_unlock(m);
192
193                 /*
194                  * We've successfully busied the page
195                  */
196                 if (m->queue - m->pc != queue) {
197                         vm_page_wakeup(m);
198                         continue;
199                 }
200                 if (m->wire_count || m->hold_count) {
201                         vm_page_wakeup(m);
202                         continue;
203                 }
204                 if ((object = m->object) == NULL) {
205                         vm_page_wakeup(m);
206                         continue;
207                 }
208                 vm_page_test_dirty(m);
209                 if (m->dirty || (m->flags & PG_NEED_COMMIT)) {
210                         vm_object_hold(object);
211                         KKASSERT(m->object == object);
212
213                         if (object->type == OBJT_VNODE) {
214                                 vm_page_wakeup(m);
215                                 vn_lock(object->handle, LK_EXCLUSIVE|LK_RETRY);
216                                 vm_object_page_clean(object, 0, 0, OBJPC_SYNC);
217                                 vn_unlock(((struct vnode *)object->handle));
218                         } else if (object->type == OBJT_SWAP ||
219                                         object->type == OBJT_DEFAULT) {
220                                 m_tmp = m;
221                                 vm_pageout_flush(&m_tmp, 1, 0);
222                         } else {
223                                 vm_page_wakeup(m);
224                         }
225                         vm_object_drop(object);
226                 } else if (m->hold_count == 0) {
227                         vm_page_cache(m);
228                 } else {
229                         vm_page_wakeup(m);
230                 }
231         }
232
233         /*
234          * Scrap our local marker
235          */
236         vm_page_queues_spin_lock(queue);
237         TAILQ_REMOVE(&pq->pl, &marker, pageq);
238         vm_page_queues_spin_unlock(queue);
239 }
240
241 /*
242  * vm_contig_pg_alloc:
243  *
244  * Allocate contiguous pages from the VM.  This function does not
245  * map the allocated pages into the kernel map, otherwise it is
246  * impossible to make large allocations (i.e. >2G).
247  *
248  * Malloc()'s data structures have been used for collection of
249  * statistics and for allocations of less than a page.
250  */
251 static vm_pindex_t
252 vm_contig_pg_alloc(unsigned long size, vm_paddr_t low, vm_paddr_t high,
253                    unsigned long alignment, unsigned long boundary, int mflags)
254 {
255         vm_pindex_t i, q, start;
256         vm_offset_t phys;
257         vm_page_t pga = vm_page_array;
258         vm_page_t m;
259         int pass;
260         int pqtype;
261
262         size = round_page(size);
263         if (size == 0)
264                 panic("vm_contig_pg_alloc: size must not be 0");
265         if ((alignment & (alignment - 1)) != 0)
266                 panic("vm_contig_pg_alloc: alignment must be a power of 2");
267         if ((boundary & (boundary - 1)) != 0)
268                 panic("vm_contig_pg_alloc: boundary must be a power of 2");
269
270         /*
271          * See if we can get the pages from the contiguous page reserve
272          * alist.  The returned pages will be allocated and wired but not
273          * busied.
274          *
275          * If high is not set to BUS_SPACE_MAXADDR we try using our
276          * free memory reserve first, otherwise we try it last.
277          */
278         if (high != BUS_SPACE_MAXADDR) {
279                 m = vm_page_alloc_contig(
280                         low, high, alignment, boundary,
281                         size, VM_MEMATTR_DEFAULT);
282                 if (m)
283                         return (m - &pga[0]);
284         }
285
286         /*
287          * Three passes (0, 1, 2).  Each pass scans the VM page list for
288          * free or cached pages.  After each pass if the entire scan failed
289          * we attempt to flush inactive pages and reset the start index back
290          * to 0.  For passes 1 and 2 we also attempt to flush active pages.
291          */
292         start = 0;
293         for (pass = 0; pass < 3; pass++) {
294                 /*
295                  * Find first page in array that is free, within range, 
296                  * aligned, and such that the boundary won't be crossed.
297                  */
298 again:
299                 for (i = start; i < vmstats.v_page_count; i++) {
300                         m = &pga[i];
301                         phys = VM_PAGE_TO_PHYS(m);
302                         pqtype = m->queue - m->pc;
303                         if (((pqtype == PQ_FREE) || (pqtype == PQ_CACHE)) &&
304                             (phys >= low) && (phys < high) &&
305                             ((phys & (alignment - 1)) == 0) &&
306                             (((phys ^ (phys + size - 1)) & /* bitwise and */
307                              ~(boundary - 1)) == 0) &&
308                             m->wire_count == 0 && m->hold_count == 0 &&
309                             (m->busy_count &
310                              (PBUSY_LOCKED | PBUSY_MASK)) == 0 &&
311                             (m->flags & PG_NEED_COMMIT) == 0)
312                         {
313                                 break;
314                         }
315                 }
316
317                 /*
318                  * If we cannot find the page in the given range, or we have
319                  * crossed the boundary, call the vm_contig_pg_clean() function
320                  * for flushing out the queues, and returning it back to
321                  * normal state.
322                  */
323                 if ((i == vmstats.v_page_count) ||
324                     ((VM_PAGE_TO_PHYS(&pga[i]) + size) > high)) {
325
326                         /*
327                          * Best effort flush of all inactive pages.
328                          * This is quite quick, for now stall all
329                          * callers, even if they've specified M_NOWAIT.
330                          */
331                         for (q = 0; q < PQ_L2_SIZE; ++q) {
332                                 vm_contig_pg_clean(PQ_INACTIVE + q,
333                                                    vmstats.v_inactive_count);
334                                 lwkt_yield();
335                         }
336
337                         /*
338                          * Best effort flush of active pages.
339                          *
340                          * This is very, very slow.
341                          * Only do this if the caller has agreed to M_WAITOK.
342                          *
343                          * If enough pages are flushed, we may succeed on
344                          * next (final) pass, if not the caller, contigmalloc(),
345                          * will fail in the index < 0 case.
346                          */
347                         if (pass > 0 && (mflags & M_WAITOK)) {
348                                 for (q = 0; q < PQ_L2_SIZE; ++q) {
349                                         vm_contig_pg_clean(PQ_ACTIVE + q,
350                                                        vmstats.v_active_count);
351                                 }
352                                 lwkt_yield();
353                         }
354
355                         /*
356                          * We're already too high in the address space
357                          * to succeed, reset to 0 for the next iteration.
358                          */
359                         start = 0;
360                         continue;       /* next pass */
361                 }
362                 start = i;
363
364                 /*
365                  * Check successive pages for contiguous and free.
366                  *
367                  * (still in critical section)
368                  */
369                 for (i = start + 1; i < (start + size / PAGE_SIZE); i++) {
370                         m = &pga[i];
371                         pqtype = m->queue - m->pc;
372                         if ((VM_PAGE_TO_PHYS(&m[0]) !=
373                             (VM_PAGE_TO_PHYS(&m[-1]) + PAGE_SIZE)) ||
374                             ((pqtype != PQ_FREE) && (pqtype != PQ_CACHE)) ||
375                             m->wire_count ||
376                             m->hold_count ||
377                             (m->busy_count & (PBUSY_LOCKED | PBUSY_MASK)) ||
378                             (m->flags & PG_NEED_COMMIT))
379                         {
380                                 start++;
381                                 goto again;
382                         }
383                 }
384
385                 /*
386                  * Try to allocate the pages, wiring them as we go.
387                  *
388                  * (still in critical section)
389                  */
390                 for (i = start; i < (start + size / PAGE_SIZE); i++) {
391                         m = &pga[i];
392
393                         if (vm_page_busy_try(m, TRUE)) {
394                                 vm_contig_pg_free(start,
395                                                   (i - start) * PAGE_SIZE);
396                                 start++;
397                                 goto again;
398                         }
399                         pqtype = m->queue - m->pc;
400                         if (pqtype == PQ_CACHE &&
401                             m->hold_count == 0 &&
402                             m->wire_count == 0 &&
403                             (m->flags & (PG_UNMANAGED | PG_NEED_COMMIT)) == 0) {
404                                 vm_page_protect(m, VM_PROT_NONE);
405                                 KKASSERT((m->flags & PG_MAPPED) == 0);
406                                 KKASSERT(m->dirty == 0);
407                                 vm_page_free(m);
408                                 --i;
409                                 continue;       /* retry the page */
410                         }
411                         if (pqtype != PQ_FREE || m->hold_count) {
412                                 vm_page_wakeup(m);
413                                 vm_contig_pg_free(start,
414                                                   (i - start) * PAGE_SIZE);
415                                 start++;
416                                 goto again;
417                         }
418                         KKASSERT((m->valid & m->dirty) == 0);
419                         KKASSERT(m->wire_count == 0);
420                         KKASSERT(m->object == NULL);
421                         vm_page_unqueue_nowakeup(m);
422                         m->valid = VM_PAGE_BITS_ALL;
423                         KASSERT(m->dirty == 0,
424                                 ("vm_contig_pg_alloc: page %p was dirty", m));
425                         KKASSERT(m->wire_count == 0);
426                         KKASSERT((m->busy_count & PBUSY_MASK) == 0);
427
428                         /*
429                          * Clear all flags.  Then unbusy the now allocated
430                          * page.
431                          */
432                         vm_page_flag_clear(m, ~PG_KEEP_NEWPAGE_MASK);
433                         vm_page_wire(m);
434                         vm_page_wakeup(m);
435                 }
436
437                 /*
438                  * Our job is done, return the index page of vm_page_array.
439                  */
440                 return (start); /* aka &pga[start] */
441         }
442
443         /*
444          * Failed, if we haven't already tried, allocate from our reserved
445          * dma memory.
446          */
447         if (high == BUS_SPACE_MAXADDR) {
448                 m = vm_page_alloc_contig(
449                         low, high, alignment, boundary,
450                         size, VM_MEMATTR_DEFAULT);
451                 if (m)
452                         return (m - &pga[0]);
453         }
454
455         /*
456          * Failed.
457          */
458         return ((vm_pindex_t)-1);
459 }
460
461 /*
462  * vm_contig_pg_free:
463  *
464  * Remove pages previously allocated by vm_contig_pg_alloc, and
465  * assume all references to the pages have been removed, and that
466  * it is OK to add them back to the free list.
467  *
468  * Caller must ensure no races on the page range in question.
469  * No other requirements.
470  */
471 static void
472 vm_contig_pg_free(vm_pindex_t start, u_long size)
473 {
474         vm_page_t pga = vm_page_array;
475         
476         size = round_page(size);
477         if (size == 0)
478                 panic("vm_contig_pg_free: size must not be 0");
479
480         /*
481          * The pages are wired, vm_page_free_contig() determines whether they
482          * belong to the contig space or not and either frees them to that
483          * space (leaving them wired), or unwires the page and frees it to the
484          * normal PQ_FREE queue.
485          */
486         vm_page_free_contig(&pga[start], size);
487 }
488
489 /*
490  * vm_contig_pg_kmap:
491  *
492  * Map previously allocated (vm_contig_pg_alloc) range of pages from
493  * vm_page_array[] into the KVA.  Once mapped, the pages are part of
494  * the Kernel, and are to free'ed with kmem_free(&kernel_map, addr, size).
495  *
496  * No requirements.
497  */
498 static vm_offset_t
499 vm_contig_pg_kmap(vm_pindex_t start, u_long size, vm_map_t map, int flags)
500 {
501         vm_offset_t addr;
502         vm_paddr_t pa;
503         vm_page_t pga = vm_page_array;
504         u_long offset;
505
506         if (size == 0)
507                 panic("vm_contig_pg_kmap: size must not be 0");
508         size = round_page(size);
509         addr = kmem_alloc_pageable(&kernel_map, size, VM_SUBSYS_CONTIG);
510         if (addr) {
511                 pa = VM_PAGE_TO_PHYS(&pga[start]);
512                 for (offset = 0; offset < size; offset += PAGE_SIZE)
513                         pmap_kenter_noinval(addr + offset, pa + offset);
514                 pmap_invalidate_range(&kernel_pmap, addr, addr + size);
515                 if (flags & M_ZERO)
516                         bzero((void *)addr, size);
517         }
518         return(addr);
519 }
520
521 /*
522  * No requirements.
523  */
524 void *
525 contigmalloc(
526         unsigned long size,     /* should be size_t here and for malloc() */
527         struct malloc_type *type,
528         int flags,
529         vm_paddr_t low,
530         vm_paddr_t high,
531         unsigned long alignment,
532         unsigned long boundary)
533 {
534         return contigmalloc_map(size, type, flags, low, high, alignment,
535                         boundary, &kernel_map);
536 }
537
538 /*
539  * No requirements.
540  */
541 void *
542 contigmalloc_map(unsigned long size, struct malloc_type *type,
543                  int flags, vm_paddr_t low, vm_paddr_t high,
544                  unsigned long alignment, unsigned long boundary,
545                  vm_map_t map)
546 {
547         vm_pindex_t index;
548         void *rv;
549
550         index = vm_contig_pg_alloc(size, low, high, alignment, boundary, flags);
551         if (index == (vm_pindex_t)-1) {
552                 kprintf("contigmalloc_map: failed size %lu low=%llx "
553                         "high=%llx align=%lu boundary=%lu flags=%08x\n",
554                         size, (long long)low, (long long)high,
555                         alignment, boundary, flags);
556                 return NULL;
557         }
558
559         rv = (void *)vm_contig_pg_kmap(index, size, map, flags);
560         if (rv == NULL)
561                 vm_contig_pg_free(index, size);
562         
563         return rv;
564 }
565
566 /*
567  * No requirements.
568  */
569 void
570 contigfree(void *addr, unsigned long size, struct malloc_type *type)
571 {
572         vm_paddr_t pa;
573         vm_page_t m;
574
575         if (size == 0)
576                 panic("vm_contig_pg_kmap: size must not be 0");
577         size = round_page(size);
578
579         pa = pmap_kextract((vm_offset_t)addr);
580         pmap_qremove((vm_offset_t)addr, size / PAGE_SIZE);
581         kmem_free(&kernel_map, (vm_offset_t)addr, size);
582
583         m = PHYS_TO_VM_PAGE(pa);
584         vm_page_free_contig(m, size);
585 }
586
587 /*
588  * No requirements.
589  */
590 vm_offset_t
591 kmem_alloc_contig(vm_offset_t size, vm_paddr_t low, vm_paddr_t high,
592                   vm_offset_t alignment)
593 {
594         return ((vm_offset_t)contigmalloc_map(size, M_DEVBUF, M_NOWAIT, low,
595                                 high, alignment, 0ul, &kernel_map));
596 }