bsd/sys/shm_internal.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*      $NetBSD: shm.h,v 1.15 1994/06/29 06:45:17 cgd Exp $     */
  31
  32 /*
  33  * Copyright (c) 1994 Adam Glass
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. All advertising materials mentioning features or use of this software
  45  *    must display the following acknowledgement:
  46  *      This product includes software developed by Adam Glass.
  47  * 4. The name of the author may not be used to endorse or promote products
  48  *    derived from this software without specific prior written permission
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  51  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  53  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  55  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  59  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  */
  61
  62 /*
  63  * As defined+described in "X/Open System Interfaces and Headers"
  64  *                         Issue 4, p. XXX
  65  */
  66
  67 #ifndef _SYS_SHM_INTERNALH_
  68 #define _SYS_SHM_INTERNALH_
  69
  70 #include <sys/shm.h>
  71 #include <sys/cdefs.h>
  72
  73 #include <machine/types.h>
  74
  75 #if __DARWIN_ALIGN_NATURAL
  76 #pragma options align=natural
  77 #endif
  78
  79 struct user_shmid_ds {
  80         struct ipc_perm shm_perm;       /* operation permission structure */
  81         user_size_t     shm_segsz;      /* size of segment in bytes */
  82         pid_t           shm_lpid;       /* PID of last shared memory op */
  83         pid_t           shm_cpid;       /* PID of creator */
  84         short           shm_nattch;     /* number of current attaches */
  85         time_t          shm_atime;      /* time of last shmat() */
  86         time_t          shm_dtime;      /* time of last shmdt() */
  87         time_t          shm_ctime;      /* time of last change by shmctl() */
  88         user_addr_t     shm_internal;   /* reserved for kernel use */
  89 };
  90
  91 #if __DARWIN_ALIGN_NATURAL
  92 #pragma options align=reset
  93 #endif
  94
  95 /*
  96  * System 5 style catch-all structure for shared memory constants that
  97  * might be of interest to user programs.  Also part of the ipcs interface.
  98  * Note: use of user_ssize_t intentional: permits 32 bit ipcs to provide
  99  * information about 64 bit programs shared segments.
 100  */
 101 struct shminfo {
 102         user_ssize_t    shmmax;         /* max shm segment size (bytes) */
 103         user_ssize_t    shmmin;         /* min shm segment size (bytes) */
 104         user_ssize_t    shmmni;         /* max number of shm identifiers */
 105         user_ssize_t    shmseg;         /* max shm segments per process */
 106         user_ssize_t    shmall;         /* max amount of shm (pages) */
 107 };
 108
 109 #ifdef KERNEL
 110 extern struct shminfo shminfo;
 111 extern struct user_shmid_ds *shmsegs;
 112
 113 struct proc;
 114
 115 __BEGIN_DECLS
 116
 117 void    shmexit(struct proc *);
 118 int     shmfork(struct proc *, struct proc *);
 119 __private_extern__ void shmexec(struct proc *);
 120
 121 __END_DECLS
 122
 123 #endif /* kernel */
 124
 125 #endif /* !_SYS_SHM_INTERNALH_ */