Home | History | Annotate | Line # | Download | only in uvm
uvm.h revision 1.77
      1 /*	$NetBSD: uvm.h,v 1.77 2020/05/17 15:11: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 	/* allocator */
     82 	struct pgflcache *pgflcache[VM_NFREELIST];/* cpu-local cached pages */
     83 	void		*pgflcachemem;		/* pointer to allocated mem */
     84 	size_t		pgflcachememsz;		/* size of allocated memory */
     85 	u_int		pgflcolor;		/* next color to allocate */
     86 	u_int		pgflbucket;		/* where to send our pages */
     87 
     88 	/* entropy */
     89 	krndsource_t 	rs;			/* entropy source */
     90 
     91 	/* uvmpdpol: queue of intended page status changes. */
     92 	struct vm_page	**pdq;			/* queue entries */
     93 	u_int		pdqhead;		/* current queue head */
     94 	u_int		pdqtail;		/* maximum number entries */
     95 	int		pdqtime;		/* last time queue cleared */
     96 };
     97 
     98 /*
     99  * uvm structure (vm global state: collected in one structure for ease
    100  * of reference...)
    101  */
    102 
    103 struct uvm {
    104 	/* vm_page related parameters */
    105 
    106 		/* vm_page queues */
    107 	struct pgfreelist page_free[VM_NFREELIST]; /* unallocated pages */
    108 	u_int	bucketcount;
    109 	bool	page_init_done;		/* true if uvm_page_init() finished */
    110 
    111 		/* page daemon trigger */
    112 	int pagedaemon;			/* daemon sleeps on this */
    113 	struct lwp *pagedaemon_lwp;	/* daemon's lid */
    114 };
    115 
    116 /*
    117  * kernel object: to support anonymous pageable kernel memory
    118  */
    119 extern struct uvm_object *uvm_kernel_object;
    120 
    121 /*
    122  * locks (made globals for lockstat).
    123  */
    124 
    125 extern kmutex_t uvm_kentry_lock;
    126 
    127 #endif /* _KERNEL */
    128 
    129 /*
    130  * vm_map_entry etype bits:
    131  */
    132 
    133 #define UVM_ET_OBJ		0x01	/* it is a uvm_object */
    134 #define UVM_ET_SUBMAP		0x02	/* it is a vm_map submap */
    135 #define UVM_ET_COPYONWRITE 	0x04	/* copy_on_write */
    136 #define UVM_ET_NEEDSCOPY	0x08	/* needs_copy */
    137 
    138 #define UVM_ET_ISOBJ(E)		(((E)->etype & UVM_ET_OBJ) != 0)
    139 #define UVM_ET_ISSUBMAP(E)	(((E)->etype & UVM_ET_SUBMAP) != 0)
    140 #define UVM_ET_ISCOPYONWRITE(E)	(((E)->etype & UVM_ET_COPYONWRITE) != 0)
    141 #define UVM_ET_ISNEEDSCOPY(E)	(((E)->etype & UVM_ET_NEEDSCOPY) != 0)
    142 
    143 #ifdef _KERNEL
    144 
    145 /*
    146  * holds all the internal UVM data
    147  */
    148 extern struct uvm uvm;
    149 
    150 /*
    151  * historys
    152  */
    153 
    154 #ifdef UVMHIST
    155 UVMHIST_DECL(maphist);
    156 UVMHIST_DECL(pdhist);
    157 UVMHIST_DECL(ubchist);
    158 UVMHIST_DECL(loanhist);
    159 #endif
    160 
    161 extern struct evcnt uvm_ra_total;
    162 extern struct evcnt uvm_ra_hit;
    163 extern struct evcnt uvm_ra_miss;
    164 
    165 /*
    166  * UVM_UNLOCK_AND_WAIT: atomic unlock+wait... wrapper around the
    167  * interlocked tsleep() function.
    168  */
    169 
    170 #define	UVM_UNLOCK_AND_WAIT(event, slock, intr, msg, timo)		\
    171 do {									\
    172 	(void) mtsleep(event, PVM | PNORELOCK | (intr ? PCATCH : 0),	\
    173 	    msg, timo, slock);						\
    174 } while (/*CONSTCOND*/ 0)
    175 
    176 void uvm_kick_pdaemon(void);
    177 
    178 /*
    179  * UVM_PAGE_OWN: track page ownership (only if UVM_PAGE_TRKOWN)
    180  */
    181 
    182 #if defined(UVM_PAGE_TRKOWN)
    183 #define UVM_PAGE_OWN(PG, TAG) uvm_page_own(PG, TAG)
    184 #else
    185 #define UVM_PAGE_OWN(PG, TAG) /* nothing */
    186 #endif /* UVM_PAGE_TRKOWN */
    187 
    188 #include <uvm/uvm_fault_i.h>
    189 
    190 #endif /* _KERNEL */
    191 
    192 #endif /* _UVM_UVM_H_ */
    193