usr/src/man/man2/_lwp_mutex_lock.2

   1 '\" te
   2 .\"  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH _LWP_MUTEX_LOCK 2 "Jul 30, 1992"
   7 .SH NAME
   8 _lwp_mutex_lock, _lwp_mutex_unlock, _lwp_mutex_trylock \- mutual exclusion
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/lwp.h>
  13
  14 \fBint\fR \fB_lwp_mutex_lock\fR(\fBlwp_mutex_t *\fR\fImp\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fB_lwp_mutex_trylock\fR(\fBlwp_mutex_t *\fR\fImp\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fB_lwp_mutex_unlock\fR(\fBlwp_mutex_t *\fR\fImp\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 These functions serialize the execution of lightweight processes. They are
  31 useful for ensuring that only one lightweight process can execute a critical
  32 section of code at any one time (mutual exclusion). LWP mutexes must be
  33 initialized to 0 before use.
  34 .sp
  35 .LP
  36 The \fB_lwp_mutex_lock()\fR function locks the LWP mutex pointed to by
  37 \fImp\fR. If the mutex is already locked, the calling LWP blocks until the
  38 mutex becomes available. When \fB_lwp_mutex_lock()\fR returns, the mutex is
  39 locked and the calling LWP is the "owner".
  40 .sp
  41 .LP
  42 The \fB_lwp_mutex_trylock()\fR function attempts to lock the mutex. If the
  43 mutex is already locked it returns with an error. If the mutex is unlocked, it
  44 is locked and \fB_lwp_mutex_trylock()\fR returns.
  45 .sp
  46 .LP
  47 The \fB_lwp_mutex_unlock()\fR function unlocks a locked mutex. The mutex must
  48 be locked and the calling LWP must be the one that last locked the mutex (the
  49 owner). If any other LWPs are waiting for the mutex to become available, one of
  50 them is unblocked.
  51 .SH RETURN VALUES
  52 .sp
  53 .LP
  54 Upon successful completion, \fB0\fR is returned. A non-zero value indicates an
  55 error.
  56 .SH ERRORS
  57 .sp
  58 .LP
  59 If any of the following conditions are detected, \fB_lwp_mutex_lock()\fR,
  60 \fB_lwp_mutex_trylock()\fR, and \fB_lwp_mutex_unlock()\fR fail and return the
  61 corresponding value:
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBEINVAL\fR\fR
  66 .ad
  67 .RS 10n
  68 The \fImp\fR argument points to an invalid LWP mutex.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBEFAULT\fR\fR
  75 .ad
  76 .RS 10n
  77 The \fImp\fR argument points to an illegal address.
  78 .RE
  79
  80 .sp
  81 .LP
  82 If any of the following conditions occur, \fB_lwp_mutex_trylock()\fR fails and
  83 returns the corresponding value:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBEBUSY\fR\fR
  88 .ad
  89 .RS 9n
  90 The \fImp\fR argument points to a locked mutex.
  91 .RE
  92
  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBIntro\fR(2), \fB_lwp_cond_wait\fR(2)