include/sys/mman.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /* Copyright 2013 OmniTI Computer Consulting, Inc. All rights reserved. */
  23 /*
  24  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
  25  *
  26  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  27  * Use is subject to license terms.
  28  * Copyright 2015 Joyent, Inc.  All rights reserved.
  29  */
  30
  31 /*      Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T     */
  32 /*        All Rights Reserved   */
  33
  34 /*
  35  * University Copyright- Copyright (c) 1982, 1986, 1988
  36  * The Regents of the University of California
  37  * All Rights Reserved
  38  *
  39  * University Acknowledgment- Portions of this document are derived from
  40  * software developed by the University of California, Berkeley, and its
  41  * contributors.
  42  */
  43
  44 #ifndef _SYS_MMAN_H
  45 #define _SYS_MMAN_H
  46
  47 #include <sys/feature_tests.h>
  48
  49 #ifdef  __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 #if     !defined(_ASM) && !defined(_KERNEL)
  54 #include <sys/types.h>
  55 #endif  /* !_ASM && !_KERNEL */
  56
  57 /*
  58  * Protections are chosen from these bits, or-ed together.
  59  * Note - not all implementations literally provide all possible
  60  * combinations.  PROT_WRITE is often implemented as (PROT_READ |
  61  * PROT_WRITE) and (PROT_EXECUTE as PROT_READ | PROT_EXECUTE).
  62  * However, no implementation will permit a write to succeed
  63  * where PROT_WRITE has not been set.  Also, no implementation will
  64  * allow any access to succeed where prot is specified as PROT_NONE.
  65  */
  66 #define PROT_READ       0x1             /* pages can be read */
  67 #define PROT_WRITE      0x2             /* pages can be written */
  68 #define PROT_EXEC       0x4             /* pages can be executed */
  69
  70 #ifdef  _KERNEL
  71 #define PROT_USER       0x8             /* pages are user accessable */
  72 #define PROT_ZFOD       (PROT_READ | PROT_WRITE | PROT_EXEC | PROT_USER)
  73 #define PROT_ALL        (PROT_READ | PROT_WRITE | PROT_EXEC | PROT_USER)
  74 #endif  /* _KERNEL */
  75
  76 #define PROT_NONE       0x0             /* pages cannot be accessed */
  77
  78 /* sharing types:  must choose either SHARED or PRIVATE */
  79 #define MAP_SHARED      1               /* share changes */
  80 #define MAP_PRIVATE     2               /* changes are private */
  81 #define MAP_TYPE        0xf             /* mask for share type */
  82
  83 /* other flags to mmap (or-ed in to MAP_SHARED or MAP_PRIVATE) */
  84 #define MAP_FILE        0               /* map from file (default) */
  85 #define MAP_FIXED       0x10            /* user assigns address */
  86 /* Not implemented */
  87 #define MAP_RENAME      0x20            /* rename private pages to file */
  88 #define MAP_NORESERVE   0x40            /* don't reserve needed swap area */
  89 /* Note that 0x80 is _MAP_LOW32, defined below */
  90 #define MAP_ANON        0x100           /* map anonymous pages directly */
  91 #define MAP_ANONYMOUS   MAP_ANON        /* (source compatibility) */
  92 #define MAP_ALIGN       0x200           /* addr specifies alignment */
  93 #define MAP_TEXT        0x400           /* map code segment */
  94 #define MAP_INITDATA    0x800           /* map data segment */
  95
  96 #ifdef _KERNEL
  97 #define _MAP_TEXTREPL   0x1000
  98 #define _MAP_RANDOMIZE  0x2000
  99 #define _MAP_STARTLOW   0x4000
 100 #endif /* _KERNEL */
 101
 102 #if     (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2)
 103 /* these flags are used by memcntl */
 104 #define PROC_TEXT       (PROT_EXEC | PROT_READ)
 105 #define PROC_DATA       (PROT_READ | PROT_WRITE | PROT_EXEC)
 106 #define SHARED          0x10
 107 #define PRIVATE         0x20
 108 #define VALID_ATTR  (PROT_READ|PROT_WRITE|PROT_EXEC|SHARED|PRIVATE)
 109 #endif  /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) */
 110
 111 #if     (_POSIX_C_SOURCE <= 2) || defined(_XPG4_2)
 112 #ifdef  _KERNEL
 113 #define PROT_EXCL       0x20
 114 #endif  /* _KERNEL */
 115
 116 #define _MAP_LOW32      0x80    /* force mapping in lower 4G of address space */
 117 #define MAP_32BIT       _MAP_LOW32
 118 #endif  /* (_POSIX_C_SOURCE <= 2) */
 119
 120
 121 #ifdef __UNLEASHED_VISIBLE
 122 /* External flags for mmapobj syscall (Exclusive of MAP_* flags above) */
 123 #define MMOBJ_PADDING           0x10000
 124 #define MMOBJ_INTERPRET         0x20000
 125 #define MMOBJ_PRIMARY           0x40000
 126
 127 #define MMOBJ_ALL_FLAGS         (MMOBJ_PADDING |        \
 128     MMOBJ_INTERPRET |                                   \
 129     MMOBJ_PRIMARY)
 130
 131 /*
 132  * Values for mr_flags field of mmapobj_result_t below.
 133  * The bottom 16 bits are mutually exclusive and thus only one
 134  * of them can be set at a time.  Use MR_GET_TYPE below to check this value.
 135  * The top 16 bits are used for flags which are not mutually exclusive and
 136  * thus more than one of these flags can be set for a given mmapobj_result_t.
 137  *
 138  * MR_PADDING being set indicates that this memory range represents the user
 139  * requested padding.
 140  *
 141  * MR_HDR_ELF being set indicates that the ELF header of the mapped object
 142  * is mapped at mr_addr + mr_offset.
 143  *
 144  * MR_HDR_AOUT being set indicates that the AOUT (4.x) header of the mapped
 145  * object is mapped at mr_addr + mr_offset.
 146  */
 147
 148 /*
 149  * External flags for mr_flags field below.
 150  */
 151 #define MR_PADDING      0x1
 152 #define MR_HDR_ELF      0x2
 153 #define MR_HDR_AOUT     0x3
 154
 155 /*
 156  * Internal flags for mr_flags field below.
 157  */
 158 #ifdef  _KERNEL
 159 #define MR_RESV 0x80000000      /* overmapped /dev/null */
 160 #endif  /* _KERNEL */
 161
 162 #define MR_TYPE_MASK 0x0000ffff
 163 #define MR_GET_TYPE(val)        ((val) & MR_TYPE_MASK)
 164
 165 #if     !defined(_ASM)
 166 typedef struct mmapobj_result {
 167         caddr_t         mr_addr;        /* mapping address */
 168         size_t          mr_msize;       /* mapping size */
 169         size_t          mr_fsize;       /* file size */
 170         size_t          mr_offset;      /* offset into file */
 171         uint_t          mr_prot;        /* the protections provided */
 172         uint_t          mr_flags;       /* info on the mapping */
 173 } mmapobj_result_t;
 174 #if     !defined(_KERNEL)
 175 extern int mmapobj(int, uint_t, mmapobj_result_t *, uint_t *, void *);
 176 #endif  /* !defined(_KERNEL) */
 177
 178 #if defined(_KERNEL) || defined(_SYSCALL32)
 179 typedef struct mmapobj_result32 {
 180         caddr32_t       mr_addr;        /* mapping address */
 181         size32_t        mr_msize;       /* mapping size */
 182         size32_t        mr_fsize;       /* file size */
 183         size32_t        mr_offset;      /* offset into file */
 184         uint_t          mr_prot;        /* the protections provided */
 185         uint_t          mr_flags;       /* info on the mapping */
 186 } mmapobj_result32_t;
 187 #endif  /* defined(_KERNEL) || defined(_SYSCALL32) */
 188 #endif  /* !defined(_ASM) */
 189 #endif  /* __UNLEASHED_VISIBLE */
 190
 191 #if     !defined(_ASM) && !defined(_KERNEL)
 192 /*
 193  * large file compilation environment setup
 194  *
 195  * In the LP64 compilation environment, map large file interfaces
 196  * back to native versions where possible.
 197  */
 198
 199 #if !defined(_LP64) && _FILE_OFFSET_BITS == 64
 200 #ifdef  __PRAGMA_REDEFINE_EXTNAME
 201 #pragma redefine_extname        mmap    mmap64
 202 #else
 203 #define mmap                    mmap64
 204 #endif
 205 #endif /* !_LP64 && _FILE_OFFSET_BITS == 64 */
 206
 207 #if defined(_LP64) && defined(_LARGEFILE64_SOURCE)
 208 #ifdef  __PRAGMA_REDEFINE_EXTNAME
 209 #pragma redefine_extname        mmap64  mmap
 210 #else
 211 #define mmap64                  mmap
 212 #endif
 213 #endif  /* _LP64 && _LARGEFILE64_SOURCE */
 214
 215 #ifdef __PRAGMA_REDEFINE_EXTNAME
 216 #pragma redefine_extname        getpagesizes    getpagesizes2
 217 #else
 218 #define getpagesizes    getpagesizes2
 219 #endif
 220
 221 extern void *mmap(void *, size_t, int, int, int, off_t);
 222 extern int munmap(void *, size_t);
 223 extern int mprotect(void *, size_t, int);
 224 extern int msync(void *, size_t, int);
 225 extern int mlock(const void *, size_t);
 226 extern int munlock(const void *, size_t);
 227 /* transitional large file interface version */
 228 #if     defined(_LARGEFILE64_SOURCE) && !((_FILE_OFFSET_BITS == 64) && \
 229             !defined(__PRAGMA_REDEFINE_EXTNAME))
 230 extern void *mmap64(void *, size_t, int, int, int, off64_t);
 231 #endif  /* _LARGEFILE64_SOURCE... */
 232
 233 extern int mincore(caddr_t, size_t, char *);
 234 extern int memcntl(caddr_t, size_t, int, caddr_t, int, int);
 235 extern int madvise(caddr_t, size_t, int);
 236 extern int getpagesizes(size_t *, int);
 237 extern int getpagesizes2(size_t *, int);
 238 extern int posix_madvise(void *, size_t, int);
 239
 240 /* guard visibility of uint64_t */
 241 #if defined(_INT64_TYPE)
 242 extern int meminfo(const uint64_t *, int, const uint_t *, int, uint64_t *,
 243         uint_t *);
 244 #endif /* defined(_INT64_TYPE) */
 245
 246 extern int mlockall(int);
 247 extern int munlockall(void);
 248 extern int shm_open(const char *, int, mode_t);
 249 extern int shm_unlink(const char *);
 250
 251 /* mmap failure value */
 252 #define MAP_FAILED      ((void *) -1)
 253
 254
 255 #endif  /* !_ASM && !_KERNEL */
 256
 257 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__)
 258 #if !defined(_ASM)
 259 /*
 260  * structure for memcntl hat advise operations.
 261  */
 262 struct memcntl_mha {
 263         uint_t          mha_cmd;        /* command(s) */
 264         uint_t          mha_flags;
 265         size_t          mha_pagesize;
 266 };
 267
 268 #if defined(_SYSCALL32)
 269 struct memcntl_mha32 {
 270         uint_t          mha_cmd;        /* command(s) */
 271         uint_t          mha_flags;
 272         size32_t        mha_pagesize;
 273 };
 274 #endif  /* _SYSCALL32 */
 275 #endif  /* !defined(_ASM) */
 276 #endif  /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */
 277
 278 #if     (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) || defined(__EXTENSIONS__)
 279 /*
 280  * advice to madvise
 281  *
 282  * Note, if more than 4 bits worth of advice (eg. 16) are specified then
 283  * changes will be necessary to the struct vpage.
 284  */
 285 #define MADV_NORMAL             0       /* no further special treatment */
 286 #define MADV_RANDOM             1       /* expect random page references */
 287 #define MADV_SEQUENTIAL         2       /* expect sequential page references */
 288 #define MADV_WILLNEED           3       /* will need these pages */
 289 #define MADV_DONTNEED           4       /* don't need these pages */
 290 #define MADV_FREE               5       /* contents can be freed */
 291 #define MADV_ACCESS_DEFAULT     6       /* default access */
 292 #define MADV_ACCESS_LWP         7       /* next LWP to access heavily */
 293 #define MADV_ACCESS_MANY        8       /* many processes to access heavily */
 294 #define MADV_PURGE              9       /* contents will be purged */
 295
 296 #endif  /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) ...  */
 297
 298 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__)
 299 /* advice to posix_madvise */
 300 /* these values must be kept in sync with the MADV_* values, above */
 301 #define POSIX_MADV_NORMAL       0       /* MADV_NORMAL */
 302 #define POSIX_MADV_RANDOM       1       /* MADV_RANDOM */
 303 #define POSIX_MADV_SEQUENTIAL   2       /* MADV_SEQUENTIAL */
 304 #define POSIX_MADV_WILLNEED     3       /* MADV_WILLNEED */
 305 #define POSIX_MADV_DONTNEED     4       /* MADV_DONTNEED */
 306 #endif
 307
 308 /* flags to msync */
 309 #define MS_OLDSYNC      0x0             /* old value of MS_SYNC */
 310                                         /* modified for UNIX98 compliance */
 311 #define MS_SYNC         0x4             /* wait for msync */
 312 #define MS_ASYNC        0x1             /* return immediately */
 313 #define MS_INVALIDATE   0x2             /* invalidate caches */
 314
 315 #if     (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) || defined(__EXTENSIONS__)
 316 /* functions to mctl */
 317 #define MC_SYNC         1               /* sync with backing store */
 318 #define MC_LOCK         2               /* lock pages in memory */
 319 #define MC_UNLOCK       3               /* unlock pages from memory */
 320 #define MC_ADVISE       4               /* give advice to management */
 321 #define MC_LOCKAS       5               /* lock address space in memory */
 322 #define MC_UNLOCKAS     6               /* unlock address space from memory */
 323 #define MC_HAT_ADVISE   7               /* advise hat map size */
 324 #define MC_INHERIT_ZERO 8               /* zero out regions on fork() */
 325
 326 /* sub-commands for MC_HAT_ADVISE */
 327 #define MHA_MAPSIZE_VA          0x1     /* set preferred page size */
 328 #define MHA_MAPSIZE_BSSBRK      0x2     /* set preferred page size */
 329                                         /* for last bss adjacent to */
 330                                         /* brk area and brk area itself */
 331 #define MHA_MAPSIZE_STACK       0x4     /* set preferred page size */
 332                                         /* processes main stack */
 333
 334 #endif  /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) ... */
 335
 336 #if (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2)) || defined(__EXTENSIONS__)
 337 /* flags to mlockall */
 338 #define MCL_CURRENT     0x1             /* lock current mappings */
 339 #define MCL_FUTURE      0x2             /* lock future mappings */
 340 #endif /* (!defined(_XPG4_2) || (_POSIX_C_SOURCE)) || defined(__EXTENSIONS__) */
 341
 342 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__)
 343
 344 /* definitions for meminfosys syscall */
 345 #define MISYS_MEMINFO           0x0
 346
 347 #if !defined(_ASM)
 348
 349 #if defined(_INT64_TYPE)
 350 /* private structure for meminfo */
 351 typedef struct meminfo {
 352         const uint64_t *mi_inaddr;      /* array of input addresses */
 353         const uint_t *mi_info_req;      /* array of types of info requested */
 354         uint64_t *mi_outdata;           /* array of results are placed */
 355         uint_t *mi_validity;            /* array of bitwise result codes */
 356         int mi_info_count;              /* number of pieces of info requested */
 357 } meminfo_t;
 358 #endif /* defined(_INT64_TYPE) */
 359
 360 #if defined(_SYSCALL32)
 361 typedef struct meminfo32 {
 362         caddr32_t mi_inaddr;    /* array of input addresses */
 363         caddr32_t mi_info_req;  /* array of types of information requested */
 364         caddr32_t mi_outdata;   /* array of results are placed */
 365         caddr32_t mi_validity;  /* array of bitwise result codes */
 366         int32_t mi_info_count;  /* number of pieces of information requested */
 367 } meminfo32_t;
 368 #endif /* defined(_SYSCALL32) */
 369
 370 #endif /* !defined(_ASM) */
 371
 372 /*
 373  * info_req request type definitions for meminfo
 374  * request types starting with MEMINFO_V are used for Virtual addresses
 375  * and should not be mixed with MEMINFO_PLGRP which is targeted for Physical
 376  * addresses
 377  */
 378 #define MEMINFO_SHIFT           16
 379 #define MEMINFO_MASK            (0xFF << MEMINFO_SHIFT)
 380 #define MEMINFO_VPHYSICAL       (0x01 << MEMINFO_SHIFT) /* get physical addr */
 381 #define MEMINFO_VLGRP           (0x02 << MEMINFO_SHIFT) /* get lgroup */
 382 #define MEMINFO_VPAGESIZE       (0x03 << MEMINFO_SHIFT) /* size of phys page */
 383 #define MEMINFO_VREPLCNT        (0x04 << MEMINFO_SHIFT) /* no. of replica */
 384 #define MEMINFO_VREPL           (0x05 << MEMINFO_SHIFT) /* physical replica */
 385 #define MEMINFO_VREPL_LGRP      (0x06 << MEMINFO_SHIFT) /* lgrp of replica */
 386 #define MEMINFO_PLGRP           (0x07 << MEMINFO_SHIFT) /* lgroup for paddr */
 387
 388 /* maximum number of addresses meminfo() can process at a time */
 389 #define MAX_MEMINFO_CNT 256
 390
 391 /* maximum number of request types */
 392 #define MAX_MEMINFO_REQ 31
 393
 394 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */
 395
 396 #ifdef  __cplusplus
 397 }
 398 #endif
 399
 400 #endif  /* _SYS_MMAN_H */