sys/sys/shm.h

   1 /* $FreeBSD$ */
   2 /*      $NetBSD: shm.h,v 1.15 1994/06/29 06:45:17 cgd Exp $     */
   3
   4 /*-
   5  * SPDX-License-Identifier: BSD-4-Clause
   6  *
   7  * Copyright (c) 1994 Adam Glass
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by Adam Glass.
  21  * 4. The name of the author may not be used to endorse or promote products
  22  *    derived from this software without specific prior written permission
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  27  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  29  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  33  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 /*
  37  * As defined+described in "X/Open System Interfaces and Headers"
  38  *                         Issue 4, p. XXX
  39  */
  40
  41 #ifndef _SYS_SHM_H_
  42 #define _SYS_SHM_H_
  43
  44 #include <sys/cdefs.h>
  45 #ifdef _WANT_SYSVSHM_INTERNALS
  46 #define _WANT_SYSVIPC_INTERNALS
  47 #endif
  48 #include <sys/ipc.h>
  49 #include <sys/_types.h>
  50
  51 #include <machine/param.h>
  52
  53 #define SHM_RDONLY  010000  /* Attach read-only (else read-write) */
  54 #define SHM_RND     020000  /* Round attach address to SHMLBA */
  55 #define SHMLBA      PAGE_SIZE /* Segment low boundary address multiple */
  56
  57 /* "official" access mode definitions; somewhat braindead since you have
  58    to specify (SHM_* >> 3) for group and (SHM_* >> 6) for world permissions */
  59 #define SHM_R       (IPC_R)
  60 #define SHM_W       (IPC_W)
  61
  62 /* predefine tbd *LOCK shmctl commands */
  63 #define SHM_LOCK        11
  64 #define SHM_UNLOCK      12
  65
  66 /* ipcs shmctl commands for Linux compatibility */
  67 #define SHM_STAT        13
  68 #define SHM_INFO        14
  69
  70 #ifndef _PID_T_DECLARED
  71 typedef __pid_t         pid_t;
  72 #define _PID_T_DECLARED
  73 #endif
  74
  75 #ifndef _TIME_T_DECLARED
  76 typedef __time_t        time_t;
  77 #define _TIME_T_DECLARED
  78 #endif
  79
  80 #ifndef _SIZE_T_DECLARED
  81 typedef __size_t        size_t;
  82 #define _SIZE_T_DECLARED
  83 #endif
  84
  85 #if defined(COMPAT_FREEBSD4) || defined(COMPAT_FREEBSD5) || \
  86     defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD7)
  87 struct shmid_ds_old {
  88         struct ipc_perm_old shm_perm;   /* operation permission structure */
  89         int             shm_segsz;      /* size of segment in bytes */
  90         pid_t           shm_lpid;   /* process ID of last shared memory op */
  91         pid_t           shm_cpid;       /* process ID of creator */
  92         short           shm_nattch;     /* number of current attaches */
  93         time_t          shm_atime;      /* time of last shmat() */
  94         time_t          shm_dtime;      /* time of last shmdt() */
  95         time_t          shm_ctime;      /* time of last change by shmctl() */
  96         void           *shm_internal;   /* sysv stupidity */
  97 };
  98 #endif
  99
 100 typedef unsigned int shmatt_t;
 101
 102 struct shmid_ds {
 103         struct ipc_perm shm_perm;       /* operation permission structure */
 104         size_t          shm_segsz;      /* size of segment in bytes */
 105         pid_t           shm_lpid;   /* process ID of last shared memory op */
 106         pid_t           shm_cpid;       /* process ID of creator */
 107         shmatt_t        shm_nattch;     /* number of current attaches */
 108         time_t          shm_atime;      /* time of last shmat() */
 109         time_t          shm_dtime;      /* time of last shmdt() */
 110         time_t          shm_ctime;      /* time of last change by shmctl() */
 111 };
 112
 113 #if defined(_KERNEL) || defined(_WANT_SYSVSHM_INTERNALS)
 114 /*
 115  * System 5 style catch-all structure for shared memory constants that
 116  * might be of interest to user programs.  Do we really want/need this?
 117  */
 118 struct shminfo {
 119         u_long  shmmax;         /* max shared memory segment size (bytes) */
 120         u_long  shmmin;         /* max shared memory segment size (bytes) */
 121         u_long  shmmni;         /* max number of shared memory identifiers */
 122         u_long  shmseg;         /* max shared memory segments per process */
 123         u_long  shmall;         /* max amount of shared memory (pages) */
 124 };
 125
 126 struct vm_object;
 127
 128 /*
 129  * Add a kernel wrapper to the shmid_ds struct so that private info (like the
 130  * MAC label) can be added to it, without changing the user interface.
 131  */
 132 struct shmid_kernel {
 133         struct shmid_ds u;
 134         struct vm_object *object;
 135         struct label *label;    /* MAC label */
 136         struct ucred *cred;     /* creator's credendials */
 137 };
 138 #endif
 139
 140 struct shm_info {
 141         int used_ids;
 142         unsigned long shm_tot;
 143         unsigned long shm_rss;
 144         unsigned long shm_swp;
 145         unsigned long swap_attempts;
 146         unsigned long swap_successes;
 147 };
 148
 149 #ifdef _KERNEL
 150 struct proc;
 151 struct vmspace;
 152
 153 extern struct shminfo   shminfo;
 154
 155 void    shmexit(struct vmspace *);
 156 void    shmfork(struct proc *, struct proc *);
 157
 158 #else /* !_KERNEL */
 159
 160 #include <sys/cdefs.h>
 161
 162 #ifndef _SIZE_T_DECLARED
 163 typedef __size_t        size_t;
 164 #define _SIZE_T_DECLARED
 165 #endif
 166
 167 __BEGIN_DECLS
 168 #if __BSD_VISIBLE
 169 int shmsys(int, ...);
 170 #endif
 171 void *shmat(int, const void *, int);
 172 int shmget(key_t, size_t, int);
 173 int shmctl(int, int, struct shmid_ds *);
 174 int shmdt(const void *);
 175 __END_DECLS
 176
 177 #endif /* _KERNEL */
 178
 179 #endif /* !_SYS_SHM_H_ */