Home | History | Annotate | Line # | Download | only in uvm
uvm.h revision 1.71
      1 /*	$NetBSD: uvm.h,v 1.71 2019/12/27 12:51:57 ad 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 
     73 struct workqueue;
     74 struct pgflcache;
     75 
     76 /*
     77  * per-cpu data
     78  */
     79 
     80 struct uvm_cpu {
     81 	struct pgflcache *pgflcache[VM_NFREELIST];/* cpu-local cached pages */
     82 	void		*pgflcachemem;		/* pointer to allocated mem */
     83 	size_t		pgflcachememsz;		/* size of allocated memory */
     84 	u_int		pgflcolor;		/* next color to allocate */
     85 	u_int		pgflbucket;		/* where to send our pages */
     86 	krndsource_t 	rs;			/* entropy source */
     87 };
     88 
     89 /*
     90  * uvm structure (vm global state: collected in one structure for ease
     91  * of reference...)
     92  */
     93 
     94 struct uvm {
     95 	/* vm_page related parameters */
     96 
     97 		/* vm_page queues */
     98 	struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
     99 	u_int	bucketcount;
    100 	bool	page_init_done;		/* true if uvm_page_init() finished */
    101 	bool	numa_alloc;		/* use NUMA page allocation strategy */
    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  */
    120 extern struct uvm_object *uvm_kernel_object;
    121 
    122 /*
    123  * locks (made globals for lockstat).
    124  */
    125 
    126 extern kmutex_t uvm_kentry_lock;
    127 
    128 #endif /* _KERNEL */
    129 
    130 /*
    131  * vm_map_entry etype bits:
    132  */
    133 
    134 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
    135 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
    136 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
    137 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
    138 
    139 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
    140 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
    141 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
    142 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
    143 
    144 #ifdef _KERNEL
    145 
    146 /*
    147  * holds all the internal UVM data
    148  */
    149 extern struct uvm uvm;
    150 
    151 /*
    152  * historys
    153  */
    154 
    155 #ifdef UVMHIST
    156 UVMHIST_DECL(maphist);
    157 UVMHIST_DECL(pdhist);
    158 UVMHIST_DECL(ubchist);
    159 UVMHIST_DECL(loanhist);
    160 #endif
    161 
    162 extern struct evcnt uvm_ra_total;
    163 extern struct evcnt uvm_ra_hit;
    164 extern struct evcnt uvm_ra_miss;
    165 
    166 /*
    167  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
    168  * interlocked tsleep() function.
    169  */
    170 
    171 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
    172 do {									\
    173 	(void) mtsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0),	\
    174 	    msg, timo, slock);						\
    175 } while (/*CONSTCOND*/ 0)
    176 
    177 void uvm_kick_pdaemon(void);
    178 
    179 /*
    180  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
    181  */
    182 
    183 #if defined(UVM_PAGE_TRKOWN)
    184 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
    185 #else
    186 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
    187 #endif /* UVM_PAGE_TRKOWN */
    188 
    189 #include <uvm/uvm_fault_i.h>
    190 
    191 #endif /* _KERNEL */
    192 
    193 #endif /* _UVM_UVM_H_ */
    194