xref: /illumos-gate/usr/src/man/man3head/shm.h.3head (revision 114534a4d059eff3c9117af0dad18eb594d4339d)
te
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
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 Sun OS 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]
SHM.H 3HEAD "Sep 10, 2004"
NAME
shm.h, shm - shared memory facility
SYNOPSIS

#include <sys/shm.h>
DESCRIPTION

The <sys/shm.h> header defines the following symbolic constants: SHM_RDONLY

attach read-only (else read-write)

SHM_RND

round attach address to SHMLBA

The <sys/shm.h> header defines the following symbolic value: SHMLBA

segment low boundary address multiple

The following data types are defined through typedef: shmatt_t

Unsigned integer used for the number of current attaches that must be able to store values at least as large as a type unsigned short.

The shmid_ds structure contains the following members:

struct ipc_perm shm_perm /* operation permission structure */
size_t shm_segsz /* size of segment in bytes */
pid_t shm_lpid /* process ID of last shared memory
 operation */
pid_t shm_cpid /* process ID of creator */
shmatt_t shm_nattch /* number of current attaches */
time_t shm_atime /* time of last shmat() */
time_t shm_dtime /* time of last shmdt() */
time_t shm_ctime /* time of last change by shmctl() */

The pid_t, time_t, key_t, and size_t types are defined as described in <sys/types.h>. See types.h(3HEAD).

In addition, all of the symbols from <sys/ipc.h> are defined when this header is included.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

shmctl(2), shmget(2), shmop(2), ipc.h(3HEAD), types.h(3HEAD), attributes(5), standards(5)