Annotation of src/sys/uvm/uvm_page.h, Revision 1.59.2.25
1.58 uebayasi 1: /* $NetBSD$ */
1.1 mrg 2:
1.26 chs 3: /*
1.1 mrg 4: * Copyright (c) 1997 Charles D. Cranor and Washington University.
1.26 chs 5: * Copyright (c) 1991, 1993, The Regents of the University of California.
1.1 mrg 6: *
7: * All rights reserved.
8: *
9: * This code is derived from software contributed to Berkeley by
10: * The Mach Operating System project at Carnegie-Mellon University.
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. All advertising materials mentioning features or use of this software
21: * must display the following acknowledgement:
22: * This product includes software developed by Charles D. Cranor,
1.26 chs 23: * Washington University, the University of California, Berkeley and
1.1 mrg 24: * its contributors.
25: * 4. Neither the name of the University nor the names of its contributors
26: * may be used to endorse or promote products derived from this software
27: * without specific prior written permission.
28: *
29: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39: * SUCH DAMAGE.
40: *
41: * @(#)vm_page.h 7.3 (Berkeley) 4/21/91
1.3 mrg 42: * from: Id: uvm_page.h,v 1.1.2.6 1998/02/04 02:31:42 chuck Exp
1.1 mrg 43: *
44: *
45: * Copyright (c) 1987, 1990 Carnegie-Mellon University.
46: * All rights reserved.
1.26 chs 47: *
1.1 mrg 48: * Permission to use, copy, modify and distribute this software and
49: * its documentation is hereby granted, provided that both the copyright
50: * notice and this permission notice appear in all copies of the
51: * software, derivative works or modified versions, and any portions
52: * thereof, and that both notices appear in supporting documentation.
1.26 chs 53: *
54: * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
55: * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
1.1 mrg 56: * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
1.26 chs 57: *
1.1 mrg 58: * Carnegie Mellon requests users of this software to return to
59: *
60: * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
61: * School of Computer Science
62: * Carnegie Mellon University
63: * Pittsburgh PA 15213-3890
64: *
65: * any improvements or extensions that they make and grant Carnegie the
66: * rights to redistribute these changes.
67: */
68:
1.4 perry 69: #ifndef _UVM_UVM_PAGE_H_
70: #define _UVM_UVM_PAGE_H_
71:
1.1 mrg 72: /*
73: * uvm_page.h
74: */
75:
1.16 mrg 76: /*
77: * Resident memory system definitions.
78: */
79:
80: /*
81: * Management of resident (logical) pages.
82: *
83: * A small structure is kept for each resident
84: * page, indexed by page number. Each structure
85: * is an element of several lists:
86: *
1.55 ad 87: * A red-black tree rooted with the containing
88: * object is used to quickly perform object+
89: * offset lookups
1.16 mrg 90: *
91: * A list of all pages for a given object,
92: * so they can be quickly deactivated at
93: * time of deallocation.
94: *
95: * An ordered list of pages due for pageout.
96: *
97: * In addition, the structure contains the object
98: * and offset to which this page belongs (for pageout),
99: * and sundry status bits.
100: *
101: * Fields in this structure are locked either by the lock on the
102: * object that the page belongs to (O) or by the lock on the page
103: * queues (P) [or both].
104: */
105:
106: /*
107: * locking note: the mach version of this data structure had bit
108: * fields for the flags, and the bit fields were divided into two
109: * items (depending on who locked what). some time, in BSD, the bit
110: * fields were dumped and all the flags were lumped into one short.
111: * that is fine for a single threaded uniprocessor OS, but bad if you
1.51 ad 112: * want to actual make use of locking. so, we've separated things
113: * back out again.
1.16 mrg 114: *
115: * note the page structure has no lock of its own.
116: */
117:
118: #include <uvm/uvm_extern.h>
119: #include <uvm/uvm_pglist.h>
120:
1.55 ad 121: #include <sys/rb.h>
122:
1.16 mrg 123: struct vm_page {
1.55 ad 124: struct rb_node rb_node; /* tree of pages in obj (O) */
1.54 ad 125:
126: union {
127: TAILQ_ENTRY(vm_page) queue;
128: LIST_ENTRY(vm_page) list;
129: } pageq; /* queue info for FIFO
1.18 chs 130: * queue or free list (P) */
1.54 ad 131: union {
132: TAILQ_ENTRY(vm_page) queue;
133: LIST_ENTRY(vm_page) list;
134: } listq; /* pages in same object (O)*/
1.18 chs 135:
136: struct vm_anon *uanon; /* anon (O,P) */
137: struct uvm_object *uobject; /* object (O,P) */
138: voff_t offset; /* offset into object (O,P) */
1.31 chs 139: uint16_t flags; /* object flags [O] */
140: uint16_t loan_count; /* number of active loans
1.18 chs 141: * to read: [O or P]
142: * to modify: [O _and_ P] */
1.31 chs 143: uint16_t wire_count; /* wired down map refs [P] */
144: uint16_t pqflags; /* page queue flags [P] */
1.59.2.15 uebayasi 145: paddr_t phys_addr; /* physical address of page */
146:
1.22 thorpej 147: #ifdef __HAVE_VM_PAGE_MD
148: struct vm_page_md mdpage; /* pmap-specific data */
149: #endif
1.21 thorpej 150:
1.16 mrg 151: #if defined(UVM_PAGE_TRKOWN)
1.18 chs 152: /* debugging fields to track page ownership */
153: pid_t owner; /* proc that set PG_BUSY */
1.48 perseant 154: lwpid_t lowner; /* lwp that set PG_BUSY */
1.40 chs 155: const char *owner_tag; /* why it was set busy */
1.16 mrg 156: #endif
157: };
158:
159: /*
160: * These are the flags defined for vm_page.
161: */
162:
163: /*
164: * locking rules:
165: * PG_ ==> locked by object lock
1.26 chs 166: * PQ_ ==> lock by page queue lock
1.16 mrg 167: * PQ_FREE is locked by free queue lock and is mutex with all other PQs
168: *
169: * PG_ZERO is used to indicate that a page has been pre-zero'd. This flag
170: * is only set when the page is on no queues, and is cleared when the page
171: * is placed on the free list.
172: */
1.18 chs 173:
174: #define PG_BUSY 0x0001 /* page is locked */
175: #define PG_WANTED 0x0002 /* someone is waiting for page */
176: #define PG_TABLED 0x0004 /* page is in VP table */
1.16 mrg 177: #define PG_CLEAN 0x0008 /* page has not been modified */
1.31 chs 178: #define PG_PAGEOUT 0x0010 /* page to be freed for pagedaemon */
179: #define PG_RELEASED 0x0020 /* page to be freed when unbusied */
1.18 chs 180: #define PG_FAKE 0x0040 /* page is not yet initialized */
1.31 chs 181: #define PG_RDONLY 0x0080 /* page must be mapped read-only */
182: #define PG_ZERO 0x0100 /* page is pre-zero'd */
1.59.2.23 uebayasi 183: #define PG_DIRECT 0x0200 /* page is direct vnode data */
1.18 chs 184:
185: #define PG_PAGER1 0x1000 /* pager-specific flag */
1.16 mrg 186:
1.46 yamt 187: #define UVM_PGFLAGBITS \
188: "\20\1BUSY\2WANTED\3TABLED\4CLEAN\5PAGEOUT\6RELEASED\7FAKE\10RDONLY" \
1.59.2.23 uebayasi 189: "\11ZERO\12DIRECT\15PAGER1"
1.46 yamt 190:
191: #define PQ_FREE 0x0001 /* page is on free list */
192: #define PQ_ANON 0x0002 /* page is part of an anon, rather
1.16 mrg 193: than an uvm_object */
1.46 yamt 194: #define PQ_AOBJ 0x0004 /* page is part of an anonymous
1.16 mrg 195: uvm_object */
196: #define PQ_SWAPBACKED (PQ_ANON|PQ_AOBJ)
1.46 yamt 197: #define PQ_READAHEAD 0x0008 /* read-ahead but has not been "hit" yet */
198:
199: #define PQ_PRIVATE1 0x0100
200: #define PQ_PRIVATE2 0x0200
201: #define PQ_PRIVATE3 0x0400
202: #define PQ_PRIVATE4 0x0800
203: #define PQ_PRIVATE5 0x1000
204: #define PQ_PRIVATE6 0x2000
205: #define PQ_PRIVATE7 0x4000
206: #define PQ_PRIVATE8 0x8000
207:
208: #define UVM_PQFLAGBITS \
209: "\20\1FREE\2ANON\3AOBJ\4READAHEAD" \
210: "\11PRIVATE1\12PRIVATE2\13PRIVATE3\14PRIVATE4" \
211: "\15PRIVATE5\16PRIVATE6\17PRIVATE7\20PRIVATE8"
1.16 mrg 212:
213: /*
214: * physical memory layout structure
215: *
216: * MD vmparam.h must #define:
217: * VM_PHYSEG_MAX = max number of physical memory segments we support
218: * (if this is "1" then we revert to a "contig" case)
219: * VM_PHYSSEG_STRAT: memory sort/search options (for VM_PHYSEG_MAX > 1)
220: * - VM_PSTRAT_RANDOM: linear search (random order)
221: * - VM_PSTRAT_BSEARCH: binary search (sorted by address)
222: * - VM_PSTRAT_BIGFIRST: linear search (sorted by largest segment first)
223: * - others?
1.17 mrg 224: * XXXCDC: eventually we should purge all left-over global variables...
1.16 mrg 225: */
226: #define VM_PSTRAT_RANDOM 1
227: #define VM_PSTRAT_BSEARCH 2
228: #define VM_PSTRAT_BIGFIRST 3
229:
230: /*
1.45 uebayasi 231: * vm_physseg: describes one segment of physical memory
1.16 mrg 232: */
233: struct vm_physseg {
234: paddr_t start; /* PF# of first page in segment */
235: paddr_t end; /* (PF# of last page in segment) + 1 */
1.59.2.20 uebayasi 236:
237: /* memory properties */
1.16 mrg 238: paddr_t avail_start; /* PF# of first free page in segment */
239: paddr_t avail_end; /* (PF# of last free page in segment) +1 */
240: int free_list; /* which free list they belong on */
241: struct vm_page *pgs; /* vm_page structures (from start) */
1.59.2.1 uebayasi 242: struct vm_page *endpg; /* vm_page structure for end */
1.59.2.20 uebayasi 243:
1.22 thorpej 244: #ifdef __HAVE_PMAP_PHYSSEG
1.16 mrg 245: struct pmap_physseg pmseg; /* pmap specific (MD) data */
1.21 thorpej 246: #endif
1.59.2.19 uebayasi 247: SIMPLEQ_ENTRY(vm_physseg) list;
1.59.2.20 uebayasi 248:
249: /* device properties */
250: int prot; /* protection of device region */
251: int flags; /* XXXUEBS BUS_SPACE_MAP_* */
1.16 mrg 252: };
253:
1.13 thorpej 254: #ifdef _KERNEL
255:
1.1 mrg 256: /*
1.15 thorpej 257: * globals
258: */
259:
1.47 thorpej 260: extern bool vm_page_zero_enable;
1.15 thorpej 261:
262: /*
1.16 mrg 263: * physical memory config is stored in vm_physmem.
264: */
1.1 mrg 265:
1.59.2.18 uebayasi 266: #define VM_PHYSMEM_PTR(i) (vm_physmem_ptrs[i])
267: #define VM_PHYSDEV_PTR(i) (vm_physdev_ptrs[i])
268:
1.59.2.17 uebayasi 269: extern struct vm_physseg *vm_physmem_ptrs[VM_PHYSSEG_MAX];
1.59.2.4 uebayasi 270: extern int vm_nphysmem;
1.59.2.25! uebayasi 271: #ifdef XIP
1.59.2.17 uebayasi 272: extern struct vm_physseg *vm_physdev_ptrs[VM_PHYSSEG_MAX];
1.59.2.5 uebayasi 273: extern int vm_nphysdev;
274: #endif
1.59.2.4 uebayasi 275:
276: #define vm_nphysseg vm_nphysmem /* XXX backward compat */
1.15 thorpej 277:
1.1 mrg 278: /*
1.8 chuck 279: * prototypes: the following prototypes define the interface to pages
1.1 mrg 280: */
281:
1.37 junyoung 282: void uvm_page_init(vaddr_t *, vaddr_t *);
1.1 mrg 283: #if defined(UVM_PAGE_TRKOWN)
1.40 chs 284: void uvm_page_own(struct vm_page *, const char *);
1.1 mrg 285: #endif
1.8 chuck 286: #if !defined(PMAP_STEAL_MEMORY)
1.47 thorpej 287: bool uvm_page_physget(paddr_t *);
1.8 chuck 288: #endif
1.37 junyoung 289: void uvm_page_recolor(int);
290: void uvm_pageidlezero(void);
291:
1.43 yamt 292: void uvm_pageactivate(struct vm_page *);
1.37 junyoung 293: vaddr_t uvm_pageboot_alloc(vsize_t);
1.43 yamt 294: void uvm_pagecopy(struct vm_page *, struct vm_page *);
295: void uvm_pagedeactivate(struct vm_page *);
296: void uvm_pagedequeue(struct vm_page *);
1.46 yamt 297: void uvm_pageenqueue(struct vm_page *);
1.37 junyoung 298: void uvm_pagefree(struct vm_page *);
299: void uvm_page_unbusy(struct vm_page **, int);
1.43 yamt 300: struct vm_page *uvm_pagelookup(struct uvm_object *, voff_t);
301: void uvm_pageunwire(struct vm_page *);
302: void uvm_pagewait(struct vm_page *, int);
303: void uvm_pagewake(struct vm_page *);
304: void uvm_pagewire(struct vm_page *);
305: void uvm_pagezero(struct vm_page *);
1.57 thorpej 306: bool uvm_pageismanaged(paddr_t);
1.59.2.22 uebayasi 307: bool uvm_pageisdirect_p(const struct vm_page *);
1.9 thorpej 308:
1.43 yamt 309: int uvm_page_lookup_freelist(struct vm_page *);
1.16 mrg 310:
1.59.2.2 uebayasi 311: int vm_physseg_find(paddr_t, int *);
1.59.2.6 uebayasi 312: struct vm_page *uvm_phys_to_vm_page(paddr_t);
313: paddr_t uvm_vm_page_to_phys(const struct vm_page *);
1.59.2.5 uebayasi 314: #ifdef XIP
1.59.2.22 uebayasi 315: int vm_physseg_find_direct(paddr_t, int *);
1.59.2.5 uebayasi 316: #endif
1.16 mrg 317:
318: /*
319: * macros
320: */
1.31 chs 321:
1.56 yamt 322: #define UVM_PAGE_TREE_PENALTY 4 /* XXX: a guess */
1.16 mrg 323:
1.59.2.3 uebayasi 324: #define VM_PAGE_TO_PHYS(entry) uvm_vm_page_to_phys(entry)
1.20 thorpej 325:
1.59.2.11 uebayasi 326: #ifdef __HAVE_VM_PAGE_MD
1.59.2.10 uebayasi 327: #define VM_PAGE_TO_MD(pg) (&(pg)->mdpage)
1.59.2.11 uebayasi 328: #endif
1.59.2.8 uebayasi 329:
1.20 thorpej 330: /*
331: * Compute the page color bucket for a given page.
332: */
333: #define VM_PGCOLOR_BUCKET(pg) \
1.24 thorpej 334: (atop(VM_PAGE_TO_PHYS((pg))) & uvmexp.colormask)
1.16 mrg 335:
1.59.2.2 uebayasi 336: #define PHYS_TO_VM_PAGE(pa) uvm_phys_to_vm_page(pa)
1.16 mrg 337:
338: #define VM_PAGE_IS_FREE(entry) ((entry)->pqflags & PQ_FREE)
1.54 ad 339: #define VM_FREE_PAGE_TO_CPU(pg) ((struct uvm_cpu *)((uintptr_t)pg->offset))
1.35 yamt 340:
341: #ifdef DEBUG
342: void uvm_pagezerocheck(struct vm_page *);
343: #endif /* DEBUG */
1.13 thorpej 344:
345: #endif /* _KERNEL */
1.1 mrg 346:
1.4 perry 347: #endif /* _UVM_UVM_PAGE_H_ */
CVSweb <webmaster@jp.NetBSD.org>