Synesis Software

include/sys/mman.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////////
00002  * File:    mman.h (sys/mman.h)
00003  *
00004  * Purpose: Declaration of the mmap() and munmap() API functions.
00005  *
00006  * Created: 18th December 2003
00007  * Updated: 12th September 2006
00008  *
00009  * Home:    http://synesis.com.au/software/
00010  *
00011  * Copyright (c) 2003-2006, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without 
00015  * modification, are permitted provided that the following conditions are met:
00016  *
00017  * - Redistributions of source code must retain the above copyright notice, this
00018  *   list of conditions and the following disclaimer. 
00019  * - Redistributions in binary form must reproduce the above copyright notice,
00020  *   this list of conditions and the following disclaimer in the documentation
00021  *   and/or other materials provided with the distribution.
00022  * - Neither the names of Matthew Wilson and Synesis Software nor the names of
00023  *   any contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00036  * POSSIBILITY OF SUCH DAMAGE.
00037  *
00038  * ////////////////////////////////////////////////////////////////////////// */
00039 
00040 
00046 #ifndef SYNSOFT_UNIXEM_INCL_SYS_H_MMAP
00047 #define SYNSOFT_UNIXEM_INCL_SYS_H_MMAP
00048 
00049 #ifndef UNIXEM_DOCUMENTATION_SKIP_SECTION
00050 # define SYNSOFT_UNIXEM_VER_SYS_H_MMAP_MAJOR    2
00051 # define SYNSOFT_UNIXEM_VER_SYS_H_MMAP_MINOR    1
00052 # define SYNSOFT_UNIXEM_VER_SYS_H_MMAP_REVISION 3
00053 # define SYNSOFT_UNIXEM_VER_SYS_H_MMAP_EDIT     18
00054 #endif /* !UNIXEM_DOCUMENTATION_SKIP_SECTION */
00055 
00056 #include <stddef.h>     /* for size_t */
00057 #include <sys/stat.h>   /* for off_t */
00058 #include <sys/types.h>
00059 
00060 /* ////////////////////////////////////////////////////////////////////////// */
00061 
00072 /* ////////////////////////////////////////////////////////////////////////// */
00073 
00074 #ifndef _WIN32
00075 # error This file is only currently defined for compilation on Win32 systems
00076 #endif /* _WIN32 */
00077 
00078 /* /////////////////////////////////////////////////////////////////////////////
00079  * Constants and definitions
00080  */
00081 
00082 #define PROT_READ       (0x01)          
00083 #define PROT_WRITE      (0x02)          
00084 #define PROT_EXEC       (0x04)          
00085 #define PROT_NONE       (0x00)          
00087 #define MAP_PRIVATE     (0x02)          
00088 #define MAP_ANONYMOUS   (0x20)          
00089 #define MAP_FIXED       (0x10)          
00091 #define MAP_FAILED      ((void*)-1)     
00093 /* /////////////////////////////////////////////////////////////////////////////
00094  * API functions
00095  */
00096 
00097 #ifdef __cplusplus
00098 extern "C"
00099 {
00100 #endif /* __cplusplus */
00101 
00120 void *mmap(void *addr, size_t len, int prot, int flags, int fd, off_t offset);
00121 
00135 int munmap(void *addr, size_t len);
00136 
00145 int msync(void *addr, size_t len, int flags);
00146 
00147 #ifdef __cplusplus
00148 } /* extern "C" */
00149 #endif /* __cplusplus */
00150 
00151 /* ////////////////////////////////////////////////////////////////////////// */
00152 
00155 /* ////////////////////////////////////////////////////////////////////////// */
00156 
00157 #endif /* SYNSOFT_UNIXEM_INCL_SYS_H_MMAP */
00158 
00159 /* ////////////////////////////////////////////////////////////////////////// */

UNIX Emulation for Win32 Libraries documentation © Synesis Software Pty Ltd, 2002-2005