carta
pthread_cleanup_pop_restore_np(3)

pthread_cleanup_pop_restore_np3

Push and pop thread cancelation clean-up handlers while saving cancelability type

Part of pthread_cleanup_push_defer_np(3).

Usage

void pthread_cleanup_push_defer_np(typeof(void (void *)) *routine, void *arg); void pthread_cleanup_pop_restore_np(int execute);

_GNU_SOURCE

Library

POSIX threads library (libpthread, -lpthread)

Overview

These functions are the same as pthread_cleanup_push(3) and pthread_cleanup_pop(3), except for the differences noted on this page.

Like pthread_cleanup_push(3), pthread_cleanup_push_defer_np() pushes routine onto the thread's stack of cancelation clean-up handlers. In addition, it also saves the thread's current cancelability type, and sets the cancelability type to "deferred" (see pthread_setcanceltype(3)); this ensures that cancelation clean-up will occur even if the thread's cancelability type was "asynchronous" before the call.

Like pthread_cleanup_pop(3), pthread_cleanup_pop_restore_np() pops the top-most clean-up handler from the thread's stack of cancelation clean-up handlers. In addition, it restores the thread's cancelability type to its value at the time of the matching 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 pthread_cleanup_push(3).

This sequence of calls:

pthread_cleanup_push_defer_np(routine, arg);
pthread_cleanup_pop_restore_np(execute);

is equivalent to (but shorter and more efficient than):

int oldtype;
pthread_cleanup_push(routine, arg);
pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldtype);
...
pthread_setcanceltype(oldtype, NULL);
pthread_cleanup_pop(execute);

History

  • Arch Linux 2026-11-01: the text shown here
  • Debian 13 (Trixie)
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie)
  • Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze)
  • Debian 5.0 (Lenny)

Standards

GNU; hence the suffix "_np" (nonportable) in the names.

History

glibc 2.0

From man-pages 6.19-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.