[thirdparty/glibc.git] / bits / mman.h

/* Definitions for BSD-style memory management.
   Copyright (C) 1994-1998,2000,01,02 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, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA.  */

/* These are the bits used by 4.4 BSD and its derivatives.  On systems
   (such as GNU) where these facilities are not system services but can be
   emulated in the C library, these are the definitions we emulate.  */

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

/* 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_NONE	 0x00	/* No access.  */
#define	PROT_READ	 0x04	/* Pages can be read.  */
#define	PROT_WRITE	 0x02	/* Pages can be written.  */
#define	PROT_EXEC	 0x01	/* Pages can be executed.  */

/* Flags contain mapping type, sharing type and options.  */

/* Mapping type (must choose one and only one of these).  */
#ifdef __USE_BSD
# define MAP_FILE	 0x0001	/* Mapped from a file or device.  */
# define MAP_ANON	 0x0002	/* Allocated from anonymous virtual memory.  */
# define MAP_TYPE	 0x000f	/* Mask for type field.  */
# ifdef __USE_MISC
#  define MAP_ANONYMOUS  MAP_ANON /* Linux name. */
# endif
#endif

/* Sharing types (must choose one and only one of these).  */
#ifdef __USE_BSD
# define MAP_COPY	 0x0020	/* Virtual copy of region at mapping time.  */
#endif
#define	MAP_SHARED	 0x0010	/* Share changes.  */
#define	MAP_PRIVATE	 0x0000	/* Changes private; copy pages on write.  */

/* Other flags.  */
#define	MAP_FIXED	 0x0100	/* Map address must be exactly as requested. */
#ifdef __USE_BSD
# define MAP_NOEXTEND	 0x0200	/* For MAP_FILE, don't change file size.  */
# define MAP_HASSEMPHORE 0x0400	/* Region may contain semaphores.  */
# define MAP_INHERIT	 0x0800	/* Region is retained after exec.  */
#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	 4	/* Don't need these pages.  */
#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	4 /* Don't need these pages.  */
#endif

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

/* Flags for `mlockall' (can be OR'd together).  */
#define MCL_CURRENT	1		/* Lock all currently mapped pages.  */
#define MCL_FUTURE	2		/* Lock all additions to address
					   space.  */
Commit	Line	Data
3d42e04d	1	/* Definitions for BSD-style memory management.
a334319f	2	Copyright (C) 1994-1998,2000,01,02 Free Software Foundation, Inc.
54d79e99 UD	3	This file is part of the GNU C Library.
	4
	5	The GNU C Library is free software; you can redistribute it and/or
41bdb6e2 AJ	6	modify it under the terms of the GNU Lesser General Public
	7	License as published by the Free Software Foundation; either
	8	version 2.1 of the License, or (at your option) any later version.
54d79e99 UD	9
	10	The GNU C Library is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2	13	Lesser General Public License for more details.
54d79e99	14
41bdb6e2 AJ	15	You should have received a copy of the GNU Lesser General Public
	16	License along with the GNU C Library; if not, write to the Free
	17	Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	18	02111-1307 USA. */
28f540f4 RM	19
	20	/* These are the bits used by 4.4 BSD and its derivatives. On systems
	21	(such as GNU) where these facilities are not system services but can be
	22	emulated in the C library, these are the definitions we emulate. */
	23
8f6f7a31 UD	24	#ifndef _SYS_MMAN_H
	25	# error "Never use <bits/mman.h> directly; include <sys/mman.h> instead."
	26	#endif
28f540f4 RM	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
0413b54c UD	33	#define PROT_NONE 0x00 /* No access. */
	34	#define PROT_READ 0x04 /* Pages can be read. */
	35	#define PROT_WRITE 0x02 /* Pages can be written. */
	36	#define PROT_EXEC 0x01 /* Pages can be executed. */
28f540f4	37
28f540f4 RM	38	/* Flags contain mapping type, sharing type and options. */
	39
	40	/* Mapping type (must choose one and only one of these). */
0413b54c UD	41	#ifdef __USE_BSD
	42	# define MAP_FILE 0x0001 /* Mapped from a file or device. */
	43	# define MAP_ANON 0x0002 /* Allocated from anonymous virtual memory. */
	44	# define MAP_TYPE 0x000f /* Mask for type field. */
6ac73ea7 RM	45	# ifdef __USE_MISC
	46	# define MAP_ANONYMOUS MAP_ANON /* Linux name. */
	47	# endif
0413b54c	48	#endif
28f540f4 RM	49
28f540f4 RM	50	/* Sharing types (must choose one and only one of these). */
0413b54c UD	51	#ifdef __USE_BSD
	52	# define MAP_COPY 0x0020 /* Virtual copy of region at mapping time. */
	53	#endif
	54	#define MAP_SHARED 0x0010 /* Share changes. */
	55	#define MAP_PRIVATE 0x0000 /* Changes private; copy pages on write. */
28f540f4 RM	56
28f540f4 RM	57	/* Other flags. */
0413b54c UD	58	#define MAP_FIXED 0x0100 /* Map address must be exactly as requested. */
	59	#ifdef __USE_BSD
	60	# define MAP_NOEXTEND 0x0200 /* For MAP_FILE, don't change file size. */
	61	# define MAP_HASSEMPHORE 0x0400 /* Region may contain semaphores. */
	62	# define MAP_INHERIT 0x0800 /* Region is retained after exec. */
	63	#endif
28f540f4 RM	64
28f540f4 RM	65	/* Advice to `madvise'. */
0413b54c UD	66	#ifdef __USE_BSD
	67	# define MADV_NORMAL 0 /* No further special treatment. */
	68	# define MADV_RANDOM 1 /* Expect random page references. */
	69	# define MADV_SEQUENTIAL 2 /* Expect sequential page references. */
	70	# define MADV_WILLNEED 3 /* Will need these pages. */
	71	# define MADV_DONTNEED 4 /* Don't need these pages. */
	72	#endif
	73
8f6f7a31 UD	74	/* The POSIX people had to invent similar names for the same things. */
	75	#ifdef __USE_XOPEN2K
	76	# define POSIX_MADV_NORMAL 0 /* No further special treatment. */
	77	# define POSIX_MADV_RANDOM 1 /* Expect random page references. */
	78	# define POSIX_MADV_SEQUENTIAL 2 /* Expect sequential page references. */
	79	# define POSIX_MADV_WILLNEED 3 /* Will need these pages. */
	80	# define POSIX_MADV_DONTNEED 4 /* Don't need these pages. */
	81	#endif
d81b986b	82
3a2832a0 RM	83	/* Flags to `msync'. */
	84	#define MS_ASYNC 1 /* Sync memory asynchronously. */
	85	#define MS_SYNC 0 /* Synchronous memory sync. */
	86	#define MS_INVALIDATE 2 /* Invalidate the caches. */
d81b986b RM	87
	88	/* Flags for `mlockall' (can be OR'd together). */
	89	#define MCL_CURRENT 1 /* Lock all currently mapped pages. */
	90	#define MCL_FUTURE 2 /* Lock all additions to address
	91	space. */