share/man/man3/pthread_mutex_lock.3

   1 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the author nor the names of any co-contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd January 31, 2006
  31 .Dt PTHREAD_MUTEX_LOCK 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_mutex_lock
  35 .Nd lock a mutex
  36 .Sh LIBRARY
  37 .Lb libpthread
  38 .Lb libthr
  39 .Sh SYNOPSIS
  40 .In pthread.h
  41 .Ft int
  42 .Fn pthread_mutex_lock "pthread_mutex_t *mutex"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn pthread_mutex_lock
  46 function locks
  47 .Fa mutex .
  48 If the mutex is already locked, the calling thread will block until the
  49 mutex becomes available.
  50 .Sh RETURN VALUES
  51 If successful,
  52 .Fn pthread_mutex_lock
  53 will return zero, otherwise an error number will be returned to
  54 indicate the error.
  55 .Sh ERRORS
  56 The
  57 .Fn pthread_mutex_lock
  58 function will fail if:
  59 .Bl -tag -width Er
  60 .It Bq Er EINVAL
  61 The value specified by
  62 .Fa mutex
  63 is invalid.
  64 .It Bq Er EDEADLK
  65 A deadlock would occur if the thread blocked waiting for
  66 .Fa mutex .
  67 .El
  68 .Sh SEE ALSO
  69 .Xr pthread_mutex_destroy 3 ,
  70 .Xr pthread_mutex_init 3 ,
  71 .Xr pthread_mutex_trylock 3 ,
  72 .Xr pthread_mutex_unlock 3
  73 .Sh STANDARDS
  74 The
  75 .Fn pthread_mutex_lock
  76 function conforms to
  77 .St -p1003.1-96 .