[apple/xnu.git] / bsd / sys / shm.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*	$NetBSD: shm.h,v 1.15 1994/06/29 06:45:17 cgd Exp $	*/

/*
 * Copyright (c) 1994 Adam Glass
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Adam Glass.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * As defined+described in "X/Open System Interfaces and Headers"
 *                         Issue 4, p. XXX
 */

#ifndef _SYS_SHM_H_
#define _SYS_SHM_H_

#include <sys/cdefs.h>
#include <sys/_types.h>

/*
 * [XSI]	All of the symbols from <sys/ipc.h> SHALL be defined
 *		when this header is included
 */
#include <sys/ipc.h>

/*
 * [XSI] The pid_t, time_t, key_t, and size_t types shall be defined as
 * described in <sys/types.h>.
 *
 * NOTE:	The definition of the key_t type is implicit from the
 *		inclusion of <sys/ipc.h>
 */
#ifndef _PID_T
typedef __darwin_pid_t	pid_t;
#define _PID_T
#endif

#ifndef	_TIME_T
#define	_TIME_T
typedef	__darwin_time_t	time_t;
#endif

#ifndef _SIZE_T
#define _SIZE_T
typedef __darwin_size_t	size_t;
#endif

/*
 * [XSI] The unsigned integer type used for the number of current attaches
 * that MUST be able to store values at least as large as a type unsigned
 * short.
 */
typedef unsigned short	shmatt_t;


/*
 * Possible flag values which may be OR'ed into the third argument to
 * shmat()
 */
#define SHM_RDONLY	010000	/* [XSI] Attach read-only (else read-write) */
#define SHM_RND		020000	/* [XSI] Round attach address to SHMLBA */

/*
 * This value is symbolic, and generally not expected to be sed by user
 * programs directly, although such ise is permitted by the standard.  Its
 * value in our implementation is equal to the number of bytes per page.
 *
 * NOTE:	We DO NOT obtain this value from the appropriate system
 *		headers at this time, to avoid the resulting namespace
 *		pollution, which is why we discourages its use.
 */
#define SHMLBA      4096	/* [XSI] Segment low boundary address multiple*/

/* "official" access mode definitions; somewhat braindead since you have
   to specify (SHM_* >> 3) for group and (SHM_* >> 6) for world permissions */
#define SHM_R       (IPC_R)
#define SHM_W       (IPC_W)

/*
 * Technically, we should force all code references to the new structure
 * definition, not in just the standards conformance case, and leave the
 * legacy interface there for binary compatibility only.  Currently, we
 * are only forcing this for programs requesting standards conformance.
 */
#if __DARWIN_UNIX03 || defined(KERNEL)
/*
 * Structure used internally.
 * 
 * This structure is exposed because standards dictate that it is used as
 * the third argment to shmctl().
 *
 * NOTE:	The field shm_internal is not meaningful in user space,
 *		and must not be used there.
 */
#if (defined(_POSIX_C_SOURCE) && !defined(_DARWIN_C_SOURCE))
struct shmid_ds
#else
#define	shmid_ds	__shmid_ds_new
struct __shmid_ds_new
#endif
{
	struct __ipc_perm_new shm_perm;	/* [XSI] Operation permission value */
	size_t		shm_segsz;	/* [XSI] Size of segment in bytes */
	pid_t		shm_lpid;	/* [XSI] PID of last shared memory op */
	pid_t		shm_cpid;	/* [XSI] PID of creator */
	shmatt_t	shm_nattch;	/* [XSI] Number of current attaches */
	time_t		shm_atime;	/* [XSI] Time of last shmat() */
	time_t		shm_dtime;	/* [XSI] Time of last shmdt() */
	time_t		shm_ctime;	/* [XSI] Time of last shmctl() change */
	void		*shm_internal;	/* reserved for kernel use */
};
#else	/* !__DARWIN_UNIX03 */
#define	shmid_ds	__shmid_ds_old
#endif	/* !__DARWIN_UNIX03 */

#if !__DARWIN_UNIX03
struct __shmid_ds_old {
	struct __ipc_perm_old shm_perm;	/* [XSI] Operation permission value */
	size_t		shm_segsz;	/* [XSI] Size of segment in bytes */
	pid_t		shm_lpid;	/* [XSI] PID of last shared memory op */
	pid_t		shm_cpid;	/* [XSI] PID of creator */
	shmatt_t	shm_nattch;	/* [XSI] Number of current attaches */
	time_t		shm_atime;	/* [XSI] Time of last shmat() */
	time_t		shm_dtime;	/* [XSI] Time of last shmdt() */
	time_t		shm_ctime;	/* [XSI] Time of last shmctl() change */
	void		*shm_internal;	/* reserved for kernel use */
};
#endif	/* !__DARWIN_UNIX03 */

#ifndef KERNEL

__BEGIN_DECLS
#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
int	shmsys(int, ...);
#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
void	*shmat (int, const void *, int);
int	shmctl(int, int, struct shmid_ds *) __DARWIN_ALIAS(shmctl);
int	shmdt(const void *);
int	shmget(key_t, size_t, int);
__END_DECLS

#endif /* !KERNEL */

#endif /* !_SYS_SHM_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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 License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* $NetBSD: shm.h,v 1.15 1994/06/29 06:45:17 cgd Exp $ */
	29
	30	/*
	31	* Copyright (c) 1994 Adam Glass
	32	* All rights reserved.
	33	*
	34	* Redistribution and use in source and binary forms, with or without
	35	* modification, are permitted provided that the following conditions
	36	* are met:
	37	* 1. Redistributions of source code must retain the above copyright
	38	* notice, this list of conditions and the following disclaimer.
	39	* 2. Redistributions in binary form must reproduce the above copyright
	40	* notice, this list of conditions and the following disclaimer in the
	41	* documentation and/or other materials provided with the distribution.
	42	* 3. All advertising materials mentioning features or use of this software
	43	* must display the following acknowledgement:
	44	* This product includes software developed by Adam Glass.
	45	* 4. The name of the author may not be used to endorse or promote products
	46	* derived from this software without specific prior written permission
	47	*
	48	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	49	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	50	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	51	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	52	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	53	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	54	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	55	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	56	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	57	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	58	*/
	59
	60	/*
	61	* As defined+described in "X/Open System Interfaces and Headers"
	62	* Issue 4, p. XXX
	63	*/
	64
	65	#ifndef _SYS_SHM_H_
	66	#define _SYS_SHM_H_
	67
91447636 A	68	#include <sys/cdefs.h>
	69	#include <sys/_types.h>
	70
	71	/*
	72	* [XSI] All of the symbols from <sys/ipc.h> SHALL be defined
	73	* when this header is included
	74	*/
1c79356b A	75	#include <sys/ipc.h>
1c79356b A	76
91447636 A	77	/*
	78	* [XSI] The pid_t, time_t, key_t, and size_t types shall be defined as
	79	* described in <sys/types.h>.
	80	*
	81	* NOTE: The definition of the key_t type is implicit from the
	82	* inclusion of <sys/ipc.h>
	83	*/
	84	#ifndef _PID_T
	85	typedef __darwin_pid_t pid_t;
	86	#define _PID_T
	87	#endif
	88
	89	#ifndef _TIME_T
	90	#define _TIME_T
	91	typedef __darwin_time_t time_t;
	92	#endif
	93
	94	#ifndef _SIZE_T
	95	#define _SIZE_T
	96	typedef __darwin_size_t size_t;
	97	#endif
	98
	99	/*
	100	* [XSI] The unsigned integer type used for the number of current attaches
	101	* that MUST be able to store values at least as large as a type unsigned
	102	* short.
	103	*/
	104	typedef unsigned short shmatt_t;
	105
	106
	107	/*
	108	* Possible flag values which may be OR'ed into the third argument to
	109	* shmat()
	110	*/
	111	#define SHM_RDONLY 010000 /* [XSI] Attach read-only (else read-write) */
	112	#define SHM_RND 020000 /* [XSI] Round attach address to SHMLBA */
	113
	114	/*
	115	* This value is symbolic, and generally not expected to be sed by user
	116	* programs directly, although such ise is permitted by the standard. Its
	117	* value in our implementation is equal to the number of bytes per page.
	118	*
	119	* NOTE: We DO NOT obtain this value from the appropriate system
	120	* headers at this time, to avoid the resulting namespace
	121	* pollution, which is why we discourages its use.
	122	*/
	123	#define SHMLBA 4096 /* [XSI] Segment low boundary address multiple*/
1c79356b A	124
	125	/* "official" access mode definitions; somewhat braindead since you have
	126	to specify (SHM_* >> 3) for group and (SHM_* >> 6) for world permissions */
	127	#define SHM_R (IPC_R)
	128	#define SHM_W (IPC_W)
	129
1c79356b	130	/*
91447636 A	131	* Technically, we should force all code references to the new structure
	132	* definition, not in just the standards conformance case, and leave the
	133	* legacy interface there for binary compatibility only. Currently, we
	134	* are only forcing this for programs requesting standards conformance.
1c79356b	135	*/
2d21ac55	136	#if __DARWIN_UNIX03 \|\| defined(KERNEL)
91447636 A	137	/*
	138	* Structure used internally.
	139	*
	140	* This structure is exposed because standards dictate that it is used as
	141	* the third argment to shmctl().
	142	*
	143	* NOTE: The field shm_internal is not meaningful in user space,
2d21ac55	144	* and must not be used there.
91447636	145	*/
2d21ac55 A	146	#if (defined(_POSIX_C_SOURCE) && !defined(_DARWIN_C_SOURCE))
	147	struct shmid_ds
	148	#else
	149	#define shmid_ds __shmid_ds_new
	150	struct __shmid_ds_new
	151	#endif
	152	{
91447636 A	153	struct __ipc_perm_new shm_perm; /* [XSI] Operation permission value */
	154	size_t shm_segsz; /* [XSI] Size of segment in bytes */
	155	pid_t shm_lpid; /* [XSI] PID of last shared memory op */
	156	pid_t shm_cpid; /* [XSI] PID of creator */
2d21ac55	157	shmatt_t shm_nattch; /* [XSI] Number of current attaches */
91447636 A	158	time_t shm_atime; /* [XSI] Time of last shmat() */
	159	time_t shm_dtime; /* [XSI] Time of last shmdt() */
	160	time_t shm_ctime; /* [XSI] Time of last shmctl() change */
	161	void shm_internal; / reserved for kernel use */
1c79356b	162	};
2d21ac55	163	#else /* !__DARWIN_UNIX03 */
91447636	164	#define shmid_ds __shmid_ds_old
2d21ac55	165	#endif /* !__DARWIN_UNIX03 */
1c79356b	166
2d21ac55	167	#if !__DARWIN_UNIX03
91447636 A	168	struct __shmid_ds_old {
	169	struct __ipc_perm_old shm_perm; /* [XSI] Operation permission value */
	170	size_t shm_segsz; /* [XSI] Size of segment in bytes */
	171	pid_t shm_lpid; /* [XSI] PID of last shared memory op */
	172	pid_t shm_cpid; /* [XSI] PID of creator */
2d21ac55	173	shmatt_t shm_nattch; /* [XSI] Number of current attaches */
91447636 A	174	time_t shm_atime; /* [XSI] Time of last shmat() */
	175	time_t shm_dtime; /* [XSI] Time of last shmdt() */
	176	time_t shm_ctime; /* [XSI] Time of last shmctl() change */
	177	void shm_internal; / reserved for kernel use */
	178	};
2d21ac55	179	#endif /* !__DARWIN_UNIX03 */
1c79356b	180
91447636	181	#ifndef KERNEL
1c79356b A	182
1c79356b A	183	__BEGIN_DECLS
2d21ac55	184	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
91447636	185	int shmsys(int, ...);
2d21ac55	186	#endif /* (!_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE) */
91447636 A	187	void shmat (int, const void , int);
	188	int shmctl(int, int, struct shmid_ds *) __DARWIN_ALIAS(shmctl);
	189	int shmdt(const void *);
	190	int shmget(key_t, size_t, int);
1c79356b A	191	__END_DECLS
	192
	193	#endif /* !KERNEL */
	194
	195	#endif /* !_SYS_SHM_H_ */