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.Dd October 25, 2014
29.Dt PTHREAD_CLEANUP_PUSH 3
30.Os
31.Sh NAME
32.Nm pthread_cleanup_push
33.Nd add a cleanup function for thread exit
34.Sh LIBRARY
35.Lb libpthread
36.Sh SYNOPSIS
37.In pthread.h
38.Ft void
39.Fn pthread_cleanup_push "void \*[lp]*cleanup_routine\*[rp]\*[lp]void *\*[rp]" "void *arg"
40.Sh DESCRIPTION
41The
42.Fn pthread_cleanup_push
43function adds
44.Fa cleanup_routine
45to the top of the stack of cleanup handlers that
46get called when the current thread exits.
47.Pp
48When
49.Fa cleanup_routine
50is called, it is passed
51.Fa arg
52as its only argument.
53.Pp
54The
55.Fn pthread_cleanup_push
56function is implemented as a macro that opens a new block.
57Invocations of this function must appear as standalone statements that are
58paired with a later call of
59.Xr pthread_cleanup_pop 3
60in the same lexical scope.
61.Sh RETURN VALUES
62The
63.Fn pthread_cleanup_push
64function does not return any value.
65.Sh ERRORS
66None
67.Sh SEE ALSO
68.Xr pthread_cleanup_pop 3 ,
69.Xr pthread_exit 3
70.Sh STANDARDS
71The
72.Fn pthread_cleanup_push
73function conforms to
74.St -p1003.1-96 .
75