[thirdparty/glibc.git] / sysdeps / unix / sysv / linux / alpha / bits / mman.h

/* Definitions for POSIX memory map interface.  Linux/Alpha version.
   Copyright (C) 1997, 1998, 2000, 2003, 2006, 2009
   Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library.  If not, see
   <http://www.gnu.org/licenses/>.  */

#ifndef _SYS_MMAN_H
# error "Never use <bits/mman.h> directly; include <sys/mman.h> instead."
#endif

/* The following definitions basically come from the kernel headers.
   But the kernel header is not namespace clean.  */


/* Protections are chosen from these bits, OR'd together.  The
   implementation does not necessarily support PROT_EXEC or PROT_WRITE
   without PROT_READ.  The only guarantees are that no writing will be
   allowed without PROT_WRITE and no access will be allowed for PROT_NONE. */

#define PROT_READ	  0x1		/* Page can be read.  */
#define PROT_WRITE	  0x2		/* Page can be written.  */
#define PROT_EXEC	  0x4		/* Page can be executed.  */
#define PROT_NONE	  0x0		/* Page can not be accessed.  */
#define PROT_GROWSDOWN	  0x01000000	/* Extend change to start of
					   growsdown vma (mprotect only).  */
#define PROT_GROWSUP	  0x02000000	/* Extend change to start of
					   growsup vma (mprotect only).  */

/* Sharing types (must choose one and only one of these).  */
#define MAP_SHARED	  0x01		/* Share changes.  */
#define MAP_PRIVATE	  0x02		/* Changes are private.  */
#ifdef __USE_MISC
# define MAP_TYPE	  0x0f		/* Mask for type of mapping.  */
#endif

/* Other flags.  */
#define MAP_FIXED	  0x100		/* Interpret addr exactly.  */
#ifdef __USE_MISC
# define MAP_FILE	  0
# define MAP_ANONYMOUS	  0x10		/* Don't use a file.  */
# define MAP_ANON	  MAP_ANONYMOUS
#endif

/* Not used by Linux, but here to make sure we don't clash with
   OSF/1 defines.  */
#if 0 && defined __USE_BSD
# define MAP_HASSEMAPHORE 0x0200
# define MAP_INHERIT	  0x0400
# define MAP_UNALIGNED	  0x0800
#endif

/* These are Linux-specific.  */
#ifdef __USE_MISC
# define MAP_GROWSDOWN	  0x01000	/* Stack-like segment.  */
# define MAP_DENYWRITE	  0x02000	/* ETXTBSY */
# define MAP_EXECUTABLE	  0x04000	/* Mark it as an executable.  */
# define MAP_LOCKED	  0x08000	/* Lock the mapping.  */
# define MAP_NORESERVE	  0x10000	/* Don't check for reservations.  */
# define MAP_POPULATE	  0x20000	/* Populate (prefault) pagetables.  */
# define MAP_NONBLOCK	  0x40000	/* Do not block on IO.  */
#endif

/* Flags to `msync'.  */
#define MS_ASYNC	  1		/* Sync memory asynchronously.  */
#define MS_SYNC		  2		/* Synchronous memory sync.  */
#define MS_INVALIDATE	  4		/* Invalidate the caches.  */

/* Flags for `mlockall'.  */
#define MCL_CURRENT	  8192		/* Lock all currently mapped pages.  */
#define MCL_FUTURE	  16384		/* Lock all additions to address
					   space.  */

/* Flags for `mremap'.  */
#ifdef __USE_GNU
# define MREMAP_MAYMOVE	1
# define MREMAP_FIXED	2
#endif

/* Advice to `madvise'.  */
#ifdef __USE_BSD
# define MADV_NORMAL      0  /* No further special treatment.  */
# define MADV_RANDOM      1  /* Expect random page references.  */
# define MADV_SEQUENTIAL  2  /* Expect sequential page references.  */
# define MADV_WILLNEED    3  /* Will need these pages.  */
# define MADV_DONTNEED    6  /* Don't need these pages.  */
# define MADV_REMOVE      9  /* Remove these pages and resources.  */
# define MADV_DONTFORK    10 /* Do not inherit across fork.  */
# define MADV_DOFORK      11 /* Do inherit across fork.  */
# define MADV_MERGEABLE   12 /* KSM may merge identical pages.  */
# define MADV_UNMERGEABLE 13 /* KSM may not merge identical pages.  */
# define MADV_HWPOISON   100 /* Poison a page for testing.  */
#endif

/* The POSIX people had to invent similar names for the same things.  */
#ifdef __USE_XOPEN2K
# define POSIX_MADV_NORMAL	0 /* No further special treatment.  */
# define POSIX_MADV_RANDOM	1 /* Expect random page references.  */
# define POSIX_MADV_SEQUENTIAL	2 /* Expect sequential page references.  */
# define POSIX_MADV_WILLNEED	3 /* Will need these pages.  */
# define POSIX_MADV_DONTNEED	6 /* Don't need these pages.  */
#endif

/* Not used by Linux, but here to make sure we don't clash with
   OSF/1 defines.  */
#if 0 && defined __USE_BSD
# define MADV_DONTNEED_COMPAT 4	/* Old version?  */
# define MADV_SPACEAVAIL 5	/* Ensure resources are available.  */
#endif
Commit	Line	Data
90571408	1	/* Definitions for POSIX memory map interface. Linux/Alpha version.
4dc21b9d MT	2	Copyright (C) 1997, 1998, 2000, 2003, 2006, 2009
4dc21b9d MT	3	Free Software Foundation, Inc.
177c2e9a UD	4	This file is part of the GNU C Library.
	5
	6	The GNU C Library is free software; you can redistribute it and/or
3214b89b AJ	7	modify it under the terms of the GNU Lesser General Public
	8	License as published by the Free Software Foundation; either
	9	version 2.1 of the License, or (at your option) any later version.
177c2e9a UD	10
	11	The GNU C Library is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3214b89b	14	Lesser General Public License for more details.
177c2e9a	15
3214b89b	16	You should have received a copy of the GNU Lesser General Public
ab84e3ff PE	17	License along with the GNU C Library. If not, see
ab84e3ff PE	18	<http://www.gnu.org/licenses/>. */
177c2e9a UD	19
177c2e9a UD	20	#ifndef _SYS_MMAN_H
90571408	21	# error "Never use <bits/mman.h> directly; include <sys/mman.h> instead."
177c2e9a UD	22	#endif
	23
	24	/* The following definitions basically come from the kernel headers.
	25	But the kernel header is not namespace clean. */
	26
	27
	28	/* Protections are chosen from these bits, OR'd together. The
	29	implementation does not necessarily support PROT_EXEC or PROT_WRITE
	30	without PROT_READ. The only guarantees are that no writing will be
	31	allowed without PROT_WRITE and no access will be allowed for PROT_NONE. */
	32
	33	#define PROT_READ 0x1 /* Page can be read. */
	34	#define PROT_WRITE 0x2 /* Page can be written. */
	35	#define PROT_EXEC 0x4 /* Page can be executed. */
	36	#define PROT_NONE 0x0 /* Page can not be accessed. */
3d87932d UD	37	#define PROT_GROWSDOWN 0x01000000 /* Extend change to start of
	38	growsdown vma (mprotect only). */
	39	#define PROT_GROWSUP 0x02000000 /* Extend change to start of
	40	growsup vma (mprotect only). */
177c2e9a UD	41
	42	/* Sharing types (must choose one and only one of these). */
	43	#define MAP_SHARED 0x01 /* Share changes. */
	44	#define MAP_PRIVATE 0x02 /* Changes are private. */
	45	#ifdef __USE_MISC
	46	# define MAP_TYPE 0x0f /* Mask for type of mapping. */
	47	#endif
	48
	49	/* Other flags. */
	50	#define MAP_FIXED 0x100 /* Interpret addr exactly. */
	51	#ifdef __USE_MISC
	52	# define MAP_FILE 0
	53	# define MAP_ANONYMOUS 0x10 /* Don't use a file. */
	54	# define MAP_ANON MAP_ANONYMOUS
	55	#endif
	56
651f8ea8 RH	57	/* Not used by Linux, but here to make sure we don't clash with
651f8ea8 RH	58	OSF/1 defines. */
3d87932d	59	#if 0 && defined __USE_BSD
177c2e9a UD	60	# define MAP_HASSEMAPHORE 0x0200
	61	# define MAP_INHERIT 0x0400
	62	# define MAP_UNALIGNED 0x0800
	63	#endif
	64
	65	/* These are Linux-specific. */
	66	#ifdef __USE_MISC
aca56a7f UD	67	# define MAP_GROWSDOWN 0x01000 /* Stack-like segment. */
	68	# define MAP_DENYWRITE 0x02000 /* ETXTBSY */
	69	# define MAP_EXECUTABLE 0x04000 /* Mark it as an executable. */
	70	# define MAP_LOCKED 0x08000 /* Lock the mapping. */
177c2e9a	71	# define MAP_NORESERVE 0x10000 /* Don't check for reservations. */
aca56a7f UD	72	# define MAP_POPULATE 0x20000 /* Populate (prefault) pagetables. */
aca56a7f UD	73	# define MAP_NONBLOCK 0x40000 /* Do not block on IO. */
177c2e9a UD	74	#endif
	75
	76	/* Flags to `msync'. */
	77	#define MS_ASYNC 1 /* Sync memory asynchronously. */
	78	#define MS_SYNC 2 /* Synchronous memory sync. */
	79	#define MS_INVALIDATE 4 /* Invalidate the caches. */
	80
	81	/* Flags for `mlockall'. */
	82	#define MCL_CURRENT 8192 /* Lock all currently mapped pages. */
	83	#define MCL_FUTURE 16384 /* Lock all additions to address
	84	space. */
	85
	86	/* Flags for `mremap'. */
	87	#ifdef __USE_GNU
	88	# define MREMAP_MAYMOVE 1
971a928c	89	# define MREMAP_FIXED 2
177c2e9a	90	#endif
cd112ac0 RH	91
	92	/* Advice to `madvise'. */
	93	#ifdef __USE_BSD
4dc21b9d MT	94	# define MADV_NORMAL 0 /* No further special treatment. */
	95	# define MADV_RANDOM 1 /* Expect random page references. */
	96	# define MADV_SEQUENTIAL 2 /* Expect sequential page references. */
	97	# define MADV_WILLNEED 3 /* Will need these pages. */
	98	# define MADV_DONTNEED 6 /* Don't need these pages. */
	99	# define MADV_REMOVE 9 /* Remove these pages and resources. */
	100	# define MADV_DONTFORK 10 /* Do not inherit across fork. */
	101	# define MADV_DOFORK 11 /* Do inherit across fork. */
	102	# define MADV_MERGEABLE 12 /* KSM may merge identical pages. */
	103	# define MADV_UNMERGEABLE 13 /* KSM may not merge identical pages. */
	104	# define MADV_HWPOISON 100 /* Poison a page for testing. */
cd112ac0 RH	105	#endif
cd112ac0 RH	106
fd327b88 UD	107	/* The POSIX people had to invent similar names for the same things. */
	108	#ifdef __USE_XOPEN2K
	109	# define POSIX_MADV_NORMAL 0 /* No further special treatment. */
	110	# define POSIX_MADV_RANDOM 1 /* Expect random page references. */
	111	# define POSIX_MADV_SEQUENTIAL 2 /* Expect sequential page references. */
	112	# define POSIX_MADV_WILLNEED 3 /* Will need these pages. */
	113	# define POSIX_MADV_DONTNEED 6 /* Don't need these pages. */
	114	#endif
	115
cd112ac0 RH	116	/* Not used by Linux, but here to make sure we don't clash with
cd112ac0 RH	117	OSF/1 defines. */
3d87932d	118	#if 0 && defined __USE_BSD
cd112ac0 RH	119	# define MADV_DONTNEED_COMPAT 4 /* Old version? */
	120	# define MADV_SPACEAVAIL 5 /* Ensure resources are available. */
	121	#endif