lib/libpthread/pthread_mutex_lock.3

   1 .\" $NetBSD: pthread_mutex_lock.3,v 1.5 2008/05/04 19:43:05 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
  26 .\" All rights reserved.
  27 .\"
  28 .\" Redistribution and use in source and binary forms, with or without
  29 .\" modification, are permitted provided that the following conditions
  30 .\" are met:
  31 .\" 1. Redistributions of source code must retain the above copyright
  32 .\"    notice, this list of conditions and the following disclaimer.
  33 .\" 2. Redistributions in binary form must reproduce the above copyright
  34 .\"    notice, this list of conditions and the following disclaimer in the
  35 .\"    documentation and/or other materials provided with the distribution.
  36 .\" 3. Neither the name of the author nor the names of any co-contributors
  37 .\"    may be used to endorse or promote products derived from this software
  38 .\"    without specific prior written permission.
  39 .\"
  40 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  41 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  44 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50 .\" SUCH DAMAGE.
  51 .\"
  52 .\" $FreeBSD: src/lib/libpthread/man/pthread_mutex_lock.3,v 1.11 2002/09/16 19:29:29 mini Exp $
  53 .\"
  54 .Dd January 30, 2003
  55 .Dt PTHREAD_MUTEX_LOCK 3
  56 .Os
  57 .Sh NAME
  58 .Nm pthread_mutex_lock ,
  59 .Nm pthread_mutex_trylock
  60 .Nd acquire a lock on a mutex
  61 .Sh LIBRARY
  62 .Lb libpthread
  63 .Sh SYNOPSIS
  64 .In pthread.h
  65 .Ft int
  66 .Fn pthread_mutex_lock "pthread_mutex_t *mutex"
  67 .Ft int
  68 .Fn pthread_mutex_trylock "pthread_mutex_t *mutex"
  69 .Sh DESCRIPTION
  70 The
  71 .Fn pthread_mutex_lock
  72 function locks
  73 .Fa mutex .
  74 If the mutex is already locked, the calling thread will block until the
  75 mutex becomes available.
  76 .Pp
  77 The
  78 .Fn pthread_mutex_trylock
  79 function locks
  80 .Fa mutex .
  81 If the mutex is already locked,
  82 .Fn pthread_mutex_trylock
  83 will not block waiting for the mutex, but will return an error condition.
  84 .Sh RETURN VALUES
  85 If successful,
  86 .Fn pthread_mutex_lock
  87 and
  88 .Fn pthread_mutex_trylock
  89 will return zero, otherwise an error number will be returned to
  90 indicate the error.
  91 .Sh ERRORS
  92 .Fn pthread_mutex_lock
  93 may fail if:
  94 .Bl -tag -width Er
  95 .It Bq Er EDEADLK
  96 A deadlock would occur if the thread blocked waiting for
  97 .Fa mutex .
  98 .It Bq Er EINVAL
  99 The value specified by
 100 .Fa mutex
 101 is invalid.
 102 .El
 103 .Pp
 104 .Fn pthread_mutex_trylock
 105 shall fail if:
 106 .Bl -tag -width Er
 107 .It Bq Er EBUSY
 108 .Fa Mutex
 109 is already locked.
 110 .El
 111 .Pp
 112 .Fn pthread_mutex_trylock
 113 may fail if:
 114 .Bl -tag -width Er
 115 .It Bq Er EINVAL
 116 The value specified by
 117 .Fa mutex
 118 is invalid.
 119 .El
 120 .Sh SEE ALSO
 121 .Xr pthread_mutex_destroy 3 ,
 122 .Xr pthread_mutex_init 3 ,
 123 .Xr pthread_mutex_unlock 3
 124 .Sh STANDARDS
 125 .Fn pthread_mutex_lock
 126 and
 127 .Fn pthread_mutex_trylock
 128 conform to
 129 .St -p1003.1-96 .