xref: /xnu-8792.61.2/osfmk/mach/vm_behavior.h (revision 42e220869062b56f8d7d0726fd4c88954f87902c)
1 /*
2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * @OSF_COPYRIGHT@
30  */
31 /*
32  *	File:	mach/vm_behavior.h
33  *
34  *	Virtual memory map behavior definitions.
35  *
36  */
37 
38 #ifndef _MACH_VM_BEHAVIOR_H_
39 #define _MACH_VM_BEHAVIOR_H_
40 
41 /*
42  *	Types defined:
43  *
44  *	vm_behavior_t	behavior codes.
45  */
46 
47 typedef int             vm_behavior_t;
48 
49 /*
50  *	Enumeration of valid values for vm_behavior_t.
51  *	These describe expected page reference behavior for
52  *	for a given range of virtual memory.  For implementation
53  *	details see vm/vm_fault.c
54  */
55 
56 
57 /*
58  * The following behaviors affect the memory region's future behavior
59  * and are stored in the VM map entry data structure.
60  */
61 #define VM_BEHAVIOR_DEFAULT     ((vm_behavior_t) 0)     /* default */
62 #define VM_BEHAVIOR_RANDOM      ((vm_behavior_t) 1)     /* random */
63 #define VM_BEHAVIOR_SEQUENTIAL  ((vm_behavior_t) 2)     /* forward sequential */
64 #define VM_BEHAVIOR_RSEQNTL     ((vm_behavior_t) 3)     /* reverse sequential */
65 
66 /*
67  * The following "behaviors" affect the memory region only at the time of the
68  * call and are not stored in the VM map entry.
69  */
70 #define VM_BEHAVIOR_WILLNEED    ((vm_behavior_t) 4)     /* will need in near future */
71 #define VM_BEHAVIOR_DONTNEED    ((vm_behavior_t) 5)     /* dont need in near future */
72 #define VM_BEHAVIOR_FREE        ((vm_behavior_t) 6)     /* free memory without write-back */
73 #define VM_BEHAVIOR_ZERO_WIRED_PAGES    ((vm_behavior_t) 7)     /* zero out the wired pages of an entry if it is being deleted without unwiring them first */
74 #define VM_BEHAVIOR_REUSABLE    ((vm_behavior_t) 8)
75 #define VM_BEHAVIOR_REUSE       ((vm_behavior_t) 9)
76 #define VM_BEHAVIOR_CAN_REUSE   ((vm_behavior_t) 10)
77 #define VM_BEHAVIOR_PAGEOUT     ((vm_behavior_t) 11)
78 
79 #endif  /*_MACH_VM_BEHAVIOR_H_*/
80