From patchwork Fri Oct 4 21:12:08 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Carlos O'Donell X-Patchwork-Id: 34833 Received: (qmail 16242 invoked by alias); 4 Oct 2019 21:12:20 -0000 Mailing-List: contact libc-alpha-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: libc-alpha-owner@sourceware.org Delivered-To: mailing list libc-alpha@sourceware.org Received: (qmail 16184 invoked by uid 89); 4 Oct 2019 21:12:19 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-18.2 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3 autolearn=ham version=3.3.1 spammy= X-HELO: us-smtp-delivery-1.mimecast.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1570223535; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=SfWPnWFwI3i+1EBZkz+WWx17cnkUYZftRq8RVdxcY/Q=; b=F7t0FcaH5Jnt/C+JJUVzH+Kgd0o7qQSKYJednfdcQt5Ho9xXywFlUdMZ2z06EuQ7YH7vVt D8030DLSOSvHnlBnqeRUuN6Ucrvh0Yz3vHweY5MD2+DE58elW8TsJ1SRuBP6aTfvYe1JY7 JOZlqjnoMFdqdyxHcWbmcUK+bypPW0k= Return-Path: To: "Michael Kerrisk (man-pages)" , linux-man , libc-alpha , Mathieu Desnoyers From: Carlos O'Donell Subject: [patch] Describe issues with cancellation points in signal handlers. Message-ID: <953b30ef-6546-ab16-06cb-e9d8d179dce2@redhat.com> Date: Fri, 4 Oct 2019 17:12:08 -0400 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.8.0 MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 In a recent conversation with Mathieu Desnoyers I was reminded that we haven't written up anything about how deferred cancellation and asynchronous signal handlers interact. Mathieu ran into some of this behaviour and I promised to improve the documentation in this area to point out the potential pitfall. Thoughts? 8< --- 8< --- 8< In pthread_setcancelstate.3, pthreads.7, and signal-safety.7 we describe that if you have an asynchronous signal nesting over a deferred cancellation region that any cancellation point in the signal handler may trigger a cancellation that will behave as-if it was an asynhcronous cancellation. This asynchronous cancellation may have unexpected effects on the consistency of the application. Therefore care should be taken with asynchronous signals and deferred cancellation. --- man3/pthread_setcancelstate.3 | 5 ++++- man7/pthreads.7 | 9 +++++++++ man7/signal-safety.7 | 5 +++++ 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/man3/pthread_setcancelstate.3 b/man3/pthread_setcancelstate.3 index 0237d572b..1a6fe45bf 100644 --- a/man3/pthread_setcancelstate.3 +++ b/man3/pthread_setcancelstate.3 @@ -78,7 +78,10 @@ A cancellation request is deferred until the thread next calls a function that is a cancellation point (see .BR pthreads (7)). This is the default cancelability type in all new threads, -including the initial thread. +including the initial thread. Even with deferred cancellation a +cancellation point in an asynchronous signal handler may still +be acted upon and the effect is as-if it was an asynchronous +cancellation. .TP .B PTHREAD_CANCEL_ASYNCHRONOUS The thread can be canceled at any time. diff --git a/man7/pthreads.7 b/man7/pthreads.7 index 06417d503..b39236c39 100644 --- a/man7/pthreads.7 +++ b/man7/pthreads.7 @@ -564,6 +564,15 @@ not specified in the standard as cancellation points. In particular, an implementation is likely to mark any nonstandard function that may block as a cancellation point. (This includes most functions that can touch files.) +.in +.PP +It should be noted that even if an application is not using +asynchronous cancellation, that calling a function from the above list +from an asynchronous signal handler may cause the equivalent of +asynchronous cancellation. The underlying user code may not expect +asynchronous cancellation and the state of the user data may become +inconsistent. Therefore signals should be used with caution when +entering a region of deferred cancellation. .\" So, scanning "cancellation point" comments in the glibc 2.8 header .\" files, it looks as though at least the following nonstandard .\" functions are cancellation points: diff --git a/man7/signal-safety.7 b/man7/signal-safety.7 index 3879a5aef..051702b76 100644 --- a/man7/signal-safety.7 +++ b/man7/signal-safety.7 @@ -314,6 +314,11 @@ is likely to remove .BR fork (2) from the list of async-signal-safe functions. .\" +.IP * 3 +Asynchronous signal handlers that call functions which are cancellation +points and nest over regions of deferred cancellation may trigger +cancellation whose behavior is as-if asynchronous cancellation had +occurred and may cause application state to become inconsistent. .SS Deviations in the GNU C library The following known deviations from the standard occur in the GNU C library: