sys/sys/mman.h

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