xref: /onnv-gate/usr/src/uts/common/sys/shm.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate /*	Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T	*/
28*0Sstevel@tonic-gate /*	  All Rights Reserved  	*/
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate /*
31*0Sstevel@tonic-gate  * Portions of this source code were derived from Berkeley 4.3 BSD
32*0Sstevel@tonic-gate  * under license from the Regents of the University of California.
33*0Sstevel@tonic-gate  */
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #ifndef	_SYS_SHM_H
36*0Sstevel@tonic-gate #define	_SYS_SHM_H
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #include <sys/ipc.h>
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate #ifdef	__cplusplus
43*0Sstevel@tonic-gate extern "C" {
44*0Sstevel@tonic-gate #endif
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate /*
47*0Sstevel@tonic-gate  *	IPC Shared Memory Facility.
48*0Sstevel@tonic-gate  */
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate /*
51*0Sstevel@tonic-gate  *	Implementation Constants.
52*0Sstevel@tonic-gate  */
53*0Sstevel@tonic-gate #if (defined(_KERNEL) || defined(_KMEMUSER))
54*0Sstevel@tonic-gate 
55*0Sstevel@tonic-gate #define	SHMLBA	PAGESIZE	/* segment low boundary address multiple */
56*0Sstevel@tonic-gate 				/* (SHMLBA must be a power of 2) */
57*0Sstevel@tonic-gate #else
58*0Sstevel@tonic-gate #include <sys/unistd.h>		/* needed for _SC_PAGESIZE */
59*0Sstevel@tonic-gate extern long _sysconf(int);	/* System Private interface to sysconf() */
60*0Sstevel@tonic-gate #define	SHMLBA	(_sysconf(_SC_PAGESIZE))
61*0Sstevel@tonic-gate #endif	/* defined(_KERNEL) || defined(_KMEMUSER)) */
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate /*
64*0Sstevel@tonic-gate  *	Permission Definitions.
65*0Sstevel@tonic-gate  */
66*0Sstevel@tonic-gate #define	SHM_R	0400	/* read permission */
67*0Sstevel@tonic-gate #define	SHM_W	0200	/* write permission */
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate /*
70*0Sstevel@tonic-gate  *	Message Operation Flags.
71*0Sstevel@tonic-gate  */
72*0Sstevel@tonic-gate #define	SHM_RDONLY	010000	/* attach read-only (else read-write) */
73*0Sstevel@tonic-gate #define	SHM_RND		020000	/* round attach address to SHMLBA */
74*0Sstevel@tonic-gate #define	SHM_SHARE_MMU	040000  /* share VM resources such as page table */
75*0Sstevel@tonic-gate #define	SHM_PAGEABLE	0100000 /* pageable ISM */
76*0Sstevel@tonic-gate 
77*0Sstevel@tonic-gate /*
78*0Sstevel@tonic-gate  * Valid flags bits for shmat shmflag argument.
79*0Sstevel@tonic-gate  */
80*0Sstevel@tonic-gate #define	SHMAT_VALID_FLAGS_MASK		\
81*0Sstevel@tonic-gate 	(SHM_R | SHM_W | SHM_RDONLY | SHM_RND | SHM_SHARE_MMU | SHM_PAGEABLE)
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate typedef unsigned long shmatt_t;
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate /*
86*0Sstevel@tonic-gate  *	Structure Definitions.
87*0Sstevel@tonic-gate  */
88*0Sstevel@tonic-gate struct shmid_ds {
89*0Sstevel@tonic-gate 	struct ipc_perm	shm_perm;	/* operation permission struct */
90*0Sstevel@tonic-gate 	size_t		shm_segsz;	/* size of segment in bytes */
91*0Sstevel@tonic-gate #if defined(_LP64) || defined(_XOPEN_SOURCE)
92*0Sstevel@tonic-gate 	void		*shm_amp;
93*0Sstevel@tonic-gate #else
94*0Sstevel@tonic-gate 	struct anon_map	*shm_amp;	/* segment anon_map pointer */
95*0Sstevel@tonic-gate #endif
96*0Sstevel@tonic-gate 	ushort_t	shm_lkcnt;	/* number of times it is being locked */
97*0Sstevel@tonic-gate 	pid_t		shm_lpid;	/* pid of last shmop */
98*0Sstevel@tonic-gate 	pid_t		shm_cpid;	/* pid of creator */
99*0Sstevel@tonic-gate 	shmatt_t	shm_nattch;	/* number of attaches */
100*0Sstevel@tonic-gate 	ulong_t		shm_cnattch;	/* number of ISM attaches */
101*0Sstevel@tonic-gate #if defined(_LP64)
102*0Sstevel@tonic-gate 	time_t		shm_atime;	/* last shmat time */
103*0Sstevel@tonic-gate 	time_t		shm_dtime;	/* last shmdt time */
104*0Sstevel@tonic-gate 	time_t		shm_ctime;	/* last change time */
105*0Sstevel@tonic-gate 	int64_t		shm_pad4[4];	/* reserve area */
106*0Sstevel@tonic-gate #else	/* _LP64 */
107*0Sstevel@tonic-gate 	time_t		shm_atime;	/* last shmat time */
108*0Sstevel@tonic-gate 	int32_t		shm_pad1;	/* reserved for time_t expansion */
109*0Sstevel@tonic-gate 	time_t		shm_dtime;	/* last shmdt time */
110*0Sstevel@tonic-gate 	int32_t		shm_pad2;	/* reserved for time_t expansion */
111*0Sstevel@tonic-gate 	time_t		shm_ctime;	/* last change time */
112*0Sstevel@tonic-gate 	int32_t		shm_pad3;	/* reserved for time_t expansion */
113*0Sstevel@tonic-gate 	int32_t		shm_pad4[4];	/* reserve area  */
114*0Sstevel@tonic-gate #endif	/* _LP64 */
115*0Sstevel@tonic-gate };
116*0Sstevel@tonic-gate 
117*0Sstevel@tonic-gate /*
118*0Sstevel@tonic-gate  * Shared memory control operations
119*0Sstevel@tonic-gate  */
120*0Sstevel@tonic-gate #define	SHM_LOCK	3	/* Lock segment in core */
121*0Sstevel@tonic-gate #define	SHM_UNLOCK	4	/* Unlock segment */
122*0Sstevel@tonic-gate 
123*0Sstevel@tonic-gate #if !defined(_KERNEL)
124*0Sstevel@tonic-gate #if defined(__STDC__)
125*0Sstevel@tonic-gate int shmget(key_t, size_t, int);
126*0Sstevel@tonic-gate int shmids(int *, uint_t, uint_t *);
127*0Sstevel@tonic-gate int shmctl(int, int, struct shmid_ds *);
128*0Sstevel@tonic-gate void *shmat(int, const void *, int);
129*0Sstevel@tonic-gate #if defined(_XPG4)
130*0Sstevel@tonic-gate int shmdt(const void *);
131*0Sstevel@tonic-gate #else
132*0Sstevel@tonic-gate int shmdt(char *);
133*0Sstevel@tonic-gate #endif /* defined(_XPG4) */
134*0Sstevel@tonic-gate #else /* __STDC__ */
135*0Sstevel@tonic-gate int shmctl();
136*0Sstevel@tonic-gate int shmget();
137*0Sstevel@tonic-gate int shmids();
138*0Sstevel@tonic-gate void *shmat();
139*0Sstevel@tonic-gate int shmdt();
140*0Sstevel@tonic-gate #endif /* __STDC__ */
141*0Sstevel@tonic-gate #endif /* !defined(_KERNEL) */
142*0Sstevel@tonic-gate 
143*0Sstevel@tonic-gate #ifdef	__cplusplus
144*0Sstevel@tonic-gate }
145*0Sstevel@tonic-gate #endif
146*0Sstevel@tonic-gate 
147*0Sstevel@tonic-gate #endif	/* _SYS_SHM_H */
148