2008-12-04 14:47:20 +00:00
|
|
|
.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.TH PTHREAD_CLEANUP_PUSH_DEFER_NP 3 2008-12-04 "Linux" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
|
|
|
pthread_cleanup_push_defer_np, pthread_cleanup_pop_restore_np \- push and pop
|
|
|
|
thread cancellation clean-up handlers while saving cancelability type
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <pthread.h>
|
|
|
|
|
|
|
|
.BI "void pthread_cleanup_push_defer_np(void (*" routine ")(void *),"
|
|
|
|
.BI " void *" arg );
|
|
|
|
.BI "void pthread_cleanup_pop_restore_np(int " execute );
|
|
|
|
.sp
|
|
|
|
Compile and link with \fI\-pthread\fP.
|
|
|
|
.SH DESCRIPTION
|
|
|
|
These functions are the same as
|
|
|
|
.BR pthread_cleanup_push (3)
|
|
|
|
and
|
|
|
|
.BR pthread_cleanup_pop (3),
|
|
|
|
except for the differences noted on this page.
|
|
|
|
|
|
|
|
Like
|
|
|
|
.BR pthread_cleanup_push (3),
|
|
|
|
.BR pthread_cleanup_push_defer_np ()
|
|
|
|
pushes
|
|
|
|
.I routine
|
|
|
|
onto the thread's stack of cancellation clean-up handlers.
|
|
|
|
In addition, it also saves the thread's current cancelability type,
|
|
|
|
and sets the cancelability type to "deferred" (see
|
|
|
|
.BR pthread_setcanceltype (3));
|
|
|
|
this ensures that cancellation clean-up will occur
|
|
|
|
even if the thread's cancelability type was "asynchronous"
|
|
|
|
before the the call.
|
|
|
|
|
|
|
|
Like
|
|
|
|
.BR pthread_cleanup_pop (3),
|
|
|
|
.BR pthread_cleanup_pop_restore_np ()
|
|
|
|
pops the top-most clean-up handler from the thread's
|
|
|
|
stack of cancellation clean-up handlers.
|
|
|
|
In addition, it restores the thread's cancelability
|
|
|
|
type to its value at the time of the matching
|
|
|
|
.BR pthread_cleanup_push_defer_np ().
|
|
|
|
|
|
|
|
The caller must ensure that calls to these
|
|
|
|
functions are paired within the same function,
|
|
|
|
and at the same lexical nesting level.
|
|
|
|
Other restrictions apply, as described in
|
|
|
|
.BR pthread_cleanup_push (3).
|
|
|
|
|
|
|
|
This sequence of calls:
|
|
|
|
|
|
|
|
.in +4n
|
|
|
|
.nf
|
|
|
|
pthread_cleanup_push_defer_np(routine, arg);
|
|
|
|
pthread_cleanup_pop_restore_np(execute);
|
|
|
|
.fi
|
|
|
|
.in
|
|
|
|
|
|
|
|
is equivalent to (but shorter and more efficient than):
|
|
|
|
|
ioctl_list.2, mount.2, select_tut.2, stat.2, getifaddrs.3, pthread_cleanup_push_defer_np.3, pthread_getcpuclockid.3, proc.5, bootparam.7: Global fix: s/sub-/sub/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "sub-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 17:36:10 +00:00
|
|
|
.\" As far as I can see, LinuxThreads reverses the two substeps
|
2008-12-04 14:47:20 +00:00
|
|
|
.\" in the push and pop below.
|
|
|
|
.in +4n
|
|
|
|
.nf
|
|
|
|
int oldtype;
|
|
|
|
|
|
|
|
pthread_cleanup_push(routine, arg);
|
|
|
|
pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldtype);
|
|
|
|
\&...
|
|
|
|
pthread_setcanceltype(oldtype, NULL);
|
|
|
|
pthread_cleanup_pop(execute);
|
|
|
|
.fi
|
|
|
|
.in
|
|
|
|
.\" SH VERSIONS
|
|
|
|
.\" Available since glibc 2.0
|
|
|
|
.SH CONFORMING TO
|
accept.2, execve.2, futimesat.2, getresuid.2, getrlimit.2, madvise.2, mq_getsetattr.2, msgctl.2, nice.2, open.2, poll.2, setresuid.2, shmctl.2, sigaction.2, times.2, utimensat.2, __setfpucw.3, atoi.3, endian.3, err.3, euidaccess.3, fenv.3, fopencookie.3, fpurge.3, getgrouplist.3, getutmp.3, j0.3, lgamma.3, netlink.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_cleanup_push_defer_np.3, pthread_getattr_np.3, pthread_kill_other_threads_np.3, pthread_setaffinity_np.3, pthread_tryjoin_np.3, pthread_yield.3, random_r.3, readdir.3, rtnetlink.3, scanf.3, setenv.3, significand.3, sigsetops.3, strerror.3, strstr.3, sysv_signal.3, termios.3, timegm.3, unlocked_stdio.3, y0.3, locale.5, bootparam.7, feature_test_macros.7, ip.7, locale.7, pthreads.7, rtld-audit.7, nscd.8: Global fix: s/non-standard/nonstandard/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:37:52 +00:00
|
|
|
These functions are nonstandard GNU extensions;
|
execve.2, fallocate.2, futex.2, sched_rr_get_interval.2, select_tut.2, shmget.2, timer_getoverrun.2, times.2, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_cleanup_push_defer_np.3, pthread_getattr_np.3, pthread_self.3, pthread_setaffinity_np.3, pthread_tryjoin_np.3, sem_open.3, stdin.3, rtc.4, tty_ioctl.4, unix.7: Global fix: s/non-portable/nonportable/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:46:09 +00:00
|
|
|
hence the suffix "_np" (nonportable) in the names.
|
2008-12-04 14:47:20 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
.BR pthread_cancel (3),
|
|
|
|
.BR pthread_cleanup_push (3),
|
|
|
|
.BR pthread_setcancelstate (3),
|
|
|
|
.BR pthread_testcancel (3),
|
|
|
|
.BR pthreads (7)
|