xref: /netbsd-src/sys/sys/ipc.h (revision ae1bfcddc410612bc8c58b807e1830becb69a24c)
1 /*
2  * Copyright (c) 1988 University of Utah.
3  * Copyright (c) 1990, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  * (c) UNIX System Laboratories, Inc.
6  * All or some portions of this file are derived from material licensed
7  * to the University of California by American Telephone and Telegraph
8  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
9  * the permission of UNIX System Laboratories, Inc.
10  *
11  * This code is derived from software contributed to Berkeley by
12  * the Systems Programming Group of the University of Utah Computer
13  * Science Department.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  * 3. All advertising materials mentioning features or use of this software
24  *    must display the following acknowledgement:
25  *	This product includes software developed by the University of
26  *	California, Berkeley and its contributors.
27  * 4. Neither the name of the University nor the names of its contributors
28  *    may be used to endorse or promote products derived from this software
29  *    without specific prior written permission.
30  *
31  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
32  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
35  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
40  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41  * SUCH DAMAGE.
42  *
43  *	from: @(#)ipc.h	8.3 (Berkeley) 1/21/94
44  *	$Id: ipc.h,v 1.7 1994/05/21 04:13:59 cgd Exp $
45  */
46 
47 /*
48  * SVID compatible ipc.h file
49  */
50 #ifndef _SYS_IPC_H_
51 #define _SYS_IPC_H_
52 
53 typedef	long	key_t;	/* XXX should be in types.h */
54 
55 struct ipc_perm {
56 	ushort	cuid;	/* creator user id */
57 	ushort	cgid;	/* creator group id */
58 	ushort	uid;	/* user id */
59 	ushort	gid;	/* group id */
60 	ushort	mode;	/* r/w permission */
61 	ushort	seq;	/* sequence # (to generate unique msg/sem/shm id) */
62 	key_t	key;	/* user specified msg/sem/shm key */
63 };
64 
65 /* common mode bits */
66 #define	IPC_R		00400	/* read permission */
67 #define	IPC_W		00200	/* write/alter permission */
68 
69 /* SVID required constants (same values as system 5) */
70 #define	IPC_CREAT	01000	/* create entry if key does not exist */
71 #define	IPC_EXCL	02000	/* fail if key exists */
72 #define	IPC_NOWAIT	04000	/* error if request must wait */
73 
74 #define	IPC_PRIVATE	(key_t)0 /* private key */
75 
76 #define	IPC_RMID	0	/* remove identifier */
77 #define	IPC_SET		1	/* set options */
78 #define	IPC_STAT	2	/* get options */
79 
80 #ifdef KERNEL
81 /* Macros to convert between ipc ids and array indices or sequence ids */
82 #define	IPCID_TO_IX(id)		((id) & 0xffff)
83 #define	IPCID_TO_SEQ(id)	(((id) >> 16) & 0xffff)
84 #define	IXSEQ_TO_IPCID(ix,perm)	(((perm.seq) << 16) | (ix & 0xffff))
85 #endif /* KERNEL */
86 
87 #endif /* !_SYS_IPC_H_ */
88