[src/trunk]: src/lib/libpthread Split pthread_attr_getdetachstate(3) and pthr...

To: source-changes-hg%NetBSD.org@localhost
Subject: [src/trunk]: src/lib/libpthread Split pthread_attr_getdetachstate(3) and pthr...
From: jruoho <jruoho%NetBSD.org@localhost>
Date: Mon, 06 Apr 2020 19:09:48 +0000
details:   https://anonhg.NetBSD.org/src/rev/aacdf895e71c
branches:  trunk
changeset: 756146:aacdf895e71c
user:      jruoho <jruoho%NetBSD.org@localhost>
date:      Wed Jul 07 08:57:36 2010 +0000

description:
Split pthread_attr_getdetachstate(3) and pthread_attr_setdetachstate(3) to a
separate page. Once ready, the main page, pthread_attr(3), will contain a
summary of the various thread attribute functions.

diffstat:

 lib/libpthread/Makefile                      |    6 +-
 lib/libpthread/pthread_attr.3                |   36 +-------
 lib/libpthread/pthread_attr_getdetachstate.3 |  119 +++++++++++++++++++++++++++
 3 files changed, 123 insertions(+), 38 deletions(-)

diffs (235 lines):

diff -r 77bfc2054a62 -r aacdf895e71c lib/libpthread/Makefile
--- a/lib/libpthread/Makefile   Wed Jul 07 08:41:11 2010 +0000
+++ b/lib/libpthread/Makefile   Wed Jul 07 08:57:36 2010 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.59 2010/07/07 08:22:53 jruoho Exp $
+#      $NetBSD: Makefile,v 1.60 2010/07/07 08:57:36 jruoho Exp $
 #
 
 WARNS= 4
@@ -90,6 +90,7 @@
 MAN+=  affinity.3 pthread.3 \
        pthread_attr.3 \
        pthread_attr_get_np.3 \
+       pthread_attr_getdetachstate.3 \
        pthread_attr_getname_np.3 \
        pthread_attr_getscope.3 \
        pthread_attr_setcreatesuspend_np.3 \
@@ -126,8 +127,6 @@
 MLINKS+=       pthread_attr.3 pthread_attr_getguardsize.3
 MLINKS+=       pthread_attr.3 pthread_attr_setstackaddr.3
 MLINKS+=       pthread_attr.3 pthread_attr_getstackaddr.3
-MLINKS+=       pthread_attr.3 pthread_attr_setdetachstate.3
-MLINKS+=       pthread_attr.3 pthread_attr_getdetachstate.3
 MLINKS+=       pthread_attr.3 pthread_attr_setinheritsched.3
 MLINKS+=       pthread_attr.3 pthread_attr_getinheritsched.3
 MLINKS+=       pthread_attr.3 pthread_attr_setschedparam.3
@@ -135,6 +134,7 @@
 MLINKS+=       pthread_attr.3 pthread_attr_setschedpolicy.3
 MLINKS+=       pthread_attr.3 pthread_attr_getschedpolicy.3
 
+MLINKS+=       pthread_attr_getdetachstate.3 pthread_attr_setdetachstate.3
 MLINKS+=       pthread_attr_getscope.3 pthread_attr_setscope.3
 
 MLINKS+=       pthread_barrierattr.3 pthread_barrierattr_init.3
diff -r 77bfc2054a62 -r aacdf895e71c lib/libpthread/pthread_attr.3
--- a/lib/libpthread/pthread_attr.3     Wed Jul 07 08:41:11 2010 +0000
+++ b/lib/libpthread/pthread_attr.3     Wed Jul 07 08:57:36 2010 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: pthread_attr.3,v 1.12 2010/07/07 08:41:11 jruoho Exp $
+.\"    $NetBSD: pthread_attr.3,v 1.13 2010/07/07 08:57:36 jruoho Exp $
 .\"
 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -65,8 +65,6 @@
 .Nm pthread_attr_getguardsize ,
 .Nm pthread_attr_setstackaddr ,
 .Nm pthread_attr_getstackaddr ,
-.Nm pthread_attr_setdetachstate ,
-.Nm pthread_attr_getdetachstate ,
 .Nm pthread_attr_setinheritsched ,
 .Nm pthread_attr_getinheritsched ,
 .Nm pthread_attr_setschedparam ,
@@ -95,10 +93,6 @@
 .Ft int
 .Fn pthread_attr_getstackaddr "const pthread_attr_t * restrict attr" "void ** restrict stackaddr"
 .Ft int
-.Fn pthread_attr_setdetachstate "pthread_attr_t *attr" "int detachstate"
-.Ft int
-.Fn pthread_attr_getdetachstate "const pthread_attr_t *attr" "int *detachstate"
-.Ft int
 .Fn pthread_attr_setinheritsched "pthread_attr_t *attr" "int inheritsched"
 .Ft int
 .Fn pthread_attr_getinheritsched "const pthread_attr_t * restrict attr" "int * restrict inheritsched"
@@ -136,23 +130,6 @@
 .Fn pthread_attr_get*
 functions copy the value of the attribute that corresponds to each function name
 to the location pointed to by the second function parameter.
-.Pp
-The attribute parameters for the
-.Fn pthread_attr_setdetachstate
-and
-.Fn pthread_attr_getdetachstate
-are mutually exclusive and must be one of:
-.Bl -tag -width xxxxxxxx
-.It Dv PTHREAD_CREATE_JOINABLE
-The threads must explicitly be waited for using the
-.Fn pthread_join
-function once they exit for their status to be received and their resources
-to be freed.
-This is the default.
-.It Dv PTHREAD_CREATE_DETACHED
-The thread's resources will automatically be freed once the thread exits,
-and the thread will not be joined.
-.El
 .Sh RETURN VALUES
 If successful, these functions return 0.
 Otherwise, an error number is returned to indicate the error.
@@ -182,15 +159,6 @@
 .Dv PTHREAD_STACK_MIN .
 .El
 .Pp
-.Fn pthread_attr_setdetachstate
-should fail if:
-.Bl -tag -width Er
-.It Bq Er EINVAL
-The value specified by
-.Fa detachstate
-is invalid.
-.El
-.Pp
 Fn pthread_attr_setinheritsched
 may fail if:
 .Bl -tag -width Er
@@ -232,8 +200,6 @@
 .Fn pthread_attr_getstacksize ,
 .Fn pthread_attr_setstackaddr ,
 .Fn pthread_attr_getstackaddr ,
-.Fn pthread_attr_setdetachstate ,
-.Fn pthread_attr_getdetachstate ,
 .Fn pthread_attr_setinheritsched ,
 .Fn pthread_attr_getinheritsched ,
 .Fn pthread_attr_setschedparam ,
diff -r 77bfc2054a62 -r aacdf895e71c lib/libpthread/pthread_attr_getdetachstate.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpthread/pthread_attr_getdetachstate.3      Wed Jul 07 08:57:36 2010 +0000
@@ -0,0 +1,119 @@
+.\"    $NetBSD: pthread_attr_getdetachstate.3,v 1.1 2010/07/07 08:57:36 jruoho Exp $
+.\"
+.\" Copyright (c) 2002, 2010 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" 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, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, 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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``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 FOUNDATION OR CONTRIBUTORS
+.\" 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.
+.\"
+.\" Copyright (C) 2000 Jason Evans <jasone%FreeBSD.org@localhost>.
+.\" All rights reserved.
+.\"
+.\" 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.
+.\"
+.\" $FreeBSD: src/lib/libpthread/man/pthread_attr.3,v 1.11 2002/09/16 19:29:28 mini Exp $
+.\"
+.Dd July 7, 2010
+.Dt PTHREAD_ATTR_GETDETACHSTATE 3
+.Os
+.Sh NAME
+.Nm pthread_attr_getdetachstate
+.Nd get and set the
+.Dq detach state
+attribute
+.Sh LIBRARY
+.Lb libpthread
+.Sh SYNOPSIS
+.In pthread.h
+.Ft int
+.Fn pthread_attr_getdetachstate "const pthread_attr_t *attr" "int *detachstate"
+.Ft int
+.Fn pthread_attr_setdetachstate "pthread_attr_t *attr" "int detachstate"
+.Sh DESCRIPTION
+The attribute parameters for the
+.Fn pthread_attr_getdetachstate
+and
+.Fn pthread_attr_setdetachstate
+functions are mutually exclusive and must be one of:
+.Bl -tag -width PTHREAD_CREATE_DETACHED -offset 2n
+.It Dv PTHREAD_CREATE_JOINABLE
+The threads must explicitly be waited for using the
+.Xr pthread_join 3
+function once they exit for their status to be received and their resources
+to be freed.
+This is the default.
+.It Dv PTHREAD_CREATE_DETACHED
+The thread's resources will automatically be freed once the thread exits,
+and the thread will not be joined.
+.El
+.Pp
+If the thread is created as detached,
+it is an error to use the thread
+.Tn ID
+with
+.Xr pthread_detach 3
+or
+.Xr pthread_join 3 .
+.Sh RETURN VALUES
+If successful, these functions return 0.
+Otherwise, an error number is returned to indicate the error.
+.Sh ERRORS
+No errors are defined for
+.Fn pthread_attr_getdetachstate .
+.Pp
+The
+.Fn pthread_attr_setdetachstate
+function should fail if:
+.Bl -tag -width Er
+.It Bq Er EINVAL
+The value specified by
+.Fa detachstate
+is invalid.
+.El
+.Sh SEE ALSO
+.Xr pthread_attr 3 ,
+.Xr pthread_detach 3 ,
+.Xr pthread_join 3
+.Sh STANDARDS
+Both functions conform to
+.St -p1003.1-96 .
Prev by Date: [src/trunk]: src/lib/libpthread Move pthread_attr_{g, s}etscope() to a separat...
Next by Date: [src/trunk]: src/lib/libpthread Sort sections.
Previous by Thread: [src/trunk]: src/lib/libpthread Move pthread_attr_{g, s}etscope() to a separat...
Next by Thread: [src/trunk]: src/lib/libpthread Sort sections.
Indexes:
Home | Main Index | Thread Index | Old Index