ipc.h revision 176221 
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 * 4. Neither the name of the University nor the names of its contributors
24 *    may be used to endorse or promote products derived from this software
25 *    without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * SUCH DAMAGE.
38 *
39 *	@(#)ipc.h	8.4 (Berkeley) 2/19/95
40 * $FreeBSD: head/sys/sys/ipc.h 176221 2008-02-12 20:55:03Z csjp $
41 */
42
43/*
44 * SVID compatible ipc.h file
45 */
46#ifndef _SYS_IPC_H_
47#define _SYS_IPC_H_
48
49#include <sys/cdefs.h>
50#include <sys/_types.h>
51
52#ifndef _GID_T_DECLARED
53typedef	__gid_t		gid_t;
54#define	_GID_T_DECLARED
55#endif
56
57#ifndef _KEY_T_DECLARED
58typedef	__key_t		key_t;
59#define	_KEY_T_DECLARED
60#endif
61
62#ifndef _MODE_T_DECLARED
63typedef	__mode_t	mode_t;
64#define	_MODE_T_DECLARED
65#endif
66
67#ifndef _UID_T_DECLARED
68typedef	__uid_t		uid_t;
69#define	_UID_T_DECLARED
70#endif
71
72/*
73 * XXX almost all members have wrong types.
74 */
75struct ipc_perm {
76	unsigned short	cuid;	/* creator user id */
77	unsigned short	cgid;	/* creator group id */
78	unsigned short	uid;	/* user id */
79	unsigned short	gid;	/* group id */
80	unsigned short	mode;	/* r/w permission */
81	unsigned short	seq;	/* sequence # (to generate unique ipcid) */
82	key_t		key;	/* user specified msg/sem/shm key */
83};
84
85#if __BSD_VISIBLE
86/* common mode bits */
87#define	IPC_R		000400	/* read permission */
88#define	IPC_W		000200	/* write/alter permission */
89#define	IPC_M		010000	/* permission to change control info */
90#endif
91
92/* SVID required constants (same values as system 5) */
93#define	IPC_CREAT	001000	/* create entry if key does not exist */
94#define	IPC_EXCL	002000	/* fail if key exists */
95#define	IPC_NOWAIT	004000	/* error if request must wait */
96
97#define	IPC_PRIVATE	(key_t)0 /* private key */
98
99#define	IPC_RMID	0	/* remove identifier */
100#define	IPC_SET		1	/* set options */
101#define	IPC_STAT	2	/* get options */
102#if __BSD_VISIBLE
103/*
104 * For Linux compatability.
105 */
106#define	IPC_INFO	3	/* get info */
107#endif
108
109#ifdef _KERNEL
110/* Macros to convert between ipc ids and array indices or sequence ids */
111#define	IPCID_TO_IX(id)		((id) & 0xffff)
112#define	IPCID_TO_SEQ(id)	(((id) >> 16) & 0xffff)
113#define	IXSEQ_TO_IPCID(ix,perm)	(((perm.seq) << 16) | (ix & 0xffff))
114
115struct thread;
116struct proc;
117struct vmspace;
118
119int	ipcperm(struct thread *, struct ipc_perm *, int);
120extern void (*shmfork_hook)(struct proc *, struct proc *);
121extern void (*shmexit_hook)(struct vmspace *);
122
123#else /* ! _KERNEL */
124
125__BEGIN_DECLS
126key_t	ftok(const char *, int);
127__END_DECLS
128
129#endif /* _KERNEL */
130
131#endif /* !_SYS_IPC_H_ */
132