From nobody Wed Jan 10 17:50:37 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 4T9FhG15zPz55V1P; Wed, 10 Jan 2024 17:50:38 +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 4T9FhF70wLz46pv; Wed, 10 Jan 2024 17:50:37 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1704909038; 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=aG5ZluH+4tWJLb7+/5c9aMKv321s7nUuyHkguldv8dc=; b=LMdLvJEmlVyr1K4b9BopbXYoeAsDZkv4aXXtU/dKozRfOf7wHge5Ky7YAAaPyQD54Ccg/Y dkyXPm+z1vPP7eDM38v1l4AWkgVPeYEGcNqMm6fXc/QWoF+eZOThiMVFiiHuUf1WFqBk0+ DESfPCcWcU2sQj4drxhqxJv9k/owXCV8c0kH5eb3TOIF+2jVXTdXLiOMypSQdhJER/Q6t/ b3jGFAuAuS/EQIN9gAroKg5lIYUELaEsLIcvbFzllYZIYpQfJiXBzUKO9X97q6Q/afTIQ9 X95FX5jOmPtG645hLFXJtj+jZBY/jnwwotDsLqGw5FIaD6J9UGdL7ZZpwc4yzg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1704909038; 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=aG5ZluH+4tWJLb7+/5c9aMKv321s7nUuyHkguldv8dc=; b=TpBt8pNQzNGgJDxcqx5zuNBcPWdpz8d9iA4HkVcI0a1LNO3Xh4hcM2tmTnE8fk2LAnmURb /E+BRk2tx9y3VSZ85hBh03dtDaklmV+scMlbSvmc09I+Q3GKzlBp6CHVtyLzttyuzogbjX 0EAiHSgxpKeIGCKpK0cvnh2yUMlkPyrbAYDOKXfTkiAdFA75DxAAAJ1INCnmRQ6qM7M3tY vAFG8Hjm7K9ZxioHToaYag4BJyn10FGIx1lBAbkbAFmmdTQgkAkyrCVZmoaQwOHFGZnlF9 vaCKw8wuT8RijAcHgqzGFYfTE9HG3HKYjR0vi+OYsz2ilYAWFeZsOAtqQq6QzA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1704909038; a=rsa-sha256; cv=none; b=oZImTwalug2Pw4hhMo2tNjgzCmaf9raZqgjXC+RPxFviNKJHzszXS85ehaluSZ9kCvhcUI N0zEwD2Zk6SD7+z7Vyt0zIIgOx14w78sWxDNy6pIuhkOBDZahzqU3De45oFNQY/tUj86GT 1NEK6690o+hG2MP00xTVlboK7pA4a4HHovBnkb01UdfddP+CzXJW/rawvPjp/0ecbIVHao Xdw0sqgMtbf/mMVKYe/X4gYUIlVQlGtYwkMV2rSgoo+5eG85XBcGdtXt7JLl0bC8/8I47Z 0Y13ZTRp+TYsObgwB1hJRNIR4FTbIXCbcyXUv3O1xZGgott71OZd0b5Fj09ddA== 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 4T9FhF663wzlVt; Wed, 10 Jan 2024 17:50:37 +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 40AHob6s098307; Wed, 10 Jan 2024 17:50:37 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 40AHob5v098304; Wed, 10 Jan 2024 17:50:37 GMT (envelope-from git) Date: Wed, 10 Jan 2024 17:50:37 GMT Message-Id: <202401101750.40AHob5v098304@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Olivier Certner Subject: git: 6211cd4be32d - main - pthread_attr_get_np(3): Revamp 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: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: olce X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 6211cd4be32dfdc51b5ac452d4ead98a36ec42a6 Auto-Submitted: auto-generated The branch main has been updated by olce: URL: https://cgit.FreeBSD.org/src/commit/?id=6211cd4be32dfdc51b5ac452d4ead98a36ec42a6 commit 6211cd4be32dfdc51b5ac452d4ead98a36ec42a6 Author: Olivier Certner AuthorDate: 2024-01-05 13:14:48 +0000 Commit: Olivier Certner CommitDate: 2024-01-10 17:50:19 +0000 pthread_attr_get_np(3): Revamp Fix and more thoroughly describe the attributes object lifecycle. Also, correct the text about which attributes' values are reported. Add the ENOMEM error. While here, rephrase unclear passages, add references and fix the example's style. Reviewed by: kib, emaste Approved by: emaste (mentor) MFC after: 2 weeks Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D43330 --- share/man/man3/pthread_attr_get_np.3 | 84 +++++++++++++++++++++--------------- 1 file changed, 49 insertions(+), 35 deletions(-) diff --git a/share/man/man3/pthread_attr_get_np.3 b/share/man/man3/pthread_attr_get_np.3 index a13835287d7f..07153586c1b2 100644 --- a/share/man/man3/pthread_attr_get_np.3 +++ b/share/man/man3/pthread_attr_get_np.3 @@ -1,5 +1,10 @@ .\" Copyright (c) 2002,2003 Alexey Zelkin .\" All rights reserved. +.\" Copyright (c) 2024 The FreeBSD Foundation +.\" +.\" Portions of this documentation were written by Olivier Certner +.\" at Kumacom SARL 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 @@ -22,12 +27,12 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd October 12, 2021 +.Dd January 5, 2024 .Dt PTHREAD_ATTR_GET_NP 3 .Os .Sh NAME .Nm pthread_attr_get_np -.Nd get attributes of existent thread +.Nd get attributes of an existing thread .Sh LIBRARY .Lb libpthread .Sh SYNOPSIS @@ -37,51 +42,54 @@ .Sh DESCRIPTION The .Fn pthread_attr_get_np -function is used to get existent thread's attributes. -Most fields of -.Vt pthread_attr_t -structure are exact values of attributes provided at thread creation -time (as parameter to -.Xr pthread_create 3 -function), except for the stack address. -.Pp -Value returned as -.Fa dst -is supposed to be used in conjunction with -.Fn pthread_attr_get* -functions to retrieve individual values from +function is used to retrieve the attributes of the specified thread into an +existing .Vt pthread_attr_t structure. -Parameter -.Fa dst -should point to allocated memory area big enough to fit this structure. +The attributes' values are the current ones for the target thread, except for +the stack top address if not properly aligned for the architecture, since in +this case its value has been adjusted internally before use. .Pp -It is HIGHLY RECOMMENDED to use +Argument +.Fa dst +must be a pointer to a valid attributes object +.Po +it was initialized at some point by .Xr pthread_attr_init 3 -function to allocate attribute storage. -.Sh IMPLEMENTATION NOTES -The -.Fn pthread_attr_get_np -function will always return a pointer to the thread's real stack address, -regardless of its value in the original attributes structure. +and was not destroyed since then +.Pc . +After a successful call to +.Fn pthread_attr_get_np , +the individual attributes' values can be retrieved as usual via the +corresponding accessor functions as documented in +.Xr pthread_attr 3 . +After a failed call to +.Fn pthread_attr_get_np , +the object pointed to by +.Fa dst +is left unmodified, and can continue to be used as if the failed call never +happened. .Sh RETURN VALUES If successful, .Fn pthread_attr_get_np function returns 0. Otherwise, an error number is returned to indicate the error. .Sh EXAMPLES +This function retrieves the stack size of the thread specified by the +.Fa pid +argument: .Bd -literal size_t -my_thread_stack_size(pthread_t pid) +my_thread_stack_size(pthread_t tid) { - pthread_attr_t attr; - size_t size; + pthread_attr_t attr; + size_t size; - pthread_attr_init(&attr); - pthread_attr_get_np(pid, &attr); - pthread_attr_getstacksize(&attr, &size); - pthread_attr_destroy(&attr); - return(size); + pthread_attr_init(&attr); + pthread_attr_get_np(tid, &attr); + pthread_attr_getstacksize(&attr, &size); + pthread_attr_destroy(&attr); + return (size); } .Ed .Sh ERRORS @@ -90,12 +98,16 @@ The function will fail if: .Bl -tag -width Er .It Bq Er EINVAL -Invalid value for one of given parameters. +One of the arguments has an invalid value. .It Bq Er ESRCH No thread could be found corresponding to that specified by the given thread ID. +.It Bq Er ENOMEM +There was not enough memory to allocate additional storage needed by the attributes +object's implementation. .El .Sh SEE ALSO +.Xr pthread_attr 3 , .Xr pthread_attr_destroy 3 , .Xr pthread_attr_getdetachstate 3 , .Xr pthread_attr_getinheritsched 3 , @@ -111,4 +123,6 @@ thread ID. The .Fn pthread_attr_get_np function and this manual page were written by -.An Alexey Zelkin Aq Mt phantom@FreeBSD.org . +.An Alexey Zelkin Aq Mt phantom@FreeBSD.org , +and the latter was revised by +.An Olivier Certner Aq Mt olce@FreeBSD.org .