The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/mman.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 1982, 1986, 1993
    3  *      The Regents of the University of California.  All rights reserved.
    4  *
    5  * Redistribution and use in source and binary forms, with or without
    6  * modification, are permitted provided that the following conditions
    7  * are met:
    8  * 1. Redistributions of source code must retain the above copyright
    9  *    notice, this list of conditions and the following disclaimer.
   10  * 2. Redistributions in binary form must reproduce the above copyright
   11  *    notice, this list of conditions and the following disclaimer in the
   12  *    documentation and/or other materials provided with the distribution.
   13  * 4. Neither the name of the University nor the names of its contributors
   14  *    may be used to endorse or promote products derived from this software
   15  *    without specific prior written permission.
   16  *
   17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   27  * SUCH DAMAGE.
   28  *
   29  *      @(#)mman.h      8.2 (Berkeley) 1/9/95
   30  * $FreeBSD: releng/10.2/sys/sys/mman.h 271399 2014-09-10 15:45:18Z jhb $
   31  */
   32 
   33 #ifndef _SYS_MMAN_H_
   34 #define _SYS_MMAN_H_
   35 
   36 #include <sys/cdefs.h>
   37 #include <sys/_types.h>
   38 
   39 #if __BSD_VISIBLE
   40 /*
   41  * Inheritance for minherit()
   42  */
   43 #define INHERIT_SHARE   0
   44 #define INHERIT_COPY    1
   45 #define INHERIT_NONE    2
   46 #endif
   47 
   48 /*
   49  * Protections are chosen from these bits, or-ed together
   50  */
   51 #define PROT_NONE       0x00    /* no permissions */
   52 #define PROT_READ       0x01    /* pages can be read */
   53 #define PROT_WRITE      0x02    /* pages can be written */
   54 #define PROT_EXEC       0x04    /* pages can be executed */
   55 
   56 /*
   57  * Flags contain sharing type and options.
   58  * Sharing types; choose one.
   59  */
   60 #define MAP_SHARED      0x0001          /* share changes */
   61 #define MAP_PRIVATE     0x0002          /* changes are private */
   62 #if __BSD_VISIBLE
   63 #define MAP_COPY        MAP_PRIVATE     /* Obsolete */
   64 #endif
   65 
   66 /*
   67  * Other flags
   68  */
   69 #define MAP_FIXED        0x0010 /* map addr must be exactly as requested */
   70 
   71 #if __BSD_VISIBLE
   72 #define MAP_RENAME       0x0020 /* Sun: rename private pages to file */
   73 #define MAP_NORESERVE    0x0040 /* Sun: don't reserve needed swap area */
   74 #define MAP_RESERVED0080 0x0080 /* previously misimplemented MAP_INHERIT */
   75 #define MAP_RESERVED0100 0x0100 /* previously unimplemented MAP_NOEXTEND */
   76 #define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */
   77 #define MAP_STACK        0x0400 /* region grows down, like a stack */
   78 #define MAP_NOSYNC       0x0800 /* page to but do not sync underlying file */
   79 
   80 /*
   81  * Mapping type
   82  */
   83 #define MAP_FILE         0x0000 /* map from file (default) */
   84 #define MAP_ANON         0x1000 /* allocated from memory, swap space */
   85 #ifndef _KERNEL
   86 #define MAP_ANONYMOUS    MAP_ANON /* For compatibility. */
   87 #endif /* !_KERNEL */
   88 
   89 /*
   90  * Extended flags
   91  */
   92 #define MAP_EXCL         0x00004000 /* for MAP_FIXED, fail if address is used */
   93 #define MAP_NOCORE       0x00020000 /* dont include these pages in a coredump */
   94 #define MAP_PREFAULT_READ 0x00040000 /* prefault mapping for reading */
   95 #ifdef __LP64__
   96 #define MAP_32BIT        0x00080000 /* map in the low 2GB of address space */
   97 #endif
   98 
   99 /*
  100  * Request specific alignment (n == log2 of the desired alignment).
  101  *
  102  * MAP_ALIGNED_SUPER requests optimal superpage alignment, but does
  103  * not enforce a specific alignment.
  104  */
  105 #define MAP_ALIGNED(n)   ((n) << MAP_ALIGNMENT_SHIFT)
  106 #define MAP_ALIGNMENT_SHIFT     24
  107 #define MAP_ALIGNMENT_MASK      MAP_ALIGNED(0xff)
  108 #define MAP_ALIGNED_SUPER       MAP_ALIGNED(1) /* align on a superpage */
  109 #endif /* __BSD_VISIBLE */
  110 
  111 #if __POSIX_VISIBLE >= 199309
  112 /*
  113  * Process memory locking
  114  */
  115 #define MCL_CURRENT     0x0001  /* Lock only current memory */
  116 #define MCL_FUTURE      0x0002  /* Lock all future memory as well */
  117 #endif
  118 
  119 /*
  120  * Error return from mmap()
  121  */
  122 #define MAP_FAILED      ((void *)-1)
  123 
  124 /*
  125  * msync() flags
  126  */
  127 #define MS_SYNC         0x0000  /* msync synchronously */
  128 #define MS_ASYNC        0x0001  /* return immediately */
  129 #define MS_INVALIDATE   0x0002  /* invalidate all cached data */
  130 
  131 /*
  132  * Advice to madvise
  133  */
  134 #define _MADV_NORMAL    0       /* no further special treatment */
  135 #define _MADV_RANDOM    1       /* expect random page references */
  136 #define _MADV_SEQUENTIAL 2      /* expect sequential page references */
  137 #define _MADV_WILLNEED  3       /* will need these pages */
  138 #define _MADV_DONTNEED  4       /* dont need these pages */
  139 
  140 #if __BSD_VISIBLE
  141 #define MADV_NORMAL     _MADV_NORMAL
  142 #define MADV_RANDOM     _MADV_RANDOM
  143 #define MADV_SEQUENTIAL _MADV_SEQUENTIAL
  144 #define MADV_WILLNEED   _MADV_WILLNEED
  145 #define MADV_DONTNEED   _MADV_DONTNEED
  146 #define MADV_FREE       5       /* dont need these pages, and junk contents */
  147 #define MADV_NOSYNC     6       /* try to avoid flushes to physical media */
  148 #define MADV_AUTOSYNC   7       /* revert to default flushing strategy */
  149 #define MADV_NOCORE     8       /* do not include these pages in a core file */
  150 #define MADV_CORE       9       /* revert to including pages in a core file */
  151 #define MADV_PROTECT    10      /* protect process from pageout kill */
  152 
  153 /*
  154  * Return bits from mincore
  155  */
  156 #define MINCORE_INCORE           0x1 /* Page is incore */
  157 #define MINCORE_REFERENCED       0x2 /* Page has been referenced by us */
  158 #define MINCORE_MODIFIED         0x4 /* Page has been modified by us */
  159 #define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
  160 #define MINCORE_MODIFIED_OTHER  0x10 /* Page has been modified */
  161 #define MINCORE_SUPER           0x20 /* Page is a "super" page */
  162 
  163 /*
  164  * Anonymous object constant for shm_open().
  165  */
  166 #define SHM_ANON                ((char *)1)
  167 #endif /* __BSD_VISIBLE */
  168 
  169 /*
  170  * XXX missing POSIX_TYPED_MEM_* macros and
  171  * posix_typed_mem_info structure.
  172  */
  173 #if __POSIX_VISIBLE >= 200112
  174 #define POSIX_MADV_NORMAL       _MADV_NORMAL
  175 #define POSIX_MADV_RANDOM       _MADV_RANDOM
  176 #define POSIX_MADV_SEQUENTIAL   _MADV_SEQUENTIAL
  177 #define POSIX_MADV_WILLNEED     _MADV_WILLNEED
  178 #define POSIX_MADV_DONTNEED     _MADV_DONTNEED
  179 #endif
  180 
  181 #ifndef _MODE_T_DECLARED
  182 typedef __mode_t        mode_t;
  183 #define _MODE_T_DECLARED
  184 #endif
  185 
  186 #ifndef _OFF_T_DECLARED
  187 typedef __off_t         off_t;
  188 #define _OFF_T_DECLARED
  189 #endif
  190 
  191 #ifndef _SIZE_T_DECLARED
  192 typedef __size_t        size_t;
  193 #define _SIZE_T_DECLARED
  194 #endif
  195 
  196 #if defined(_KERNEL) || defined(_WANT_FILE)
  197 #include <sys/lock.h>
  198 #include <sys/mutex.h>
  199 #include <sys/queue.h>
  200 #include <sys/rangelock.h>
  201 #include <vm/vm.h>
  202 
  203 struct file;
  204 
  205 struct shmfd {
  206         size_t          shm_size;
  207         vm_object_t     shm_object;
  208         int             shm_refs;
  209         uid_t           shm_uid;
  210         gid_t           shm_gid;
  211         mode_t          shm_mode;
  212         int             shm_kmappings;
  213 
  214         /*
  215          * Values maintained solely to make this a better-behaved file
  216          * descriptor for fstat() to run on.
  217          */
  218         struct timespec shm_atime;
  219         struct timespec shm_mtime;
  220         struct timespec shm_ctime;
  221         struct timespec shm_birthtime;
  222         ino_t           shm_ino;
  223 
  224         struct label    *shm_label;             /* MAC label */
  225         const char      *shm_path;
  226 
  227         struct rangelock shm_rl;
  228         struct mtx      shm_mtx;
  229 };
  230 #endif
  231 
  232 #ifdef _KERNEL
  233 int     shm_mmap(struct shmfd *shmfd, vm_size_t objsize, vm_ooffset_t foff,
  234             vm_object_t *obj);
  235 int     shm_map(struct file *fp, size_t size, off_t offset, void **memp);
  236 int     shm_unmap(struct file *fp, void *mem, size_t size);
  237 void    shm_path(struct shmfd *shmfd, char *path, size_t size);
  238 
  239 #else /* !_KERNEL */
  240 
  241 __BEGIN_DECLS
  242 /*
  243  * XXX not yet implemented: posix_mem_offset(), posix_typed_mem_get_info(),
  244  * posix_typed_mem_open().
  245  */
  246 #if __BSD_VISIBLE
  247 int     getpagesizes(size_t *, int);
  248 int     madvise(void *, size_t, int);
  249 int     mincore(const void *, size_t, char *);
  250 int     minherit(void *, size_t, int);
  251 #endif
  252 int     mlock(const void *, size_t);
  253 #ifndef _MMAP_DECLARED
  254 #define _MMAP_DECLARED
  255 void *  mmap(void *, size_t, int, int, int, off_t);
  256 #endif
  257 int     mprotect(const void *, size_t, int);
  258 int     msync(void *, size_t, int);
  259 int     munlock(const void *, size_t);
  260 int     munmap(void *, size_t);
  261 #if __POSIX_VISIBLE >= 200112
  262 int     posix_madvise(void *, size_t, int);
  263 #endif
  264 #if __POSIX_VISIBLE >= 199309
  265 int     mlockall(int);
  266 int     munlockall(void);
  267 int     shm_open(const char *, int, mode_t);
  268 int     shm_unlink(const char *);
  269 #endif
  270 __END_DECLS
  271 
  272 #endif /* !_KERNEL */
  273 
  274 #endif /* !_SYS_MMAN_H_ */

Cache object: 451687e99cea59b5c88b148941227c94


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.