xref: /freebsd/share/man/man3/pthread_mutex_timedlock.3 (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1.\" Copyright (c) 2003 Michael Telahun Makonnen
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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd August 7, 2019
28.Dt PTHREAD_MUTEX_TIMEDLOCK 3
29.Os
30.Sh NAME
31.Nm pthread_mutex_timedlock
32.Nd lock a mutex without blocking indefinitely
33.Sh LIBRARY
34.Lb libpthread
35.Sh SYNOPSIS
36.In pthread.h
37.In time.h
38.Ft int
39.Fn pthread_mutex_timedlock "pthread_mutex_t *restrict mutex" "const struct timespec *restrict abs_timeout"
40.Sh DESCRIPTION
41The
42.Fn pthread_mutex_timedlock
43function will lock
44.Fa mutex .
45If it is already locked the calling thread will block until
46the mutex becomes available or
47the timeout,
48specified by abs_timeout,
49expires.
50The time of the timeout is an absolute time and
51is not relative to the current time.
52.Sh RETURN VALUES
53If successful,
54.Fn pthread_mutex_timedlock
55will return zero, otherwise an error number will be returned to
56indicate the error.
57.Sh ERRORS
58The
59.Fn pthread_mutex_timedlock
60function will fail if:
61.Bl -tag -width Er
62.It Bq "Er ENOTRECOVERABLE"
63The
64.Fa mutex
65was created with the protocol attribute having the
66value PTHREAD_PRIO_PROTECT and
67the calling thread's priority is higher than the
68mutex's current priority ceiling.
69.It Bq Er EINVAL
70The process or thread would have blocked, and
71.Fa abs_timeout
72specified a nanosecond value less than zero or
73greater than or equal to 1 billion.
74.It Bq Er EINVAL
75The
76.Fa mutex
77parameter is invalid.
78.It Bq Er ETIMEDOUT
79The
80.Fa mutex
81could not be locked before the timeout expired.
82.It Bq Er EAGAIN
83The
84.Fa mutex
85could not be acquired because the
86maximum number of recursive locks for the
87.Fa mutex
88has been exceeded.
89.It Bq Er EDEADLK
90The current thread already owns the
91.Fa mutex .
92.It Bq Er EOWNERDEAD
93The argument
94.Fa mutex
95points to a robust mutex and the process containing the previous owning
96thread terminated while holding the mutex lock.
97The lock was granted to the caller and it is up to the new owner
98to make the state consistent.
99.It Bq Er ENOTRECOVERABLE
100The state protected by the
101.Fa mutex
102is not recoverable.
103.El
104.Sh SEE ALSO
105.Xr pthread_mutex_consistent 3 ,
106.Xr pthread_mutex_destroy 3 ,
107.Xr pthread_mutex_init 3 ,
108.Xr pthread_mutex_lock 3 ,
109.Xr pthread_mutex_trylock 3 ,
110.Xr pthread_mutex_unlock 3
111.Sh STANDARDS
112The
113.Fn pthread_mutex_timedlock
114function is expected to conform to
115.St -p1003.1-96 .
116