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