uvm.h revision 1.45 
1/*	$OpenBSD: uvm.h,v 1.45 2011/07/03 18:36:49 oga Exp $	*/
2/*	$NetBSD: uvm.h,v 1.24 2000/11/27 08:40:02 chs Exp $	*/
3
4/*
5 *
6 * Copyright (c) 1997 Charles D. Cranor and Washington University.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 *    must display the following acknowledgement:
19 *      This product includes software developed by Charles D. Cranor and
20 *      Washington University.
21 * 4. The name of the author may not be used to endorse or promote products
22 *    derived from this software without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 * from: Id: uvm.h,v 1.1.2.14 1998/02/02 20:07:19 chuck Exp
36 */
37
38#ifndef _UVM_UVM_H_
39#define _UVM_UVM_H_
40
41#include <uvm/uvm_extern.h>
42
43/*
44 * pull in prototypes
45 */
46
47#include <uvm/uvm_amap.h>
48#include <uvm/uvm_aobj.h>
49#include <uvm/uvm_fault.h>
50#include <uvm/uvm_glue.h>
51#include <uvm/uvm_km.h>
52#include <uvm/uvm_loan.h>
53#include <uvm/uvm_map.h>
54#include <uvm/uvm_object.h>
55#include <uvm/uvm_page.h>
56#include <uvm/uvm_pager.h>
57#include <uvm/uvm_swap.h>
58#include <uvm/uvm_pmemrange.h>
59#ifdef UVM_SWAP_ENCRYPT
60#include <uvm/uvm_swap_encrypt.h>
61#endif
62
63#include <machine/vmparam.h>
64
65/*
66 * uvm_constraint_range's:
67 * MD code is allowed to setup constraint ranges for memory allocators, the
68 * primary use for this is to keep allocation for certain memory consumers
69 * such as mbuf pools withing address ranges that are reachable by devices
70 * that perform DMA.
71 *
72 * It is also to discourge memory allocations from being satisfied from ranges
73 * such as the ISA memory range, if they can be satisfied with allocation
74 * from other ranges.
75 *
76 * the MD ranges are defined in arch/ARCH/ARCH/machdep.c
77 */
78struct uvm_constraint_range {
79	paddr_t	ucr_low;
80	paddr_t ucr_high;
81};
82
83/* Constraint ranges, set by MD code. */
84extern struct uvm_constraint_range  isa_constraint;
85extern struct uvm_constraint_range  dma_constraint;
86extern struct uvm_constraint_range  no_constraint;
87extern struct uvm_constraint_range *uvm_md_constraints[];
88
89/*
90 * uvm structure (vm global state: collected in one structure for ease
91 * of reference...)
92 */
93
94struct uvm {
95	/* vm_page related parameters */
96
97	/* vm_page queues */
98	struct pglist page_active;	/* allocated pages, in use */
99	struct pglist page_inactive_swp;/* pages inactive (reclaim or free) */
100	struct pglist page_inactive_obj;/* pages inactive (reclaim or free) */
101	/* Lock order: object lock,  pageqlock, then fpageqlock. */
102	simple_lock_data_t pageqlock;	/* lock for active/inactive page q */
103	struct mutex fpageqlock;	/* lock for free page q  + pdaemon */
104	boolean_t page_init_done;	/* TRUE if uvm_page_init() finished */
105	boolean_t page_idle_zero;	/* TRUE if we should try to zero
106					   pages in the idle loop */
107	struct uvm_pmr_control pmr_control; /* pmemrange data */
108
109		/* page daemon trigger */
110	int pagedaemon;			/* daemon sleeps on this */
111	struct proc *pagedaemon_proc;	/* daemon's pid */
112
113		/* aiodone daemon trigger */
114	int aiodoned;			/* daemon sleeps on this */
115	struct proc *aiodoned_proc;	/* daemon's pid */
116	struct mutex aiodoned_lock;
117
118	/* static kernel map entry pool */
119	vm_map_entry_t kentry_free;	/* free page pool */
120	simple_lock_data_t kentry_lock;
121
122	/* aio_done is locked by uvm.aiodoned_lock. */
123	TAILQ_HEAD(, buf) aio_done;		/* done async i/o reqs */
124
125	/* swap-related items */
126	simple_lock_data_t swap_data_lock;
127
128	/* kernel object: to support anonymous pageable kernel memory */
129	struct uvm_object *kernel_object;
130};
131
132/*
133 * vm_map_entry etype bits:
134 */
135
136#define UVM_ET_OBJ		0x01	/* it is a uvm_object */
137#define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
138#define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
139#define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
140#define	UVM_ET_HOLE		0x10	/* no backend */
141
142#define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
143#define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
144#define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
145#define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
146#define UVM_ET_ISHOLE(E)	(((E)->etype & UVM_ET_HOLE) != 0)
147
148#ifdef _KERNEL
149
150/*
151 * holds all the internal UVM data
152 */
153extern struct uvm uvm;
154
155/*
156 * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
157 * interlocked tsleep() function.
158 */
159
160#define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
161do {									\
162	tsleep(event, PVM|PNORELOCK|(intr ? PCATCH : 0), msg, timo);	\
163} while (0)
164
165/*
166 * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
167 */
168
169#if defined(UVM_PAGE_TRKOWN)
170#define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
171#else
172#define UVM_PAGE_OWN(PG, TAG) /* nothing */
173#endif /* UVM_PAGE_TRKOWN */
174
175#endif /* _KERNEL */
176
177#endif /* _UVM_UVM_H_ */
178