119 lines
4.5 KiB
Groff
119 lines
4.5 KiB
Groff
.\" $NetBSD: pthread_cleanup_push.3,v 1.6 2010/07/09 08:51:28 jruoho Exp $
|
|
.\"
|
|
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the author nor the names of any co-contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD: src/lib/libpthread/man/pthread_cleanup_push.3,v 1.11 2002/09/16 19:29:28 mini Exp $
|
|
.\"
|
|
.Dd July 9, 2010
|
|
.Dt PTHREAD_CLEANUP 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm pthread_cleanup_push ,
|
|
.Nm pthread_cleanup_pop
|
|
.Nd add and remove cleanup functions for thread exit
|
|
.Sh LIBRARY
|
|
.Lb libpthread
|
|
.Sh SYNOPSIS
|
|
.In pthread.h
|
|
.Ft void
|
|
.Fn pthread_cleanup_push "void \*[lp]*cleanup_routine\*[rp]\*[lp]void *\*[rp]" "void *arg"
|
|
.Ft void
|
|
.Fn pthread_cleanup_pop "int execute"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn pthread_cleanup_push
|
|
function adds
|
|
.Fa cleanup_routine
|
|
to the top of the stack of cleanup handlers that
|
|
get called when the current thread exits.
|
|
.Pp
|
|
The
|
|
.Fn pthread_cleanup_pop
|
|
function pops the top cleanup routine off of the current threads cleanup
|
|
routine stack, and, if
|
|
.Fa execute
|
|
is non-zero, it will execute the function.
|
|
.Pp
|
|
When
|
|
.Fa cleanup_routine
|
|
is called, it is passed
|
|
.Fa arg
|
|
as its only argument.
|
|
.Pp
|
|
These functions may be implemented as macros which contain scope delimiters;
|
|
therefore, there must be a matching
|
|
.Fn pthread_cleanup_pop
|
|
for every
|
|
.Fn pthread_cleanup_push
|
|
at the same level of lexical scoping.
|
|
.Pp
|
|
The effect of calling
|
|
.Fn longjmp
|
|
or
|
|
.Fn siglongjmp
|
|
is undefined after a call to
|
|
.Fn pthread_cleanup_push
|
|
but before the matching call to
|
|
.Fn pthread_cleanup_pop
|
|
after the jump buffer was filled.
|
|
.Sh RETURN VALUES
|
|
Neither
|
|
.Fn pthread_cleanup_push
|
|
nor
|
|
.Fn pthread_cleanup_pop
|
|
returns a value.
|
|
.Sh ERRORS
|
|
None.
|
|
.Sh SEE ALSO
|
|
.Xr pthread_exit 3
|
|
.Sh STANDARDS
|
|
Both functions conform to
|
|
.St -p1003.1-2001 .
|