1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * include/asm-xtensa/mman.h
4  *
5  * Xtensa Processor memory-manager definitions
6  *
7  * This file is subject to the terms and conditions of the GNU General Public
8  * License.  See the file "COPYING" in the main directory of this archive
9  * for more details.
10  *
11  * Copyright (C) 1995 by Ralf Baechle
12  * Copyright (C) 2001 - 2005 Tensilica Inc.
13  */
14 
15 #ifndef _XTENSA_MMAN_H
16 #define _XTENSA_MMAN_H
17 
18 /*
19  * Protections are chosen from these bits, OR'd together.  The
20  * implementation does not necessarily support PROT_EXEC or PROT_WRITE
21  * without PROT_READ.  The only guarantees are that no writing will be
22  * allowed without PROT_WRITE and no access will be allowed for PROT_NONE.
23  */
24 
25 #define PROT_NONE	0x0		/* page can not be accessed */
26 #define PROT_READ	0x1		/* page can be read */
27 #define PROT_WRITE	0x2		/* page can be written */
28 #define PROT_EXEC	0x4		/* page can be executed */
29 
30 #define PROT_SEM	0x10		/* page may be used for atomic ops */
31 #define PROT_GROWSDOWN	0x01000000	/* mprotect flag: extend change to start of growsdown vma */
32 #define PROT_GROWSUP	0x02000000	/* mprotect flag: extend change to end fo growsup vma */
33 
34 /*
35  * Flags for mmap
36  */
37 /* 0x01 - 0x03 are defined in linux/mman.h */
38 #define MAP_TYPE	0x00f		/* Mask for type of mapping */
39 #define MAP_FIXED	0x010		/* Interpret addr exactly */
40 
41 /* not used by linux, but here to make sure we don't clash with ABI defines */
42 #define MAP_RENAME	0x020		/* Assign page to file */
43 #define MAP_AUTOGROW	0x040		/* File may grow by writing */
44 #define MAP_LOCAL	0x080		/* Copy on fork/sproc */
45 #define MAP_AUTORSRV	0x100		/* Logical swap reserved on demand */
46 
47 /* These are linux-specific */
48 #define MAP_NORESERVE	0x0400		/* don't check for reservations */
49 #define MAP_ANONYMOUS	0x0800		/* don't use a file */
50 #define MAP_GROWSDOWN	0x1000		/* stack-like segment */
51 #define MAP_DENYWRITE	0x2000		/* ETXTBSY */
52 #define MAP_EXECUTABLE	0x4000		/* mark it as an executable */
53 #define MAP_LOCKED	0x8000		/* pages are locked */
54 #define MAP_POPULATE	0x10000		/* populate (prefault) pagetables */
55 #define MAP_NONBLOCK	0x20000		/* do not block on IO */
56 #define MAP_STACK	0x40000		/* give out an address that is best suited for process/thread stacks */
57 #define MAP_HUGETLB	0x80000		/* create a huge page mapping */
58 #define MAP_FIXED_NOREPLACE 0x100000	/* MAP_FIXED which doesn't unmap underlying mapping */
59 #define MAP_UNINITIALIZED 0x4000000	/* For anonymous mmap, memory could be
60 					 * uninitialized */
61 
62 /*
63  * Flags for msync
64  */
65 #define MS_ASYNC	0x0001		/* sync memory asynchronously */
66 #define MS_INVALIDATE	0x0002		/* invalidate mappings & caches */
67 #define MS_SYNC		0x0004		/* synchronous memory sync */
68 
69 /*
70  * Flags for mlockall
71  */
72 #define MCL_CURRENT	1		/* lock all current mappings */
73 #define MCL_FUTURE	2		/* lock all future mappings */
74 #define MCL_ONFAULT	4		/* lock all pages that are faulted in */
75 
76 /*
77  * Flags for mlock
78  */
79 #define MLOCK_ONFAULT	0x01		/* Lock pages in range after they are faulted in, do not prefault */
80 
81 #define MADV_NORMAL	0		/* no further special treatment */
82 #define MADV_RANDOM	1		/* expect random page references */
83 #define MADV_SEQUENTIAL	2		/* expect sequential page references */
84 #define MADV_WILLNEED	3		/* will need these pages */
85 #define MADV_DONTNEED	4		/* don't need these pages */
86 
87 /* common parameters: try to keep these consistent across architectures */
88 #define MADV_FREE	8		/* free pages only if memory pressure */
89 #define MADV_REMOVE	9		/* remove these pages & resources */
90 #define MADV_DONTFORK	10		/* don't inherit across fork */
91 #define MADV_DOFORK	11		/* do inherit across fork */
92 
93 #define MADV_MERGEABLE   12		/* KSM may merge identical pages */
94 #define MADV_UNMERGEABLE 13		/* KSM may not merge identical pages */
95 
96 #define MADV_HUGEPAGE	14		/* Worth backing with hugepages */
97 #define MADV_NOHUGEPAGE	15		/* Not worth backing with hugepages */
98 
99 #define MADV_DONTDUMP   16		/* Explicity exclude from the core dump,
100 					   overrides the coredump filter bits */
101 #define MADV_DODUMP	17		/* Clear the MADV_NODUMP flag */
102 
103 #define MADV_WIPEONFORK 18		/* Zero memory on fork, child only */
104 #define MADV_KEEPONFORK 19		/* Undo MADV_WIPEONFORK */
105 
106 #define MADV_COLD	20		/* deactivate these pages */
107 #define MADV_PAGEOUT	21		/* reclaim these pages */
108 
109 #define MADV_POPULATE_READ	22	/* populate (prefault) page tables readable */
110 #define MADV_POPULATE_WRITE	23	/* populate (prefault) page tables writable */
111 
112 #define MADV_DONTNEED_LOCKED	24	/* like DONTNEED, but drop locked pages too */
113 
114 #define MADV_COLLAPSE	25		/* Synchronous hugepage collapse */
115 
116 /* compatibility flags */
117 #define MAP_FILE	0
118 
119 #define PKEY_DISABLE_ACCESS	0x1
120 #define PKEY_DISABLE_WRITE	0x2
121 #define PKEY_ACCESS_MASK	(PKEY_DISABLE_ACCESS |\
122 				 PKEY_DISABLE_WRITE)
123 
124 #endif /* _XTENSA_MMAN_H */
125