1/* $NetBSD: uvm.h,v 1.68 2017/01/02 20:08:32 cherry Exp $ */
2
3/*
4 * Copyright (c) 1997 Charles D. Cranor and Washington University.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * from: Id: uvm.h,v 1.1.2.14 1998/02/02 20:07:19 chuck Exp
28 */
29
30#ifndef _UVM_UVM_H_
31#define _UVM_UVM_H_
32
33#if defined(_KERNEL_OPT)
34#include "opt_lockdebug.h"
35#include "opt_multiprocessor.h"
36#include "opt_uvmhist.h"
37#include "opt_uvm_page_trkown.h"
38#endif
39
40#include <uvm/uvm_extern.h>
41
42#ifdef _KERNEL
43#include <uvm/uvm_stat.h>
44#endif
45
46/*
47 * pull in prototypes
48 */
49
50#include <uvm/uvm_amap.h>
51#include <uvm/uvm_aobj.h>
52#include <uvm/uvm_fault.h>
53#include <uvm/uvm_glue.h>
54#include <uvm/uvm_km.h>
55#include <uvm/uvm_loan.h>
56#include <uvm/uvm_map.h>
57#include <uvm/uvm_object.h>
58#include <uvm/uvm_page.h>
59#include <uvm/uvm_pager.h>
60#include <uvm/uvm_pdaemon.h>
61#include <uvm/uvm_swap.h>
62
63#ifdef _KERNEL
64
65#include <uvm/uvm_physseg.h>
66#include <sys/rndsource.h>
67
68/*
69 * pull in VM_NFREELIST
70 */
71#include <machine/vmparam.h>
72
73struct workqueue;
74
75/*
76 * per-cpu data
77 */
78
79struct uvm_cpu {
80 struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
81 int page_free_nextcolor; /* next color to allocate from */
82 int page_idlezero_next; /* which color to zero next */
83 bool page_idle_zero; /* TRUE if we should try to zero
84 pages in the idle loop */
85 int pages[PGFL_NQUEUES]; /* total of pages in page_free */
86 u_int emap_gen; /* emap generation number */
87
88 krndsource_t rs; /* entropy source */
89};
90
91/*
92 * uvm structure (vm global state: collected in one structure for ease
93 * of reference...)
94 */
95
96struct uvm {
97 /* vm_page related parameters */
98
99 /* vm_page queues */
100 struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
101 bool page_init_done; /* TRUE if uvm_page_init() finished */
102
103 /* page daemon trigger */
104 int pagedaemon; /* daemon sleeps on this */
105 struct lwp *pagedaemon_lwp; /* daemon's lid */
106
107 /* aiodone daemon */
108 struct workqueue *aiodone_queue;
109
110 /* aio_done is locked by uvm.pagedaemon_lock and splbio! */
111 TAILQ_HEAD(, buf) aio_done; /* done async i/o reqs */
112
113 /* per-cpu data */
114 struct uvm_cpu *cpus[MAXCPUS];
115};
116
117/*
118 * kernel object: to support anonymous pageable kernel memory
119 */
120extern struct uvm_object *uvm_kernel_object;
121
122/*
123 * locks (made globals for lockstat).
124 */
125
126extern kmutex_t uvm_pageqlock; /* lock for active/inactive page q */
127extern kmutex_t uvm_fpageqlock; /* lock for free page q */
128extern kmutex_t uvm_kentry_lock;
129extern kmutex_t uvm_swap_data_lock;
130
131#endif /* _KERNEL */
132
133/*
134 * vm_map_entry etype bits:
135 */
136
137#define UVM_ET_OBJ 0x01 /* it is a uvm_object */
138#define UVM_ET_SUBMAP 0x02 /* it is a vm_map submap */
139#define UVM_ET_COPYONWRITE 0x04 /* copy_on_write */
140#define UVM_ET_NEEDSCOPY 0x08 /* needs_copy */
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
147#ifdef _KERNEL
148
149/*
150 * holds all the internal UVM data
151 */
152extern struct uvm uvm;
153
154/*
155 * historys
156 */
157
158#ifdef UVMHIST
159UVMHIST_DECL(maphist);
160UVMHIST_DECL(pdhist);
161UVMHIST_DECL(ubchist);
162UVMHIST_DECL(loanhist);
163#endif
164
165extern struct evcnt uvm_ra_total;
166extern struct evcnt uvm_ra_hit;
167extern struct evcnt uvm_ra_miss;
168
169/*
170 * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
171 * interlocked tsleep() function.
172 */
173
174#define UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo) \
175do { \
176 (void) mtsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0), \
177 msg, timo, slock); \
178} while (/*CONSTCOND*/ 0)
179
180void uvm_kick_pdaemon(void);
181
182/*
183 * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
184 */
185
186#if defined(UVM_PAGE_TRKOWN)
187#define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
188#else
189#define UVM_PAGE_OWN(PG, TAG) /* nothing */
190#endif /* UVM_PAGE_TRKOWN */
191
192#include <uvm/uvm_fault_i.h>
193
194#endif /* _KERNEL */
195
196#endif /* _UVM_UVM_H_ */
197