proc->thread stage 4: rework the VFS and DEVICE subsystems to take thread
[dragonfly.git] / sys / vm / vm_page.h
1 /*
2  * Copyright (c) 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * The Mach Operating System project at Carnegie-Mellon University.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. 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.h     8.2 (Berkeley) 12/13/93
37  *
38  *
39  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40  * All rights reserved.
41  *
42  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
43  *
44  * Permission to use, copy, modify and distribute this software and
45  * its documentation is hereby granted, provided that both the copyright
46  * notice and this permission notice appear in all copies of the
47  * software, derivative works or modified versions, and any portions
48  * thereof, and that both notices appear in supporting documentation.
49  *
50  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
51  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
52  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
53  *
54  * Carnegie Mellon requests users of this software to return to
55  *
56  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
57  *  School of Computer Science
58  *  Carnegie Mellon University
59  *  Pittsburgh PA 15213-3890
60  *
61  * any improvements or extensions that they make and grant Carnegie the
62  * rights to redistribute these changes.
63  *
64  * $FreeBSD: src/sys/vm/vm_page.h,v 1.75.2.8 2002/03/06 01:07:09 dillon Exp $
65  * $DragonFly: src/sys/vm/vm_page.h,v 1.3 2003/06/21 07:54:57 dillon Exp $
66  */
67
68 /*
69  *      Resident memory system definitions.
70  */
71
72 #ifndef _VM_PAGE_
73 #define _VM_PAGE_
74
75 #if !defined(KLD_MODULE)
76 #include "opt_vmpage.h"
77 #endif
78
79 #include <vm/pmap.h>
80 #include <machine/atomic.h>
81
82 /*
83  *      Management of resident (logical) pages.
84  *
85  *      A small structure is kept for each resident
86  *      page, indexed by page number.  Each structure
87  *      is an element of several lists:
88  *
89  *              A hash table bucket used to quickly
90  *              perform object/offset lookups
91  *
92  *              A list of all pages for a given object,
93  *              so they can be quickly deactivated at
94  *              time of deallocation.
95  *
96  *              An ordered list of pages due for pageout.
97  *
98  *      In addition, the structure contains the object
99  *      and offset to which this page belongs (for pageout),
100  *      and sundry status bits.
101  *
102  *      Fields in this structure are locked either by the lock on the
103  *      object that the page belongs to (O) or by the lock on the page
104  *      queues (P).
105  *
106  *      The 'valid' and 'dirty' fields are distinct.  A page may have dirty
107  *      bits set without having associated valid bits set.  This is used by
108  *      NFS to implement piecemeal writes.
109  */
110
111 TAILQ_HEAD(pglist, vm_page);
112
113 struct vm_page {
114         TAILQ_ENTRY(vm_page) pageq;     /* queue info for FIFO queue or free list (P) */
115         struct vm_page  *hnext;         /* hash table link (O,P)        */
116         TAILQ_ENTRY(vm_page) listq;     /* pages in same object (O)     */
117
118         vm_object_t object;             /* which object am I in (O,P)*/
119         vm_pindex_t pindex;             /* offset into object (O,P) */
120         vm_offset_t phys_addr;          /* physical address of page */
121         struct md_page md;              /* machine dependant stuff */
122         u_short queue;                  /* page queue index */
123         u_short flags,                  /* see below */
124                 pc;                     /* page color */
125         u_short wire_count;             /* wired down maps refs (P) */
126         short hold_count;               /* page hold count */
127         u_char  act_count;              /* page usage count */
128         u_char  busy;                   /* page busy count */
129         /* NOTE that these must support one bit per DEV_BSIZE in a page!!! */
130         /* so, on normal X86 kernels, they must be at least 8 bits wide */
131 #if PAGE_SIZE == 4096
132         u_char  valid;                  /* map of valid DEV_BSIZE chunks */
133         u_char  dirty;                  /* map of dirty DEV_BSIZE chunks */
134 #elif PAGE_SIZE == 8192
135         u_short valid;                  /* map of valid DEV_BSIZE chunks */
136         u_short dirty;                  /* map of dirty DEV_BSIZE chunks */
137 #endif
138 };
139
140 /*
141  * note: currently use SWAPBLK_NONE as an absolute value rather then 
142  * a flag bit.
143  */
144
145 #define SWAPBLK_MASK    ((daddr_t)((u_daddr_t)-1 >> 1))         /* mask */
146 #define SWAPBLK_NONE    ((daddr_t)((u_daddr_t)SWAPBLK_MASK + 1))/* flag */
147
148 #if !defined(KLD_MODULE)
149
150 /*
151  * Page coloring parameters
152  */
153 /* Each of PQ_FREE, and PQ_CACHE have PQ_HASH_SIZE entries */
154
155 /* Backward compatibility for existing PQ_*CACHE config options. */
156 #if !defined(PQ_CACHESIZE)
157 #if defined(PQ_HUGECACHE)
158 #define PQ_CACHESIZE 1024
159 #elif defined(PQ_LARGECACHE)
160 #define PQ_CACHESIZE 512
161 #elif defined(PQ_MEDIUMCACHE)
162 #define PQ_CACHESIZE 256
163 #elif defined(PQ_NORMALCACHE)
164 #define PQ_CACHESIZE 64
165 #elif defined(PQ_NOOPT)
166 #define PQ_CACHESIZE 0
167 #else
168 #define PQ_CACHESIZE 128
169 #endif
170 #endif
171
172 #if PQ_CACHESIZE >= 1024
173 #define PQ_PRIME1 31    /* Prime number somewhat less than PQ_HASH_SIZE */
174 #define PQ_PRIME2 23    /* Prime number somewhat less than PQ_HASH_SIZE */
175 #define PQ_L2_SIZE 256  /* A number of colors opt for 1M cache */
176
177 #elif PQ_CACHESIZE >= 512
178 #define PQ_PRIME1 31    /* Prime number somewhat less than PQ_HASH_SIZE */
179 #define PQ_PRIME2 23    /* Prime number somewhat less than PQ_HASH_SIZE */
180 #define PQ_L2_SIZE 128  /* A number of colors opt for 512K cache */
181
182 #elif PQ_CACHESIZE >= 256
183 #define PQ_PRIME1 13    /* Prime number somewhat less than PQ_HASH_SIZE */
184 #define PQ_PRIME2 7     /* Prime number somewhat less than PQ_HASH_SIZE */
185 #define PQ_L2_SIZE 64   /* A number of colors opt for 256K cache */
186
187 #elif PQ_CACHESIZE >= 128
188 #define PQ_PRIME1 9     /* Produces a good PQ_L2_SIZE/3 + PQ_PRIME1 */
189 #define PQ_PRIME2 5     /* Prime number somewhat less than PQ_HASH_SIZE */
190 #define PQ_L2_SIZE 32   /* A number of colors opt for 128k cache */
191
192 #elif PQ_CACHESIZE >= 64
193 #define PQ_PRIME1 5     /* Prime number somewhat less than PQ_HASH_SIZE */
194 #define PQ_PRIME2 3     /* Prime number somewhat less than PQ_HASH_SIZE */
195 #define PQ_L2_SIZE 16   /* A reasonable number of colors (opt for 64K cache) */
196
197 #else
198 #define PQ_PRIME1 1     /* Disable page coloring. */
199 #define PQ_PRIME2 1
200 #define PQ_L2_SIZE 1
201
202 #endif
203
204 #define PQ_L2_MASK (PQ_L2_SIZE - 1)
205
206 #define PQ_NONE 0
207 #define PQ_FREE 1
208 #define PQ_INACTIVE (1 + 1*PQ_L2_SIZE)
209 #define PQ_ACTIVE (2 + 1*PQ_L2_SIZE)
210 #define PQ_CACHE (3 + 1*PQ_L2_SIZE)
211 #define PQ_HOLD  (3 + 2*PQ_L2_SIZE)
212 #define PQ_COUNT (4 + 2*PQ_L2_SIZE)
213
214 struct vpgqueues {
215         struct pglist pl;
216         int     *cnt;
217         int     lcnt;
218 };
219
220 extern struct vpgqueues vm_page_queues[PQ_COUNT];
221
222 #endif
223
224 /*
225  * These are the flags defined for vm_page.
226  *
227  * Note: PG_FILLED and PG_DIRTY are added for the filesystems.
228  *
229  * Note: PG_UNMANAGED (used by OBJT_PHYS) indicates that the page is
230  *       not under PV management but otherwise should be treated as a
231  *       normal page.  Pages not under PV management cannot be paged out
232  *       via the object/vm_page_t because there is no knowledge of their
233  *       pte mappings, nor can they be removed from their objects via 
234  *       the object, and such pages are also not on any PQ queue.
235  */
236 #define PG_BUSY         0x0001          /* page is in transit (O) */
237 #define PG_WANTED       0x0002          /* someone is waiting for page (O) */
238 #define PG_WINATCFLS    0x0004          /* flush dirty page on inactive q */
239 #define PG_FICTITIOUS   0x0008          /* physical page doesn't exist (O) */
240 #define PG_WRITEABLE    0x0010          /* page is mapped writeable */
241 #define PG_MAPPED       0x0020          /* page is mapped */
242 #define PG_ZERO         0x0040          /* page is zeroed */
243 #define PG_REFERENCED   0x0080          /* page has been referenced */
244 #define PG_CLEANCHK     0x0100          /* page will be checked for cleaning */
245 #define PG_SWAPINPROG   0x0200          /* swap I/O in progress on page      */
246 #define PG_NOSYNC       0x0400          /* do not collect for syncer */
247 #define PG_UNMANAGED    0x0800          /* No PV management for page */
248 #define PG_MARKER       0x1000          /* special queue marker page */
249
250 /*
251  * Misc constants.
252  */
253
254 #define ACT_DECLINE             1
255 #define ACT_ADVANCE             3
256 #define ACT_INIT                5
257 #define ACT_MAX                 64
258 #define PFCLUSTER_BEHIND        3
259 #define PFCLUSTER_AHEAD         3
260
261 #ifdef _KERNEL
262 /*
263  * Each pageable resident page falls into one of four lists:
264  *
265  *      free
266  *              Available for allocation now.
267  *
268  * The following are all LRU sorted:
269  *
270  *      cache
271  *              Almost available for allocation. Still in an
272  *              object, but clean and immediately freeable at
273  *              non-interrupt times.
274  *
275  *      inactive
276  *              Low activity, candidates for reclamation.
277  *              This is the list of pages that should be
278  *              paged out next.
279  *
280  *      active
281  *              Pages that are "active" i.e. they have been
282  *              recently referenced.
283  *
284  *      zero
285  *              Pages that are really free and have been pre-zeroed
286  *
287  */
288
289 extern int vm_page_zero_count;
290
291 extern vm_page_t vm_page_array;         /* First resident page in table */
292 extern int vm_page_array_size;          /* number of vm_page_t's */
293 extern long first_page;                 /* first physical page number */
294
295 #define VM_PAGE_TO_PHYS(entry)  ((entry)->phys_addr)
296
297 #define PHYS_TO_VM_PAGE(pa) \
298                 (&vm_page_array[atop(pa) - first_page ])
299
300 /*
301  *      Functions implemented as macros
302  */
303
304 static __inline void
305 vm_page_flag_set(vm_page_t m, unsigned int bits)
306 {
307         atomic_set_short(&(m)->flags, bits);
308 }
309
310 static __inline void
311 vm_page_flag_clear(vm_page_t m, unsigned int bits)
312 {
313         atomic_clear_short(&(m)->flags, bits);
314 }
315
316 #if 0
317 static __inline void
318 vm_page_assert_wait(vm_page_t m, int interruptible)
319 {
320         vm_page_flag_set(m, PG_WANTED);
321         assert_wait((int) m, interruptible);
322 }
323 #endif
324
325 static __inline void
326 vm_page_busy(vm_page_t m)
327 {
328         KASSERT((m->flags & PG_BUSY) == 0, ("vm_page_busy: page already busy!!!"));
329         vm_page_flag_set(m, PG_BUSY);
330 }
331
332 /*
333  *      vm_page_flash:
334  *
335  *      wakeup anyone waiting for the page.
336  */
337
338 static __inline void
339 vm_page_flash(vm_page_t m)
340 {
341         if (m->flags & PG_WANTED) {
342                 vm_page_flag_clear(m, PG_WANTED);
343                 wakeup(m);
344         }
345 }
346
347 /*
348  *      vm_page_wakeup:
349  *
350  *      clear the PG_BUSY flag and wakeup anyone waiting for the
351  *      page.
352  *
353  */
354
355 static __inline void
356 vm_page_wakeup(vm_page_t m)
357 {
358         KASSERT(m->flags & PG_BUSY, ("vm_page_wakeup: page not busy!!!"));
359         vm_page_flag_clear(m, PG_BUSY);
360         vm_page_flash(m);
361 }
362
363 /*
364  *
365  *
366  */
367
368 static __inline void
369 vm_page_io_start(vm_page_t m)
370 {
371         atomic_add_char(&(m)->busy, 1);
372 }
373
374 static __inline void
375 vm_page_io_finish(vm_page_t m)
376 {
377         atomic_subtract_char(&m->busy, 1);
378         if (m->busy == 0)
379                 vm_page_flash(m);
380 }
381
382
383 #if PAGE_SIZE == 4096
384 #define VM_PAGE_BITS_ALL 0xff
385 #endif
386
387 #if PAGE_SIZE == 8192
388 #define VM_PAGE_BITS_ALL 0xffff
389 #endif
390
391 #define VM_ALLOC_NORMAL         0
392 #define VM_ALLOC_INTERRUPT      1
393 #define VM_ALLOC_SYSTEM         2
394 #define VM_ALLOC_ZERO           3
395 #define VM_ALLOC_RETRY          0x80
396
397 void vm_page_unhold(vm_page_t mem);
398
399 void vm_page_activate (vm_page_t);
400 vm_page_t vm_page_alloc (vm_object_t, vm_pindex_t, int);
401 vm_page_t vm_page_grab (vm_object_t, vm_pindex_t, int);
402 void vm_page_cache (register vm_page_t);
403 int vm_page_try_to_cache (vm_page_t);
404 int vm_page_try_to_free (vm_page_t);
405 void vm_page_dontneed (register vm_page_t);
406 static __inline void vm_page_copy (vm_page_t, vm_page_t);
407 static __inline void vm_page_free (vm_page_t);
408 static __inline void vm_page_free_zero (vm_page_t);
409 void vm_page_deactivate (vm_page_t);
410 void vm_page_insert (vm_page_t, vm_object_t, vm_pindex_t);
411 vm_page_t vm_page_lookup (vm_object_t, vm_pindex_t);
412 void vm_page_remove (vm_page_t);
413 void vm_page_rename (vm_page_t, vm_object_t, vm_pindex_t);
414 vm_offset_t vm_page_startup (vm_offset_t, vm_offset_t, vm_offset_t);
415 vm_page_t vm_add_new_page (vm_offset_t pa);
416 void vm_page_unmanage (vm_page_t);
417 void vm_page_unwire (vm_page_t, int);
418 void vm_page_wire (vm_page_t);
419 void vm_page_unqueue (vm_page_t);
420 void vm_page_unqueue_nowakeup (vm_page_t);
421 void vm_page_set_validclean (vm_page_t, int, int);
422 void vm_page_set_dirty (vm_page_t, int, int);
423 void vm_page_clear_dirty (vm_page_t, int, int);
424 void vm_page_set_invalid (vm_page_t, int, int);
425 static __inline boolean_t vm_page_zero_fill (vm_page_t);
426 int vm_page_is_valid (vm_page_t, int, int);
427 void vm_page_test_dirty (vm_page_t);
428 int vm_page_bits (int, int);
429 vm_page_t _vm_page_list_find (int, int);
430 void vm_page_zero_invalid(vm_page_t m, boolean_t setvalid);
431 void vm_page_free_toq(vm_page_t m);
432
433 /*
434  * Keep page from being freed by the page daemon
435  * much of the same effect as wiring, except much lower
436  * overhead and should be used only for *very* temporary
437  * holding ("wiring").
438  */
439 static __inline void
440 vm_page_hold(vm_page_t mem)
441 {
442         mem->hold_count++;
443 }
444
445 /*
446  *      vm_page_protect:
447  *
448  *      Reduce the protection of a page.  This routine never raises the 
449  *      protection and therefore can be safely called if the page is already
450  *      at VM_PROT_NONE (it will be a NOP effectively ).
451  */
452
453 static __inline void
454 vm_page_protect(vm_page_t mem, int prot)
455 {
456         if (prot == VM_PROT_NONE) {
457                 if (mem->flags & (PG_WRITEABLE|PG_MAPPED)) {
458                         pmap_page_protect(mem, VM_PROT_NONE);
459                         vm_page_flag_clear(mem, PG_WRITEABLE|PG_MAPPED);
460                 }
461         } else if ((prot == VM_PROT_READ) && (mem->flags & PG_WRITEABLE)) {
462                 pmap_page_protect(mem, VM_PROT_READ);
463                 vm_page_flag_clear(mem, PG_WRITEABLE);
464         }
465 }
466
467 /*
468  *      vm_page_zero_fill:
469  *
470  *      Zero-fill the specified page.
471  *      Written as a standard pagein routine, to
472  *      be used by the zero-fill object.
473  */
474 static __inline boolean_t
475 vm_page_zero_fill(m)
476         vm_page_t m;
477 {
478         pmap_zero_page(VM_PAGE_TO_PHYS(m));
479         return (TRUE);
480 }
481
482 /*
483  *      vm_page_copy:
484  *
485  *      Copy one page to another
486  */
487 static __inline void
488 vm_page_copy(src_m, dest_m)
489         vm_page_t src_m;
490         vm_page_t dest_m;
491 {
492         pmap_copy_page(VM_PAGE_TO_PHYS(src_m), VM_PAGE_TO_PHYS(dest_m));
493         dest_m->valid = VM_PAGE_BITS_ALL;
494 }
495
496 /*
497  *      vm_page_free:
498  *
499  *      Free a page
500  *
501  *      The clearing of PG_ZERO is a temporary safety until the code can be
502  *      reviewed to determine that PG_ZERO is being properly cleared on
503  *      write faults or maps.  PG_ZERO was previously cleared in 
504  *      vm_page_alloc().
505  */
506 static __inline void
507 vm_page_free(m)
508         vm_page_t m;
509 {
510         vm_page_flag_clear(m, PG_ZERO);
511         vm_page_free_toq(m);
512 }
513
514 /*
515  *      vm_page_free_zero:
516  *
517  *      Free a page to the zerod-pages queue
518  */
519 static __inline void
520 vm_page_free_zero(m)
521         vm_page_t m;
522 {
523         vm_page_flag_set(m, PG_ZERO);
524         vm_page_free_toq(m);
525 }
526
527 /*
528  *      vm_page_sleep_busy:
529  *
530  *      Wait until page is no longer PG_BUSY or (if also_m_busy is TRUE)
531  *      m->busy is zero.  Returns TRUE if it had to sleep ( including if 
532  *      it almost had to sleep and made temporary spl*() mods), FALSE 
533  *      otherwise.
534  *
535  *      This routine assumes that interrupts can only remove the busy
536  *      status from a page, not set the busy status or change it from
537  *      PG_BUSY to m->busy or vise versa (which would create a timing
538  *      window).
539  *
540  *      Note that being an inline, this code will be well optimized.
541  */
542
543 static __inline int
544 vm_page_sleep_busy(vm_page_t m, int also_m_busy, const char *msg)
545 {
546         if ((m->flags & PG_BUSY) || (also_m_busy && m->busy))  {
547                 int s = splvm();
548                 if ((m->flags & PG_BUSY) || (also_m_busy && m->busy)) {
549                         /*
550                          * Page is busy. Wait and retry.
551                          */
552                         vm_page_flag_set(m, PG_WANTED | PG_REFERENCED);
553                         tsleep(m, PVM, msg, 0);
554                 }
555                 splx(s);
556                 return(TRUE);
557                 /* not reached */
558         }
559         return(FALSE);
560 }
561
562 /*
563  *      vm_page_dirty:
564  *
565  *      make page all dirty
566  */
567
568 static __inline void
569 vm_page_dirty(vm_page_t m)
570 {
571 #if !defined(KLD_MODULE)
572         KASSERT(m->queue - m->pc != PQ_CACHE, ("vm_page_dirty: page in cache!"));
573 #endif
574         m->dirty = VM_PAGE_BITS_ALL;
575 }
576
577 /*
578  *      vm_page_undirty:
579  *
580  *      Set page to not be dirty.  Note: does not clear pmap modify bits 
581  */
582
583 static __inline void
584 vm_page_undirty(vm_page_t m)
585 {
586         m->dirty = 0;
587 }
588
589 #if !defined(KLD_MODULE)
590
591 static __inline vm_page_t
592 vm_page_list_find(int basequeue, int index, boolean_t prefer_zero)
593 {
594         vm_page_t m;
595
596 #if PQ_L2_SIZE > 1
597         if (prefer_zero) {
598                 m = TAILQ_LAST(&vm_page_queues[basequeue+index].pl, pglist);
599         } else {
600                 m = TAILQ_FIRST(&vm_page_queues[basequeue+index].pl);
601         }
602         if (m == NULL)
603                 m = _vm_page_list_find(basequeue, index);
604 #else
605         if (prefer_zero) {
606                 m = TAILQ_LAST(&vm_page_queues[basequeue].pl, pglist);
607         } else {
608                 m = TAILQ_FIRST(&vm_page_queues[basequeue].pl);
609         }
610 #endif
611         return(m);
612 }
613
614 #endif
615
616 #endif                          /* _KERNEL */
617 #endif                          /* !_VM_PAGE_ */