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