usr/src/man/man3c/sem_post.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Copyright (c) 1997, The Open Group. All Rights Reserved.
  45 .\" Portions Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH SEM_POST 3C "Feb 5, 2008"
  48 .SH NAME
  49 sem_post \- increment the count of a semaphore
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <semaphore.h>
  54
  55 \fBint\fR \fBsem_post\fR(\fBsem_t *\fR\fIsem\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBsem_post()\fR function unlocks the semaphore referenced by \fIsem\fR by
  62 performing a semaphore unlock operation on that semaphore.
  63 .sp
  64 .LP
  65 If the semaphore value resulting from this operation is positive, then no
  66 threads  were blocked waiting for the semaphore to become unlocked; the
  67 semaphore value is simply incremented.
  68 .sp
  69 .LP
  70 If the value of the semaphore resulting from this operation is 0, then one of
  71 the threads  blocked waiting for the semaphore will be allowed to return
  72 successfully from its call to \fBsem_wait\fR(3C). If the symbol
  73 \fB_POSIX_PRIORITY_SCHEDULING\fR is defined, the thread  to be unblocked will
  74 be chosen in a manner appropriate to the scheduling policies and parameters in
  75 effect for the blocked threads. In the case of the schedulers \fBSCHED_FIFO\fR
  76 and \fBSCHED_RR\fR, the highest priority waiting thread  will be unblocked, and
  77 if there is more than one highest priority thread  blocked waiting for the
  78 semaphore, then the highest priority thread that has been waiting the longest
  79 will be unblocked. If the symbol \fB_POSIX_PRIORITY_SCHEDULING\fR is not
  80 defined, the choice of a thread  to unblock is unspecified.
  81 .SH RETURN VALUES
  82 .sp
  83 .LP
  84 If successful, \fBsem_post()\fR returns \fB0\fR; otherwise it returns
  85 \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  86 .SH ERRORS
  87 .sp
  88 .LP
  89 The \fBsem_post()\fR function will fail if:
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBEINVAL\fR \fR
  94 .ad
  95 .RS 14n
  96 The \fIsem\fR argument does not refer to a valid semaphore.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBENOSYS\fR \fR
 103 .ad
 104 .RS 14n
 105 The \fBsem_post()\fR function is not supported by the system.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBEOVERFLOW\fR \fR
 112 .ad
 113 .RS 14n
 114 The semaphore value exceeds \fBSEM_VALUE_MAX\fR.
 115 .RE
 116
 117 .SH USAGE
 118 .sp
 119 .LP
 120 The \fBsem_post()\fR function is reentrant with respect to signals and may be
 121 invoked from a signal-catching function. The semaphore functionality described
 122 on this manual page is for the POSIX (see \fBstandards\fR(5)) threads
 123 implementation. For the documentation of the Solaris threads interface, see
 124 \fBsemaphore\fR(3C)).
 125 .SH EXAMPLES
 126 .sp
 127 .LP
 128 See \fBsem_wait\fR(3C).
 129 .SH ATTRIBUTES
 130 .sp
 131 .LP
 132 See \fBattributes\fR(5) for descriptions of the following attributes:
 133 .sp
 134
 135 .sp
 136 .TS
 137 box;
 138 c | c
 139 l | l .
 140 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 141 _
 142 Interface Stability     Committed
 143 _
 144 MT-Level        Async-Signal-Safe
 145 _
 146 Standard        See \fBstandards\fR(5).
 147 .TE
 148
 149 .SH SEE ALSO
 150 .sp
 151 .LP
 152 \fBsched_setscheduler\fR(3C), \fBsem_wait\fR(3C), \fBsemaphore\fR(3C),
 153 \fBattributes\fR(5), \fBstandards\fR(5)