xref: /freebsd/share/man/man3/pthread_cleanup_pop.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
11fbdc08dSPoul-Henning Kamp.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
21fbdc08dSPoul-Henning Kamp.\" All rights reserved.
31fbdc08dSPoul-Henning Kamp.\"
41fbdc08dSPoul-Henning Kamp.\" Redistribution and use in source and binary forms, with or without
51fbdc08dSPoul-Henning Kamp.\" modification, are permitted provided that the following conditions
61fbdc08dSPoul-Henning Kamp.\" are met:
71fbdc08dSPoul-Henning Kamp.\" 1. Redistributions of source code must retain the above copyright
81fbdc08dSPoul-Henning Kamp.\"    notice, this list of conditions and the following disclaimer.
91fbdc08dSPoul-Henning Kamp.\" 2. Redistributions in binary form must reproduce the above copyright
101fbdc08dSPoul-Henning Kamp.\"    notice, this list of conditions and the following disclaimer in the
111fbdc08dSPoul-Henning Kamp.\"    documentation and/or other materials provided with the distribution.
121fbdc08dSPoul-Henning Kamp.\" 3. Neither the name of the author nor the names of any co-contributors
131fbdc08dSPoul-Henning Kamp.\"    may be used to endorse or promote products derived from this software
141fbdc08dSPoul-Henning Kamp.\"    without specific prior written permission.
151fbdc08dSPoul-Henning Kamp.\"
161fbdc08dSPoul-Henning Kamp.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
171fbdc08dSPoul-Henning Kamp.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
181fbdc08dSPoul-Henning Kamp.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
191fbdc08dSPoul-Henning Kamp.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
201fbdc08dSPoul-Henning Kamp.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
211fbdc08dSPoul-Henning Kamp.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
221fbdc08dSPoul-Henning Kamp.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
231fbdc08dSPoul-Henning Kamp.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
241fbdc08dSPoul-Henning Kamp.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
251fbdc08dSPoul-Henning Kamp.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
261fbdc08dSPoul-Henning Kamp.\" SUCH DAMAGE.
271fbdc08dSPoul-Henning Kamp.\"
28613a9773SJohn Baldwin.Dd October 25, 2014
291fbdc08dSPoul-Henning Kamp.Dt PTHREAD_CLEANUP_POP 3
30a307d598SRuslan Ermilov.Os
311fbdc08dSPoul-Henning Kamp.Sh NAME
321fbdc08dSPoul-Henning Kamp.Nm pthread_cleanup_pop
331fbdc08dSPoul-Henning Kamp.Nd call the first cleanup routine
34d8a78688SAlexey Zelkin.Sh LIBRARY
35ec7452f1SRuslan Ermilov.Lb libpthread
361fbdc08dSPoul-Henning Kamp.Sh SYNOPSIS
3732eef9aeSRuslan Ermilov.In pthread.h
381fbdc08dSPoul-Henning Kamp.Ft void
391fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_pop "int execute"
401fbdc08dSPoul-Henning Kamp.Sh DESCRIPTION
411fbdc08dSPoul-Henning KampThe
421fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_pop
431fbdc08dSPoul-Henning Kampfunction pops the top cleanup routine off of the current threads cleanup
441fbdc08dSPoul-Henning Kamproutine stack, and, if
451fbdc08dSPoul-Henning Kamp.Fa execute
46c6ff3a1bSSheldon Hearnis non-zero, it will execute the function.
47c6ff3a1bSSheldon HearnIf there is no cleanup routine
481fbdc08dSPoul-Henning Kampthen
491fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_pop
501fbdc08dSPoul-Henning Kampdoes nothing.
51613a9773SJohn Baldwin.Pp
52613a9773SJohn BaldwinThe
53*9ef82a94SJohn Baldwin.Fn pthread_cleanup_pop
54613a9773SJohn Baldwinfunction is implemented as a macro that closes a block.
55613a9773SJohn BaldwinInvocations of this function must appear as standalone statements that are
56613a9773SJohn Baldwinpaired with an earlier call of
57613a9773SJohn Baldwin.Xr pthread_cleanup_push 3
58613a9773SJohn Baldwinin the same lexical scope.
591fbdc08dSPoul-Henning Kamp.Sh RETURN VALUES
606f673fd1SPhilippe CharnierThe
611fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_pop
626f673fd1SPhilippe Charnierfunction does not return any value.
631fbdc08dSPoul-Henning Kamp.Sh ERRORS
641fbdc08dSPoul-Henning KampNone
651fbdc08dSPoul-Henning Kamp.Sh SEE ALSO
661fbdc08dSPoul-Henning Kamp.Xr pthread_cleanup_push 3 ,
671fbdc08dSPoul-Henning Kamp.Xr pthread_exit 3
681fbdc08dSPoul-Henning Kamp.Sh STANDARDS
696f673fd1SPhilippe CharnierThe
701fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_pop
716f673fd1SPhilippe Charnierfunction conforms to
72096841ecSRuslan Ermilov.St -p1003.1-96 .
73