kernel - VM rework part 13 - Core pmap work, stabilize & optimize
[dragonfly.git] / sys / vm / vm_page.c
1 /*
2  * Copyright (c) 2003-2019 The DragonFly Project.  All rights reserved.
3  * Copyright (c) 1991 Regents of the University of California.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * The Mach Operating System project at Carnegie-Mellon University.
8  *
9  * This code is derived from software contributed to The DragonFly Project
10  * by Matthew Dillon <dillon@backplane.com>
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      from: @(#)vm_page.c     7.4 (Berkeley) 5/7/91
37  * $FreeBSD: src/sys/vm/vm_page.c,v 1.147.2.18 2002/03/10 05:03:19 alc Exp $
38  */
39
40 /*
41  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
42  * All rights reserved.
43  *
44  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
45  *
46  * Permission to use, copy, modify and distribute this software and
47  * its documentation is hereby granted, provided that both the copyright
48  * notice and this permission notice appear in all copies of the
49  * software, derivative works or modified versions, and any portions
50  * thereof, and that both notices appear in supporting documentation.
51  *
52  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
53  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
54  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
55  *
56  * Carnegie Mellon requests users of this software to return to
57  *
58  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
59  *  School of Computer Science
60  *  Carnegie Mellon University
61  *  Pittsburgh PA 15213-3890
62  *
63  * any improvements or extensions that they make and grant Carnegie the
64  * rights to redistribute these changes.
65  */
66 /*
67  * Resident memory management module.  The module manipulates 'VM pages'.
68  * A VM page is the core building block for memory management.
69  */
70
71 #include <sys/param.h>
72 #include <sys/systm.h>
73 #include <sys/malloc.h>
74 #include <sys/proc.h>
75 #include <sys/vmmeter.h>
76 #include <sys/vnode.h>
77 #include <sys/kernel.h>
78 #include <sys/alist.h>
79 #include <sys/sysctl.h>
80 #include <sys/cpu_topology.h>
81
82 #include <vm/vm.h>
83 #include <vm/vm_param.h>
84 #include <sys/lock.h>
85 #include <vm/vm_kern.h>
86 #include <vm/pmap.h>
87 #include <vm/vm_map.h>
88 #include <vm/vm_object.h>
89 #include <vm/vm_page.h>
90 #include <vm/vm_pageout.h>
91 #include <vm/vm_pager.h>
92 #include <vm/vm_extern.h>
93 #include <vm/swap_pager.h>
94
95 #include <machine/inttypes.h>
96 #include <machine/md_var.h>
97 #include <machine/specialreg.h>
98 #include <machine/bus_dma.h>
99
100 #include <vm/vm_page2.h>
101 #include <sys/spinlock2.h>
102
103 struct vm_page_hash_elm {
104         vm_page_t       m;
105         int             ticks;
106         int             unused01;
107 };
108
109 #define VM_PAGE_HASH_SET        4               /* power of 2, set-assoc */
110 #define VM_PAGE_HASH_MAX        (1024 * 1024)   /* power of 2, max size */
111
112 /*
113  * SET - Minimum required set associative size, must be a power of 2.  We
114  *       want this to match or exceed the set-associativeness of the cpu,
115  *       up to a reasonable limit (we will use 16).
116  */
117 __read_mostly static int set_assoc_mask = 16 - 1;
118
119 static void vm_page_queue_init(void);
120 static void vm_page_free_wakeup(void);
121 static vm_page_t vm_page_select_cache(u_short pg_color);
122 static vm_page_t _vm_page_list_find2(int basequeue, int index, int *lastp);
123 static void _vm_page_deactivate_locked(vm_page_t m, int athead);
124 static void vm_numa_add_topology_mem(cpu_node_t *cpup, int physid, long bytes);
125
126 /*
127  * Array of tailq lists
128  */
129 struct vpgqueues vm_page_queues[PQ_COUNT];
130
131 static volatile int vm_pages_waiting;
132 static struct alist vm_contig_alist;
133 static struct almeta vm_contig_ameta[ALIST_RECORDS_65536];
134 static struct spinlock vm_contig_spin = SPINLOCK_INITIALIZER(&vm_contig_spin, "vm_contig_spin");
135
136 __read_mostly static int vm_page_hash_vnode_only;
137 __read_mostly static int vm_page_hash_size;
138 __read_mostly static struct vm_page_hash_elm *vm_page_hash;
139
140 static u_long vm_dma_reserved = 0;
141 TUNABLE_ULONG("vm.dma_reserved", &vm_dma_reserved);
142 SYSCTL_ULONG(_vm, OID_AUTO, dma_reserved, CTLFLAG_RD, &vm_dma_reserved, 0,
143             "Memory reserved for DMA");
144 SYSCTL_UINT(_vm, OID_AUTO, dma_free_pages, CTLFLAG_RD,
145             &vm_contig_alist.bl_free, 0, "Memory reserved for DMA");
146
147 SYSCTL_INT(_vm, OID_AUTO, page_hash_vnode_only, CTLFLAG_RW,
148             &vm_page_hash_vnode_only, 0, "Only hash vnode pages");
149 #if 0
150 static int vm_page_hash_debug;
151 SYSCTL_INT(_vm, OID_AUTO, page_hash_debug, CTLFLAG_RW,
152             &vm_page_hash_debug, 0, "Only hash vnode pages");
153 #endif
154
155 static int vm_contig_verbose = 0;
156 TUNABLE_INT("vm.contig_verbose", &vm_contig_verbose);
157
158 RB_GENERATE2(vm_page_rb_tree, vm_page, rb_entry, rb_vm_page_compare,
159              vm_pindex_t, pindex);
160
161 static void
162 vm_page_queue_init(void) 
163 {
164         int i;
165
166         for (i = 0; i < PQ_L2_SIZE; i++)
167                 vm_page_queues[PQ_FREE+i].cnt_offset =
168                         offsetof(struct vmstats, v_free_count);
169         for (i = 0; i < PQ_L2_SIZE; i++)
170                 vm_page_queues[PQ_CACHE+i].cnt_offset =
171                         offsetof(struct vmstats, v_cache_count);
172         for (i = 0; i < PQ_L2_SIZE; i++)
173                 vm_page_queues[PQ_INACTIVE+i].cnt_offset =
174                         offsetof(struct vmstats, v_inactive_count);
175         for (i = 0; i < PQ_L2_SIZE; i++)
176                 vm_page_queues[PQ_ACTIVE+i].cnt_offset =
177                         offsetof(struct vmstats, v_active_count);
178         for (i = 0; i < PQ_L2_SIZE; i++)
179                 vm_page_queues[PQ_HOLD+i].cnt_offset =
180                         offsetof(struct vmstats, v_active_count);
181         /* PQ_NONE has no queue */
182
183         for (i = 0; i < PQ_COUNT; i++) {
184                 vm_page_queues[i].lastq = -1;
185                 TAILQ_INIT(&vm_page_queues[i].pl);
186                 spin_init(&vm_page_queues[i].spin, "vm_page_queue_init");
187         }
188 }
189
190 /*
191  * note: place in initialized data section?  Is this necessary?
192  */
193 vm_pindex_t first_page = 0;
194 vm_pindex_t vm_page_array_size = 0;
195 vm_page_t vm_page_array = NULL;
196 vm_paddr_t vm_low_phys_reserved;
197
198 /*
199  * (low level boot)
200  *
201  * Sets the page size, perhaps based upon the memory size.
202  * Must be called before any use of page-size dependent functions.
203  */
204 void
205 vm_set_page_size(void)
206 {
207         if (vmstats.v_page_size == 0)
208                 vmstats.v_page_size = PAGE_SIZE;
209         if (((vmstats.v_page_size - 1) & vmstats.v_page_size) != 0)
210                 panic("vm_set_page_size: page size not a power of two");
211 }
212
213 /*
214  * (low level boot)
215  *
216  * Add a new page to the freelist for use by the system.  New pages
217  * are added to both the head and tail of the associated free page
218  * queue in a bottom-up fashion, so both zero'd and non-zero'd page
219  * requests pull 'recent' adds (higher physical addresses) first.
220  *
221  * Beware that the page zeroing daemon will also be running soon after
222  * boot, moving pages from the head to the tail of the PQ_FREE queues.
223  *
224  * Must be called in a critical section.
225  */
226 static void
227 vm_add_new_page(vm_paddr_t pa)
228 {
229         struct vpgqueues *vpq;
230         vm_page_t m;
231
232         m = PHYS_TO_VM_PAGE(pa);
233         m->phys_addr = pa;
234         m->flags = 0;
235         m->pat_mode = PAT_WRITE_BACK;
236         m->pc = (pa >> PAGE_SHIFT);
237
238         /*
239          * Twist for cpu localization in addition to page coloring, so
240          * different cpus selecting by m->queue get different page colors.
241          */
242         m->pc ^= ((pa >> PAGE_SHIFT) / PQ_L2_SIZE);
243         m->pc ^= ((pa >> PAGE_SHIFT) / (PQ_L2_SIZE * PQ_L2_SIZE));
244         m->pc &= PQ_L2_MASK;
245
246         /*
247          * Reserve a certain number of contiguous low memory pages for
248          * contigmalloc() to use.
249          */
250         if (pa < vm_low_phys_reserved) {
251                 atomic_add_long(&vmstats.v_page_count, 1);
252                 atomic_add_long(&vmstats.v_dma_pages, 1);
253                 m->queue = PQ_NONE;
254                 m->wire_count = 1;
255                 atomic_add_long(&vmstats.v_wire_count, 1);
256                 alist_free(&vm_contig_alist, pa >> PAGE_SHIFT, 1);
257                 return;
258         }
259
260         /*
261          * General page
262          */
263         m->queue = m->pc + PQ_FREE;
264         KKASSERT(m->dirty == 0);
265
266         atomic_add_long(&vmstats.v_page_count, 1);
267         atomic_add_long(&vmstats.v_free_count, 1);
268         vpq = &vm_page_queues[m->queue];
269         TAILQ_INSERT_HEAD(&vpq->pl, m, pageq);
270         ++vpq->lcnt;
271 }
272
273 /*
274  * (low level boot)
275  *
276  * Initializes the resident memory module.
277  *
278  * Preallocates memory for critical VM structures and arrays prior to
279  * kernel_map becoming available.
280  *
281  * Memory is allocated from (virtual2_start, virtual2_end) if available,
282  * otherwise memory is allocated from (virtual_start, virtual_end).
283  *
284  * On x86-64 (virtual_start, virtual_end) is only 2GB and may not be
285  * large enough to hold vm_page_array & other structures for machines with
286  * large amounts of ram, so we want to use virtual2* when available.
287  */
288 void
289 vm_page_startup(void)
290 {
291         vm_offset_t vaddr = virtual2_start ? virtual2_start : virtual_start;
292         vm_offset_t mapped;
293         vm_pindex_t npages;
294         vm_paddr_t page_range;
295         vm_paddr_t new_end;
296         int i;
297         vm_paddr_t pa;
298         vm_paddr_t last_pa;
299         vm_paddr_t end;
300         vm_paddr_t biggestone, biggestsize;
301         vm_paddr_t total;
302         vm_page_t m;
303
304         total = 0;
305         biggestsize = 0;
306         biggestone = 0;
307         vaddr = round_page(vaddr);
308
309         /*
310          * Make sure ranges are page-aligned.
311          */
312         for (i = 0; phys_avail[i].phys_end; ++i) {
313                 phys_avail[i].phys_beg = round_page64(phys_avail[i].phys_beg);
314                 phys_avail[i].phys_end = trunc_page64(phys_avail[i].phys_end);
315                 if (phys_avail[i].phys_end < phys_avail[i].phys_beg)
316                         phys_avail[i].phys_end = phys_avail[i].phys_beg;
317         }
318
319         /*
320          * Locate largest block
321          */
322         for (i = 0; phys_avail[i].phys_end; ++i) {
323                 vm_paddr_t size = phys_avail[i].phys_end -
324                                   phys_avail[i].phys_beg;
325
326                 if (size > biggestsize) {
327                         biggestone = i;
328                         biggestsize = size;
329                 }
330                 total += size;
331         }
332         --i;    /* adjust to last entry for use down below */
333
334         end = phys_avail[biggestone].phys_end;
335         end = trunc_page(end);
336
337         /*
338          * Initialize the queue headers for the free queue, the active queue
339          * and the inactive queue.
340          */
341         vm_page_queue_init();
342
343 #if !defined(_KERNEL_VIRTUAL)
344         /*
345          * VKERNELs don't support minidumps and as such don't need
346          * vm_page_dump
347          *
348          * Allocate a bitmap to indicate that a random physical page
349          * needs to be included in a minidump.
350          *
351          * The amd64 port needs this to indicate which direct map pages
352          * need to be dumped, via calls to dump_add_page()/dump_drop_page().
353          *
354          * However, x86 still needs this workspace internally within the
355          * minidump code.  In theory, they are not needed on x86, but are
356          * included should the sf_buf code decide to use them.
357          */
358         page_range = phys_avail[i].phys_end / PAGE_SIZE;
359         vm_page_dump_size = round_page(roundup2(page_range, NBBY) / NBBY);
360         end -= vm_page_dump_size;
361         vm_page_dump = (void *)pmap_map(&vaddr, end, end + vm_page_dump_size,
362                                         VM_PROT_READ | VM_PROT_WRITE);
363         bzero((void *)vm_page_dump, vm_page_dump_size);
364 #endif
365         /*
366          * Compute the number of pages of memory that will be available for
367          * use (taking into account the overhead of a page structure per
368          * page).
369          */
370         first_page = phys_avail[0].phys_beg / PAGE_SIZE;
371         page_range = phys_avail[i].phys_end / PAGE_SIZE - first_page;
372         npages = (total - (page_range * sizeof(struct vm_page))) / PAGE_SIZE;
373
374 #ifndef _KERNEL_VIRTUAL
375         /*
376          * (only applies to real kernels)
377          *
378          * Reserve a large amount of low memory for potential 32-bit DMA
379          * space allocations.  Once device initialization is complete we
380          * release most of it, but keep (vm_dma_reserved) memory reserved
381          * for later use.  Typically for X / graphics.  Through trial and
382          * error we find that GPUs usually requires ~60-100MB or so.
383          *
384          * By default, 128M is left in reserve on machines with 2G+ of ram.
385          */
386         vm_low_phys_reserved = (vm_paddr_t)65536 << PAGE_SHIFT;
387         if (vm_low_phys_reserved > total / 4)
388                 vm_low_phys_reserved = total / 4;
389         if (vm_dma_reserved == 0) {
390                 vm_dma_reserved = 128 * 1024 * 1024;    /* 128MB */
391                 if (vm_dma_reserved > total / 16)
392                         vm_dma_reserved = total / 16;
393         }
394 #endif
395         alist_init(&vm_contig_alist, 65536, vm_contig_ameta,
396                    ALIST_RECORDS_65536);
397
398         /*
399          * Initialize the mem entry structures now, and put them in the free
400          * queue.
401          */
402         if (bootverbose && ctob(physmem) >= 400LL*1024*1024*1024)
403                 kprintf("initializing vm_page_array ");
404         new_end = trunc_page(end - page_range * sizeof(struct vm_page));
405         mapped = pmap_map(&vaddr, new_end, end, VM_PROT_READ | VM_PROT_WRITE);
406         vm_page_array = (vm_page_t)mapped;
407
408 #if defined(__x86_64__) && !defined(_KERNEL_VIRTUAL)
409         /*
410          * since pmap_map on amd64 returns stuff out of a direct-map region,
411          * we have to manually add these pages to the minidump tracking so
412          * that they can be dumped, including the vm_page_array.
413          */
414         for (pa = new_end;
415              pa < phys_avail[biggestone].phys_end;
416              pa += PAGE_SIZE) {
417                 dump_add_page(pa);
418         }
419 #endif
420
421         /*
422          * Clear all of the page structures, run basic initialization so
423          * PHYS_TO_VM_PAGE() operates properly even on pages not in the
424          * map.
425          */
426         bzero((caddr_t) vm_page_array, page_range * sizeof(struct vm_page));
427         vm_page_array_size = page_range;
428         if (bootverbose && ctob(physmem) >= 400LL*1024*1024*1024)
429                 kprintf("size = 0x%zx\n", vm_page_array_size);
430
431         m = &vm_page_array[0];
432         pa = ptoa(first_page);
433         for (i = 0; i < page_range; ++i) {
434                 spin_init(&m->spin, "vm_page");
435                 m->phys_addr = pa;
436                 pa += PAGE_SIZE;
437                 ++m;
438         }
439
440         /*
441          * Construct the free queue(s) in ascending order (by physical
442          * address) so that the first 16MB of physical memory is allocated
443          * last rather than first.  On large-memory machines, this avoids
444          * the exhaustion of low physical memory before isa_dma_init has run.
445          */
446         vmstats.v_page_count = 0;
447         vmstats.v_free_count = 0;
448         for (i = 0; phys_avail[i].phys_end && npages > 0; ++i) {
449                 pa = phys_avail[i].phys_beg;
450                 if (i == biggestone)
451                         last_pa = new_end;
452                 else
453                         last_pa = phys_avail[i].phys_end;
454                 while (pa < last_pa && npages-- > 0) {
455                         vm_add_new_page(pa);
456                         pa += PAGE_SIZE;
457                 }
458         }
459         if (virtual2_start)
460                 virtual2_start = vaddr;
461         else
462                 virtual_start = vaddr;
463         mycpu->gd_vmstats = vmstats;
464 }
465
466 /*
467  * (called from early boot only)
468  *
469  * Reorganize VM pages based on numa data.  May be called as many times as
470  * necessary.  Will reorganize the vm_page_t page color and related queue(s)
471  * to allow vm_page_alloc() to choose pages based on socket affinity.
472  *
473  * NOTE: This function is only called while we are still in UP mode, so
474  *       we only need a critical section to protect the queues (which
475  *       saves a lot of time, there are likely a ton of pages).
476  */
477 void
478 vm_numa_organize(vm_paddr_t ran_beg, vm_paddr_t bytes, int physid)
479 {
480         vm_paddr_t scan_beg;
481         vm_paddr_t scan_end;
482         vm_paddr_t ran_end;
483         struct vpgqueues *vpq;
484         vm_page_t m;
485         vm_page_t mend;
486         int socket_mod;
487         int socket_value;
488         int i;
489
490         /*
491          * Check if no physical information, or there was only one socket
492          * (so don't waste time doing nothing!).
493          */
494         if (cpu_topology_phys_ids <= 1 ||
495             cpu_topology_core_ids == 0) {
496                 return;
497         }
498
499         /*
500          * Setup for our iteration.  Note that ACPI may iterate CPU
501          * sockets starting at 0 or 1 or some other number.  The
502          * cpu_topology code mod's it against the socket count.
503          */
504         ran_end = ran_beg + bytes;
505
506         socket_mod = PQ_L2_SIZE / cpu_topology_phys_ids;
507         socket_value = (physid % cpu_topology_phys_ids) * socket_mod;
508         mend = &vm_page_array[vm_page_array_size];
509
510         crit_enter();
511
512         /*
513          * Adjust cpu_topology's phys_mem parameter
514          */
515         if (root_cpu_node)
516                 vm_numa_add_topology_mem(root_cpu_node, physid, (long)bytes);
517
518         /*
519          * Adjust vm_page->pc and requeue all affected pages.  The
520          * allocator will then be able to localize memory allocations
521          * to some degree.
522          */
523         for (i = 0; phys_avail[i].phys_end; ++i) {
524                 scan_beg = phys_avail[i].phys_beg;
525                 scan_end = phys_avail[i].phys_end;
526                 if (scan_end <= ran_beg)
527                         continue;
528                 if (scan_beg >= ran_end)
529                         continue;
530                 if (scan_beg < ran_beg)
531                         scan_beg = ran_beg;
532                 if (scan_end > ran_end)
533                         scan_end = ran_end;
534                 if (atop(scan_end) > first_page + vm_page_array_size)
535                         scan_end = ptoa(first_page + vm_page_array_size);
536
537                 m = PHYS_TO_VM_PAGE(scan_beg);
538                 while (scan_beg < scan_end) {
539                         KKASSERT(m < mend);
540                         if (m->queue != PQ_NONE) {
541                                 vpq = &vm_page_queues[m->queue];
542                                 TAILQ_REMOVE(&vpq->pl, m, pageq);
543                                 --vpq->lcnt;
544                                 /* queue doesn't change, no need to adj cnt */
545                                 m->queue -= m->pc;
546                                 m->pc %= socket_mod;
547                                 m->pc += socket_value;
548                                 m->pc &= PQ_L2_MASK;
549                                 m->queue += m->pc;
550                                 vpq = &vm_page_queues[m->queue];
551                                 TAILQ_INSERT_HEAD(&vpq->pl, m, pageq);
552                                 ++vpq->lcnt;
553                                 /* queue doesn't change, no need to adj cnt */
554                         } else {
555                                 m->pc %= socket_mod;
556                                 m->pc += socket_value;
557                                 m->pc &= PQ_L2_MASK;
558                         }
559                         scan_beg += PAGE_SIZE;
560                         ++m;
561                 }
562         }
563
564         crit_exit();
565 }
566
567 /*
568  * (called from early boot only)
569  *
570  * Don't allow the NUMA organization to leave vm_page_queues[] nodes
571  * completely empty for a logical cpu.  Doing so would force allocations
572  * on that cpu to always borrow from a nearby cpu, create unnecessary
573  * contention, and cause vm_page_alloc() to iterate more queues and run more
574  * slowly.
575  *
576  * This situation can occur when memory sticks are not entirely populated,
577  * populated at different densities, or in naturally assymetric systems
578  * such as the 2990WX.  There could very well be many vm_page_queues[]
579  * entries with *NO* pages assigned to them.
580  *
581  * Fixing this up ensures that each logical CPU has roughly the same
582  * sized memory pool, and more importantly ensures that logical CPUs
583  * do not wind up with an empty memory pool.
584  *
585  * At them moment we just iterate the other queues and borrow pages,
586  * moving them into the queues for cpus with severe deficits even though
587  * the memory might not be local to those cpus.  I am not doing this in
588  * a 'smart' way, its effectively UMA style (sorta, since its page-by-page
589  * whereas real UMA typically exchanges address bits 8-10 with high address
590  * bits).  But it works extremely well and gives us fairly good deterministic
591  * results on the cpu cores associated with these secondary nodes.
592  */
593 void
594 vm_numa_organize_finalize(void)
595 {
596         struct vpgqueues *vpq;
597         vm_page_t m;
598         long lcnt_lo;
599         long lcnt_hi;
600         int iter;
601         int i;
602         int scale_lim;
603
604         crit_enter();
605
606         /*
607          * Machines might not use an exact power of 2 for phys_ids,
608          * core_ids, ht_ids, etc.  This can slightly reduce the actual
609          * range of indices in vm_page_queues[] that are nominally used.
610          */
611         if (cpu_topology_ht_ids) {
612                 scale_lim = PQ_L2_SIZE / cpu_topology_phys_ids;
613                 scale_lim = scale_lim / cpu_topology_core_ids;
614                 scale_lim = scale_lim / cpu_topology_ht_ids;
615                 scale_lim = scale_lim * cpu_topology_ht_ids;
616                 scale_lim = scale_lim * cpu_topology_core_ids;
617                 scale_lim = scale_lim * cpu_topology_phys_ids;
618         } else {
619                 scale_lim = PQ_L2_SIZE;
620         }
621
622         /*
623          * Calculate an average, set hysteresis for balancing from
624          * 10% below the average to the average.
625          */
626         lcnt_hi = 0;
627         for (i = 0; i < scale_lim; ++i) {
628                 lcnt_hi += vm_page_queues[i].lcnt;
629         }
630         lcnt_hi /= scale_lim;
631         lcnt_lo = lcnt_hi - lcnt_hi / 10;
632
633         kprintf("vm_page: avg %ld pages per queue, %d queues\n",
634                 lcnt_hi, scale_lim);
635
636         iter = 0;
637         for (i = 0; i < scale_lim; ++i) {
638                 vpq = &vm_page_queues[PQ_FREE + i];
639                 while (vpq->lcnt < lcnt_lo) {
640                         struct vpgqueues *vptmp;
641
642                         iter = (iter + 1) & PQ_L2_MASK;
643                         vptmp = &vm_page_queues[PQ_FREE + iter];
644                         if (vptmp->lcnt < lcnt_hi)
645                                 continue;
646                         m = TAILQ_FIRST(&vptmp->pl);
647                         KKASSERT(m->queue == PQ_FREE + iter);
648                         TAILQ_REMOVE(&vptmp->pl, m, pageq);
649                         --vptmp->lcnt;
650                         /* queue doesn't change, no need to adj cnt */
651                         m->queue -= m->pc;
652                         m->pc = i;
653                         m->queue += m->pc;
654                         TAILQ_INSERT_HEAD(&vpq->pl, m, pageq);
655                         ++vpq->lcnt;
656                 }
657         }
658         crit_exit();
659 }
660
661 static
662 void
663 vm_numa_add_topology_mem(cpu_node_t *cpup, int physid, long bytes)
664 {
665         int cpuid;
666         int i;
667
668         switch(cpup->type) {
669         case PACKAGE_LEVEL:
670                 cpup->phys_mem += bytes;
671                 break;
672         case CHIP_LEVEL:
673                 /*
674                  * All members should have the same chipid, so we only need
675                  * to pull out one member.
676                  */
677                 if (CPUMASK_TESTNZERO(cpup->members)) {
678                         cpuid = BSFCPUMASK(cpup->members);
679                         if (physid ==
680                             get_chip_ID_from_APICID(CPUID_TO_APICID(cpuid))) {
681                                 cpup->phys_mem += bytes;
682                         }
683                 }
684                 break;
685         case CORE_LEVEL:
686         case THREAD_LEVEL:
687                 /*
688                  * Just inherit from the parent node
689                  */
690                 cpup->phys_mem = cpup->parent_node->phys_mem;
691                 break;
692         }
693         for (i = 0; i < MAXCPU && cpup->child_node[i]; ++i)
694                 vm_numa_add_topology_mem(cpup->child_node[i], physid, bytes);
695 }
696
697 /*
698  * We tended to reserve a ton of memory for contigmalloc().  Now that most
699  * drivers have initialized we want to return most the remaining free
700  * reserve back to the VM page queues so they can be used for normal
701  * allocations.
702  *
703  * We leave vm_dma_reserved bytes worth of free pages in the reserve pool.
704  */
705 static void
706 vm_page_startup_finish(void *dummy __unused)
707 {
708         alist_blk_t blk;
709         alist_blk_t rblk;
710         alist_blk_t count;
711         alist_blk_t xcount;
712         alist_blk_t bfree;
713         vm_page_t m;
714         struct vm_page_hash_elm *mp;
715         int mask;
716
717         /*
718          * Set the set_assoc_mask based on the fitted number of CPUs.
719          * This is a mask, so we subject 1.
720          *
721          * w/PQ_L2_SIZE = 1024, Don't let the associativity drop below 8.
722          * So if we have 256 CPUs, two hyper-threads will wind up sharing.
723          *
724          * The maximum is PQ_L2_SIZE.  However, we limit the starting
725          * maximum to 16 (mask = 15) in order to improve the cache locality
726          * of related kernel data structures.
727          */
728         mask = PQ_L2_SIZE / ncpus_fit - 1;
729         if (mask < 7)           /* minimum is 8-way w/256 CPU threads */
730                 mask = 7;
731         if (mask < 15)
732                 mask = 15;
733         cpu_ccfence();
734         set_assoc_mask = mask;
735
736         /*
737          * Return part of the initial reserve back to the system
738          */
739         spin_lock(&vm_contig_spin);
740         for (;;) {
741                 bfree = alist_free_info(&vm_contig_alist, &blk, &count);
742                 if (bfree <= vm_dma_reserved / PAGE_SIZE)
743                         break;
744                 if (count == 0)
745                         break;
746
747                 /*
748                  * Figure out how much of the initial reserve we have to
749                  * free in order to reach our target.
750                  */
751                 bfree -= vm_dma_reserved / PAGE_SIZE;
752                 if (count > bfree) {
753                         blk += count - bfree;
754                         count = bfree;
755                 }
756
757                 /*
758                  * Calculate the nearest power of 2 <= count.
759                  */
760                 for (xcount = 1; xcount <= count; xcount <<= 1)
761                         ;
762                 xcount >>= 1;
763                 blk += count - xcount;
764                 count = xcount;
765
766                 /*
767                  * Allocate the pages from the alist, then free them to
768                  * the normal VM page queues.
769                  *
770                  * Pages allocated from the alist are wired.  We have to
771                  * busy, unwire, and free them.  We must also adjust
772                  * vm_low_phys_reserved before freeing any pages to prevent
773                  * confusion.
774                  */
775                 rblk = alist_alloc(&vm_contig_alist, blk, count);
776                 if (rblk != blk) {
777                         kprintf("vm_page_startup_finish: Unable to return "
778                                 "dma space @0x%08x/%d -> 0x%08x\n",
779                                 blk, count, rblk);
780                         break;
781                 }
782                 atomic_add_long(&vmstats.v_dma_pages, -(long)count);
783                 spin_unlock(&vm_contig_spin);
784
785                 m = PHYS_TO_VM_PAGE((vm_paddr_t)blk << PAGE_SHIFT);
786                 vm_low_phys_reserved = VM_PAGE_TO_PHYS(m);
787                 while (count) {
788                         vm_page_busy_wait(m, FALSE, "cpgfr");
789                         vm_page_unwire(m, 0);
790                         vm_page_free(m);
791                         --count;
792                         ++m;
793                 }
794                 spin_lock(&vm_contig_spin);
795         }
796         spin_unlock(&vm_contig_spin);
797
798         /*
799          * Print out how much DMA space drivers have already allocated and
800          * how much is left over.
801          */
802         kprintf("DMA space used: %jdk, remaining available: %jdk\n",
803                 (intmax_t)(vmstats.v_dma_pages - vm_contig_alist.bl_free) *
804                 (PAGE_SIZE / 1024),
805                 (intmax_t)vm_contig_alist.bl_free * (PAGE_SIZE / 1024));
806
807         /*
808          * Power of 2
809          */
810         vm_page_hash_size = 4096;
811         while (vm_page_hash_size < (vm_page_array_size / 16))
812                 vm_page_hash_size <<= 1;
813         if (vm_page_hash_size > VM_PAGE_HASH_MAX)
814                 vm_page_hash_size = VM_PAGE_HASH_MAX;
815
816         /*
817          * hash table for vm_page_lookup_quick()
818          */
819         mp = (void *)kmem_alloc3(&kernel_map,
820                                  vm_page_hash_size * sizeof(*vm_page_hash),
821                                  VM_SUBSYS_VMPGHASH, KM_CPU(0));
822         bzero(mp, vm_page_hash_size * sizeof(*mp));
823         cpu_sfence();
824         vm_page_hash = mp;
825 }
826 SYSINIT(vm_pgend, SI_SUB_PROC0_POST, SI_ORDER_ANY,
827         vm_page_startup_finish, NULL);
828
829
830 /*
831  * Scan comparison function for Red-Black tree scans.  An inclusive
832  * (start,end) is expected.  Other fields are not used.
833  */
834 int
835 rb_vm_page_scancmp(struct vm_page *p, void *data)
836 {
837         struct rb_vm_page_scan_info *info = data;
838
839         if (p->pindex < info->start_pindex)
840                 return(-1);
841         if (p->pindex > info->end_pindex)
842                 return(1);
843         return(0);
844 }
845
846 int
847 rb_vm_page_compare(struct vm_page *p1, struct vm_page *p2)
848 {
849         if (p1->pindex < p2->pindex)
850                 return(-1);
851         if (p1->pindex > p2->pindex)
852                 return(1);
853         return(0);
854 }
855
856 void
857 vm_page_init(vm_page_t m)
858 {
859         /* do nothing for now.  Called from pmap_page_init() */
860 }
861
862 /*
863  * Each page queue has its own spin lock, which is fairly optimal for
864  * allocating and freeing pages at least.
865  *
866  * The caller must hold the vm_page_spin_lock() before locking a vm_page's
867  * queue spinlock via this function.  Also note that m->queue cannot change
868  * unless both the page and queue are locked.
869  */
870 static __inline
871 void
872 _vm_page_queue_spin_lock(vm_page_t m)
873 {
874         u_short queue;
875
876         queue = m->queue;
877         if (queue != PQ_NONE) {
878                 spin_lock(&vm_page_queues[queue].spin);
879                 KKASSERT(queue == m->queue);
880         }
881 }
882
883 static __inline
884 void
885 _vm_page_queue_spin_unlock(vm_page_t m)
886 {
887         u_short queue;
888
889         queue = m->queue;
890         cpu_ccfence();
891         if (queue != PQ_NONE)
892                 spin_unlock(&vm_page_queues[queue].spin);
893 }
894
895 static __inline
896 void
897 _vm_page_queues_spin_lock(u_short queue)
898 {
899         cpu_ccfence();
900         if (queue != PQ_NONE)
901                 spin_lock(&vm_page_queues[queue].spin);
902 }
903
904
905 static __inline
906 void
907 _vm_page_queues_spin_unlock(u_short queue)
908 {
909         cpu_ccfence();
910         if (queue != PQ_NONE)
911                 spin_unlock(&vm_page_queues[queue].spin);
912 }
913
914 void
915 vm_page_queue_spin_lock(vm_page_t m)
916 {
917         _vm_page_queue_spin_lock(m);
918 }
919
920 void
921 vm_page_queues_spin_lock(u_short queue)
922 {
923         _vm_page_queues_spin_lock(queue);
924 }
925
926 void
927 vm_page_queue_spin_unlock(vm_page_t m)
928 {
929         _vm_page_queue_spin_unlock(m);
930 }
931
932 void
933 vm_page_queues_spin_unlock(u_short queue)
934 {
935         _vm_page_queues_spin_unlock(queue);
936 }
937
938 /*
939  * This locks the specified vm_page and its queue in the proper order
940  * (page first, then queue).  The queue may change so the caller must
941  * recheck on return.
942  */
943 static __inline
944 void
945 _vm_page_and_queue_spin_lock(vm_page_t m)
946 {
947         vm_page_spin_lock(m);
948         _vm_page_queue_spin_lock(m);
949 }
950
951 static __inline
952 void
953 _vm_page_and_queue_spin_unlock(vm_page_t m)
954 {
955         _vm_page_queues_spin_unlock(m->queue);
956         vm_page_spin_unlock(m);
957 }
958
959 void
960 vm_page_and_queue_spin_unlock(vm_page_t m)
961 {
962         _vm_page_and_queue_spin_unlock(m);
963 }
964
965 void
966 vm_page_and_queue_spin_lock(vm_page_t m)
967 {
968         _vm_page_and_queue_spin_lock(m);
969 }
970
971 /*
972  * Helper function removes vm_page from its current queue.
973  * Returns the base queue the page used to be on.
974  *
975  * The vm_page and the queue must be spinlocked.
976  * This function will unlock the queue but leave the page spinlocked.
977  */
978 static __inline u_short
979 _vm_page_rem_queue_spinlocked(vm_page_t m)
980 {
981         struct vpgqueues *pq;
982         u_short queue;
983         u_short oqueue;
984         long *cnt;
985
986         queue = m->queue;
987         if (queue != PQ_NONE) {
988                 pq = &vm_page_queues[queue];
989                 TAILQ_REMOVE(&pq->pl, m, pageq);
990
991                 /*
992                  * Adjust our pcpu stats.  In order for the nominal low-memory
993                  * algorithms to work properly we don't let any pcpu stat get
994                  * too negative before we force it to be rolled-up into the
995                  * global stats.  Otherwise our pageout and vm_wait tests
996                  * will fail badly.
997                  *
998                  * The idea here is to reduce unnecessary SMP cache
999                  * mastership changes in the global vmstats, which can be
1000                  * particularly bad in multi-socket systems.
1001                  */
1002                 cnt = (long *)((char *)&mycpu->gd_vmstats_adj + pq->cnt_offset);
1003                 atomic_add_long(cnt, -1);
1004                 if (*cnt < -VMMETER_SLOP_COUNT) {
1005                         u_long copy = atomic_swap_long(cnt, 0);
1006                         cnt = (long *)((char *)&vmstats + pq->cnt_offset);
1007                         atomic_add_long(cnt, copy);
1008                         cnt = (long *)((char *)&mycpu->gd_vmstats +
1009                                       pq->cnt_offset);
1010                         atomic_add_long(cnt, copy);
1011                 }
1012                 pq->lcnt--;
1013                 m->queue = PQ_NONE;
1014                 oqueue = queue;
1015                 queue -= m->pc;
1016                 vm_page_queues_spin_unlock(oqueue);     /* intended */
1017         }
1018         return queue;
1019 }
1020
1021 /*
1022  * Helper function places the vm_page on the specified queue.  Generally
1023  * speaking only PQ_FREE pages are placed at the head, to allow them to
1024  * be allocated sooner rather than later on the assumption that they
1025  * are cache-hot.
1026  *
1027  * The vm_page must be spinlocked.
1028  * The vm_page must NOT be FICTITIOUS (that would be a disaster)
1029  * This function will return with both the page and the queue locked.
1030  */
1031 static __inline void
1032 _vm_page_add_queue_spinlocked(vm_page_t m, u_short queue, int athead)
1033 {
1034         struct vpgqueues *pq;
1035         u_long *cnt;
1036
1037         KKASSERT(m->queue == PQ_NONE && (m->flags & PG_FICTITIOUS) == 0);
1038
1039         if (queue != PQ_NONE) {
1040                 vm_page_queues_spin_lock(queue);
1041                 pq = &vm_page_queues[queue];
1042                 ++pq->lcnt;
1043
1044                 /*
1045                  * Adjust our pcpu stats.  If a system entity really needs
1046                  * to incorporate the count it will call vmstats_rollup()
1047                  * to roll it all up into the global vmstats strufture.
1048                  */
1049                 cnt = (long *)((char *)&mycpu->gd_vmstats_adj + pq->cnt_offset);
1050                 atomic_add_long(cnt, 1);
1051
1052                 /*
1053                  * PQ_FREE is always handled LIFO style to try to provide
1054                  * cache-hot pages to programs.
1055                  */
1056                 m->queue = queue;
1057                 if (queue - m->pc == PQ_FREE) {
1058                         TAILQ_INSERT_HEAD(&pq->pl, m, pageq);
1059                 } else if (athead) {
1060                         TAILQ_INSERT_HEAD(&pq->pl, m, pageq);
1061                 } else {
1062                         TAILQ_INSERT_TAIL(&pq->pl, m, pageq);
1063                 }
1064                 /* leave the queue spinlocked */
1065         }
1066 }
1067
1068 /*
1069  * Wait until page is no longer BUSY.  If also_m_busy is TRUE we wait
1070  * until the page is no longer BUSY or SBUSY (busy_count field is 0).
1071  *
1072  * Returns TRUE if it had to sleep, FALSE if we did not.  Only one sleep
1073  * call will be made before returning.
1074  *
1075  * This function does NOT busy the page and on return the page is not
1076  * guaranteed to be available.
1077  */
1078 void
1079 vm_page_sleep_busy(vm_page_t m, int also_m_busy, const char *msg)
1080 {
1081         u_int32_t busy_count;
1082
1083         for (;;) {
1084                 busy_count = m->busy_count;
1085                 cpu_ccfence();
1086
1087                 if ((busy_count & PBUSY_LOCKED) == 0 &&
1088                     (also_m_busy == 0 || (busy_count & PBUSY_MASK) == 0)) {
1089                         break;
1090                 }
1091                 tsleep_interlock(m, 0);
1092                 if (atomic_cmpset_int(&m->busy_count, busy_count,
1093                                       busy_count | PBUSY_WANTED)) {
1094                         atomic_set_int(&m->flags, PG_REFERENCED);
1095                         tsleep(m, PINTERLOCKED, msg, 0);
1096                         break;
1097                 }
1098         }
1099 }
1100
1101 /*
1102  * This calculates and returns a page color given an optional VM object and
1103  * either a pindex or an iterator.  We attempt to return a cpu-localized
1104  * pg_color that is still roughly 16-way set-associative.  The CPU topology
1105  * is used if it was probed.
1106  *
1107  * The caller may use the returned value to index into e.g. PQ_FREE when
1108  * allocating a page in order to nominally obtain pages that are hopefully
1109  * already localized to the requesting cpu.  This function is not able to
1110  * provide any sort of guarantee of this, but does its best to improve
1111  * hardware cache management performance.
1112  *
1113  * WARNING! The caller must mask the returned value with PQ_L2_MASK.
1114  */
1115 u_short
1116 vm_get_pg_color(int cpuid, vm_object_t object, vm_pindex_t pindex)
1117 {
1118         u_short pg_color;
1119         int object_pg_color;
1120
1121         /*
1122          * WARNING! cpu_topology_core_ids might not be a power of two.
1123          *          We also shouldn't make assumptions about
1124          *          cpu_topology_phys_ids either.
1125          *
1126          * WARNING! ncpus might not be known at this time (during early
1127          *          boot), and might be set to 1.
1128          *
1129          * General format: [phys_id][core_id][cpuid][set-associativity]
1130          * (but uses modulo, so not necessarily precise bit masks)
1131          */
1132         object_pg_color = object ? object->pg_color : 0;
1133
1134         if (cpu_topology_ht_ids) {
1135                 int phys_id;
1136                 int core_id;
1137                 int ht_id;
1138                 int physcale;
1139                 int grpscale;
1140                 int cpuscale;
1141
1142                 /*
1143                  * Translate cpuid to socket, core, and hyperthread id.
1144                  */
1145                 phys_id = get_cpu_phys_id(cpuid);
1146                 core_id = get_cpu_core_id(cpuid);
1147                 ht_id = get_cpu_ht_id(cpuid);
1148
1149                 /*
1150                  * Calculate pg_color for our array index.
1151                  *
1152                  * physcale - socket multiplier.
1153                  * grpscale - core multiplier (cores per socket)
1154                  * cpu*     - cpus per core
1155                  *
1156                  * WARNING! In early boot, ncpus has not yet been
1157                  *          initialized and may be set to (1).
1158                  *
1159                  * WARNING! physcale must match the organization that
1160                  *          vm_numa_organize() creates to ensure that
1161                  *          we properly localize allocations to the
1162                  *          requested cpuid.
1163                  */
1164                 physcale = PQ_L2_SIZE / cpu_topology_phys_ids;
1165                 grpscale = physcale / cpu_topology_core_ids;
1166                 cpuscale = grpscale / cpu_topology_ht_ids;
1167
1168                 pg_color = phys_id * physcale;
1169                 pg_color += core_id * grpscale;
1170                 pg_color += ht_id * cpuscale;
1171                 pg_color += (pindex + object_pg_color) % cpuscale;
1172
1173 #if 0
1174                 if (grpsize >= 8) {
1175                         pg_color += (pindex + object_pg_color) % grpsize;
1176                 } else {
1177                         if (grpsize <= 2) {
1178                                 grpsize = 8;
1179                         } else {
1180                                 /* 3->9, 4->8, 5->10, 6->12, 7->14 */
1181                                 grpsize += grpsize;
1182                                 if (grpsize < 8)
1183                                         grpsize += grpsize;
1184                         }
1185                         pg_color += (pindex + object_pg_color) % grpsize;
1186                 }
1187 #endif
1188         } else {
1189                 /*
1190                  * Unknown topology, distribute things evenly.
1191                  *
1192                  * WARNING! In early boot, ncpus has not yet been
1193                  *          initialized and may be set to (1).
1194                  */
1195                 int cpuscale;
1196
1197                 cpuscale = PQ_L2_SIZE / ncpus;
1198
1199                 pg_color = cpuid * cpuscale;
1200                 pg_color += (pindex + object_pg_color) % cpuscale;
1201         }
1202         return (pg_color & PQ_L2_MASK);
1203 }
1204
1205 /*
1206  * Wait until BUSY can be set, then set it.  If also_m_busy is TRUE we
1207  * also wait for m->busy_count to become 0 before setting PBUSY_LOCKED.
1208  */
1209 void
1210 VM_PAGE_DEBUG_EXT(vm_page_busy_wait)(vm_page_t m,
1211                                      int also_m_busy, const char *msg
1212                                      VM_PAGE_DEBUG_ARGS)
1213 {
1214         u_int32_t busy_count;
1215
1216         for (;;) {
1217                 busy_count = m->busy_count;
1218                 cpu_ccfence();
1219                 if (busy_count & PBUSY_LOCKED) {
1220                         tsleep_interlock(m, 0);
1221                         if (atomic_cmpset_int(&m->busy_count, busy_count,
1222                                           busy_count | PBUSY_WANTED)) {
1223                                 atomic_set_int(&m->flags, PG_REFERENCED);
1224                                 tsleep(m, PINTERLOCKED, msg, 0);
1225                         }
1226                 } else if (also_m_busy && busy_count) {
1227                         tsleep_interlock(m, 0);
1228                         if (atomic_cmpset_int(&m->busy_count, busy_count,
1229                                           busy_count | PBUSY_WANTED)) {
1230                                 atomic_set_int(&m->flags, PG_REFERENCED);
1231                                 tsleep(m, PINTERLOCKED, msg, 0);
1232                         }
1233                 } else {
1234                         if (atomic_cmpset_int(&m->busy_count, busy_count,
1235                                               busy_count | PBUSY_LOCKED)) {
1236 #ifdef VM_PAGE_DEBUG
1237                                 m->busy_func = func;
1238                                 m->busy_line = lineno;
1239 #endif
1240                                 break;
1241                         }
1242                 }
1243         }
1244 }
1245
1246 /*
1247  * Attempt to set BUSY.  If also_m_busy is TRUE we only succeed if
1248  * m->busy_count is also 0.
1249  *
1250  * Returns non-zero on failure.
1251  */
1252 int
1253 VM_PAGE_DEBUG_EXT(vm_page_busy_try)(vm_page_t m, int also_m_busy
1254                                     VM_PAGE_DEBUG_ARGS)
1255 {
1256         u_int32_t busy_count;
1257
1258         for (;;) {
1259                 busy_count = m->busy_count;
1260                 cpu_ccfence();
1261                 if (busy_count & PBUSY_LOCKED)
1262                         return TRUE;
1263                 if (also_m_busy && (busy_count & PBUSY_MASK) != 0)
1264                         return TRUE;
1265                 if (atomic_cmpset_int(&m->busy_count, busy_count,
1266                                       busy_count | PBUSY_LOCKED)) {
1267 #ifdef VM_PAGE_DEBUG
1268                                 m->busy_func = func;
1269                                 m->busy_line = lineno;
1270 #endif
1271                         return FALSE;
1272                 }
1273         }
1274 }
1275
1276 /*
1277  * Clear the BUSY flag and return non-zero to indicate to the caller
1278  * that a wakeup() should be performed.
1279  *
1280  * (inline version)
1281  */
1282 static __inline
1283 int
1284 _vm_page_wakeup(vm_page_t m)
1285 {
1286         u_int32_t busy_count;
1287
1288         busy_count = m->busy_count;
1289         cpu_ccfence();
1290         for (;;) {
1291                 if (atomic_fcmpset_int(&m->busy_count, &busy_count,
1292                                       busy_count &
1293                                       ~(PBUSY_LOCKED | PBUSY_WANTED))) {
1294                         return((int)(busy_count & PBUSY_WANTED));
1295                 }
1296         }
1297         /* not reached */
1298 }
1299
1300 /*
1301  * Clear the BUSY flag and wakeup anyone waiting for the page.  This
1302  * is typically the last call you make on a page before moving onto
1303  * other things.
1304  */
1305 void
1306 vm_page_wakeup(vm_page_t m)
1307 {
1308         KASSERT(m->busy_count & PBUSY_LOCKED,
1309                 ("vm_page_wakeup: page not busy!!!"));
1310         if (_vm_page_wakeup(m))
1311                 wakeup(m);
1312 }
1313
1314 /*
1315  * Hold a page, preventing reuse.  This is typically only called on pages
1316  * in a known state (either held busy, special, or interlocked in some
1317  * manner).  Holding a page does not ensure that it remains valid, it only
1318  * prevents reuse.  The page must not already be on the FREE queue or in
1319  * any danger of being moved to the FREE queue concurrent with this call.
1320  *
1321  * Other parts of the system can still disassociate the page from its object
1322  * and attempt to free it, or perform read or write I/O on it and/or otherwise
1323  * manipulate the page, but if the page is held the VM system will leave the
1324  * page and its data intact and not cycle it through the FREE queue until
1325  * the last hold has been released.
1326  *
1327  * (see vm_page_wire() if you want to prevent the page from being
1328  *  disassociated from its object too).
1329  */
1330 void
1331 vm_page_hold(vm_page_t m)
1332 {
1333         atomic_add_int(&m->hold_count, 1);
1334         KKASSERT(m->queue - m->pc != PQ_FREE);
1335 }
1336
1337 /*
1338  * The opposite of vm_page_hold().  If the page is on the HOLD queue
1339  * it was freed while held and must be moved back to the FREE queue.
1340  *
1341  * To avoid racing against vm_page_free*() we must re-test conditions
1342  * after obtaining the spin-lock.  The initial test can also race a
1343  * vm_page_free*() that is in the middle of moving a page to PQ_HOLD,
1344  * leaving the page on PQ_HOLD with hold_count == 0.  Rather than
1345  * throw a spin-lock in the critical path, we rely on the pageout
1346  * daemon to clean-up these loose ends.
1347  *
1348  * More critically, the 'easy movement' between queues without busying
1349  * a vm_page is only allowed for PQ_FREE<->PQ_HOLD.
1350  */
1351 void
1352 vm_page_unhold(vm_page_t m)
1353 {
1354         KASSERT(m->hold_count > 0 && m->queue - m->pc != PQ_FREE,
1355                 ("vm_page_unhold: pg %p illegal hold_count (%d) or "
1356                  "on FREE queue (%d)",
1357                  m, m->hold_count, m->queue - m->pc));
1358
1359         if (atomic_fetchadd_int(&m->hold_count, -1) == 1 &&
1360             m->queue - m->pc == PQ_HOLD) {
1361                 vm_page_spin_lock(m);
1362                 if (m->hold_count == 0 && m->queue - m->pc == PQ_HOLD) {
1363                         _vm_page_queue_spin_lock(m);
1364                         _vm_page_rem_queue_spinlocked(m);
1365                         _vm_page_add_queue_spinlocked(m, PQ_FREE + m->pc, 1);
1366                         _vm_page_queue_spin_unlock(m);
1367                 }
1368                 vm_page_spin_unlock(m);
1369         }
1370 }
1371
1372 /*
1373  * Create a fictitious page with the specified physical address and
1374  * memory attribute.  The memory attribute is the only the machine-
1375  * dependent aspect of a fictitious page that must be initialized.
1376  */
1377 void
1378 vm_page_initfake(vm_page_t m, vm_paddr_t paddr, vm_memattr_t memattr)
1379 {
1380         if ((m->flags & PG_FICTITIOUS) != 0) {
1381                 /*
1382                  * The page's memattr might have changed since the
1383                  * previous initialization.  Update the pmap to the
1384                  * new memattr.
1385                  */
1386                 goto memattr;
1387         }
1388         m->phys_addr = paddr;
1389         m->queue = PQ_NONE;
1390         /* Fictitious pages don't use "segind". */
1391         /* Fictitious pages don't use "order" or "pool". */
1392         m->flags = PG_FICTITIOUS | PG_UNMANAGED;
1393         m->busy_count = PBUSY_LOCKED;
1394         m->wire_count = 1;
1395         spin_init(&m->spin, "fake_page");
1396         pmap_page_init(m);
1397 memattr:
1398         pmap_page_set_memattr(m, memattr);
1399 }
1400
1401 /*
1402  * Inserts the given vm_page into the object and object list.
1403  *
1404  * The pagetables are not updated but will presumably fault the page
1405  * in if necessary, or if a kernel page the caller will at some point
1406  * enter the page into the kernel's pmap.  We are not allowed to block
1407  * here so we *can't* do this anyway.
1408  *
1409  * This routine may not block.
1410  * This routine must be called with the vm_object held.
1411  * This routine must be called with a critical section held.
1412  *
1413  * This routine returns TRUE if the page was inserted into the object
1414  * successfully, and FALSE if the page already exists in the object.
1415  */
1416 int
1417 vm_page_insert(vm_page_t m, vm_object_t object, vm_pindex_t pindex)
1418 {
1419         ASSERT_LWKT_TOKEN_HELD_EXCL(vm_object_token(object));
1420         if (m->object != NULL)
1421                 panic("vm_page_insert: already inserted");
1422
1423         atomic_add_int(&object->generation, 1);
1424
1425         /*
1426          * Associate the VM page with an (object, offset).
1427          *
1428          * The vm_page spin lock is required for interactions with the pmap.
1429          */
1430         vm_page_spin_lock(m);
1431         m->object = object;
1432         m->pindex = pindex;
1433         if (vm_page_rb_tree_RB_INSERT(&object->rb_memq, m)) {
1434                 m->object = NULL;
1435                 m->pindex = 0;
1436                 vm_page_spin_unlock(m);
1437                 return FALSE;
1438         }
1439         ++object->resident_page_count;
1440         ++mycpu->gd_vmtotal.t_rm;
1441         vm_page_spin_unlock(m);
1442
1443         /*
1444          * Since we are inserting a new and possibly dirty page,
1445          * update the object's OBJ_WRITEABLE and OBJ_MIGHTBEDIRTY flags.
1446          */
1447         if ((m->valid & m->dirty) ||
1448             (m->flags & (PG_WRITEABLE | PG_NEED_COMMIT)))
1449                 vm_object_set_writeable_dirty(object);
1450
1451         /*
1452          * Checks for a swap assignment and sets PG_SWAPPED if appropriate.
1453          */
1454         swap_pager_page_inserted(m);
1455         return TRUE;
1456 }
1457
1458 /*
1459  * Removes the given vm_page_t from the (object,index) table
1460  *
1461  * The page must be BUSY and will remain BUSY on return.
1462  * No other requirements.
1463  *
1464  * NOTE: FreeBSD side effect was to unbusy the page on return.  We leave
1465  *       it busy.
1466  *
1467  * NOTE: Caller is responsible for any pmap disposition prior to the
1468  *       rename (as the pmap code will not be able to find the entries
1469  *       once the object has been disassociated).  The caller may choose
1470  *       to leave the pmap association intact if this routine is being
1471  *       called as part of a rename between shadowed objects.
1472  *
1473  * This routine may not block.
1474  */
1475 void
1476 vm_page_remove(vm_page_t m)
1477 {
1478         vm_object_t object;
1479
1480         if (m->object == NULL) {
1481                 return;
1482         }
1483
1484         if ((m->busy_count & PBUSY_LOCKED) == 0)
1485                 panic("vm_page_remove: page not busy");
1486
1487         object = m->object;
1488
1489         vm_object_hold(object);
1490
1491         /*
1492          * Remove the page from the object and update the object.
1493          *
1494          * The vm_page spin lock is required for interactions with the pmap.
1495          */
1496         vm_page_spin_lock(m);
1497         vm_page_rb_tree_RB_REMOVE(&object->rb_memq, m);
1498         --object->resident_page_count;
1499         --mycpu->gd_vmtotal.t_rm;
1500         m->object = NULL;
1501         atomic_add_int(&object->generation, 1);
1502         vm_page_spin_unlock(m);
1503
1504         vm_object_drop(object);
1505 }
1506
1507 /*
1508  * Calculate the hash position for the vm_page hash heuristic.
1509  *
1510  * Mask by ~3 to offer 4-way set-assoc
1511  */
1512 static __inline
1513 struct vm_page_hash_elm *
1514 vm_page_hash_hash(vm_object_t object, vm_pindex_t pindex)
1515 {
1516         size_t hi;
1517
1518         /* mix it up */
1519         hi = (intptr_t)object ^ object->pg_color ^ pindex;
1520         hi += object->pg_color * pindex;
1521         hi = hi ^ (hi >> 20);
1522         hi &= vm_page_hash_size - 1;            /* bounds */
1523         hi &= ~(VM_PAGE_HASH_SET - 1);          /* set-assoc */
1524         return (&vm_page_hash[hi]);
1525 }
1526
1527 /*
1528  * Heuristical page lookup that does not require any locks.  Returns
1529  * a soft-busied page on success, NULL on failure.
1530  *
1531  * Caller must lookup the page the slow way if NULL is returned.
1532  */
1533 vm_page_t
1534 vm_page_hash_get(vm_object_t object, vm_pindex_t pindex)
1535 {
1536         struct vm_page_hash_elm *mp;
1537         vm_page_t m;
1538         int i;
1539
1540         if (vm_page_hash == NULL)
1541                 return NULL;
1542         mp = vm_page_hash_hash(object, pindex);
1543         for (i = 0; i < VM_PAGE_HASH_SET; ++i) {
1544                 m = mp[i].m;
1545                 cpu_ccfence();
1546                 if (m == NULL)
1547                         continue;
1548                 if (m->object != object || m->pindex != pindex)
1549                         continue;
1550                 if (vm_page_sbusy_try(m))
1551                         continue;
1552                 if (m->object == object && m->pindex == pindex) {
1553                         mp[i].ticks = ticks;
1554                         return m;
1555                 }
1556                 vm_page_sbusy_drop(m);
1557         }
1558         return NULL;
1559 }
1560
1561 /*
1562  * Enter page onto vm_page_hash[].  This is a heuristic, SMP collisions
1563  * are allowed.
1564  */
1565 static __inline
1566 void
1567 vm_page_hash_enter(vm_page_t m)
1568 {
1569         struct vm_page_hash_elm *mp;
1570         struct vm_page_hash_elm *best;
1571         int i;
1572
1573         /*
1574          * Only enter type-stable vm_pages with well-shared objects.
1575          */
1576         if (vm_page_hash == NULL ||
1577             m < &vm_page_array[0] ||
1578             m >= &vm_page_array[vm_page_array_size])
1579                 return;
1580         if (m->object == NULL)
1581                 return;
1582 #if 0
1583         /*
1584          * Disabled at the moment, there are some degenerate conditions
1585          * with often-exec'd programs that get ignored.  In particular,
1586          * the kernel's elf loader does a vn_rdwr() on the first page of
1587          * a binary.
1588          */
1589         if (m->object->ref_count <= 2 || (m->object->flags & OBJ_ONEMAPPING))
1590                 return;
1591 #endif
1592         if (vm_page_hash_vnode_only && m->object->type != OBJT_VNODE)
1593                 return;
1594
1595         /*
1596          *
1597          */
1598         mp = vm_page_hash_hash(m->object, m->pindex);
1599         best = mp;
1600         for (i = 0; i < VM_PAGE_HASH_SET; ++i) {
1601                 if (mp[i].m == m) {
1602                         mp[i].ticks = ticks;
1603                         return;
1604                 }
1605
1606                 /*
1607                  * The best choice is the oldest entry
1608                  */
1609                 if ((ticks - best->ticks) < (ticks - mp[i].ticks) ||
1610                     (int)(ticks - mp[i].ticks) < 0) {
1611                         best = &mp[i];
1612                 }
1613         }
1614         best->m = m;
1615         best->ticks = ticks;
1616 }
1617
1618 /*
1619  * Locate and return the page at (object, pindex), or NULL if the
1620  * page could not be found.
1621  *
1622  * The caller must hold the vm_object token.
1623  */
1624 vm_page_t
1625 vm_page_lookup(vm_object_t object, vm_pindex_t pindex)
1626 {
1627         vm_page_t m;
1628
1629         /*
1630          * Search the hash table for this object/offset pair
1631          */
1632         ASSERT_LWKT_TOKEN_HELD(vm_object_token(object));
1633         m = vm_page_rb_tree_RB_LOOKUP(&object->rb_memq, pindex);
1634         if (m) {
1635                 KKASSERT(m->object == object && m->pindex == pindex);
1636                 vm_page_hash_enter(m);
1637         }
1638         return(m);
1639 }
1640
1641 vm_page_t
1642 VM_PAGE_DEBUG_EXT(vm_page_lookup_busy_wait)(struct vm_object *object,
1643                                             vm_pindex_t pindex,
1644                                             int also_m_busy, const char *msg
1645                                             VM_PAGE_DEBUG_ARGS)
1646 {
1647         u_int32_t busy_count;
1648         vm_page_t m;
1649
1650         ASSERT_LWKT_TOKEN_HELD(vm_object_token(object));
1651         m = vm_page_rb_tree_RB_LOOKUP(&object->rb_memq, pindex);
1652         while (m) {
1653                 KKASSERT(m->object == object && m->pindex == pindex);
1654                 busy_count = m->busy_count;
1655                 cpu_ccfence();
1656                 if (busy_count & PBUSY_LOCKED) {
1657                         tsleep_interlock(m, 0);
1658                         if (atomic_cmpset_int(&m->busy_count, busy_count,
1659                                           busy_count | PBUSY_WANTED)) {
1660                                 atomic_set_int(&m->flags, PG_REFERENCED);
1661                                 tsleep(m, PINTERLOCKED, msg, 0);
1662                                 m = vm_page_rb_tree_RB_LOOKUP(&object->rb_memq,
1663                                                               pindex);
1664                         }
1665                 } else if (also_m_busy && busy_count) {
1666                         tsleep_interlock(m, 0);
1667                         if (atomic_cmpset_int(&m->busy_count, busy_count,
1668                                           busy_count | PBUSY_WANTED)) {
1669                                 atomic_set_int(&m->flags, PG_REFERENCED);
1670                                 tsleep(m, PINTERLOCKED, msg, 0);
1671                                 m = vm_page_rb_tree_RB_LOOKUP(&object->rb_memq,
1672                                                               pindex);
1673                         }
1674                 } else if (atomic_cmpset_int(&m->busy_count, busy_count,
1675                                              busy_count | PBUSY_LOCKED)) {
1676 #ifdef VM_PAGE_DEBUG
1677                         m->busy_func = func;
1678                         m->busy_line = lineno;
1679 #endif
1680                         vm_page_hash_enter(m);
1681                         break;
1682                 }
1683         }
1684         return m;
1685 }
1686
1687 /*
1688  * Attempt to lookup and busy a page.
1689  *
1690  * Returns NULL if the page could not be found
1691  *
1692  * Returns a vm_page and error == TRUE if the page exists but could not
1693  * be busied.
1694  *
1695  * Returns a vm_page and error == FALSE on success.
1696  */
1697 vm_page_t
1698 VM_PAGE_DEBUG_EXT(vm_page_lookup_busy_try)(struct vm_object *object,
1699                                            vm_pindex_t pindex,
1700                                            int also_m_busy, int *errorp
1701                                            VM_PAGE_DEBUG_ARGS)
1702 {
1703         u_int32_t busy_count;
1704         vm_page_t m;
1705
1706         ASSERT_LWKT_TOKEN_HELD(vm_object_token(object));
1707         m = vm_page_rb_tree_RB_LOOKUP(&object->rb_memq, pindex);
1708         *errorp = FALSE;
1709         while (m) {
1710                 KKASSERT(m->object == object && m->pindex == pindex);
1711                 busy_count = m->busy_count;
1712                 cpu_ccfence();
1713                 if (busy_count & PBUSY_LOCKED) {
1714                         *errorp = TRUE;
1715                         break;
1716                 }
1717                 if (also_m_busy && busy_count) {
1718                         *errorp = TRUE;
1719                         break;
1720                 }
1721                 if (atomic_cmpset_int(&m->busy_count, busy_count,
1722                                       busy_count | PBUSY_LOCKED)) {
1723 #ifdef VM_PAGE_DEBUG
1724                         m->busy_func = func;
1725                         m->busy_line = lineno;
1726 #endif
1727                         vm_page_hash_enter(m);
1728                         break;
1729                 }
1730         }
1731         return m;
1732 }
1733
1734 /*
1735  * Returns a page that is only soft-busied for use by the caller in
1736  * a read-only fashion.  Returns NULL if the page could not be found,
1737  * the soft busy could not be obtained, or the page data is invalid.
1738  */
1739 vm_page_t
1740 vm_page_lookup_sbusy_try(struct vm_object *object, vm_pindex_t pindex,
1741                          int pgoff, int pgbytes)
1742 {
1743         vm_page_t m;
1744
1745         ASSERT_LWKT_TOKEN_HELD(vm_object_token(object));
1746         m = vm_page_rb_tree_RB_LOOKUP(&object->rb_memq, pindex);
1747         if (m) {
1748                 if ((m->valid != VM_PAGE_BITS_ALL &&
1749                      !vm_page_is_valid(m, pgoff, pgbytes)) ||
1750                     (m->flags & PG_FICTITIOUS)) {
1751                         m = NULL;
1752                 } else if (vm_page_sbusy_try(m)) {
1753                         m = NULL;
1754                 } else if ((m->valid != VM_PAGE_BITS_ALL &&
1755                             !vm_page_is_valid(m, pgoff, pgbytes)) ||
1756                            (m->flags & PG_FICTITIOUS)) {
1757                         vm_page_sbusy_drop(m);
1758                         m = NULL;
1759                 } else {
1760                         vm_page_hash_enter(m);
1761                 }
1762         }
1763         return m;
1764 }
1765
1766 /*
1767  * Caller must hold the related vm_object
1768  */
1769 vm_page_t
1770 vm_page_next(vm_page_t m)
1771 {
1772         vm_page_t next;
1773
1774         next = vm_page_rb_tree_RB_NEXT(m);
1775         if (next && next->pindex != m->pindex + 1)
1776                 next = NULL;
1777         return (next);
1778 }
1779
1780 /*
1781  * vm_page_rename()
1782  *
1783  * Move the given vm_page from its current object to the specified
1784  * target object/offset.  The page must be busy and will remain so
1785  * on return.
1786  *
1787  * new_object must be held.
1788  * This routine might block. XXX ?
1789  *
1790  * NOTE: Swap associated with the page must be invalidated by the move.  We
1791  *       have to do this for several reasons:  (1) we aren't freeing the
1792  *       page, (2) we are dirtying the page, (3) the VM system is probably
1793  *       moving the page from object A to B, and will then later move
1794  *       the backing store from A to B and we can't have a conflict.
1795  *
1796  * NOTE: We *always* dirty the page.  It is necessary both for the
1797  *       fact that we moved it, and because we may be invalidating
1798  *       swap.  If the page is on the cache, we have to deactivate it
1799  *       or vm_page_dirty() will panic.  Dirty pages are not allowed
1800  *       on the cache.
1801  *
1802  * NOTE: Caller is responsible for any pmap disposition prior to the
1803  *       rename (as the pmap code will not be able to find the entries
1804  *       once the object has been disassociated or changed).  Nominally
1805  *       the caller is moving a page between shadowed objects and so the
1806  *       pmap association is retained without having to remove the page
1807  *       from it.
1808  */
1809 void
1810 vm_page_rename(vm_page_t m, vm_object_t new_object, vm_pindex_t new_pindex)
1811 {
1812         KKASSERT(m->busy_count & PBUSY_LOCKED);
1813         ASSERT_LWKT_TOKEN_HELD_EXCL(vm_object_token(new_object));
1814         if (m->object) {
1815                 ASSERT_LWKT_TOKEN_HELD_EXCL(vm_object_token(m->object));
1816                 vm_page_remove(m);
1817         }
1818         if (vm_page_insert(m, new_object, new_pindex) == FALSE) {
1819                 panic("vm_page_rename: target exists (%p,%"PRIu64")",
1820                       new_object, new_pindex);
1821         }
1822         if (m->queue - m->pc == PQ_CACHE)
1823                 vm_page_deactivate(m);
1824         vm_page_dirty(m);
1825 }
1826
1827 /*
1828  * vm_page_unqueue() without any wakeup.  This routine is used when a page
1829  * is to remain BUSYied by the caller.
1830  *
1831  * This routine may not block.
1832  */
1833 void
1834 vm_page_unqueue_nowakeup(vm_page_t m)
1835 {
1836         vm_page_and_queue_spin_lock(m);
1837         (void)_vm_page_rem_queue_spinlocked(m);
1838         vm_page_spin_unlock(m);
1839 }
1840
1841 /*
1842  * vm_page_unqueue() - Remove a page from its queue, wakeup the pagedemon
1843  * if necessary.
1844  *
1845  * This routine may not block.
1846  */
1847 void
1848 vm_page_unqueue(vm_page_t m)
1849 {
1850         u_short queue;
1851
1852         vm_page_and_queue_spin_lock(m);
1853         queue = _vm_page_rem_queue_spinlocked(m);
1854         if (queue == PQ_FREE || queue == PQ_CACHE) {
1855                 vm_page_spin_unlock(m);
1856                 pagedaemon_wakeup();
1857         } else {
1858                 vm_page_spin_unlock(m);
1859         }
1860 }
1861
1862 /*
1863  * vm_page_list_find()
1864  *
1865  * Find a page on the specified queue with color optimization.
1866  *
1867  * The page coloring optimization attempts to locate a page that does
1868  * not overload other nearby pages in the object in the cpu's L1 or L2
1869  * caches.  We need this optimization because cpu caches tend to be
1870  * physical caches, while object spaces tend to be virtual.
1871  *
1872  * The page coloring optimization also, very importantly, tries to localize
1873  * memory to cpus and physical sockets.
1874  *
1875  * Each PQ_FREE and PQ_CACHE color queue has its own spinlock and the
1876  * algorithm is adjusted to localize allocations on a per-core basis.
1877  * This is done by 'twisting' the colors.
1878  *
1879  * The page is returned spinlocked and removed from its queue (it will
1880  * be on PQ_NONE), or NULL. The page is not BUSY'd.  The caller
1881  * is responsible for dealing with the busy-page case (usually by
1882  * deactivating the page and looping).
1883  *
1884  * NOTE:  This routine is carefully inlined.  A non-inlined version
1885  *        is available for outside callers but the only critical path is
1886  *        from within this source file.
1887  *
1888  * NOTE:  This routine assumes that the vm_pages found in PQ_CACHE and PQ_FREE
1889  *        represent stable storage, allowing us to order our locks vm_page
1890  *        first, then queue.
1891  */
1892 static __inline
1893 vm_page_t
1894 _vm_page_list_find(int basequeue, int index)
1895 {
1896         struct vpgqueues *pq;
1897         vm_page_t m;
1898
1899         index &= PQ_L2_MASK;
1900         pq = &vm_page_queues[basequeue + index];
1901
1902         /*
1903          * Try this cpu's colored queue first.  Test for a page unlocked,
1904          * then lock the queue and locate a page.  Note that the lock order
1905          * is reversed, but we do not want to dwadle on the page spinlock
1906          * anyway as it is held significantly longer than the queue spinlock.
1907          */
1908         if (TAILQ_FIRST(&pq->pl)) {
1909                 spin_lock(&pq->spin);
1910                 TAILQ_FOREACH(m, &pq->pl, pageq) {
1911                         if (spin_trylock(&m->spin) == 0)
1912                                 continue;
1913                         KKASSERT(m->queue == basequeue + index);
1914                         _vm_page_rem_queue_spinlocked(m);
1915                         pq->lastq = -1;
1916                         return(m);
1917                 }
1918                 spin_unlock(&pq->spin);
1919         }
1920
1921         /*
1922          * If we are unable to get a page, do a more involved NUMA-aware
1923          * search.  However, to avoid re-searching empty queues over and
1924          * over again skip to pq->last if appropriate.
1925          */
1926         if (pq->lastq >= 0)
1927                 index = pq->lastq;
1928
1929         m = _vm_page_list_find2(basequeue, index, &pq->lastq);
1930
1931         return(m);
1932 }
1933
1934 /*
1935  * If we could not find the page in the desired queue try to find it in
1936  * a nearby (NUMA-aware) queue.
1937  */
1938 static vm_page_t
1939 _vm_page_list_find2(int basequeue, int index, int *lastp)
1940 {
1941         struct vpgqueues *pq;
1942         vm_page_t m = NULL;
1943         int pqmask = set_assoc_mask >> 1;
1944         int pqi;
1945         int range;
1946         int skip_start;
1947         int skip_next;
1948         int count;
1949
1950         index &= PQ_L2_MASK;
1951         pq = &vm_page_queues[basequeue];
1952         count = 0;
1953         skip_start = -1;
1954         skip_next = -1;
1955
1956         /*
1957          * Run local sets of 16, 32, 64, 128, up to the entire queue if all
1958          * else fails (PQ_L2_MASK).
1959          *
1960          * pqmask is a mask, 15, 31, 63, etc.
1961          *
1962          * Test each queue unlocked first, then lock the queue and locate
1963          * a page.  Note that the lock order is reversed, but we do not want
1964          * to dwadle on the page spinlock anyway as it is held significantly
1965          * longer than the queue spinlock.
1966          */
1967         do {
1968                 pqmask = (pqmask << 1) | 1;
1969
1970                 pqi = index;
1971                 range = pqmask + 1;
1972
1973                 while (range > 0) {
1974                         if (pqi >= skip_start && pqi < skip_next) {
1975                                 range -= skip_next - pqi;
1976                                 pqi = (pqi & ~pqmask) | (skip_next & pqmask);
1977                         }
1978                         if (range > 0 && TAILQ_FIRST(&pq[pqi].pl)) {
1979                                 spin_lock(&pq[pqi].spin);
1980                                 TAILQ_FOREACH(m, &pq[pqi].pl, pageq) {
1981                                         if (spin_trylock(&m->spin) == 0)
1982                                                 continue;
1983                                         KKASSERT(m->queue == basequeue + pqi);
1984                                         _vm_page_rem_queue_spinlocked(m);
1985
1986                                         /*
1987                                          * If we had to wander too far, set
1988                                          * *lastp to skip past empty queues.
1989                                          */
1990                                         if (count >= 8)
1991                                                 *lastp = pqi & PQ_L2_MASK;
1992                                         return(m);
1993                                 }
1994                                 spin_unlock(&pq[pqi].spin);
1995                         }
1996                         --range;
1997                         ++count;
1998                         pqi = (pqi & ~pqmask) | ((pqi + 1) & pqmask);
1999                 }
2000                 skip_start = pqi & ~pqmask;
2001                 skip_next = (pqi | pqmask) + 1;
2002         } while (pqmask != PQ_L2_MASK);
2003
2004         return(m);
2005 }
2006
2007 /*
2008  * Returns a vm_page candidate for allocation.  The page is not busied so
2009  * it can move around.  The caller must busy the page (and typically
2010  * deactivate it if it cannot be busied!)
2011  *
2012  * Returns a spinlocked vm_page that has been removed from its queue.
2013  */
2014 vm_page_t
2015 vm_page_list_find(int basequeue, int index)
2016 {
2017         return(_vm_page_list_find(basequeue, index));
2018 }
2019
2020 /*
2021  * Find a page on the cache queue with color optimization, remove it
2022  * from the queue, and busy it.  The returned page will not be spinlocked.
2023  *
2024  * A candidate failure will be deactivated.  Candidates can fail due to
2025  * being busied by someone else, in which case they will be deactivated.
2026  *
2027  * This routine may not block.
2028  *
2029  */
2030 static vm_page_t
2031 vm_page_select_cache(u_short pg_color)
2032 {
2033         vm_page_t m;
2034
2035         for (;;) {
2036                 m = _vm_page_list_find(PQ_CACHE, pg_color);
2037                 if (m == NULL)
2038                         break;
2039                 /*
2040                  * (m) has been removed from its queue and spinlocked
2041                  */
2042                 if (vm_page_busy_try(m, TRUE)) {
2043                         _vm_page_deactivate_locked(m, 0);
2044                         vm_page_spin_unlock(m);
2045                 } else {
2046                         /*
2047                          * We successfully busied the page
2048                          */
2049                         if ((m->flags & (PG_UNMANAGED | PG_NEED_COMMIT)) == 0 &&
2050                             m->hold_count == 0 &&
2051                             m->wire_count == 0 &&
2052                             (m->dirty & m->valid) == 0) {
2053                                 vm_page_spin_unlock(m);
2054                                 pagedaemon_wakeup();
2055                                 return(m);
2056                         }
2057
2058                         /*
2059                          * The page cannot be recycled, deactivate it.
2060                          */
2061                         _vm_page_deactivate_locked(m, 0);
2062                         if (_vm_page_wakeup(m)) {
2063                                 vm_page_spin_unlock(m);
2064                                 wakeup(m);
2065                         } else {
2066                                 vm_page_spin_unlock(m);
2067                         }
2068                 }
2069         }
2070         return (m);
2071 }
2072
2073 /*
2074  * Find a free page.  We attempt to inline the nominal case and fall back
2075  * to _vm_page_select_free() otherwise.  A busied page is removed from
2076  * the queue and returned.
2077  *
2078  * This routine may not block.
2079  */
2080 static __inline vm_page_t
2081 vm_page_select_free(u_short pg_color)
2082 {
2083         vm_page_t m;
2084
2085         for (;;) {
2086                 m = _vm_page_list_find(PQ_FREE, pg_color);
2087                 if (m == NULL)
2088                         break;
2089                 if (vm_page_busy_try(m, TRUE)) {
2090                         /*
2091                          * Various mechanisms such as a pmap_collect can
2092                          * result in a busy page on the free queue.  We
2093                          * have to move the page out of the way so we can
2094                          * retry the allocation.  If the other thread is not
2095                          * allocating the page then m->valid will remain 0 and
2096                          * the pageout daemon will free the page later on.
2097                          *
2098                          * Since we could not busy the page, however, we
2099                          * cannot make assumptions as to whether the page
2100                          * will be allocated by the other thread or not,
2101                          * so all we can do is deactivate it to move it out
2102                          * of the way.  In particular, if the other thread
2103                          * wires the page it may wind up on the inactive
2104                          * queue and the pageout daemon will have to deal
2105                          * with that case too.
2106                          */
2107                         _vm_page_deactivate_locked(m, 0);
2108                         vm_page_spin_unlock(m);
2109                 } else {
2110                         /*
2111                          * Theoretically if we are able to busy the page
2112                          * atomic with the queue removal (using the vm_page
2113                          * lock) nobody else should have been able to mess
2114                          * with the page before us.
2115                          *
2116                          * Assert the page state.  Note that even though
2117                          * wiring doesn't adjust queues, a page on the free
2118                          * queue should never be wired at this point.
2119                          */
2120                         KKASSERT((m->flags & (PG_UNMANAGED |
2121                                               PG_NEED_COMMIT)) == 0);
2122                         KASSERT(m->hold_count == 0,
2123                                 ("m->hold_count is not zero "
2124                                  "pg %p q=%d flags=%08x hold=%d wire=%d",
2125                                  m, m->queue, m->flags,
2126                                  m->hold_count, m->wire_count));
2127                         KKASSERT(m->wire_count == 0);
2128                         vm_page_spin_unlock(m);
2129                         pagedaemon_wakeup();
2130
2131                         /* return busied and removed page */
2132                         return(m);
2133                 }
2134         }
2135         return(m);
2136 }
2137
2138 /*
2139  * vm_page_alloc()
2140  *
2141  * Allocate and return a memory cell associated with this VM object/offset
2142  * pair.  If object is NULL an unassociated page will be allocated.
2143  *
2144  * The returned page will be busied and removed from its queues.  This
2145  * routine can block and may return NULL if a race occurs and the page
2146  * is found to already exist at the specified (object, pindex).
2147  *
2148  *      VM_ALLOC_NORMAL         allow use of cache pages, nominal free drain
2149  *      VM_ALLOC_QUICK          like normal but cannot use cache
2150  *      VM_ALLOC_SYSTEM         greater free drain
2151  *      VM_ALLOC_INTERRUPT      allow free list to be completely drained
2152  *      VM_ALLOC_ZERO           advisory request for pre-zero'd page only
2153  *      VM_ALLOC_FORCE_ZERO     advisory request for pre-zero'd page only
2154  *      VM_ALLOC_NULL_OK        ok to return NULL on insertion collision
2155  *                              (see vm_page_grab())
2156  *      VM_ALLOC_USE_GD         ok to use per-gd cache
2157  *
2158  *      VM_ALLOC_CPU(n)         allocate using specified cpu localization
2159  *
2160  * The object must be held if not NULL
2161  * This routine may not block
2162  *
2163  * Additional special handling is required when called from an interrupt
2164  * (VM_ALLOC_INTERRUPT).  We are not allowed to mess with the page cache
2165  * in this case.
2166  */
2167 vm_page_t
2168 vm_page_alloc(vm_object_t object, vm_pindex_t pindex, int page_req)
2169 {
2170         globaldata_t gd;
2171         vm_object_t obj;
2172         vm_page_t m;
2173         u_short pg_color;
2174         int cpuid_local;
2175
2176 #if 0
2177         /*
2178          * Special per-cpu free VM page cache.  The pages are pre-busied
2179          * and pre-zerod for us.
2180          */
2181         if (gd->gd_vmpg_count && (page_req & VM_ALLOC_USE_GD)) {
2182                 crit_enter_gd(gd);
2183                 if (gd->gd_vmpg_count) {
2184                         m = gd->gd_vmpg_array[--gd->gd_vmpg_count];
2185                         crit_exit_gd(gd);
2186                         goto done;
2187                 }
2188                 crit_exit_gd(gd);
2189         }
2190 #endif
2191         m = NULL;
2192
2193         /*
2194          * CPU LOCALIZATION
2195          *
2196          * CPU localization algorithm.  Break the page queues up by physical
2197          * id and core id (note that two cpu threads will have the same core
2198          * id, and core_id != gd_cpuid).
2199          *
2200          * This is nowhere near perfect, for example the last pindex in a
2201          * subgroup will overflow into the next cpu or package.  But this
2202          * should get us good page reuse locality in heavy mixed loads.
2203          *
2204          * (may be executed before the APs are started, so other GDs might
2205          *  not exist!)
2206          */
2207         if (page_req & VM_ALLOC_CPU_SPEC)
2208                 cpuid_local = VM_ALLOC_GETCPU(page_req);
2209         else
2210                 cpuid_local = mycpu->gd_cpuid;
2211
2212         pg_color = vm_get_pg_color(cpuid_local, object, pindex);
2213
2214         KKASSERT(page_req & 
2215                 (VM_ALLOC_NORMAL|VM_ALLOC_QUICK|
2216                  VM_ALLOC_INTERRUPT|VM_ALLOC_SYSTEM));
2217
2218         /*
2219          * Certain system threads (pageout daemon, buf_daemon's) are
2220          * allowed to eat deeper into the free page list.
2221          */
2222         if (curthread->td_flags & TDF_SYSTHREAD)
2223                 page_req |= VM_ALLOC_SYSTEM;
2224
2225         /*
2226          * Impose various limitations.  Note that the v_free_reserved test
2227          * must match the opposite of vm_page_count_target() to avoid
2228          * livelocks, be careful.
2229          */
2230 loop:
2231         gd = mycpu;
2232         if (gd->gd_vmstats.v_free_count >= gd->gd_vmstats.v_free_reserved ||
2233             ((page_req & VM_ALLOC_INTERRUPT) &&
2234              gd->gd_vmstats.v_free_count > 0) ||
2235             ((page_req & VM_ALLOC_SYSTEM) &&
2236              gd->gd_vmstats.v_cache_count == 0 &&
2237                 gd->gd_vmstats.v_free_count >
2238                 gd->gd_vmstats.v_interrupt_free_min)
2239         ) {
2240                 /*
2241                  * The free queue has sufficient free pages to take one out.
2242                  */
2243                 m = vm_page_select_free(pg_color);
2244         } else if (page_req & VM_ALLOC_NORMAL) {
2245                 /*
2246                  * Allocatable from the cache (non-interrupt only).  On
2247                  * success, we must free the page and try again, thus
2248                  * ensuring that vmstats.v_*_free_min counters are replenished.
2249                  */
2250 #ifdef INVARIANTS
2251                 if (curthread->td_preempted) {
2252                         kprintf("vm_page_alloc(): warning, attempt to allocate"
2253                                 " cache page from preempting interrupt\n");
2254                         m = NULL;
2255                 } else {
2256                         m = vm_page_select_cache(pg_color);
2257                 }
2258 #else
2259                 m = vm_page_select_cache(pg_color);
2260 #endif
2261                 /*
2262                  * On success move the page into the free queue and loop.
2263                  *
2264                  * Only do this if we can safely acquire the vm_object lock,
2265                  * because this is effectively a random page and the caller
2266                  * might be holding the lock shared, we don't want to
2267                  * deadlock.
2268                  */
2269                 if (m != NULL) {
2270                         KASSERT(m->dirty == 0,
2271                                 ("Found dirty cache page %p", m));
2272                         if ((obj = m->object) != NULL) {
2273                                 if (vm_object_hold_try(obj)) {
2274                                         vm_page_protect(m, VM_PROT_NONE);
2275                                         vm_page_free(m);
2276                                         /* m->object NULL here */
2277                                         vm_object_drop(obj);
2278                                 } else {
2279                                         vm_page_deactivate(m);
2280                                         vm_page_wakeup(m);
2281                                 }
2282                         } else {
2283                                 vm_page_protect(m, VM_PROT_NONE);
2284                                 vm_page_free(m);
2285                         }
2286                         goto loop;
2287                 }
2288
2289                 /*
2290                  * On failure return NULL
2291                  */
2292                 atomic_add_int(&vm_pageout_deficit, 1);
2293                 pagedaemon_wakeup();
2294                 return (NULL);
2295         } else {
2296                 /*
2297                  * No pages available, wakeup the pageout daemon and give up.
2298                  */
2299                 atomic_add_int(&vm_pageout_deficit, 1);
2300                 pagedaemon_wakeup();
2301                 return (NULL);
2302         }
2303
2304         /*
2305          * v_free_count can race so loop if we don't find the expected
2306          * page.
2307          */
2308         if (m == NULL) {
2309                 vmstats_rollup();
2310                 goto loop;
2311         }
2312
2313         /*
2314          * Good page found.  The page has already been busied for us and
2315          * removed from its queues.
2316          */
2317         KASSERT(m->dirty == 0,
2318                 ("vm_page_alloc: free/cache page %p was dirty", m));
2319         KKASSERT(m->queue == PQ_NONE);
2320
2321 #if 0
2322 done:
2323 #endif
2324         /*
2325          * Initialize the structure, inheriting some flags but clearing
2326          * all the rest.  The page has already been busied for us.
2327          */
2328         vm_page_flag_clear(m, ~PG_KEEP_NEWPAGE_MASK);
2329
2330         KKASSERT(m->wire_count == 0);
2331         KKASSERT((m->busy_count & PBUSY_MASK) == 0);
2332         m->act_count = 0;
2333         m->valid = 0;
2334
2335         /*
2336          * Caller must be holding the object lock (asserted by
2337          * vm_page_insert()).
2338          *
2339          * NOTE: Inserting a page here does not insert it into any pmaps
2340          *       (which could cause us to block allocating memory).
2341          *
2342          * NOTE: If no object an unassociated page is allocated, m->pindex
2343          *       can be used by the caller for any purpose.
2344          */
2345         if (object) {
2346                 if (vm_page_insert(m, object, pindex) == FALSE) {
2347                         vm_page_free(m);
2348                         if ((page_req & VM_ALLOC_NULL_OK) == 0)
2349                                 panic("PAGE RACE %p[%ld]/%p",
2350                                       object, (long)pindex, m);
2351                         m = NULL;
2352                 }
2353         } else {
2354                 m->pindex = pindex;
2355         }
2356
2357         /*
2358          * Don't wakeup too often - wakeup the pageout daemon when
2359          * we would be nearly out of memory.
2360          */
2361         pagedaemon_wakeup();
2362
2363         /*
2364          * A BUSY page is returned.
2365          */
2366         return (m);
2367 }
2368
2369 /*
2370  * Returns number of pages available in our DMA memory reserve
2371  * (adjusted with vm.dma_reserved=<value>m in /boot/loader.conf)
2372  */
2373 vm_size_t
2374 vm_contig_avail_pages(void)
2375 {
2376         alist_blk_t blk;
2377         alist_blk_t count;
2378         alist_blk_t bfree;
2379         spin_lock(&vm_contig_spin);
2380         bfree = alist_free_info(&vm_contig_alist, &blk, &count);
2381         spin_unlock(&vm_contig_spin);
2382
2383         return bfree;
2384 }
2385
2386 /*
2387  * Attempt to allocate contiguous physical memory with the specified
2388  * requirements.
2389  */
2390 vm_page_t
2391 vm_page_alloc_contig(vm_paddr_t low, vm_paddr_t high,
2392                      unsigned long alignment, unsigned long boundary,
2393                      unsigned long size, vm_memattr_t memattr)
2394 {
2395         alist_blk_t blk;
2396         vm_page_t m;
2397         vm_pindex_t i;
2398 #if 0
2399         static vm_pindex_t contig_rover;
2400 #endif
2401
2402         alignment >>= PAGE_SHIFT;
2403         if (alignment == 0)
2404                 alignment = 1;
2405         boundary >>= PAGE_SHIFT;
2406         if (boundary == 0)
2407                 boundary = 1;
2408         size = (size + PAGE_MASK) >> PAGE_SHIFT;
2409
2410 #if 0
2411         /*
2412          * Disabled temporarily until we find a solution for DRM (a flag
2413          * to always use the free space reserve, for performance).
2414          */
2415         if (high == BUS_SPACE_MAXADDR && alignment <= PAGE_SIZE &&
2416             boundary <= PAGE_SIZE && size == 1 &&
2417             memattr == VM_MEMATTR_DEFAULT) {
2418                 /*
2419                  * Any page will work, use vm_page_alloc()
2420                  * (e.g. when used from kmem_alloc_attr())
2421                  */
2422                 m = vm_page_alloc(NULL, (contig_rover++) & 0x7FFFFFFF,
2423                                   VM_ALLOC_NORMAL | VM_ALLOC_SYSTEM |
2424                                   VM_ALLOC_INTERRUPT);
2425                 m->valid = VM_PAGE_BITS_ALL;
2426                 vm_page_wire(m);
2427                 vm_page_wakeup(m);
2428         } else
2429 #endif
2430         {
2431                 /*
2432                  * Use the low-memory dma reserve
2433                  */
2434                 spin_lock(&vm_contig_spin);
2435                 blk = alist_alloc(&vm_contig_alist, 0, size);
2436                 if (blk == ALIST_BLOCK_NONE) {
2437                         spin_unlock(&vm_contig_spin);
2438                         if (bootverbose) {
2439                                 kprintf("vm_page_alloc_contig: %ldk nospace\n",
2440                                         (size << PAGE_SHIFT) / 1024);
2441                                 print_backtrace(5);
2442                         }
2443                         return(NULL);
2444                 }
2445                 if (high && ((vm_paddr_t)(blk + size) << PAGE_SHIFT) > high) {
2446                         alist_free(&vm_contig_alist, blk, size);
2447                         spin_unlock(&vm_contig_spin);
2448                         if (bootverbose) {
2449                                 kprintf("vm_page_alloc_contig: %ldk high "
2450                                         "%016jx failed\n",
2451                                         (size << PAGE_SHIFT) / 1024,
2452                                         (intmax_t)high);
2453                         }
2454                         return(NULL);
2455                 }
2456                 spin_unlock(&vm_contig_spin);
2457                 m = PHYS_TO_VM_PAGE((vm_paddr_t)blk << PAGE_SHIFT);
2458         }
2459         if (vm_contig_verbose) {
2460                 kprintf("vm_page_alloc_contig: %016jx/%ldk "
2461                         "(%016jx-%016jx al=%lu bo=%lu pgs=%lu attr=%d\n",
2462                         (intmax_t)m->phys_addr,
2463                         (size << PAGE_SHIFT) / 1024,
2464                         low, high, alignment, boundary, size, memattr);
2465         }
2466         if (memattr != VM_MEMATTR_DEFAULT) {
2467                 for (i = 0;i < size; i++)
2468                         pmap_page_set_memattr(&m[i], memattr);
2469         }
2470         return m;
2471 }
2472
2473 /*
2474  * Free contiguously allocated pages.  The pages will be wired but not busy.
2475  * When freeing to the alist we leave them wired and not busy.
2476  */
2477 void
2478 vm_page_free_contig(vm_page_t m, unsigned long size)
2479 {
2480         vm_paddr_t pa = VM_PAGE_TO_PHYS(m);
2481         vm_pindex_t start = pa >> PAGE_SHIFT;
2482         vm_pindex_t pages = (size + PAGE_MASK) >> PAGE_SHIFT;
2483
2484         if (vm_contig_verbose) {
2485                 kprintf("vm_page_free_contig:  %016jx/%ldk\n",
2486                         (intmax_t)pa, size / 1024);
2487         }
2488         if (pa < vm_low_phys_reserved) {
2489                 KKASSERT(pa + size <= vm_low_phys_reserved);
2490                 spin_lock(&vm_contig_spin);
2491                 alist_free(&vm_contig_alist, start, pages);
2492                 spin_unlock(&vm_contig_spin);
2493         } else {
2494                 while (pages) {
2495                         vm_page_busy_wait(m, FALSE, "cpgfr");
2496                         vm_page_unwire(m, 0);
2497                         vm_page_free(m);
2498                         --pages;
2499                         ++m;
2500                 }
2501
2502         }
2503 }
2504
2505
2506 /*
2507  * Wait for sufficient free memory for nominal heavy memory use kernel
2508  * operations.
2509  *
2510  * WARNING!  Be sure never to call this in any vm_pageout code path, which
2511  *           will trivially deadlock the system.
2512  */
2513 void
2514 vm_wait_nominal(void)
2515 {
2516         while (vm_page_count_min(0))
2517                 vm_wait(0);
2518 }
2519
2520 /*
2521  * Test if vm_wait_nominal() would block.
2522  */
2523 int
2524 vm_test_nominal(void)
2525 {
2526         if (vm_page_count_min(0))
2527                 return(1);
2528         return(0);
2529 }
2530
2531 /*
2532  * Block until free pages are available for allocation, called in various
2533  * places before memory allocations.
2534  *
2535  * The caller may loop if vm_page_count_min() == FALSE so we cannot be
2536  * more generous then that.
2537  */
2538 void
2539 vm_wait(int timo)
2540 {
2541         /*
2542          * never wait forever
2543          */
2544         if (timo == 0)
2545                 timo = hz;
2546         lwkt_gettoken(&vm_token);
2547
2548         if (curthread == pagethread ||
2549             curthread == emergpager) {
2550                 /*
2551                  * The pageout daemon itself needs pages, this is bad.
2552                  */
2553                 if (vm_page_count_min(0)) {
2554                         vm_pageout_pages_needed = 1;
2555                         tsleep(&vm_pageout_pages_needed, 0, "VMWait", timo);
2556                 }
2557         } else {
2558                 /*
2559                  * Wakeup the pageout daemon if necessary and wait.
2560                  *
2561                  * Do not wait indefinitely for the target to be reached,
2562                  * as load might prevent it from being reached any time soon.
2563                  * But wait a little to try to slow down page allocations
2564                  * and to give more important threads (the pagedaemon)
2565                  * allocation priority.
2566                  */
2567                 if (vm_page_count_target()) {
2568                         if (vm_pages_needed == 0) {
2569                                 vm_pages_needed = 1;
2570                                 wakeup(&vm_pages_needed);
2571                         }
2572                         ++vm_pages_waiting;     /* SMP race ok */
2573                         tsleep(&vmstats.v_free_count, 0, "vmwait", timo);
2574                 }
2575         }
2576         lwkt_reltoken(&vm_token);
2577 }
2578
2579 /*
2580  * Block until free pages are available for allocation
2581  *
2582  * Called only from vm_fault so that processes page faulting can be
2583  * easily tracked.
2584  */
2585 void
2586 vm_wait_pfault(void)
2587 {
2588         /*
2589          * Wakeup the pageout daemon if necessary and wait.
2590          *
2591          * Do not wait indefinitely for the target to be reached,
2592          * as load might prevent it from being reached any time soon.
2593          * But wait a little to try to slow down page allocations
2594          * and to give more important threads (the pagedaemon)
2595          * allocation priority.
2596          */
2597         if (vm_page_count_min(0)) {
2598                 lwkt_gettoken(&vm_token);
2599                 while (vm_page_count_severe()) {
2600                         if (vm_page_count_target()) {
2601                                 thread_t td;
2602
2603                                 if (vm_pages_needed == 0) {
2604                                         vm_pages_needed = 1;
2605                                         wakeup(&vm_pages_needed);
2606                                 }
2607                                 ++vm_pages_waiting;     /* SMP race ok */
2608                                 tsleep(&vmstats.v_free_count, 0, "pfault", hz);
2609
2610                                 /*
2611                                  * Do not stay stuck in the loop if the system is trying
2612                                  * to kill the process.
2613                                  */
2614                                 td = curthread;
2615                                 if (td->td_proc && (td->td_proc->p_flags & P_LOWMEMKILL))
2616                                         break;
2617                         }
2618                 }
2619                 lwkt_reltoken(&vm_token);
2620         }
2621 }
2622
2623 /*
2624  * Put the specified page on the active list (if appropriate).  Ensure
2625  * that act_count is at least ACT_INIT but do not otherwise mess with it.
2626  *
2627  * The caller should be holding the page busied ? XXX
2628  * This routine may not block.
2629  */
2630 void
2631 vm_page_activate(vm_page_t m)
2632 {
2633         u_short oqueue;
2634
2635         vm_page_spin_lock(m);
2636         if (m->queue - m->pc != PQ_ACTIVE && !(m->flags & PG_FICTITIOUS)) {
2637                 _vm_page_queue_spin_lock(m);
2638                 oqueue = _vm_page_rem_queue_spinlocked(m);
2639                 /* page is left spinlocked, queue is unlocked */
2640
2641                 if (oqueue == PQ_CACHE)
2642                         mycpu->gd_cnt.v_reactivated++;
2643                 if ((m->flags & PG_UNMANAGED) == 0) {
2644                         if (m->act_count < ACT_INIT)
2645                                 m->act_count = ACT_INIT;
2646                         _vm_page_add_queue_spinlocked(m, PQ_ACTIVE + m->pc, 0);
2647                 }
2648                 _vm_page_and_queue_spin_unlock(m);
2649                 if (oqueue == PQ_CACHE || oqueue == PQ_FREE)
2650                         pagedaemon_wakeup();
2651         } else {
2652                 if (m->act_count < ACT_INIT)
2653                         m->act_count = ACT_INIT;
2654                 vm_page_spin_unlock(m);
2655         }
2656 }
2657
2658 void
2659 vm_page_soft_activate(vm_page_t m)
2660 {
2661         if (m->queue - m->pc == PQ_ACTIVE || (m->flags & PG_FICTITIOUS)) {
2662                 if (m->act_count < ACT_INIT)
2663                         m->act_count = ACT_INIT;
2664         } else {
2665                 vm_page_activate(m);
2666         }
2667 }
2668
2669 /*
2670  * Helper routine for vm_page_free_toq() and vm_page_cache().  This
2671  * routine is called when a page has been added to the cache or free
2672  * queues.
2673  *
2674  * This routine may not block.
2675  */
2676 static __inline void
2677 vm_page_free_wakeup(void)
2678 {
2679         globaldata_t gd = mycpu;
2680
2681         /*
2682          * If the pageout daemon itself needs pages, then tell it that
2683          * there are some free.
2684          */
2685         if (vm_pageout_pages_needed &&
2686             gd->gd_vmstats.v_cache_count + gd->gd_vmstats.v_free_count >=
2687             gd->gd_vmstats.v_pageout_free_min
2688         ) {
2689                 vm_pageout_pages_needed = 0;
2690                 wakeup(&vm_pageout_pages_needed);
2691         }
2692
2693         /*
2694          * Wakeup processes that are waiting on memory.
2695          *
2696          * Generally speaking we want to wakeup stuck processes as soon as
2697          * possible.  !vm_page_count_min(0) is the absolute minimum point
2698          * where we can do this.  Wait a bit longer to reduce degenerate
2699          * re-blocking (vm_page_free_hysteresis).  The target check is just
2700          * to make sure the min-check w/hysteresis does not exceed the
2701          * normal target.
2702          */
2703         if (vm_pages_waiting) {
2704                 if (!vm_page_count_min(vm_page_free_hysteresis) ||
2705                     !vm_page_count_target()) {
2706                         vm_pages_waiting = 0;
2707                         wakeup(&vmstats.v_free_count);
2708                         ++mycpu->gd_cnt.v_ppwakeups;
2709                 }
2710 #if 0
2711                 if (!vm_page_count_target()) {
2712                         /*
2713                          * Plenty of pages are free, wakeup everyone.
2714                          */
2715                         vm_pages_waiting = 0;
2716                         wakeup(&vmstats.v_free_count);
2717                         ++mycpu->gd_cnt.v_ppwakeups;
2718                 } else if (!vm_page_count_min(0)) {
2719                         /*
2720                          * Some pages are free, wakeup someone.
2721                          */
2722                         int wcount = vm_pages_waiting;
2723                         if (wcount > 0)
2724                                 --wcount;
2725                         vm_pages_waiting = wcount;
2726                         wakeup_one(&vmstats.v_free_count);
2727                         ++mycpu->gd_cnt.v_ppwakeups;
2728                 }
2729 #endif
2730         }
2731 }
2732
2733 /*
2734  * Returns the given page to the PQ_FREE or PQ_HOLD list and disassociates
2735  * it from its VM object.
2736  *
2737  * The vm_page must be BUSY on entry.  BUSY will be released on
2738  * return (the page will have been freed).
2739  */
2740 void
2741 vm_page_free_toq(vm_page_t m)
2742 {
2743         mycpu->gd_cnt.v_tfree++;
2744         if (m->flags & (PG_MAPPED | PG_WRITEABLE))
2745                 pmap_mapped_sync(m);
2746         KKASSERT((m->flags & PG_MAPPED) == 0);
2747         KKASSERT(m->busy_count & PBUSY_LOCKED);
2748
2749         if ((m->busy_count & PBUSY_MASK) || ((m->queue - m->pc) == PQ_FREE)) {
2750                 kprintf("vm_page_free: pindex(%lu), busy %08x, "
2751                         "hold(%d)\n",
2752                         (u_long)m->pindex, m->busy_count, m->hold_count);
2753                 if ((m->queue - m->pc) == PQ_FREE)
2754                         panic("vm_page_free: freeing free page");
2755                 else
2756                         panic("vm_page_free: freeing busy page");
2757         }
2758
2759         /*
2760          * Remove from object, spinlock the page and its queues and
2761          * remove from any queue.  No queue spinlock will be held
2762          * after this section (because the page was removed from any
2763          * queue).
2764          */
2765         vm_page_remove(m);
2766
2767         /*
2768          * No further management of fictitious pages occurs beyond object
2769          * and queue removal.
2770          */
2771         if ((m->flags & PG_FICTITIOUS) != 0) {
2772                 KKASSERT(m->queue == PQ_NONE);
2773                 vm_page_wakeup(m);
2774                 return;
2775         }
2776         vm_page_and_queue_spin_lock(m);
2777         _vm_page_rem_queue_spinlocked(m);
2778
2779         m->valid = 0;
2780         vm_page_undirty(m);
2781
2782         if (m->wire_count != 0) {
2783                 if (m->wire_count > 1) {
2784                     panic(
2785                         "vm_page_free: invalid wire count (%d), pindex: 0x%lx",
2786                         m->wire_count, (long)m->pindex);
2787                 }
2788                 panic("vm_page_free: freeing wired page");
2789         }
2790
2791         /*
2792          * Clear the UNMANAGED flag when freeing an unmanaged page.
2793          * Clear the NEED_COMMIT flag
2794          */
2795         if (m->flags & PG_UNMANAGED)
2796                 vm_page_flag_clear(m, PG_UNMANAGED);
2797         if (m->flags & PG_NEED_COMMIT)
2798                 vm_page_flag_clear(m, PG_NEED_COMMIT);
2799
2800         if (m->hold_count != 0) {
2801                 _vm_page_add_queue_spinlocked(m, PQ_HOLD + m->pc, 0);
2802         } else {
2803                 _vm_page_add_queue_spinlocked(m, PQ_FREE + m->pc, 1);
2804         }
2805
2806         /*
2807          * This sequence allows us to clear BUSY while still holding
2808          * its spin lock, which reduces contention vs allocators.  We
2809          * must not leave the queue locked or _vm_page_wakeup() may
2810          * deadlock.
2811          */
2812         _vm_page_queue_spin_unlock(m);
2813         if (_vm_page_wakeup(m)) {
2814                 vm_page_spin_unlock(m);
2815                 wakeup(m);
2816         } else {
2817                 vm_page_spin_unlock(m);
2818         }
2819         vm_page_free_wakeup();
2820 }
2821
2822 /*
2823  * vm_page_unmanage()
2824  *
2825  * Prevent PV management from being done on the page.  The page is
2826  * also removed from the paging queues, and as a consequence of no longer
2827  * being managed the pageout daemon will not touch it (since there is no
2828  * way to locate the pte mappings for the page).  madvise() calls that
2829  * mess with the pmap will also no longer operate on the page.
2830  *
2831  * Beyond that the page is still reasonably 'normal'.  Freeing the page
2832  * will clear the flag.
2833  *
2834  * This routine is used by OBJT_PHYS objects - objects using unswappable
2835  * physical memory as backing store rather then swap-backed memory and
2836  * will eventually be extended to support 4MB unmanaged physical 
2837  * mappings.
2838  *
2839  * Caller must be holding the page busy.
2840  */
2841 void
2842 vm_page_unmanage(vm_page_t m)
2843 {
2844         KKASSERT(m->busy_count & PBUSY_LOCKED);
2845         if ((m->flags & PG_UNMANAGED) == 0) {
2846                 vm_page_unqueue(m);
2847         }
2848         vm_page_flag_set(m, PG_UNMANAGED);
2849 }
2850
2851 /*
2852  * Mark this page as wired down by yet another map.  We do not adjust the
2853  * queue the page is on, it will be checked for wiring as-needed.
2854  *
2855  * Caller must be holding the page busy.
2856  */
2857 void
2858 vm_page_wire(vm_page_t m)
2859 {
2860         /*
2861          * Only bump the wire statistics if the page is not already wired,
2862          * and only unqueue the page if it is on some queue (if it is unmanaged
2863          * it is already off the queues).  Don't do anything with fictitious
2864          * pages because they are always wired.
2865          */
2866         KKASSERT(m->busy_count & PBUSY_LOCKED);
2867         if ((m->flags & PG_FICTITIOUS) == 0) {
2868                 if (atomic_fetchadd_int(&m->wire_count, 1) == 0) {
2869                         atomic_add_long(&mycpu->gd_vmstats_adj.v_wire_count, 1);
2870                 }
2871                 KASSERT(m->wire_count != 0,
2872                         ("vm_page_wire: wire_count overflow m=%p", m));
2873         }
2874 }
2875
2876 /*
2877  * Release one wiring of this page, potentially enabling it to be paged again.
2878  *
2879  * Note that wired pages are no longer unconditionally removed from the
2880  * paging queues, so the page may already be on a queue.  Move the page
2881  * to the desired queue if necessary.
2882  *
2883  * Many pages placed on the inactive queue should actually go
2884  * into the cache, but it is difficult to figure out which.  What
2885  * we do instead, if the inactive target is well met, is to put
2886  * clean pages at the head of the inactive queue instead of the tail.
2887  * This will cause them to be moved to the cache more quickly and
2888  * if not actively re-referenced, freed more quickly.  If we just
2889  * stick these pages at the end of the inactive queue, heavy filesystem
2890  * meta-data accesses can cause an unnecessary paging load on memory bound 
2891  * processes.  This optimization causes one-time-use metadata to be
2892  * reused more quickly.
2893  *
2894  * Pages marked PG_NEED_COMMIT are always activated and never placed on
2895  * the inactive queue.  This helps the pageout daemon determine memory
2896  * pressure and act on out-of-memory situations more quickly.
2897  *
2898  * BUT, if we are in a low-memory situation we have no choice but to
2899  * put clean pages on the cache queue.
2900  *
2901  * A number of routines use vm_page_unwire() to guarantee that the page
2902  * will go into either the inactive or active queues, and will NEVER
2903  * be placed in the cache - for example, just after dirtying a page.
2904  * dirty pages in the cache are not allowed.
2905  *
2906  * This routine may not block.
2907  */
2908 void
2909 vm_page_unwire(vm_page_t m, int activate)
2910 {
2911         KKASSERT(m->busy_count & PBUSY_LOCKED);
2912         if (m->flags & PG_FICTITIOUS) {
2913                 /* do nothing */
2914         } else if ((int)m->wire_count <= 0) {
2915                 panic("vm_page_unwire: invalid wire count: %d", m->wire_count);
2916         } else {
2917                 if (atomic_fetchadd_int(&m->wire_count, -1) == 1) {
2918                         atomic_add_long(&mycpu->gd_vmstats_adj.v_wire_count,-1);
2919                         if (m->flags & PG_UNMANAGED) {
2920                                 ;
2921                         } else if (activate || (m->flags & PG_NEED_COMMIT)) {
2922                                 vm_page_activate(m);
2923                         } else {
2924                                 vm_page_deactivate(m);
2925                         }
2926                 }
2927         }
2928 }
2929
2930 /*
2931  * Move the specified page to the inactive queue.
2932  *
2933  * Normally athead is 0 resulting in LRU operation.  athead is set
2934  * to 1 if we want this page to be 'as if it were placed in the cache',
2935  * except without unmapping it from the process address space.
2936  *
2937  * vm_page's spinlock must be held on entry and will remain held on return.
2938  * This routine may not block.  The caller does not have to hold the page
2939  * busied but should have some sort of interlock on its validity.
2940  */
2941 static void
2942 _vm_page_deactivate_locked(vm_page_t m, int athead)
2943 {
2944         u_short oqueue;
2945
2946         /*
2947          * Ignore if already inactive.
2948          */
2949         if (m->queue - m->pc == PQ_INACTIVE || (m->flags & PG_FICTITIOUS))
2950                 return;
2951         _vm_page_queue_spin_lock(m);
2952         oqueue = _vm_page_rem_queue_spinlocked(m);
2953
2954         if ((m->flags & PG_UNMANAGED) == 0) {
2955                 if (oqueue == PQ_CACHE)
2956                         mycpu->gd_cnt.v_reactivated++;
2957                 vm_page_flag_clear(m, PG_WINATCFLS);
2958                 _vm_page_add_queue_spinlocked(m, PQ_INACTIVE + m->pc, athead);
2959                 if (athead == 0) {
2960                         atomic_add_long(
2961                                 &vm_page_queues[PQ_INACTIVE + m->pc].adds, 1);
2962                 }
2963         }
2964         /* NOTE: PQ_NONE if condition not taken */
2965         _vm_page_queue_spin_unlock(m);
2966         /* leaves vm_page spinlocked */
2967 }
2968
2969 /*
2970  * Attempt to deactivate a page.
2971  *
2972  * No requirements.
2973  */
2974 void
2975 vm_page_deactivate(vm_page_t m)
2976 {
2977         vm_page_spin_lock(m);
2978         _vm_page_deactivate_locked(m, 0);
2979         vm_page_spin_unlock(m);
2980 }
2981
2982 void
2983 vm_page_deactivate_locked(vm_page_t m)
2984 {
2985         _vm_page_deactivate_locked(m, 0);
2986 }
2987
2988 /*
2989  * Attempt to move a busied page to PQ_CACHE, then unconditionally unbusy it.
2990  *
2991  * This function returns non-zero if it successfully moved the page to
2992  * PQ_CACHE.
2993  *
2994  * This function unconditionally unbusies the page on return.
2995  */
2996 int
2997 vm_page_try_to_cache(vm_page_t m)
2998 {
2999         /*
3000          * Shortcut if we obviously cannot move the page, or if the
3001          * page is already on the cache queue, or it is ficitious.
3002          */
3003         if (m->dirty || m->hold_count || m->wire_count ||
3004             m->queue - m->pc == PQ_CACHE ||
3005             (m->flags & (PG_UNMANAGED | PG_NEED_COMMIT | PG_FICTITIOUS))) {
3006                 vm_page_wakeup(m);
3007                 return(0);
3008         }
3009
3010         /*
3011          * Page busied by us and no longer spinlocked.  Dirty pages cannot
3012          * be moved to the cache.
3013          */
3014         vm_page_test_dirty(m);
3015         if (m->dirty || (m->flags & PG_NEED_COMMIT)) {
3016                 vm_page_wakeup(m);
3017                 return(0);
3018         }
3019         vm_page_cache(m);
3020         return(1);
3021 }
3022
3023 /*
3024  * Attempt to free the page.  If we cannot free it, we do nothing.
3025  * 1 is returned on success, 0 on failure.
3026  *
3027  * Caller provides an unlocked/non-busied page.
3028  * No requirements.
3029  */
3030 int
3031 vm_page_try_to_free(vm_page_t m)
3032 {
3033         if (vm_page_busy_try(m, TRUE))
3034                 return(0);
3035
3036         /*
3037          * The page can be in any state, including already being on the free
3038          * queue.  Check to see if it really can be freed.
3039          */
3040         if (m->dirty ||                         /* can't free if it is dirty */
3041             m->hold_count ||                    /* or held (XXX may be wrong) */
3042             m->wire_count ||                    /* or wired */
3043             (m->flags & (PG_UNMANAGED |         /* or unmanaged */
3044                          PG_NEED_COMMIT |       /* or needs a commit */
3045                          PG_FICTITIOUS)) ||     /* or is fictitious */
3046             m->queue - m->pc == PQ_FREE ||      /* already on PQ_FREE */
3047             m->queue - m->pc == PQ_HOLD) {      /* already on PQ_HOLD */
3048                 vm_page_wakeup(m);
3049                 return(0);
3050         }
3051
3052         /*
3053          * We can probably free the page.
3054          *
3055          * Page busied by us and no longer spinlocked.  Dirty pages will
3056          * not be freed by this function.    We have to re-test the
3057          * dirty bit after cleaning out the pmaps.
3058          */
3059         vm_page_test_dirty(m);
3060         if (m->dirty || (m->flags & PG_NEED_COMMIT)) {
3061                 vm_page_wakeup(m);
3062                 return(0);
3063         }
3064         vm_page_protect(m, VM_PROT_NONE);
3065         if (m->dirty || (m->flags & PG_NEED_COMMIT)) {
3066                 vm_page_wakeup(m);
3067                 return(0);
3068         }
3069         vm_page_free(m);
3070         return(1);
3071 }
3072
3073 /*
3074  * vm_page_cache
3075  *
3076  * Put the specified page onto the page cache queue (if appropriate).
3077  *
3078  * The page must be busy, and this routine will release the busy and
3079  * possibly even free the page.
3080  */
3081 void
3082 vm_page_cache(vm_page_t m)
3083 {
3084         /*
3085          * Not suitable for the cache
3086          */
3087         if ((m->flags & (PG_UNMANAGED | PG_NEED_COMMIT | PG_FICTITIOUS)) ||
3088             (m->busy_count & PBUSY_MASK) ||
3089             m->wire_count || m->hold_count) {
3090                 vm_page_wakeup(m);
3091                 return;
3092         }
3093
3094         /*
3095          * Already in the cache (and thus not mapped)
3096          */
3097         if ((m->queue - m->pc) == PQ_CACHE) {
3098                 if (m->flags & (PG_MAPPED | PG_WRITEABLE))
3099                         pmap_mapped_sync(m);
3100                 KKASSERT((m->flags & PG_MAPPED) == 0);
3101                 vm_page_wakeup(m);
3102                 return;
3103         }
3104
3105 #if 0
3106         /*
3107          * REMOVED - it is possible for dirty to get set at any time as
3108          *           long as the page is still mapped and writeable.
3109          *
3110          * Caller is required to test m->dirty, but note that the act of
3111          * removing the page from its maps can cause it to become dirty
3112          * on an SMP system due to another cpu running in usermode.
3113          */
3114         if (m->dirty) {
3115                 panic("vm_page_cache: caching a dirty page, pindex: %ld",
3116                         (long)m->pindex);
3117         }
3118 #endif
3119
3120         /*
3121          * Remove all pmaps and indicate that the page is not
3122          * writeable or mapped.  Our vm_page_protect() call may
3123          * have blocked (especially w/ VM_PROT_NONE), so recheck
3124          * everything.
3125          */
3126         vm_page_protect(m, VM_PROT_NONE);
3127         pmap_mapped_sync(m);
3128         if ((m->flags & (PG_UNMANAGED | PG_MAPPED)) ||
3129             (m->busy_count & PBUSY_MASK) ||
3130             m->wire_count || m->hold_count) {
3131                 vm_page_wakeup(m);
3132         } else if (m->dirty || (m->flags & PG_NEED_COMMIT)) {
3133                 vm_page_deactivate(m);
3134                 vm_page_wakeup(m);
3135         } else {
3136                 _vm_page_and_queue_spin_lock(m);
3137                 _vm_page_rem_queue_spinlocked(m);
3138                 _vm_page_add_queue_spinlocked(m, PQ_CACHE + m->pc, 0);
3139                 _vm_page_and_queue_spin_unlock(m);
3140                 vm_page_wakeup(m);
3141                 vm_page_free_wakeup();
3142         }
3143 }
3144
3145 /*
3146  * vm_page_dontneed()
3147  *
3148  * Cache, deactivate, or do nothing as appropriate.  This routine
3149  * is typically used by madvise() MADV_DONTNEED.
3150  *
3151  * Generally speaking we want to move the page into the cache so
3152  * it gets reused quickly.  However, this can result in a silly syndrome
3153  * due to the page recycling too quickly.  Small objects will not be
3154  * fully cached.  On the otherhand, if we move the page to the inactive
3155  * queue we wind up with a problem whereby very large objects 
3156  * unnecessarily blow away our inactive and cache queues.
3157  *
3158  * The solution is to move the pages based on a fixed weighting.  We
3159  * either leave them alone, deactivate them, or move them to the cache,
3160  * where moving them to the cache has the highest weighting.
3161  * By forcing some pages into other queues we eventually force the
3162  * system to balance the queues, potentially recovering other unrelated
3163  * space from active.  The idea is to not force this to happen too
3164  * often.
3165  *
3166  * The page must be busied.
3167  */
3168 void
3169 vm_page_dontneed(vm_page_t m)
3170 {
3171         static int dnweight;
3172         int dnw;
3173         int head;
3174
3175         dnw = ++dnweight;
3176
3177         /*
3178          * occassionally leave the page alone
3179          */
3180         if ((dnw & 0x01F0) == 0 ||
3181             m->queue - m->pc == PQ_INACTIVE ||
3182             m->queue - m->pc == PQ_CACHE
3183         ) {
3184                 if (m->act_count >= ACT_INIT)
3185                         --m->act_count;
3186                 return;
3187         }
3188
3189         /*
3190          * If vm_page_dontneed() is inactivating a page, it must clear
3191          * the referenced flag; otherwise the pagedaemon will see references
3192          * on the page in the inactive queue and reactivate it. Until the 
3193          * page can move to the cache queue, madvise's job is not done.
3194          */
3195         vm_page_flag_clear(m, PG_REFERENCED);
3196         pmap_clear_reference(m);
3197
3198         if (m->dirty == 0)
3199                 vm_page_test_dirty(m);
3200
3201         if (m->dirty || (dnw & 0x0070) == 0) {
3202                 /*
3203                  * Deactivate the page 3 times out of 32.
3204                  */
3205                 head = 0;
3206         } else {
3207                 /*
3208                  * Cache the page 28 times out of every 32.  Note that
3209                  * the page is deactivated instead of cached, but placed
3210                  * at the head of the queue instead of the tail.
3211                  */
3212                 head = 1;
3213         }
3214         vm_page_spin_lock(m);
3215         _vm_page_deactivate_locked(m, head);
3216         vm_page_spin_unlock(m);
3217 }
3218
3219 /*
3220  * These routines manipulate the 'soft busy' count for a page.  A soft busy
3221  * is almost like a hard BUSY except that it allows certain compatible
3222  * operations to occur on the page while it is busy.  For example, a page
3223  * undergoing a write can still be mapped read-only.
3224  *
3225  * We also use soft-busy to quickly pmap_enter shared read-only pages
3226  * without having to hold the page locked.
3227  *
3228  * The soft-busy count can be > 1 in situations where multiple threads
3229  * are pmap_enter()ing the same page simultaneously, or when two buffer
3230  * cache buffers overlap the same page.
3231  *
3232  * The caller must hold the page BUSY when making these two calls.
3233  */
3234 void
3235 vm_page_io_start(vm_page_t m)
3236 {
3237         uint32_t ocount;
3238
3239         ocount = atomic_fetchadd_int(&m->busy_count, 1);
3240         KKASSERT(ocount & PBUSY_LOCKED);
3241 }
3242
3243 void
3244 vm_page_io_finish(vm_page_t m)
3245 {
3246         uint32_t ocount;
3247
3248         ocount = atomic_fetchadd_int(&m->busy_count, -1);
3249         KKASSERT(ocount & PBUSY_MASK);
3250 #if 0
3251         if (((ocount - 1) & (PBUSY_LOCKED | PBUSY_MASK)) == 0)
3252                 wakeup(m);
3253 #endif
3254 }
3255
3256 /*
3257  * Attempt to soft-busy a page.  The page must not be PBUSY_LOCKED.
3258  *
3259  * We can't use fetchadd here because we might race a hard-busy and the
3260  * page freeing code asserts on a non-zero soft-busy count (even if only
3261  * temporary).
3262  *
3263  * Returns 0 on success, non-zero on failure.
3264  */
3265 int
3266 vm_page_sbusy_try(vm_page_t m)
3267 {
3268         uint32_t ocount;
3269
3270         for (;;) {
3271                 ocount = m->busy_count;
3272                 cpu_ccfence();
3273                 if (ocount & PBUSY_LOCKED)
3274                         return 1;
3275                 if (atomic_cmpset_int(&m->busy_count, ocount, ocount + 1))
3276                         break;
3277         }
3278         return 0;
3279 #if 0
3280         if (m->busy_count & PBUSY_LOCKED)
3281                 return 1;
3282         ocount = atomic_fetchadd_int(&m->busy_count, 1);
3283         if (ocount & PBUSY_LOCKED) {
3284                 vm_page_sbusy_drop(m);
3285                 return 1;
3286         }
3287         return 0;
3288 #endif
3289 }
3290
3291 /*
3292  * Indicate that a clean VM page requires a filesystem commit and cannot
3293  * be reused.  Used by tmpfs.
3294  */
3295 void
3296 vm_page_need_commit(vm_page_t m)
3297 {
3298         vm_page_flag_set(m, PG_NEED_COMMIT);
3299         vm_object_set_writeable_dirty(m->object);
3300 }
3301
3302 void
3303 vm_page_clear_commit(vm_page_t m)
3304 {
3305         vm_page_flag_clear(m, PG_NEED_COMMIT);
3306 }
3307
3308 /*
3309  * Grab a page, blocking if it is busy and allocating a page if necessary.
3310  * A busy page is returned or NULL.  The page may or may not be valid and
3311  * might not be on a queue (the caller is responsible for the disposition of
3312  * the page).
3313  *
3314  * If VM_ALLOC_ZERO is specified and the grab must allocate a new page, the
3315  * page will be zero'd and marked valid.
3316  *
3317  * If VM_ALLOC_FORCE_ZERO is specified the page will be zero'd and marked
3318  * valid even if it already exists.
3319  *
3320  * If VM_ALLOC_RETRY is specified this routine will never return NULL.  Also
3321  * note that VM_ALLOC_NORMAL must be specified if VM_ALLOC_RETRY is specified.
3322  * VM_ALLOC_NULL_OK is implied when VM_ALLOC_RETRY is specified.
3323  *
3324  * This routine may block, but if VM_ALLOC_RETRY is not set then NULL is
3325  * always returned if we had blocked.  
3326  *
3327  * This routine may not be called from an interrupt.
3328  *
3329  * No other requirements.
3330  */
3331 vm_page_t
3332 vm_page_grab(vm_object_t object, vm_pindex_t pindex, int allocflags)
3333 {
3334         vm_page_t m;
3335         int error;
3336         int shared = 1;
3337
3338         KKASSERT(allocflags &
3339                 (VM_ALLOC_NORMAL|VM_ALLOC_INTERRUPT|VM_ALLOC_SYSTEM));
3340         vm_object_hold_shared(object);
3341         for (;;) {
3342                 m = vm_page_lookup_busy_try(object, pindex, TRUE, &error);
3343                 if (error) {
3344                         vm_page_sleep_busy(m, TRUE, "pgrbwt");
3345                         if ((allocflags & VM_ALLOC_RETRY) == 0) {
3346                                 m = NULL;
3347                                 break;
3348                         }
3349                         /* retry */
3350                 } else if (m == NULL) {
3351                         if (shared) {
3352                                 vm_object_upgrade(object);
3353                                 shared = 0;
3354                         }
3355                         if (allocflags & VM_ALLOC_RETRY)
3356                                 allocflags |= VM_ALLOC_NULL_OK;
3357                         m = vm_page_alloc(object, pindex,
3358                                           allocflags & ~VM_ALLOC_RETRY);
3359                         if (m)
3360                                 break;
3361                         vm_wait(0);
3362                         if ((allocflags & VM_ALLOC_RETRY) == 0)
3363                                 goto failed;
3364                 } else {
3365                         /* m found */
3366                         break;
3367                 }
3368         }
3369
3370         /*
3371          * If VM_ALLOC_ZERO an invalid page will be zero'd and set valid.
3372          *
3373          * If VM_ALLOC_FORCE_ZERO the page is unconditionally zero'd and set
3374          * valid even if already valid.
3375          *
3376          * NOTE!  We have removed all of the PG_ZERO optimizations and also
3377          *        removed the idle zeroing code.  These optimizations actually
3378          *        slow things down on modern cpus because the zerod area is
3379          *        likely uncached, placing a memory-access burden on the
3380          *        accesors taking the fault.
3381          *
3382          *        By always zeroing the page in-line with the fault, no
3383          *        dynamic ram reads are needed and the caches are hot, ready
3384          *        for userland to access the memory.
3385          */
3386         if (m->valid == 0) {
3387                 if (allocflags & (VM_ALLOC_ZERO | VM_ALLOC_FORCE_ZERO)) {
3388                         pmap_zero_page(VM_PAGE_TO_PHYS(m));
3389                         m->valid = VM_PAGE_BITS_ALL;
3390                 }
3391         } else if (allocflags & VM_ALLOC_FORCE_ZERO) {
3392                 pmap_zero_page(VM_PAGE_TO_PHYS(m));
3393                 m->valid = VM_PAGE_BITS_ALL;
3394         }
3395 failed:
3396         vm_object_drop(object);
3397         return(m);
3398 }
3399
3400 /*
3401  * Mapping function for valid bits or for dirty bits in
3402  * a page.  May not block.
3403  *
3404  * Inputs are required to range within a page.
3405  *
3406  * No requirements.
3407  * Non blocking.
3408  */
3409 int
3410 vm_page_bits(int base, int size)
3411 {
3412         int first_bit;
3413         int last_bit;
3414
3415         KASSERT(
3416             base + size <= PAGE_SIZE,
3417             ("vm_page_bits: illegal base/size %d/%d", base, size)
3418         );
3419
3420         if (size == 0)          /* handle degenerate case */
3421                 return(0);
3422
3423         first_bit = base >> DEV_BSHIFT;
3424         last_bit = (base + size - 1) >> DEV_BSHIFT;
3425
3426         return ((2 << last_bit) - (1 << first_bit));
3427 }
3428
3429 /*
3430  * Sets portions of a page valid and clean.  The arguments are expected
3431  * to be DEV_BSIZE aligned but if they aren't the bitmap is inclusive
3432  * of any partial chunks touched by the range.  The invalid portion of
3433  * such chunks will be zero'd.
3434  *
3435  * NOTE: When truncating a buffer vnode_pager_setsize() will automatically
3436  *       align base to DEV_BSIZE so as not to mark clean a partially
3437  *       truncated device block.  Otherwise the dirty page status might be
3438  *       lost.
3439  *
3440  * This routine may not block.
3441  *
3442  * (base + size) must be less then or equal to PAGE_SIZE.
3443  */
3444 static void
3445 _vm_page_zero_valid(vm_page_t m, int base, int size)
3446 {
3447         int frag;
3448         int endoff;
3449
3450         if (size == 0)  /* handle degenerate case */
3451                 return;
3452
3453         /*
3454          * If the base is not DEV_BSIZE aligned and the valid
3455          * bit is clear, we have to zero out a portion of the
3456          * first block.
3457          */
3458
3459         if ((frag = base & ~(DEV_BSIZE - 1)) != base &&
3460             (m->valid & (1 << (base >> DEV_BSHIFT))) == 0
3461         ) {
3462                 pmap_zero_page_area(
3463                     VM_PAGE_TO_PHYS(m),
3464                     frag,
3465                     base - frag
3466                 );
3467         }
3468
3469         /*
3470          * If the ending offset is not DEV_BSIZE aligned and the 
3471          * valid bit is clear, we have to zero out a portion of
3472          * the last block.
3473          */
3474
3475         endoff = base + size;
3476
3477         if ((frag = endoff & ~(DEV_BSIZE - 1)) != endoff &&
3478             (m->valid & (1 << (endoff >> DEV_BSHIFT))) == 0
3479         ) {
3480                 pmap_zero_page_area(
3481                     VM_PAGE_TO_PHYS(m),
3482                     endoff,
3483                     DEV_BSIZE - (endoff & (DEV_BSIZE - 1))
3484                 );
3485         }
3486 }
3487
3488 /*
3489  * Set valid, clear dirty bits.  If validating the entire
3490  * page we can safely clear the pmap modify bit.  We also
3491  * use this opportunity to clear the PG_NOSYNC flag.  If a process
3492  * takes a write fault on a MAP_NOSYNC memory area the flag will
3493  * be set again.
3494  *
3495  * We set valid bits inclusive of any overlap, but we can only
3496  * clear dirty bits for DEV_BSIZE chunks that are fully within
3497  * the range.
3498  *
3499  * Page must be busied?
3500  * No other requirements.
3501  */
3502 void
3503 vm_page_set_valid(vm_page_t m, int base, int size)
3504 {
3505         _vm_page_zero_valid(m, base, size);
3506         m->valid |= vm_page_bits(base, size);
3507 }
3508
3509
3510 /*
3511  * Set valid bits and clear dirty bits.
3512  *
3513  * Page must be busied by caller.
3514  *
3515  * NOTE: This function does not clear the pmap modified bit.
3516  *       Also note that e.g. NFS may use a byte-granular base
3517  *       and size.
3518  *
3519  * No other requirements.
3520  */
3521 void
3522 vm_page_set_validclean(vm_page_t m, int base, int size)
3523 {
3524         int pagebits;
3525
3526         _vm_page_zero_valid(m, base, size);
3527         pagebits = vm_page_bits(base, size);
3528         m->valid |= pagebits;
3529         m->dirty &= ~pagebits;
3530         if (base == 0 && size == PAGE_SIZE) {
3531                 /*pmap_clear_modify(m);*/
3532                 vm_page_flag_clear(m, PG_NOSYNC);
3533         }
3534 }
3535
3536 /*
3537  * Set valid & dirty.  Used by buwrite()
3538  *
3539  * Page must be busied by caller.
3540  */
3541 void
3542 vm_page_set_validdirty(vm_page_t m, int base, int size)
3543 {
3544         int pagebits;
3545
3546         pagebits = vm_page_bits(base, size);
3547         m->valid |= pagebits;
3548         m->dirty |= pagebits;
3549         if (m->object)
3550                vm_object_set_writeable_dirty(m->object);
3551 }
3552
3553 /*
3554  * Clear dirty bits.
3555  *
3556  * NOTE: This function does not clear the pmap modified bit.
3557  *       Also note that e.g. NFS may use a byte-granular base
3558  *       and size.
3559  *
3560  * Page must be busied?
3561  * No other requirements.
3562  */
3563 void
3564 vm_page_clear_dirty(vm_page_t m, int base, int size)
3565 {
3566         m->dirty &= ~vm_page_bits(base, size);
3567         if (base == 0 && size == PAGE_SIZE) {
3568                 /*pmap_clear_modify(m);*/
3569                 vm_page_flag_clear(m, PG_NOSYNC);
3570         }
3571 }
3572
3573 /*
3574  * Make the page all-dirty.
3575  *
3576  * Also make sure the related object and vnode reflect the fact that the
3577  * object may now contain a dirty page.
3578  *
3579  * Page must be busied?
3580  * No other requirements.
3581  */
3582 void
3583 vm_page_dirty(vm_page_t m)
3584 {
3585 #ifdef INVARIANTS
3586         int pqtype = m->queue - m->pc;
3587 #endif
3588         KASSERT(pqtype != PQ_CACHE && pqtype != PQ_FREE,
3589                 ("vm_page_dirty: page in free/cache queue!"));
3590         if (m->dirty != VM_PAGE_BITS_ALL) {
3591                 m->dirty = VM_PAGE_BITS_ALL;
3592                 if (m->object)
3593                         vm_object_set_writeable_dirty(m->object);
3594         }
3595 }
3596
3597 /*
3598  * Invalidates DEV_BSIZE'd chunks within a page.  Both the
3599  * valid and dirty bits for the effected areas are cleared.
3600  *
3601  * Page must be busied?
3602  * Does not block.
3603  * No other requirements.
3604  */
3605 void
3606 vm_page_set_invalid(vm_page_t m, int base, int size)
3607 {
3608         int bits;
3609
3610         bits = vm_page_bits(base, size);
3611         m->valid &= ~bits;
3612         m->dirty &= ~bits;
3613         atomic_add_int(&m->object->generation, 1);
3614 }
3615
3616 /*
3617  * The kernel assumes that the invalid portions of a page contain 
3618  * garbage, but such pages can be mapped into memory by user code.
3619  * When this occurs, we must zero out the non-valid portions of the
3620  * page so user code sees what it expects.
3621  *
3622  * Pages are most often semi-valid when the end of a file is mapped 
3623  * into memory and the file's size is not page aligned.
3624  *
3625  * Page must be busied?
3626  * No other requirements.
3627  */
3628 void
3629 vm_page_zero_invalid(vm_page_t m, boolean_t setvalid)
3630 {
3631         int b;
3632         int i;
3633
3634         /*
3635          * Scan the valid bits looking for invalid sections that
3636          * must be zerod.  Invalid sub-DEV_BSIZE'd areas ( where the
3637          * valid bit may be set ) have already been zerod by
3638          * vm_page_set_validclean().
3639          */
3640         for (b = i = 0; i <= PAGE_SIZE / DEV_BSIZE; ++i) {
3641                 if (i == (PAGE_SIZE / DEV_BSIZE) || 
3642                     (m->valid & (1 << i))
3643                 ) {
3644                         if (i > b) {
3645                                 pmap_zero_page_area(
3646                                     VM_PAGE_TO_PHYS(m), 
3647                                     b << DEV_BSHIFT,
3648                                     (i - b) << DEV_BSHIFT
3649                                 );
3650                         }
3651                         b = i + 1;
3652                 }
3653         }
3654
3655         /*
3656          * setvalid is TRUE when we can safely set the zero'd areas
3657          * as being valid.  We can do this if there are no cache consistency
3658          * issues.  e.g. it is ok to do with UFS, but not ok to do with NFS.
3659          */
3660         if (setvalid)
3661                 m->valid = VM_PAGE_BITS_ALL;
3662 }
3663
3664 /*
3665  * Is a (partial) page valid?  Note that the case where size == 0
3666  * will return FALSE in the degenerate case where the page is entirely
3667  * invalid, and TRUE otherwise.
3668  *
3669  * Does not block.
3670  * No other requirements.
3671  */
3672 int
3673 vm_page_is_valid(vm_page_t m, int base, int size)
3674 {
3675         int bits = vm_page_bits(base, size);
3676
3677         if (m->valid && ((m->valid & bits) == bits))
3678                 return 1;
3679         else
3680                 return 0;
3681 }
3682
3683 /*
3684  * Update dirty bits from pmap/mmu.  May not block.
3685  *
3686  * Caller must hold the page busy
3687  *
3688  * WARNING! Unless the page has been unmapped, this function only
3689  *          provides a likely dirty status.
3690  */
3691 void
3692 vm_page_test_dirty(vm_page_t m)
3693 {
3694         if (m->dirty != VM_PAGE_BITS_ALL && pmap_is_modified(m)) {
3695                 vm_page_dirty(m);
3696         }
3697 }
3698
3699 #include "opt_ddb.h"
3700 #ifdef DDB
3701 #include <ddb/ddb.h>
3702
3703 DB_SHOW_COMMAND(page, vm_page_print_page_info)
3704 {
3705         db_printf("vmstats.v_free_count: %ld\n", vmstats.v_free_count);
3706         db_printf("vmstats.v_cache_count: %ld\n", vmstats.v_cache_count);
3707         db_printf("vmstats.v_inactive_count: %ld\n", vmstats.v_inactive_count);
3708         db_printf("vmstats.v_active_count: %ld\n", vmstats.v_active_count);
3709         db_printf("vmstats.v_wire_count: %ld\n", vmstats.v_wire_count);
3710         db_printf("vmstats.v_free_reserved: %ld\n", vmstats.v_free_reserved);
3711         db_printf("vmstats.v_free_min: %ld\n", vmstats.v_free_min);
3712         db_printf("vmstats.v_free_target: %ld\n", vmstats.v_free_target);
3713         db_printf("vmstats.v_cache_min: %ld\n", vmstats.v_cache_min);
3714         db_printf("vmstats.v_inactive_target: %ld\n",
3715                   vmstats.v_inactive_target);
3716 }
3717
3718 DB_SHOW_COMMAND(pageq, vm_page_print_pageq_info)
3719 {
3720         int i;
3721         db_printf("PQ_FREE:");
3722         for (i = 0; i < PQ_L2_SIZE; i++) {
3723                 db_printf(" %ld", vm_page_queues[PQ_FREE + i].lcnt);
3724         }
3725         db_printf("\n");
3726                 
3727         db_printf("PQ_CACHE:");
3728         for(i = 0; i < PQ_L2_SIZE; i++) {
3729                 db_printf(" %ld", vm_page_queues[PQ_CACHE + i].lcnt);
3730         }
3731         db_printf("\n");
3732
3733         db_printf("PQ_ACTIVE:");
3734         for(i = 0; i < PQ_L2_SIZE; i++) {
3735                 db_printf(" %ld", vm_page_queues[PQ_ACTIVE + i].lcnt);
3736         }
3737         db_printf("\n");
3738
3739         db_printf("PQ_INACTIVE:");
3740         for(i = 0; i < PQ_L2_SIZE; i++) {
3741                 db_printf(" %ld", vm_page_queues[PQ_INACTIVE + i].lcnt);
3742         }
3743         db_printf("\n");
3744 }
3745 #endif /* DDB */