xref: /illumos-gate/usr/src/man/man3head/ipc.h.3head (revision bbf21555)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.

IPC.H 3HEAD "Sep 10, 2004"
NAME
ipc.h, ipc - XSI interprocess communication access structure
SYNOPSIS

#include <sys/ipc.h>
DESCRIPTION

The <sys/ipc.h> header is used by three mechanisms for interprocess communication (IPC): messages, semaphores, and shared memory. All use a common structure type, ipc_perm, to pass information used in determining permission to perform an IPC operation.

The ipc_perm structure contains the following members:

uid_t uid /* owner's user ID */
gid_t gid /* owner's group ID */
uid_t cuid /* creator's user ID */
gid_t cgid /* creator's group ID */
mode_t mode /* read/write permission

The uid_t, gid_t, mode_t, and key_t types are defined as described in <sys/types.h>. See types.h(3HEAD).

Definitions are provided for the constants listed below.

Mode bits: IPC_CREAT

Create entry if key does not exist.

IPC_EXCL

Fail if key exists.

IPC_NOWAIT

Error if request must wait.

Keys: IPC_PRIVATE

Private key.

Control commands: IPC_RMID

Remove identifier.

IPC_SET

Set options.

IPC_STAT

Get options.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

ftok (3C), types.h (3HEAD), attributes (7), standards (7)