src/Unix/vm_alloc.h

/*
 *  vm_alloc.h - Wrapper to various virtual memory allocation schemes
 *               (supports mmap, vm_allocate or fallbacks to malloc)
 *
 *  Basilisk II (C) 1997-2005 Christian Bauer
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef VM_ALLOC_H
#define VM_ALLOC_H

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#include <sys/types.h>
#endif
#ifdef HAVE_SYS_MMAN_H
#include <sys/mman.h>
#endif
#ifdef HAVE_MACH_VM
extern "C" {
#include <mach/mach.h>
}
#endif

/* Return value of `vm_acquire' in case of an error.  */
#ifdef HAVE_MACH_VM
#define VM_MAP_FAILED                   ((void *)-1)
#else
#ifdef HAVE_MMAP_VM
#define VM_MAP_FAILED                   ((void *)-1)
#else
#define VM_MAP_FAILED                   0
#endif
#endif

/* Mapping options.  */
#define VM_MAP_SHARED                   0x01
#define VM_MAP_PRIVATE                  0x02
#define VM_MAP_FIXED                    0x04
#define VM_MAP_32BIT                    0x08

/* Default mapping options.  */
#define VM_MAP_DEFAULT                  (VM_MAP_PRIVATE)

/* Protection bits.  */
#ifdef HAVE_MACH_VM
#define VM_PAGE_NOACCESS                VM_PROT_NONE
#define VM_PAGE_READ                    VM_PROT_READ
#define VM_PAGE_WRITE                   VM_PROT_WRITE
#define VM_PAGE_EXECUTE                 VM_PROT_EXECUTE
#else
#ifdef HAVE_MMAP_VM
#define VM_PAGE_NOACCESS                PROT_NONE
#define VM_PAGE_READ                    PROT_READ
#define VM_PAGE_WRITE                   PROT_WRITE
#define VM_PAGE_EXECUTE                 PROT_EXEC
#else
#define VM_PAGE_NOACCESS                0x0
#define VM_PAGE_READ                    0x1
#define VM_PAGE_WRITE                   0x2
#define VM_PAGE_EXECUTE                 0x4
#endif
#endif

/* Default protection bits.  */
#define VM_PAGE_DEFAULT                 (VM_PAGE_READ | VM_PAGE_WRITE)

/* Initialize the VM system. Returns 0 if successful, -1 for errors.  */

extern int vm_init(void);

/* Deallocate all internal data used to wrap virtual memory allocators.  */

extern void vm_exit(void);

/* Allocate zero-filled memory of SIZE bytes. The mapping is private
   and default protection bits are read / write. The return value
   is the actual mapping address chosen or VM_MAP_FAILED for errors.  */

extern void * vm_acquire(size_t size, int options = VM_MAP_DEFAULT);

/* Allocate zero-filled memory at exactly ADDR (which must be page-aligned).
   Returns 0 if successful, -1 on errors.  */

extern int vm_acquire_fixed(void * addr, size_t size, int options = VM_MAP_DEFAULT);

/* Deallocate any mapping for the region starting at ADDR and extending
   LEN bytes. Returns 0 if successful, -1 on errors.  */

extern int vm_release(void * addr, size_t size);

/* Change the memory protection of the region starting at ADDR and
   extending LEN bytes to PROT. Returns 0 if successful, -1 for errors.  */

extern int vm_protect(void * addr, size_t size, int prot);

/* Returns the size of a page.  */

extern int vm_get_page_size(void);

#endif /* VM_ALLOC_H */
Revision:	1.12
Committed:	2007-01-13T18:21:30Z (17 years, 5 months ago) by gbeauche
Content type:	text/plain
Branch:	MAIN
Changes since 1.11:	+0 -1 lines
Log Message:	Remove the 33-bit addressing hack as it's overly complex for not much gain. Rather, use an address override prefix (0x67) though Intel Core optimization reference guide says to avoid LCP prefixes. In practise, impact on performance is measurably marginal on e.g. Speedometer tests.
#	User	Rev	Content
1	gbeauche	1.1	/*
2			* vm_alloc.h - Wrapper to various virtual memory allocation schemes
3			* (supports mmap, vm_allocate or fallbacks to malloc)
4			*
5	gbeauche	1.10	* Basilisk II (C) 1997-2005 Christian Bauer
6	gbeauche	1.1	*
7			* This program is free software; you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation; either version 2 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with this program; if not, write to the Free Software
19			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20			*/
21
22			#ifndef VM_ALLOC_H
23			#define VM_ALLOC_H
24
25			#ifdef HAVE_UNISTD_H
26			#include <unistd.h>
27	gbeauche	1.3	#include <sys/types.h>
28	gbeauche	1.1	#endif
29			#ifdef HAVE_SYS_MMAN_H
30			#include <sys/mman.h>
31			#endif
32	gbeauche	1.4	#ifdef HAVE_MACH_VM
33			extern "C" {
34			#include <mach/mach.h>
35			}
36			#endif
37	gbeauche	1.1
38			/* Return value of `vm_acquire' in case of an error. */
39			#ifdef HAVE_MACH_VM
40			#define VM_MAP_FAILED ((void *)-1)
41			#else
42			#ifdef HAVE_MMAP_VM
43			#define VM_MAP_FAILED ((void *)-1)
44			#else
45			#define VM_MAP_FAILED 0
46			#endif
47			#endif
48
49	gbeauche	1.5	/* Mapping options. */
50			#define VM_MAP_SHARED 0x01
51			#define VM_MAP_PRIVATE 0x02
52			#define VM_MAP_FIXED 0x04
53			#define VM_MAP_32BIT 0x08
54
55			/* Default mapping options. */
56			#define VM_MAP_DEFAULT (VM_MAP_PRIVATE)
57
58	gbeauche	1.1	/* Protection bits. */
59			#ifdef HAVE_MACH_VM
60			#define VM_PAGE_NOACCESS VM_PROT_NONE
61			#define VM_PAGE_READ VM_PROT_READ
62			#define VM_PAGE_WRITE VM_PROT_WRITE
63			#define VM_PAGE_EXECUTE VM_PROT_EXECUTE
64			#else
65			#ifdef HAVE_MMAP_VM
66			#define VM_PAGE_NOACCESS PROT_NONE
67			#define VM_PAGE_READ PROT_READ
68			#define VM_PAGE_WRITE PROT_WRITE
69			#define VM_PAGE_EXECUTE PROT_EXEC
70			#else
71			#define VM_PAGE_NOACCESS 0x0
72			#define VM_PAGE_READ 0x1
73			#define VM_PAGE_WRITE 0x2
74			#define VM_PAGE_EXECUTE 0x4
75			#endif
76			#endif
77
78			/* Default protection bits. */
79			#define VM_PAGE_DEFAULT (VM_PAGE_READ \| VM_PAGE_WRITE)
80
81			/* Initialize the VM system. Returns 0 if successful, -1 for errors. */
82
83			extern int vm_init(void);
84
85			/* Deallocate all internal data used to wrap virtual memory allocators. */
86
87			extern void vm_exit(void);
88
89			/* Allocate zero-filled memory of SIZE bytes. The mapping is private
90			and default protection bits are read / write. The return value
91			is the actual mapping address chosen or VM_MAP_FAILED for errors. */
92
93	gbeauche	1.5	extern void * vm_acquire(size_t size, int options = VM_MAP_DEFAULT);
94	gbeauche	1.1
95			/* Allocate zero-filled memory at exactly ADDR (which must be page-aligned).
96			Returns 0 if successful, -1 on errors. */
97
98	gbeauche	1.5	extern int vm_acquire_fixed(void * addr, size_t size, int options = VM_MAP_DEFAULT);
99	gbeauche	1.1
100			/* Deallocate any mapping for the region starting at ADDR and extending
101			LEN bytes. Returns 0 if successful, -1 on errors. */
102
103			extern int vm_release(void * addr, size_t size);
104
105			/* Change the memory protection of the region starting at ADDR and
106			extending LEN bytes to PROT. Returns 0 if successful, -1 for errors. */
107
108			extern int vm_protect(void * addr, size_t size, int prot);
109
110	gbeauche	1.8	/* Returns the size of a page. */
111
112	gbeauche	1.9	extern int vm_get_page_size(void);
113	gbeauche	1.8
114	gbeauche	1.1	#endif /* VM_ALLOC_H */