From nobody Tue Apr 30 00:49:02 2024 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4VT1mH1mZ7z5HjtF; Tue, 30 Apr 2024 00:49:03 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4VT1mG6kn6z4Klb; Tue, 30 Apr 2024 00:49:02 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1714438142; 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=g7na17N0JYwIzSZBVZVu9IxtKyITb8mVh1oWUmeUkL4=; b=AXNQW2jkkAfwsT96robPVsafemQhhEiHuoJRQgN3EKNXale0zfaDDgVqIbgZqFeupRBc1Q 0QSwSwfzmyYfaMsOTJnvPMB3IPSneCI7EqiVz7rUj8vHB91mf+XL8Oudcsk7u4KM5RBdVd y5P6CVXVhfLcBLs90OPC4QOmJXgmJqxlpPP8dRzNyLrzHmYs1v6JKwmW8UeITXIKVaO6W7 yDkD6P5GdpYb7xXukEyqFcjcqoxPkgyaX7XjpMreHxzcoFe8BLr9F/vzrgrj2SL9Wnjb63 GvYvAWTg8lt+jtYUCRk//iwxo5MrmJMHPwB2ZK/9NIUZAfWtSFjT++kHMxl44Q== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1714438142; a=rsa-sha256; cv=none; b=lvjz/nglOcdjU5MwznYuF8QhCPxa/XRiLmisQHc5qBAvyEGFJodzG93U3ysv2xViWTHmBf 8QI+FZHqBAmNIse0i28ULJUdFAJYEA7iiLJgoVn3Uk5npacY7HVsKO+/Rci61nsqFR52Tp kGJ3AMR5nV3Xb4Etltgmfsk5hVDjyS5m5m5LEdIp5oJGWEtTwHDxCOnnv19UMVXVskS8Qy VLxeANij3rzrHHYQ/RJVv9UlmxjcWWE2dwCSZLI1cx62Vi3D1vw+GvQTPfYBLSwtZTjYX3 abyFhsHuPUmumqbRxzt1DKJvxxfIb/8JhSfhN5dpXnjn69qUpZ0B6eEVzlP2kA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1714438142; 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=g7na17N0JYwIzSZBVZVu9IxtKyITb8mVh1oWUmeUkL4=; b=PtP7Qvr2d4YpbtA0b/Tzq0O8ukFJMLMGEh7CTIABd15YjB+1hwD2JPYVpnHtYJ9DTgENAs nui6vpxijTx/dN8nw9gX0K+qVdlnPRJhZqCuu+1h6N7huBAbV9jq7+LgjRbaad9akcPJ8Z Ps4aqWsaJNfwIARp3KX8cBCxgaLtjBXGaFPCgiVB8AhjAE7ikDI1LykRrRrI5rykRGHXUk 7FmbQtNK+Y5spX6Dl6/DbR6JIBiZD5vD/ySfHzWZC1rIkZ6ZZE2kkpFGU/g1maxXs03Tmw XCgA1U0fLN9p4jlJjN1bAvIfgQlMiuGV6XRcypX7OiYOc63zzqWS4X8vc8FR3g== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4VT1mG6M65z1STY; Tue, 30 Apr 2024 00:49:02 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 43U0n2dN012952; Tue, 30 Apr 2024 00:49:02 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 43U0n2rK012949; Tue, 30 Apr 2024 00:49:02 GMT (envelope-from git) Date: Tue, 30 Apr 2024 00:49:02 GMT Message-Id: <202404300049.43U0n2rK012949@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Konstantin Belousov Subject: git: 42b071cbc91e - stable/14 - pthread_sigqueue(3): document List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: kib X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: 42b071cbc91e18e45e21feff39ca9e47ef93cc55 Auto-Submitted: auto-generated The branch stable/14 has been updated by kib: URL: https://cgit.FreeBSD.org/src/commit/?id=42b071cbc91e18e45e21feff39ca9e47ef93cc55 commit 42b071cbc91e18e45e21feff39ca9e47ef93cc55 Author: Konstantin Belousov AuthorDate: 2024-04-20 22:16:08 +0000 Commit: Konstantin Belousov CommitDate: 2024-04-30 00:48:09 +0000 pthread_sigqueue(3): document (cherry picked from commit 91da6becae6291533b9b59646b59bace2f905c81) --- share/man/man3/Makefile | 1 + share/man/man3/pthread_sigqueue.3 | 102 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 103 insertions(+) diff --git a/share/man/man3/Makefile b/share/man/man3/Makefile index 2b2d7516c11f..75f209ab4e0d 100644 --- a/share/man/man3/Makefile +++ b/share/man/man3/Makefile @@ -453,6 +453,7 @@ PTHREAD_MAN= pthread.3 \ pthread_set_name_np.3 \ pthread_setspecific.3 \ pthread_sigmask.3 \ + pthread_sigqueue.3 \ pthread_spin_init.3 \ pthread_spin_lock.3 \ pthread_suspend_all_np.3 \ diff --git a/share/man/man3/pthread_sigqueue.3 b/share/man/man3/pthread_sigqueue.3 new file mode 100644 index 000000000000..bf5dd62f04e6 --- /dev/null +++ b/share/man/man3/pthread_sigqueue.3 @@ -0,0 +1,102 @@ +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright 2024 The FreeBSD Foundation, Inc. +.\" +.\" This documentation was written by +.\" Konstantin Belousov under sponsorship +.\" from the FreeBSD Foundation. +.\" +.\" 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(s), this list of conditions and the following disclaimer as +.\" the first lines of this file unmodified other than the possible +.\" addition of one or more copyright notices. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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. +.\" +.Dd April 21, 2024 +.Dt PTHREAD_SIGQUEUE 3 +.Os +.Sh NAME +.Nm pthread_sigqueue +.Nd queue a signal to a specified thread +.Sh LIBRARY +.Lb libpthread +.Sh SYNOPSIS +.In pthread.h +.In signal.h +.Ft int +.Fn pthread_sigqueue "pthread_t thread" "int sig" "const union sigval value" +.Sh DESCRIPTION +The +.Fn pthread_queue +function queues a signal, specified by +.Fa sig , +to a thread, specified by +.Fa thread . +If +.Fa sig +is 0, error checking is performed, but no signal is actually sent. +The +.Fa value +is queued together with the signal, and becomes available in +.Vt siginfo_t +data passed to the signal handler. +.Pp +The +.Nm +function is similar to +.Xr sigqueue 2 , +but targets a thread in the current process instead of a process. +See +.Xr sigqueue 2 +for details about signal queueing and delivery selection. +.Sh RETURN VALUES +If successful, +.Fn pthread_sigqueue +returns 0. +Otherwise, an error number is returned. +.Sh ERRORS +The +.Fn pthread_sigqueue +function will fail if: +.Bl -tag -width Er +.It Bq Er EAGAIN +No resources are available to queue the signal. +The current process has already queued +.Brq Dv SIGQUEUE_MAX +signals that are still pending, +or a system-wide resource limit has been exceeded. +.It Bq Er ESRCH +.Fa thread +is an invalid thread ID. +.It Bq Er EINVAL +.Fa sig +is an invalid or unsupported signal number. +.El +.Sh SEE ALSO +.Xr sigqueue 2 +.Sh STANDARDS +The +.Fn pthread_sigqueue +function is a +.Fx +extension. +An identical function with the same semantic is available in other +operating systems.