usr/src/man/man3head/sem.h.3head

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" 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.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH SEM.H 3HEAD "Sep 10, 2004"
  11 .SH NAME
  12 sem.h, sem \-  semaphore facility
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <\fBsys/sem.h\fR>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The <\fBsys/sem.h\fR> header defines the following constants and structures.
  23 .sp
  24 .LP
  25 Semaphore operation flags:
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fBSEM_UNDO\fR\fR
  30 .ad
  31 .RS 12n
  32 Set up adjust on exit entry.
  33 .RE
  34
  35 .sp
  36 .LP
  37 Command definitions for the \fBsemctl()\fR function are provided as listed
  38 below. See \fBsemctl\fR(2).
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBGETNCNT\fR\fR
  43 .ad
  44 .RS 11n
  45 Get \fBsemncnt\fR.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBGETPID\fR\fR
  52 .ad
  53 .RS 11n
  54 Get \fBsempid\fR.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBGETVAL\fR\fR
  61 .ad
  62 .RS 11n
  63 Get \fBsemval\fR.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBGETALL\fR\fR
  70 .ad
  71 .RS 11n
  72 Get all cases of \fBsemval\fR.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBGETZCNT\fR\fR
  79 .ad
  80 .RS 11n
  81 Get \fBsemzcnt\fR.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBSETVAL\fR\fR
  88 .ad
  89 .RS 11n
  90 Set \fBsemval\fR.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBSETALL\fR\fR
  97 .ad
  98 .RS 11n
  99 Set all cases of \fBsemval\fR.
 100 .RE
 101
 102 .sp
 103 .LP
 104 The \fBsemid_ds\fR structure contains the following members:
 105 .sp
 106 .in +2
 107 .nf
 108 struct ipc_perm sem_perm     /* operation permission structure */
 109 unsigned short  sem_nsems    /* number of semaphores in set */
 110 time_t          sem_otime    /* last \fBsemop()\fR time */
 111 time_t          sem_ctime    /* last time changed by \fBsemctl()\fR */
 112 .fi
 113 .in -2
 114
 115 .sp
 116 .LP
 117 The \fBpid_t\fR, \fBtime_t\fR, \fBkey_t\fR, and \fBsize_t\fR types are defined
 118 as described in <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD).
 119 .sp
 120 .LP
 121 A semaphore is represented by an anonymous structure containing the following
 122 members:
 123 .sp
 124 .in +2
 125 .nf
 126 unsigned short semval     /* semaphore value */
 127 pid_t          sempid     /* process ID of last operation */
 128 unsigned short semncnt    /* number of processes waiting for \fBsemval\fR
 129                              to become greater than current value */
 130 unsigned short semzcnt    /* number of processes waiting for \fBsemval\fR
 131                              to become 0 */
 132 .fi
 133 .in -2
 134
 135 .sp
 136 .LP
 137 The \fBsembuf\fR structure contains the following members:
 138 .sp
 139 .in +2
 140 .nf
 141 unsigned short sem_num     /* semaphore number */
 142 short          sem_op      /* semaphore operation */
 143 short          sem_flg     /* operation flags */
 144 .fi
 145 .in -2
 146
 147 .sp
 148 .LP
 149 All of the symbols from <\fBsys/ipc.h\fR> are defined when this header is
 150 included. See \fBipc.h\fR(3HEAD).
 151 .SH ATTRIBUTES
 152 .sp
 153 .LP
 154 See \fBattributes\fR(5) for descriptions of the following attributes:
 155 .sp
 156
 157 .sp
 158 .TS
 159 box;
 160 c | c
 161 l | l .
 162 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 163 _
 164 Interface Stability     Standard
 165 .TE
 166
 167 .SH SEE ALSO
 168 .sp
 169 .LP
 170 \fBsemctl\fR(2), \fBsemget\fR(2), \fBsemop\fR(2), \fBipc.h\fR(3HEAD),
 171 \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)